Adds the owner of an entity (a domain unit).
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, AddEntityOwnerCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, AddEntityOwnerCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // AddEntityOwnerInput + * domainIdentifier: "STRING_VALUE", // required + * entityType: "DOMAIN_UNIT", // required + * entityIdentifier: "STRING_VALUE", // required + * owner: { // OwnerProperties Union: only one key present + * user: { // OwnerUserProperties + * userIdentifier: "STRING_VALUE", // required + * }, + * group: { // OwnerGroupProperties + * groupIdentifier: "STRING_VALUE", // required + * }, + * }, + * clientToken: "STRING_VALUE", + * }; + * const command = new AddEntityOwnerCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param AddEntityOwnerCommandInput - {@link AddEntityOwnerCommandInput} + * @returns {@link AddEntityOwnerCommandOutput} + * @see {@link AddEntityOwnerCommandInput} for command's `input` shape. + * @see {@link AddEntityOwnerCommandOutput} 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 AddEntityOwnerCommand extends $Command + .classBuilder< + AddEntityOwnerCommandInput, + AddEntityOwnerCommandOutput, + 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", "AddEntityOwner", {}) + .n("DataZoneClient", "AddEntityOwnerCommand") + .f(void 0, void 0) + .ser(se_AddEntityOwnerCommand) + .de(de_AddEntityOwnerCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/AddPolicyGrantCommand.ts b/clients/client-datazone/src/commands/AddPolicyGrantCommand.ts new file mode 100644 index 000000000000..17a1be0f80e3 --- /dev/null +++ b/clients/client-datazone/src/commands/AddPolicyGrantCommand.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 { AddPolicyGrantInput, AddPolicyGrantOutput } from "../models/models_0"; +import { de_AddPolicyGrantCommand, se_AddPolicyGrantCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link AddPolicyGrantCommand}. + */ +export interface AddPolicyGrantCommandInput extends AddPolicyGrantInput {} +/** + * @public + * + * The output of {@link AddPolicyGrantCommand}. + */ +export interface AddPolicyGrantCommandOutput extends AddPolicyGrantOutput, __MetadataBearer {} + +/** + *Adds a policy grant (an authorization policy) to a specified entity, including domain + * units, environment blueprint configurations, or environment profiles.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, AddPolicyGrantCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, AddPolicyGrantCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // AddPolicyGrantInput + * domainIdentifier: "STRING_VALUE", // required + * entityType: "DOMAIN_UNIT" || "ENVIRONMENT_BLUEPRINT_CONFIGURATION" || "ENVIRONMENT_PROFILE", // required + * entityIdentifier: "STRING_VALUE", // required + * policyType: "CREATE_DOMAIN_UNIT" || "OVERRIDE_DOMAIN_UNIT_OWNERS" || "ADD_TO_PROJECT_MEMBER_POOL" || "OVERRIDE_PROJECT_OWNERS" || "CREATE_GLOSSARY" || "CREATE_FORM_TYPE" || "CREATE_ASSET_TYPE" || "CREATE_PROJECT" || "CREATE_ENVIRONMENT_PROFILE" || "DELEGATE_CREATE_ENVIRONMENT_PROFILE" || "CREATE_ENVIRONMENT", // required + * principal: { // PolicyGrantPrincipal Union: only one key present + * user: { // UserPolicyGrantPrincipal Union: only one key present + * userIdentifier: "STRING_VALUE", + * allUsersGrantFilter: {}, + * }, + * group: { // GroupPolicyGrantPrincipal Union: only one key present + * groupIdentifier: "STRING_VALUE", + * }, + * project: { // ProjectPolicyGrantPrincipal + * projectDesignation: "OWNER" || "CONTRIBUTOR", // required + * projectIdentifier: "STRING_VALUE", + * projectGrantFilter: { // ProjectGrantFilter Union: only one key present + * domainUnitFilter: { // DomainUnitFilterForProject + * domainUnit: "STRING_VALUE", // required + * includeChildDomainUnits: true || false, + * }, + * }, + * }, + * domainUnit: { // DomainUnitPolicyGrantPrincipal + * domainUnitDesignation: "OWNER", // required + * domainUnitIdentifier: "STRING_VALUE", + * domainUnitGrantFilter: { // DomainUnitGrantFilter Union: only one key present + * allDomainUnitsGrantFilter: {}, + * }, + * }, + * }, + * detail: { // PolicyGrantDetail Union: only one key present + * createDomainUnit: { // CreateDomainUnitPolicyGrantDetail + * includeChildDomainUnits: true || false, + * }, + * overrideDomainUnitOwners: { // OverrideDomainUnitOwnersPolicyGrantDetail + * includeChildDomainUnits: true || false, + * }, + * addToProjectMemberPool: { // AddToProjectMemberPoolPolicyGrantDetail + * includeChildDomainUnits: true || false, + * }, + * overrideProjectOwners: { // OverrideProjectOwnersPolicyGrantDetail + * includeChildDomainUnits: true || false, + * }, + * createGlossary: { // CreateGlossaryPolicyGrantDetail + * includeChildDomainUnits: true || false, + * }, + * createFormType: { // CreateFormTypePolicyGrantDetail + * includeChildDomainUnits: true || false, + * }, + * createAssetType: { // CreateAssetTypePolicyGrantDetail + * includeChildDomainUnits: true || false, + * }, + * createProject: { // CreateProjectPolicyGrantDetail + * includeChildDomainUnits: true || false, + * }, + * createEnvironmentProfile: { // CreateEnvironmentProfilePolicyGrantDetail + * domainUnitId: "STRING_VALUE", + * }, + * delegateCreateEnvironmentProfile: {}, + * createEnvironment: {}, + * }, + * clientToken: "STRING_VALUE", + * }; + * const command = new AddPolicyGrantCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param AddPolicyGrantCommandInput - {@link AddPolicyGrantCommandInput} + * @returns {@link AddPolicyGrantCommandOutput} + * @see {@link AddPolicyGrantCommandInput} for command's `input` shape. + * @see {@link AddPolicyGrantCommandOutput} 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 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 AddPolicyGrantCommand extends $Command + .classBuilder< + AddPolicyGrantCommandInput, + AddPolicyGrantCommandOutput, + 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", "AddPolicyGrant", {}) + .n("DataZoneClient", "AddPolicyGrantCommand") + .f(void 0, void 0) + .ser(se_AddPolicyGrantCommand) + .de(de_AddPolicyGrantCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/CreateDomainCommand.ts b/clients/client-datazone/src/commands/CreateDomainCommand.ts index 010013e00f29..3971e4955e9f 100644 --- a/clients/client-datazone/src/commands/CreateDomainCommand.ts +++ b/clients/client-datazone/src/commands/CreateDomainCommand.ts @@ -53,6 +53,7 @@ export interface CreateDomainCommandOutput extends CreateDomainOutput, __Metadat * const response = await client.send(command); * // { // CreateDomainOutput * // id: "STRING_VALUE", // required + * // rootDomainUnitId: "STRING_VALUE", * // name: "STRING_VALUE", * // description: "STRING_VALUE", * // singleSignOn: { // SingleSignOn diff --git a/clients/client-datazone/src/commands/CreateDomainUnitCommand.ts b/clients/client-datazone/src/commands/CreateDomainUnitCommand.ts new file mode 100644 index 000000000000..0ede21840368 --- /dev/null +++ b/clients/client-datazone/src/commands/CreateDomainUnitCommand.ts @@ -0,0 +1,131 @@ +// 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 { + CreateDomainUnitInput, + CreateDomainUnitInputFilterSensitiveLog, + CreateDomainUnitOutput, + CreateDomainUnitOutputFilterSensitiveLog, +} from "../models/models_0"; +import { de_CreateDomainUnitCommand, se_CreateDomainUnitCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateDomainUnitCommand}. + */ +export interface CreateDomainUnitCommandInput extends CreateDomainUnitInput {} +/** + * @public + * + * The output of {@link CreateDomainUnitCommand}. + */ +export interface CreateDomainUnitCommandOutput extends CreateDomainUnitOutput, __MetadataBearer {} + +/** + *Creates a domain unit in Amazon DataZone.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, CreateDomainUnitCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, CreateDomainUnitCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // CreateDomainUnitInput + * domainIdentifier: "STRING_VALUE", // required + * name: "STRING_VALUE", // required + * parentDomainUnitIdentifier: "STRING_VALUE", // required + * description: "STRING_VALUE", + * clientToken: "STRING_VALUE", + * }; + * const command = new CreateDomainUnitCommand(input); + * const response = await client.send(command); + * // { // CreateDomainUnitOutput + * // id: "STRING_VALUE", // required + * // domainId: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // parentDomainUnitId: "STRING_VALUE", + * // description: "STRING_VALUE", + * // owners: [ // DomainUnitOwners // required + * // { // DomainUnitOwnerProperties Union: only one key present + * // user: { // DomainUnitUserProperties + * // userId: "STRING_VALUE", + * // }, + * // group: { // DomainUnitGroupProperties + * // groupId: "STRING_VALUE", + * // }, + * // }, + * // ], + * // ancestorDomainUnitIds: [ // DomainUnitIds // required + * // "STRING_VALUE", + * // ], + * // createdAt: new Date("TIMESTAMP"), + * // createdBy: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreateDomainUnitCommandInput - {@link CreateDomainUnitCommandInput} + * @returns {@link CreateDomainUnitCommandOutput} + * @see {@link CreateDomainUnitCommandInput} for command's `input` shape. + * @see {@link CreateDomainUnitCommandOutput} 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 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 CreateDomainUnitCommand extends $Command + .classBuilder< + CreateDomainUnitCommandInput, + CreateDomainUnitCommandOutput, + 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", "CreateDomainUnit", {}) + .n("DataZoneClient", "CreateDomainUnitCommand") + .f(CreateDomainUnitInputFilterSensitiveLog, CreateDomainUnitOutputFilterSensitiveLog) + .ser(se_CreateDomainUnitCommand) + .de(de_CreateDomainUnitCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/CreateProjectCommand.ts b/clients/client-datazone/src/commands/CreateProjectCommand.ts index b7352630ba64..9e48ae483d21 100644 --- a/clients/client-datazone/src/commands/CreateProjectCommand.ts +++ b/clients/client-datazone/src/commands/CreateProjectCommand.ts @@ -47,6 +47,7 @@ export interface CreateProjectCommandOutput extends CreateProjectOutput, __Metad * glossaryTerms: [ // GlossaryTerms * "STRING_VALUE", * ], + * domainUnitId: "STRING_VALUE", * }; * const command = new CreateProjectCommand(input); * const response = await client.send(command); @@ -68,6 +69,7 @@ export interface CreateProjectCommandOutput extends CreateProjectOutput, __Metad * // glossaryTerms: [ // GlossaryTerms * // "STRING_VALUE", * // ], + * // domainUnitId: "STRING_VALUE", * // }; * * ``` diff --git a/clients/client-datazone/src/commands/DeleteDomainUnitCommand.ts b/clients/client-datazone/src/commands/DeleteDomainUnitCommand.ts new file mode 100644 index 000000000000..9ffdd772a163 --- /dev/null +++ b/clients/client-datazone/src/commands/DeleteDomainUnitCommand.ts @@ -0,0 +1,102 @@ +// 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 { DeleteDomainUnitInput, DeleteDomainUnitOutput } from "../models/models_0"; +import { de_DeleteDomainUnitCommand, se_DeleteDomainUnitCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteDomainUnitCommand}. + */ +export interface DeleteDomainUnitCommandInput extends DeleteDomainUnitInput {} +/** + * @public + * + * The output of {@link DeleteDomainUnitCommand}. + */ +export interface DeleteDomainUnitCommandOutput extends DeleteDomainUnitOutput, __MetadataBearer {} + +/** + *Deletes a domain unit.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, DeleteDomainUnitCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, DeleteDomainUnitCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // DeleteDomainUnitInput + * domainIdentifier: "STRING_VALUE", // required + * identifier: "STRING_VALUE", // required + * }; + * const command = new DeleteDomainUnitCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteDomainUnitCommandInput - {@link DeleteDomainUnitCommandInput} + * @returns {@link DeleteDomainUnitCommandOutput} + * @see {@link DeleteDomainUnitCommandInput} for command's `input` shape. + * @see {@link DeleteDomainUnitCommandOutput} 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 DeleteDomainUnitCommand extends $Command + .classBuilder< + DeleteDomainUnitCommandInput, + DeleteDomainUnitCommandOutput, + 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", "DeleteDomainUnit", {}) + .n("DataZoneClient", "DeleteDomainUnitCommand") + .f(void 0, void 0) + .ser(se_DeleteDomainUnitCommand) + .de(de_DeleteDomainUnitCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/DeleteFormTypeCommand.ts b/clients/client-datazone/src/commands/DeleteFormTypeCommand.ts index 723b3b18d4c5..66e61653449b 100644 --- a/clients/client-datazone/src/commands/DeleteFormTypeCommand.ts +++ b/clients/client-datazone/src/commands/DeleteFormTypeCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DeleteFormTypeInput, DeleteFormTypeOutput } from "../models/models_0"; +import { DeleteFormTypeInput, DeleteFormTypeOutput } from "../models/models_1"; import { de_DeleteFormTypeCommand, se_DeleteFormTypeCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/DeleteGlossaryCommand.ts b/clients/client-datazone/src/commands/DeleteGlossaryCommand.ts index 6d79e5bb7f85..40a219c2ab93 100644 --- a/clients/client-datazone/src/commands/DeleteGlossaryCommand.ts +++ b/clients/client-datazone/src/commands/DeleteGlossaryCommand.ts @@ -6,8 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DeleteGlossaryInput } from "../models/models_0"; -import { DeleteGlossaryOutput } from "../models/models_1"; +import { DeleteGlossaryInput, DeleteGlossaryOutput } from "../models/models_1"; import { de_DeleteGlossaryCommand, se_DeleteGlossaryCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetAssetFilterCommand.ts b/clients/client-datazone/src/commands/GetAssetFilterCommand.ts index d9342373243b..394ab9b00225 100644 --- a/clients/client-datazone/src/commands/GetAssetFilterCommand.ts +++ b/clients/client-datazone/src/commands/GetAssetFilterCommand.ts @@ -6,8 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetAssetFilterInput } from "../models/models_0"; -import { GetAssetFilterOutput, GetAssetFilterOutputFilterSensitiveLog } from "../models/models_1"; +import { GetAssetFilterInput, GetAssetFilterOutput, GetAssetFilterOutputFilterSensitiveLog } from "../models/models_1"; import { de_GetAssetFilterCommand, se_GetAssetFilterCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetDomainCommand.ts b/clients/client-datazone/src/commands/GetDomainCommand.ts index 8b8ff09f7105..4d03611b4696 100644 --- a/clients/client-datazone/src/commands/GetDomainCommand.ts +++ b/clients/client-datazone/src/commands/GetDomainCommand.ts @@ -42,6 +42,7 @@ export interface GetDomainCommandOutput extends GetDomainOutput, __MetadataBeare * const response = await client.send(command); * // { // GetDomainOutput * // id: "STRING_VALUE", // required + * // rootDomainUnitId: "STRING_VALUE", * // name: "STRING_VALUE", * // description: "STRING_VALUE", * // singleSignOn: { // SingleSignOn diff --git a/clients/client-datazone/src/commands/GetDomainUnitCommand.ts b/clients/client-datazone/src/commands/GetDomainUnitCommand.ts new file mode 100644 index 000000000000..51b031ebc4df --- /dev/null +++ b/clients/client-datazone/src/commands/GetDomainUnitCommand.ts @@ -0,0 +1,119 @@ +// 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 { GetDomainUnitInput, GetDomainUnitOutput, GetDomainUnitOutputFilterSensitiveLog } from "../models/models_0"; +import { de_GetDomainUnitCommand, se_GetDomainUnitCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetDomainUnitCommand}. + */ +export interface GetDomainUnitCommandInput extends GetDomainUnitInput {} +/** + * @public + * + * The output of {@link GetDomainUnitCommand}. + */ +export interface GetDomainUnitCommandOutput extends GetDomainUnitOutput, __MetadataBearer {} + +/** + *Gets the details of the specified domain unit.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, GetDomainUnitCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, GetDomainUnitCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // GetDomainUnitInput + * domainIdentifier: "STRING_VALUE", // required + * identifier: "STRING_VALUE", // required + * }; + * const command = new GetDomainUnitCommand(input); + * const response = await client.send(command); + * // { // GetDomainUnitOutput + * // id: "STRING_VALUE", // required + * // domainId: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // parentDomainUnitId: "STRING_VALUE", + * // description: "STRING_VALUE", + * // owners: [ // DomainUnitOwners // required + * // { // DomainUnitOwnerProperties Union: only one key present + * // user: { // DomainUnitUserProperties + * // userId: "STRING_VALUE", + * // }, + * // group: { // DomainUnitGroupProperties + * // groupId: "STRING_VALUE", + * // }, + * // }, + * // ], + * // createdAt: new Date("TIMESTAMP"), + * // lastUpdatedAt: new Date("TIMESTAMP"), + * // createdBy: "STRING_VALUE", + * // lastUpdatedBy: "STRING_VALUE", + * // }; + * + * ``` + * + * @param GetDomainUnitCommandInput - {@link GetDomainUnitCommandInput} + * @returns {@link GetDomainUnitCommandOutput} + * @see {@link GetDomainUnitCommandInput} for command's `input` shape. + * @see {@link GetDomainUnitCommandOutput} 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 GetDomainUnitCommand extends $Command + .classBuilder< + GetDomainUnitCommandInput, + GetDomainUnitCommandOutput, + 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", "GetDomainUnit", {}) + .n("DataZoneClient", "GetDomainUnitCommand") + .f(void 0, GetDomainUnitOutputFilterSensitiveLog) + .ser(se_GetDomainUnitCommand) + .de(de_GetDomainUnitCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/GetEnvironmentActionCommand.ts b/clients/client-datazone/src/commands/GetEnvironmentActionCommand.ts index 64b81aa9992d..f84faf9d9ed2 100644 --- a/clients/client-datazone/src/commands/GetEnvironmentActionCommand.ts +++ b/clients/client-datazone/src/commands/GetEnvironmentActionCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetEnvironmentActionInput, GetEnvironmentActionOutput } from "../models/models_0"; +import { GetEnvironmentActionInput, GetEnvironmentActionOutput } from "../models/models_1"; import { de_GetEnvironmentActionCommand, se_GetEnvironmentActionCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetEnvironmentBlueprintCommand.ts b/clients/client-datazone/src/commands/GetEnvironmentBlueprintCommand.ts index fbcc8b72f15f..0d3114f27103 100644 --- a/clients/client-datazone/src/commands/GetEnvironmentBlueprintCommand.ts +++ b/clients/client-datazone/src/commands/GetEnvironmentBlueprintCommand.ts @@ -10,7 +10,7 @@ import { GetEnvironmentBlueprintInput, GetEnvironmentBlueprintOutput, GetEnvironmentBlueprintOutputFilterSensitiveLog, -} from "../models/models_0"; +} from "../models/models_1"; import { de_GetEnvironmentBlueprintCommand, se_GetEnvironmentBlueprintCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetEnvironmentBlueprintConfigurationCommand.ts b/clients/client-datazone/src/commands/GetEnvironmentBlueprintConfigurationCommand.ts index 39ef59bdeae4..21fe3ef557e0 100644 --- a/clients/client-datazone/src/commands/GetEnvironmentBlueprintConfigurationCommand.ts +++ b/clients/client-datazone/src/commands/GetEnvironmentBlueprintConfigurationCommand.ts @@ -6,10 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { - GetEnvironmentBlueprintConfigurationInput, - GetEnvironmentBlueprintConfigurationOutput, -} from "../models/models_0"; +import { GetEnvironmentBlueprintConfigurationInput } from "../models/models_0"; +import { GetEnvironmentBlueprintConfigurationOutput } from "../models/models_1"; import { de_GetEnvironmentBlueprintConfigurationCommand, se_GetEnvironmentBlueprintConfigurationCommand, diff --git a/clients/client-datazone/src/commands/GetEnvironmentCommand.ts b/clients/client-datazone/src/commands/GetEnvironmentCommand.ts index f584b251d484..2224f1516505 100644 --- a/clients/client-datazone/src/commands/GetEnvironmentCommand.ts +++ b/clients/client-datazone/src/commands/GetEnvironmentCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetEnvironmentInput, GetEnvironmentOutput, GetEnvironmentOutputFilterSensitiveLog } from "../models/models_0"; +import { GetEnvironmentInput, GetEnvironmentOutput, GetEnvironmentOutputFilterSensitiveLog } from "../models/models_1"; import { de_GetEnvironmentCommand, se_GetEnvironmentCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetEnvironmentCredentialsCommand.ts b/clients/client-datazone/src/commands/GetEnvironmentCredentialsCommand.ts index cefc152edb02..1930abfed61a 100644 --- a/clients/client-datazone/src/commands/GetEnvironmentCredentialsCommand.ts +++ b/clients/client-datazone/src/commands/GetEnvironmentCredentialsCommand.ts @@ -10,7 +10,7 @@ import { GetEnvironmentCredentialsInput, GetEnvironmentCredentialsOutput, GetEnvironmentCredentialsOutputFilterSensitiveLog, -} from "../models/models_0"; +} from "../models/models_1"; import { de_GetEnvironmentCredentialsCommand, se_GetEnvironmentCredentialsCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetEnvironmentProfileCommand.ts b/clients/client-datazone/src/commands/GetEnvironmentProfileCommand.ts index 50dfe5deb717..062650269b10 100644 --- a/clients/client-datazone/src/commands/GetEnvironmentProfileCommand.ts +++ b/clients/client-datazone/src/commands/GetEnvironmentProfileCommand.ts @@ -10,7 +10,7 @@ import { GetEnvironmentProfileInput, GetEnvironmentProfileOutput, GetEnvironmentProfileOutputFilterSensitiveLog, -} from "../models/models_0"; +} from "../models/models_1"; import { de_GetEnvironmentProfileCommand, se_GetEnvironmentProfileCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetFormTypeCommand.ts b/clients/client-datazone/src/commands/GetFormTypeCommand.ts index 660b14232dc7..c07ed5c9a39a 100644 --- a/clients/client-datazone/src/commands/GetFormTypeCommand.ts +++ b/clients/client-datazone/src/commands/GetFormTypeCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetFormTypeInput, GetFormTypeOutput, GetFormTypeOutputFilterSensitiveLog } from "../models/models_0"; +import { GetFormTypeInput, GetFormTypeOutput, GetFormTypeOutputFilterSensitiveLog } from "../models/models_1"; import { de_GetFormTypeCommand, se_GetFormTypeCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetGroupProfileCommand.ts b/clients/client-datazone/src/commands/GetGroupProfileCommand.ts index 1512363957f7..3eae97b1473b 100644 --- a/clients/client-datazone/src/commands/GetGroupProfileCommand.ts +++ b/clients/client-datazone/src/commands/GetGroupProfileCommand.ts @@ -10,7 +10,7 @@ import { GetGroupProfileInput, GetGroupProfileOutput, GetGroupProfileOutputFilterSensitiveLog, -} from "../models/models_0"; +} from "../models/models_1"; import { de_GetGroupProfileCommand, se_GetGroupProfileCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetIamPortalLoginUrlCommand.ts b/clients/client-datazone/src/commands/GetIamPortalLoginUrlCommand.ts index 8381469148bc..f4f6bb61d2df 100644 --- a/clients/client-datazone/src/commands/GetIamPortalLoginUrlCommand.ts +++ b/clients/client-datazone/src/commands/GetIamPortalLoginUrlCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetIamPortalLoginUrlInput, GetIamPortalLoginUrlOutput } from "../models/models_0"; +import { GetIamPortalLoginUrlInput, GetIamPortalLoginUrlOutput } from "../models/models_1"; import { de_GetIamPortalLoginUrlCommand, se_GetIamPortalLoginUrlCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetLineageNodeCommand.ts b/clients/client-datazone/src/commands/GetLineageNodeCommand.ts index 7a023e5f948d..adff62f0fda0 100644 --- a/clients/client-datazone/src/commands/GetLineageNodeCommand.ts +++ b/clients/client-datazone/src/commands/GetLineageNodeCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetLineageNodeInput, GetLineageNodeOutput, GetLineageNodeOutputFilterSensitiveLog } from "../models/models_0"; +import { GetLineageNodeInput, GetLineageNodeOutput, GetLineageNodeOutputFilterSensitiveLog } from "../models/models_1"; import { de_GetLineageNodeCommand, se_GetLineageNodeCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetProjectCommand.ts b/clients/client-datazone/src/commands/GetProjectCommand.ts index f53adaccfb62..17c55fbb2399 100644 --- a/clients/client-datazone/src/commands/GetProjectCommand.ts +++ b/clients/client-datazone/src/commands/GetProjectCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetProjectInput, GetProjectOutput, GetProjectOutputFilterSensitiveLog } from "../models/models_0"; +import { GetProjectInput, GetProjectOutput, GetProjectOutputFilterSensitiveLog } from "../models/models_1"; import { de_GetProjectCommand, se_GetProjectCommand } from "../protocols/Aws_restJson1"; /** @@ -59,6 +59,7 @@ export interface GetProjectCommandOutput extends GetProjectOutput, __MetadataBea * // glossaryTerms: [ // GlossaryTerms * // "STRING_VALUE", * // ], + * // domainUnitId: "STRING_VALUE", * // }; * * ``` diff --git a/clients/client-datazone/src/commands/GetSubscriptionCommand.ts b/clients/client-datazone/src/commands/GetSubscriptionCommand.ts index df87b9fc8c49..33514def5303 100644 --- a/clients/client-datazone/src/commands/GetSubscriptionCommand.ts +++ b/clients/client-datazone/src/commands/GetSubscriptionCommand.ts @@ -10,7 +10,7 @@ import { GetSubscriptionInput, GetSubscriptionOutput, GetSubscriptionOutputFilterSensitiveLog, -} from "../models/models_0"; +} from "../models/models_1"; import { de_GetSubscriptionCommand, se_GetSubscriptionCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetSubscriptionGrantCommand.ts b/clients/client-datazone/src/commands/GetSubscriptionGrantCommand.ts index 52d3de91d5b0..cba786608e7b 100644 --- a/clients/client-datazone/src/commands/GetSubscriptionGrantCommand.ts +++ b/clients/client-datazone/src/commands/GetSubscriptionGrantCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetSubscriptionGrantInput, GetSubscriptionGrantOutput } from "../models/models_0"; +import { GetSubscriptionGrantInput, GetSubscriptionGrantOutput } from "../models/models_1"; import { de_GetSubscriptionGrantCommand, se_GetSubscriptionGrantCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetSubscriptionRequestDetailsCommand.ts b/clients/client-datazone/src/commands/GetSubscriptionRequestDetailsCommand.ts index 8940ef99b41f..8cb873e2fa0a 100644 --- a/clients/client-datazone/src/commands/GetSubscriptionRequestDetailsCommand.ts +++ b/clients/client-datazone/src/commands/GetSubscriptionRequestDetailsCommand.ts @@ -10,7 +10,7 @@ import { GetSubscriptionRequestDetailsInput, GetSubscriptionRequestDetailsOutput, GetSubscriptionRequestDetailsOutputFilterSensitiveLog, -} from "../models/models_0"; +} from "../models/models_1"; import { de_GetSubscriptionRequestDetailsCommand, se_GetSubscriptionRequestDetailsCommand, diff --git a/clients/client-datazone/src/commands/GetSubscriptionTargetCommand.ts b/clients/client-datazone/src/commands/GetSubscriptionTargetCommand.ts index a775f1151ec7..18e04e536ce1 100644 --- a/clients/client-datazone/src/commands/GetSubscriptionTargetCommand.ts +++ b/clients/client-datazone/src/commands/GetSubscriptionTargetCommand.ts @@ -10,7 +10,7 @@ import { GetSubscriptionTargetInput, GetSubscriptionTargetOutput, GetSubscriptionTargetOutputFilterSensitiveLog, -} from "../models/models_0"; +} from "../models/models_1"; import { de_GetSubscriptionTargetCommand, se_GetSubscriptionTargetCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetTimeSeriesDataPointCommand.ts b/clients/client-datazone/src/commands/GetTimeSeriesDataPointCommand.ts index 3e22c213872a..d3b2955d5c6f 100644 --- a/clients/client-datazone/src/commands/GetTimeSeriesDataPointCommand.ts +++ b/clients/client-datazone/src/commands/GetTimeSeriesDataPointCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetTimeSeriesDataPointInput, GetTimeSeriesDataPointOutput } from "../models/models_0"; +import { GetTimeSeriesDataPointInput, GetTimeSeriesDataPointOutput } from "../models/models_1"; import { de_GetTimeSeriesDataPointCommand, se_GetTimeSeriesDataPointCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetUserProfileCommand.ts b/clients/client-datazone/src/commands/GetUserProfileCommand.ts index b1962b7fd3e9..21efe25f2049 100644 --- a/clients/client-datazone/src/commands/GetUserProfileCommand.ts +++ b/clients/client-datazone/src/commands/GetUserProfileCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetUserProfileInput, GetUserProfileOutput, GetUserProfileOutputFilterSensitiveLog } from "../models/models_0"; +import { GetUserProfileInput, GetUserProfileOutput, GetUserProfileOutputFilterSensitiveLog } from "../models/models_1"; import { de_GetUserProfileCommand, se_GetUserProfileCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/ListDomainUnitsForParentCommand.ts b/clients/client-datazone/src/commands/ListDomainUnitsForParentCommand.ts new file mode 100644 index 000000000000..eb3c473ebc43 --- /dev/null +++ b/clients/client-datazone/src/commands/ListDomainUnitsForParentCommand.ts @@ -0,0 +1,106 @@ +// 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 { ListDomainUnitsForParentInput, ListDomainUnitsForParentOutput } from "../models/models_0"; +import { de_ListDomainUnitsForParentCommand, se_ListDomainUnitsForParentCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListDomainUnitsForParentCommand}. + */ +export interface ListDomainUnitsForParentCommandInput extends ListDomainUnitsForParentInput {} +/** + * @public + * + * The output of {@link ListDomainUnitsForParentCommand}. + */ +export interface ListDomainUnitsForParentCommandOutput extends ListDomainUnitsForParentOutput, __MetadataBearer {} + +/** + *Lists child domain units for the specified parent domain unit.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, ListDomainUnitsForParentCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, ListDomainUnitsForParentCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // ListDomainUnitsForParentInput + * domainIdentifier: "STRING_VALUE", // required + * parentDomainUnitIdentifier: "STRING_VALUE", // required + * maxResults: Number("int"), + * nextToken: "STRING_VALUE", + * }; + * const command = new ListDomainUnitsForParentCommand(input); + * const response = await client.send(command); + * // { // ListDomainUnitsForParentOutput + * // items: [ // DomainUnitSummaries // required + * // { // DomainUnitSummary + * // name: "STRING_VALUE", // required + * // id: "STRING_VALUE", // required + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListDomainUnitsForParentCommandInput - {@link ListDomainUnitsForParentCommandInput} + * @returns {@link ListDomainUnitsForParentCommandOutput} + * @see {@link ListDomainUnitsForParentCommandInput} for command's `input` shape. + * @see {@link ListDomainUnitsForParentCommandOutput} 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 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 ListDomainUnitsForParentCommand extends $Command + .classBuilder< + ListDomainUnitsForParentCommandInput, + ListDomainUnitsForParentCommandOutput, + 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", "ListDomainUnitsForParent", {}) + .n("DataZoneClient", "ListDomainUnitsForParentCommand") + .f(void 0, void 0) + .ser(se_ListDomainUnitsForParentCommand) + .de(de_ListDomainUnitsForParentCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/ListEntityOwnersCommand.ts b/clients/client-datazone/src/commands/ListEntityOwnersCommand.ts new file mode 100644 index 000000000000..ecd6aa654d4a --- /dev/null +++ b/clients/client-datazone/src/commands/ListEntityOwnersCommand.ts @@ -0,0 +1,111 @@ +// 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 { ListEntityOwnersInput, ListEntityOwnersOutput } from "../models/models_1"; +import { de_ListEntityOwnersCommand, se_ListEntityOwnersCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListEntityOwnersCommand}. + */ +export interface ListEntityOwnersCommandInput extends ListEntityOwnersInput {} +/** + * @public + * + * The output of {@link ListEntityOwnersCommand}. + */ +export interface ListEntityOwnersCommandOutput extends ListEntityOwnersOutput, __MetadataBearer {} + +/** + *Lists the entity (domain units) owners.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, ListEntityOwnersCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, ListEntityOwnersCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // ListEntityOwnersInput + * domainIdentifier: "STRING_VALUE", // required + * entityType: "DOMAIN_UNIT", // required + * entityIdentifier: "STRING_VALUE", // required + * maxResults: Number("int"), + * nextToken: "STRING_VALUE", + * }; + * const command = new ListEntityOwnersCommand(input); + * const response = await client.send(command); + * // { // ListEntityOwnersOutput + * // owners: [ // EntityOwners // required + * // { // OwnerPropertiesOutput Union: only one key present + * // user: { // OwnerUserPropertiesOutput + * // userId: "STRING_VALUE", + * // }, + * // group: { // OwnerGroupPropertiesOutput + * // groupId: "STRING_VALUE", + * // }, + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListEntityOwnersCommandInput - {@link ListEntityOwnersCommandInput} + * @returns {@link ListEntityOwnersCommandOutput} + * @see {@link ListEntityOwnersCommandInput} for command's `input` shape. + * @see {@link ListEntityOwnersCommandOutput} 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 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 ListEntityOwnersCommand extends $Command + .classBuilder< + ListEntityOwnersCommandInput, + ListEntityOwnersCommandOutput, + 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", "ListEntityOwners", {}) + .n("DataZoneClient", "ListEntityOwnersCommand") + .f(void 0, void 0) + .ser(se_ListEntityOwnersCommand) + .de(de_ListEntityOwnersCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/ListEnvironmentBlueprintConfigurationsCommand.ts b/clients/client-datazone/src/commands/ListEnvironmentBlueprintConfigurationsCommand.ts index c4d55641da08..4318cd664ac9 100644 --- a/clients/client-datazone/src/commands/ListEnvironmentBlueprintConfigurationsCommand.ts +++ b/clients/client-datazone/src/commands/ListEnvironmentBlueprintConfigurationsCommand.ts @@ -9,7 +9,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { ListEnvironmentBlueprintConfigurationsInput, ListEnvironmentBlueprintConfigurationsOutput, -} from "../models/models_0"; +} from "../models/models_1"; import { de_ListEnvironmentBlueprintConfigurationsCommand, se_ListEnvironmentBlueprintConfigurationsCommand, diff --git a/clients/client-datazone/src/commands/ListPolicyGrantsCommand.ts b/clients/client-datazone/src/commands/ListPolicyGrantsCommand.ts new file mode 100644 index 000000000000..0f0586c89016 --- /dev/null +++ b/clients/client-datazone/src/commands/ListPolicyGrantsCommand.ts @@ -0,0 +1,165 @@ +// 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 { ListPolicyGrantsInput, ListPolicyGrantsOutput } from "../models/models_1"; +import { de_ListPolicyGrantsCommand, se_ListPolicyGrantsCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListPolicyGrantsCommand}. + */ +export interface ListPolicyGrantsCommandInput extends ListPolicyGrantsInput {} +/** + * @public + * + * The output of {@link ListPolicyGrantsCommand}. + */ +export interface ListPolicyGrantsCommandOutput extends ListPolicyGrantsOutput, __MetadataBearer {} + +/** + *Lists policy grants.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, ListPolicyGrantsCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, ListPolicyGrantsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // ListPolicyGrantsInput + * domainIdentifier: "STRING_VALUE", // required + * entityType: "DOMAIN_UNIT" || "ENVIRONMENT_BLUEPRINT_CONFIGURATION" || "ENVIRONMENT_PROFILE", // required + * entityIdentifier: "STRING_VALUE", // required + * policyType: "CREATE_DOMAIN_UNIT" || "OVERRIDE_DOMAIN_UNIT_OWNERS" || "ADD_TO_PROJECT_MEMBER_POOL" || "OVERRIDE_PROJECT_OWNERS" || "CREATE_GLOSSARY" || "CREATE_FORM_TYPE" || "CREATE_ASSET_TYPE" || "CREATE_PROJECT" || "CREATE_ENVIRONMENT_PROFILE" || "DELEGATE_CREATE_ENVIRONMENT_PROFILE" || "CREATE_ENVIRONMENT", // required + * maxResults: Number("int"), + * nextToken: "STRING_VALUE", + * }; + * const command = new ListPolicyGrantsCommand(input); + * const response = await client.send(command); + * // { // ListPolicyGrantsOutput + * // grantList: [ // PolicyGrantList // required + * // { // PolicyGrantMember + * // principal: { // PolicyGrantPrincipal Union: only one key present + * // user: { // UserPolicyGrantPrincipal Union: only one key present + * // userIdentifier: "STRING_VALUE", + * // allUsersGrantFilter: {}, + * // }, + * // group: { // GroupPolicyGrantPrincipal Union: only one key present + * // groupIdentifier: "STRING_VALUE", + * // }, + * // project: { // ProjectPolicyGrantPrincipal + * // projectDesignation: "OWNER" || "CONTRIBUTOR", // required + * // projectIdentifier: "STRING_VALUE", + * // projectGrantFilter: { // ProjectGrantFilter Union: only one key present + * // domainUnitFilter: { // DomainUnitFilterForProject + * // domainUnit: "STRING_VALUE", // required + * // includeChildDomainUnits: true || false, + * // }, + * // }, + * // }, + * // domainUnit: { // DomainUnitPolicyGrantPrincipal + * // domainUnitDesignation: "OWNER", // required + * // domainUnitIdentifier: "STRING_VALUE", + * // domainUnitGrantFilter: { // DomainUnitGrantFilter Union: only one key present + * // allDomainUnitsGrantFilter: {}, + * // }, + * // }, + * // }, + * // detail: { // PolicyGrantDetail Union: only one key present + * // createDomainUnit: { // CreateDomainUnitPolicyGrantDetail + * // includeChildDomainUnits: true || false, + * // }, + * // overrideDomainUnitOwners: { // OverrideDomainUnitOwnersPolicyGrantDetail + * // includeChildDomainUnits: true || false, + * // }, + * // addToProjectMemberPool: { // AddToProjectMemberPoolPolicyGrantDetail + * // includeChildDomainUnits: true || false, + * // }, + * // overrideProjectOwners: { // OverrideProjectOwnersPolicyGrantDetail + * // includeChildDomainUnits: true || false, + * // }, + * // createGlossary: { // CreateGlossaryPolicyGrantDetail + * // includeChildDomainUnits: true || false, + * // }, + * // createFormType: { // CreateFormTypePolicyGrantDetail + * // includeChildDomainUnits: true || false, + * // }, + * // createAssetType: { // CreateAssetTypePolicyGrantDetail + * // includeChildDomainUnits: true || false, + * // }, + * // createProject: { // CreateProjectPolicyGrantDetail + * // includeChildDomainUnits: true || false, + * // }, + * // createEnvironmentProfile: { // CreateEnvironmentProfilePolicyGrantDetail + * // domainUnitId: "STRING_VALUE", + * // }, + * // delegateCreateEnvironmentProfile: {}, + * // createEnvironment: {}, + * // }, + * // createdAt: new Date("TIMESTAMP"), + * // createdBy: "STRING_VALUE", + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListPolicyGrantsCommandInput - {@link ListPolicyGrantsCommandInput} + * @returns {@link ListPolicyGrantsCommandOutput} + * @see {@link ListPolicyGrantsCommandInput} for command's `input` shape. + * @see {@link ListPolicyGrantsCommandOutput} 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 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 ListPolicyGrantsCommand extends $Command + .classBuilder< + ListPolicyGrantsCommandInput, + ListPolicyGrantsCommandOutput, + 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", "ListPolicyGrants", {}) + .n("DataZoneClient", "ListPolicyGrantsCommand") + .f(void 0, void 0) + .ser(se_ListPolicyGrantsCommand) + .de(de_ListPolicyGrantsCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/ListProjectsCommand.ts b/clients/client-datazone/src/commands/ListProjectsCommand.ts index 471be1ba79a3..39766e988ae2 100644 --- a/clients/client-datazone/src/commands/ListProjectsCommand.ts +++ b/clients/client-datazone/src/commands/ListProjectsCommand.ts @@ -67,6 +67,7 @@ export interface ListProjectsCommandOutput extends ListProjectsOutput, __Metadat * // createdBy: "STRING_VALUE", // required * // createdAt: new Date("TIMESTAMP"), * // updatedAt: new Date("TIMESTAMP"), + * // domainUnitId: "STRING_VALUE", * // }, * // ], * // nextToken: "STRING_VALUE", diff --git a/clients/client-datazone/src/commands/PutEnvironmentBlueprintConfigurationCommand.ts b/clients/client-datazone/src/commands/PutEnvironmentBlueprintConfigurationCommand.ts index 06de04c2b7c0..b4283c543dbc 100644 --- a/clients/client-datazone/src/commands/PutEnvironmentBlueprintConfigurationCommand.ts +++ b/clients/client-datazone/src/commands/PutEnvironmentBlueprintConfigurationCommand.ts @@ -9,7 +9,7 @@ import { commonParams } from "../endpoint/EndpointParameters"; import { PutEnvironmentBlueprintConfigurationInput, PutEnvironmentBlueprintConfigurationOutput, -} from "../models/models_0"; +} from "../models/models_1"; import { de_PutEnvironmentBlueprintConfigurationCommand, se_PutEnvironmentBlueprintConfigurationCommand, diff --git a/clients/client-datazone/src/commands/RemoveEntityOwnerCommand.ts b/clients/client-datazone/src/commands/RemoveEntityOwnerCommand.ts new file mode 100644 index 000000000000..91aeb671367b --- /dev/null +++ b/clients/client-datazone/src/commands/RemoveEntityOwnerCommand.ts @@ -0,0 +1,109 @@ +// 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 { RemoveEntityOwnerInput, RemoveEntityOwnerOutput } from "../models/models_1"; +import { de_RemoveEntityOwnerCommand, se_RemoveEntityOwnerCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link RemoveEntityOwnerCommand}. + */ +export interface RemoveEntityOwnerCommandInput extends RemoveEntityOwnerInput {} +/** + * @public + * + * The output of {@link RemoveEntityOwnerCommand}. + */ +export interface RemoveEntityOwnerCommandOutput extends RemoveEntityOwnerOutput, __MetadataBearer {} + +/** + *Removes an owner from an entity.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, RemoveEntityOwnerCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, RemoveEntityOwnerCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // RemoveEntityOwnerInput + * domainIdentifier: "STRING_VALUE", // required + * entityType: "DOMAIN_UNIT", // required + * entityIdentifier: "STRING_VALUE", // required + * owner: { // OwnerProperties Union: only one key present + * user: { // OwnerUserProperties + * userIdentifier: "STRING_VALUE", // required + * }, + * group: { // OwnerGroupProperties + * groupIdentifier: "STRING_VALUE", // required + * }, + * }, + * clientToken: "STRING_VALUE", + * }; + * const command = new RemoveEntityOwnerCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param RemoveEntityOwnerCommandInput - {@link RemoveEntityOwnerCommandInput} + * @returns {@link RemoveEntityOwnerCommandOutput} + * @see {@link RemoveEntityOwnerCommandInput} for command's `input` shape. + * @see {@link RemoveEntityOwnerCommandOutput} 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 RemoveEntityOwnerCommand extends $Command + .classBuilder< + RemoveEntityOwnerCommandInput, + RemoveEntityOwnerCommandOutput, + 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", "RemoveEntityOwner", {}) + .n("DataZoneClient", "RemoveEntityOwnerCommand") + .f(void 0, void 0) + .ser(se_RemoveEntityOwnerCommand) + .de(de_RemoveEntityOwnerCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/RemovePolicyGrantCommand.ts b/clients/client-datazone/src/commands/RemovePolicyGrantCommand.ts new file mode 100644 index 000000000000..4c33efc39644 --- /dev/null +++ b/clients/client-datazone/src/commands/RemovePolicyGrantCommand.ts @@ -0,0 +1,125 @@ +// 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 { RemovePolicyGrantInput, RemovePolicyGrantOutput } from "../models/models_1"; +import { de_RemovePolicyGrantCommand, se_RemovePolicyGrantCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link RemovePolicyGrantCommand}. + */ +export interface RemovePolicyGrantCommandInput extends RemovePolicyGrantInput {} +/** + * @public + * + * The output of {@link RemovePolicyGrantCommand}. + */ +export interface RemovePolicyGrantCommandOutput extends RemovePolicyGrantOutput, __MetadataBearer {} + +/** + *Removes a policy grant.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, RemovePolicyGrantCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, RemovePolicyGrantCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // RemovePolicyGrantInput + * domainIdentifier: "STRING_VALUE", // required + * entityType: "DOMAIN_UNIT" || "ENVIRONMENT_BLUEPRINT_CONFIGURATION" || "ENVIRONMENT_PROFILE", // required + * entityIdentifier: "STRING_VALUE", // required + * policyType: "CREATE_DOMAIN_UNIT" || "OVERRIDE_DOMAIN_UNIT_OWNERS" || "ADD_TO_PROJECT_MEMBER_POOL" || "OVERRIDE_PROJECT_OWNERS" || "CREATE_GLOSSARY" || "CREATE_FORM_TYPE" || "CREATE_ASSET_TYPE" || "CREATE_PROJECT" || "CREATE_ENVIRONMENT_PROFILE" || "DELEGATE_CREATE_ENVIRONMENT_PROFILE" || "CREATE_ENVIRONMENT", // required + * principal: { // PolicyGrantPrincipal Union: only one key present + * user: { // UserPolicyGrantPrincipal Union: only one key present + * userIdentifier: "STRING_VALUE", + * allUsersGrantFilter: {}, + * }, + * group: { // GroupPolicyGrantPrincipal Union: only one key present + * groupIdentifier: "STRING_VALUE", + * }, + * project: { // ProjectPolicyGrantPrincipal + * projectDesignation: "OWNER" || "CONTRIBUTOR", // required + * projectIdentifier: "STRING_VALUE", + * projectGrantFilter: { // ProjectGrantFilter Union: only one key present + * domainUnitFilter: { // DomainUnitFilterForProject + * domainUnit: "STRING_VALUE", // required + * includeChildDomainUnits: true || false, + * }, + * }, + * }, + * domainUnit: { // DomainUnitPolicyGrantPrincipal + * domainUnitDesignation: "OWNER", // required + * domainUnitIdentifier: "STRING_VALUE", + * domainUnitGrantFilter: { // DomainUnitGrantFilter Union: only one key present + * allDomainUnitsGrantFilter: {}, + * }, + * }, + * }, + * clientToken: "STRING_VALUE", + * }; + * const command = new RemovePolicyGrantCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param RemovePolicyGrantCommandInput - {@link RemovePolicyGrantCommandInput} + * @returns {@link RemovePolicyGrantCommandOutput} + * @see {@link RemovePolicyGrantCommandInput} for command's `input` shape. + * @see {@link RemovePolicyGrantCommandOutput} 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 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 RemovePolicyGrantCommand extends $Command + .classBuilder< + RemovePolicyGrantCommandInput, + RemovePolicyGrantCommandOutput, + 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", "RemovePolicyGrant", {}) + .n("DataZoneClient", "RemovePolicyGrantCommand") + .f(void 0, void 0) + .ser(se_RemovePolicyGrantCommand) + .de(de_RemovePolicyGrantCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/UpdateDomainCommand.ts b/clients/client-datazone/src/commands/UpdateDomainCommand.ts index 6aa9871496fe..f245ebb9165e 100644 --- a/clients/client-datazone/src/commands/UpdateDomainCommand.ts +++ b/clients/client-datazone/src/commands/UpdateDomainCommand.ts @@ -50,6 +50,7 @@ export interface UpdateDomainCommandOutput extends UpdateDomainOutput, __Metadat * const response = await client.send(command); * // { // UpdateDomainOutput * // id: "STRING_VALUE", // required + * // rootDomainUnitId: "STRING_VALUE", * // description: "STRING_VALUE", * // singleSignOn: { // SingleSignOn * // type: "IAM_IDC" || "DISABLED", diff --git a/clients/client-datazone/src/commands/UpdateDomainUnitCommand.ts b/clients/client-datazone/src/commands/UpdateDomainUnitCommand.ts new file mode 100644 index 000000000000..d3d681eb5e59 --- /dev/null +++ b/clients/client-datazone/src/commands/UpdateDomainUnitCommand.ts @@ -0,0 +1,129 @@ +// 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 { + UpdateDomainUnitInput, + UpdateDomainUnitInputFilterSensitiveLog, + UpdateDomainUnitOutput, + UpdateDomainUnitOutputFilterSensitiveLog, +} from "../models/models_0"; +import { de_UpdateDomainUnitCommand, se_UpdateDomainUnitCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateDomainUnitCommand}. + */ +export interface UpdateDomainUnitCommandInput extends UpdateDomainUnitInput {} +/** + * @public + * + * The output of {@link UpdateDomainUnitCommand}. + */ +export interface UpdateDomainUnitCommandOutput extends UpdateDomainUnitOutput, __MetadataBearer {} + +/** + *Updates the domain unit.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, UpdateDomainUnitCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, UpdateDomainUnitCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // UpdateDomainUnitInput + * domainIdentifier: "STRING_VALUE", // required + * identifier: "STRING_VALUE", // required + * description: "STRING_VALUE", + * name: "STRING_VALUE", + * }; + * const command = new UpdateDomainUnitCommand(input); + * const response = await client.send(command); + * // { // UpdateDomainUnitOutput + * // id: "STRING_VALUE", // required + * // domainId: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // owners: [ // DomainUnitOwners // required + * // { // DomainUnitOwnerProperties Union: only one key present + * // user: { // DomainUnitUserProperties + * // userId: "STRING_VALUE", + * // }, + * // group: { // DomainUnitGroupProperties + * // groupId: "STRING_VALUE", + * // }, + * // }, + * // ], + * // description: "STRING_VALUE", + * // parentDomainUnitId: "STRING_VALUE", + * // createdAt: new Date("TIMESTAMP"), + * // lastUpdatedAt: new Date("TIMESTAMP"), + * // createdBy: "STRING_VALUE", + * // lastUpdatedBy: "STRING_VALUE", + * // }; + * + * ``` + * + * @param UpdateDomainUnitCommandInput - {@link UpdateDomainUnitCommandInput} + * @returns {@link UpdateDomainUnitCommandOutput} + * @see {@link UpdateDomainUnitCommandInput} for command's `input` shape. + * @see {@link UpdateDomainUnitCommandOutput} 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 UpdateDomainUnitCommand extends $Command + .classBuilder< + UpdateDomainUnitCommandInput, + UpdateDomainUnitCommandOutput, + 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", "UpdateDomainUnit", {}) + .n("DataZoneClient", "UpdateDomainUnitCommand") + .f(UpdateDomainUnitInputFilterSensitiveLog, UpdateDomainUnitOutputFilterSensitiveLog) + .ser(se_UpdateDomainUnitCommand) + .de(de_UpdateDomainUnitCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/UpdateProjectCommand.ts b/clients/client-datazone/src/commands/UpdateProjectCommand.ts index 6bbd8011da14..5f9b7dbe927c 100644 --- a/clients/client-datazone/src/commands/UpdateProjectCommand.ts +++ b/clients/client-datazone/src/commands/UpdateProjectCommand.ts @@ -69,6 +69,7 @@ export interface UpdateProjectCommandOutput extends UpdateProjectOutput, __Metad * // glossaryTerms: [ // GlossaryTerms * // "STRING_VALUE", * // ], + * // domainUnitId: "STRING_VALUE", * // }; * * ``` diff --git a/clients/client-datazone/src/commands/index.ts b/clients/client-datazone/src/commands/index.ts index ca00b5895892..f43099e72829 100644 --- a/clients/client-datazone/src/commands/index.ts +++ b/clients/client-datazone/src/commands/index.ts @@ -1,6 +1,8 @@ // smithy-typescript generated code export * from "./AcceptPredictionsCommand"; export * from "./AcceptSubscriptionRequestCommand"; +export * from "./AddEntityOwnerCommand"; +export * from "./AddPolicyGrantCommand"; export * from "./AssociateEnvironmentRoleCommand"; export * from "./CancelMetadataGenerationRunCommand"; export * from "./CancelSubscriptionCommand"; @@ -12,6 +14,7 @@ export * from "./CreateDataProductCommand"; export * from "./CreateDataProductRevisionCommand"; export * from "./CreateDataSourceCommand"; export * from "./CreateDomainCommand"; +export * from "./CreateDomainUnitCommand"; export * from "./CreateEnvironmentActionCommand"; export * from "./CreateEnvironmentCommand"; export * from "./CreateEnvironmentProfileCommand"; @@ -32,6 +35,7 @@ export * from "./DeleteAssetTypeCommand"; export * from "./DeleteDataProductCommand"; export * from "./DeleteDataSourceCommand"; export * from "./DeleteDomainCommand"; +export * from "./DeleteDomainUnitCommand"; export * from "./DeleteEnvironmentActionCommand"; export * from "./DeleteEnvironmentBlueprintConfigurationCommand"; export * from "./DeleteEnvironmentCommand"; @@ -54,6 +58,7 @@ export * from "./GetDataProductCommand"; export * from "./GetDataSourceCommand"; export * from "./GetDataSourceRunCommand"; export * from "./GetDomainCommand"; +export * from "./GetDomainUnitCommand"; export * from "./GetEnvironmentActionCommand"; export * from "./GetEnvironmentBlueprintCommand"; export * from "./GetEnvironmentBlueprintConfigurationCommand"; @@ -81,7 +86,9 @@ export * from "./ListDataProductRevisionsCommand"; export * from "./ListDataSourceRunActivitiesCommand"; export * from "./ListDataSourceRunsCommand"; export * from "./ListDataSourcesCommand"; +export * from "./ListDomainUnitsForParentCommand"; export * from "./ListDomainsCommand"; +export * from "./ListEntityOwnersCommand"; export * from "./ListEnvironmentActionsCommand"; export * from "./ListEnvironmentBlueprintConfigurationsCommand"; export * from "./ListEnvironmentBlueprintsCommand"; @@ -90,6 +97,7 @@ export * from "./ListEnvironmentsCommand"; export * from "./ListLineageNodeHistoryCommand"; export * from "./ListMetadataGenerationRunsCommand"; export * from "./ListNotificationsCommand"; +export * from "./ListPolicyGrantsCommand"; export * from "./ListProjectMembershipsCommand"; export * from "./ListProjectsCommand"; export * from "./ListSubscriptionGrantsCommand"; @@ -103,6 +111,8 @@ export * from "./PostTimeSeriesDataPointsCommand"; export * from "./PutEnvironmentBlueprintConfigurationCommand"; export * from "./RejectPredictionsCommand"; export * from "./RejectSubscriptionRequestCommand"; +export * from "./RemoveEntityOwnerCommand"; +export * from "./RemovePolicyGrantCommand"; export * from "./RevokeSubscriptionCommand"; export * from "./SearchCommand"; export * from "./SearchGroupProfilesCommand"; @@ -116,6 +126,7 @@ export * from "./UntagResourceCommand"; export * from "./UpdateAssetFilterCommand"; export * from "./UpdateDataSourceCommand"; export * from "./UpdateDomainCommand"; +export * from "./UpdateDomainUnitCommand"; export * from "./UpdateEnvironmentActionCommand"; export * from "./UpdateEnvironmentCommand"; export * from "./UpdateEnvironmentProfileCommand"; diff --git a/clients/client-datazone/src/models/models_0.ts b/clients/client-datazone/src/models/models_0.ts index 5275707e3c3e..d94f26f7f4d7 100644 --- a/clients/client-datazone/src/models/models_0.ts +++ b/clients/client-datazone/src/models/models_0.ts @@ -729,153 +729,118 @@ export namespace ActionParameters { * @public * @enum */ -export const ListingStatus = { - ACTIVE: "ACTIVE", - CREATING: "CREATING", - INACTIVE: "INACTIVE", +export const DataZoneEntityType = { + DOMAIN_UNIT: "DOMAIN_UNIT", } as const; /** * @public */ -export type ListingStatus = (typeof ListingStatus)[keyof typeof ListingStatus]; - -/** - *The details of an asset published in an Amazon DataZone catalog.
- * @public - */ -export interface AssetListingDetails { - /** - *The identifier of an asset published in an Amazon DataZone catalog.
- * @public - */ - listingId: string | undefined; - - /** - *The status of an asset published in an Amazon DataZone catalog.
- * @public - */ - listingStatus: ListingStatus | undefined; -} +export type DataZoneEntityType = (typeof DataZoneEntityType)[keyof typeof DataZoneEntityType]; /** - *The details of a metadata form.
+ *The properties of the domain unit owners group.
* @public */ -export interface FormInput { - /** - *The name of the metadata form.
- * @public - */ - formName: string | undefined; - - /** - *The ID of the metadata form type.
- * @public - */ - typeIdentifier?: string; - - /** - *The revision of the metadata form type.
- * @public - */ - typeRevision?: string; - +export interface OwnerGroupProperties { /** - *The content of the metadata form.
+ *The ID of the domain unit owners group.
* @public */ - content?: string; + groupIdentifier: string | undefined; } /** - *The configuration of the business name generation.
+ *The properties of the owner user.
* @public */ -export interface BusinessNameGenerationConfiguration { +export interface OwnerUserProperties { /** - *Specifies whether the business name generation is enabled.
+ *The ID of the owner user.
* @public */ - enabled?: boolean; + userIdentifier: string | undefined; } /** - *The configuration of the prediction.
+ *The properties of a domain unit's owner.
* @public */ -export interface PredictionConfiguration { - /** - *The business name generation mechanism.
- * @public - */ - businessNameGeneration?: BusinessNameGenerationConfiguration; -} +export type OwnerProperties = OwnerProperties.GroupMember | OwnerProperties.UserMember | OwnerProperties.$UnknownMember; /** * @public */ -export interface CreateAssetInput { - /** - *Asset name.
- * @public - */ - name: string | undefined; - +export namespace OwnerProperties { /** - *Amazon DataZone domain where the asset is created.
+ *Specifies that the domain unit owner is a user.
* @public */ - domainIdentifier: string | undefined; + export interface UserMember { + user: OwnerUserProperties; + group?: never; + $unknown?: never; + } /** - *The external identifier of the asset.
+ *Specifies that the domain unit owner is a group.
* @public */ - externalIdentifier?: string; + export interface GroupMember { + user?: never; + group: OwnerGroupProperties; + $unknown?: never; + } /** - *The unique identifier of this asset's type.
* @public */ - typeIdentifier: string | undefined; + export interface $UnknownMember { + user?: never; + group?: never; + $unknown: [string, any]; + } - /** - *The revision of this asset's type.
- * @public - */ - typeRevision?: string; + export interface VisitorAsset description.
- * @public - */ - description?: string; + export const visit =Glossary terms attached to the asset.
+ *The ID of the domain in which you want to add the entity owner.
* @public */ - glossaryTerms?: string[]; + domainIdentifier: string | undefined; /** - *Metadata forms attached to the asset.
+ *The type of an entity.
* @public */ - formsInput?: FormInput[]; + entityType: DataZoneEntityType | undefined; /** - *The unique identifier of the project that owns this asset.
+ *The ID of the entity to which you want to add an owner.
* @public */ - owningProjectIdentifier: string | undefined; + entityIdentifier: string | undefined; /** - *The configuration of the automatically generated business-friendly metadata for the - * asset.
+ *The owner that you want to add to the entity.
* @public */ - predictionConfiguration?: PredictionConfiguration; + owner: OwnerProperties | undefined; /** *A unique, case-sensitive identifier that is provided to ensure the idempotency of the @@ -886,2702 +851,2057 @@ export interface CreateAssetInput { } /** - *
The details of a metadata form.
* @public */ -export interface FormOutput { - /** - *The name of the metadata form.
- * @public - */ - formName: string | undefined; +export interface AddEntityOwnerOutput {} +/** + *The request has exceeded the specified service quota.
+ * @public + */ +export class ServiceQuotaExceededException extends __BaseException { + readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; + readonly $fault: "client" = "client"; /** - *The name of the metadata form type.
- * @public + * @internal */ - typeName?: string; + constructor(opts: __ExceptionOptionTypeThe details of the policy grant.
+ * @public + */ +export interface AddToProjectMemberPoolPolicyGrantDetail { /** - *The revision of the metadata form type.
+ *Specifies whether the policy grant is applied to child domain units.
* @public */ - typeRevision?: string; + includeChildDomainUnits?: boolean; +} +/** + *The details of the policy grant.
+ * @public + */ +export interface CreateAssetTypePolicyGrantDetail { /** - *The content of the metadata form.
+ *Specifies whether the policy grant is applied to child domain units.
* @public */ - content?: string; + includeChildDomainUnits?: boolean; } /** - *The summary of the time series data points form.
+ *The details of the policy grant.
* @public */ -export interface TimeSeriesDataPointSummaryFormOutput { +export interface CreateDomainUnitPolicyGrantDetail { /** - *The name of the time series data points summary form.
+ *Specifies whether the policy grant is applied to child domain units.
* @public */ - formName: string | undefined; + includeChildDomainUnits?: boolean; +} - /** - *The type ID of the time series data points summary form.
- * @public - */ - typeIdentifier: string | undefined; +/** + *The details of the policy of creating an environment.
+ * @public + */ +export interface Unit {} +/** + *The details of the policy grant.
+ * @public + */ +export interface CreateEnvironmentProfilePolicyGrantDetail { /** - *The type revision of the time series data points summary form.
+ *The ID of the domain unit.
* @public */ - typeRevision?: string; + domainUnitId?: string; +} +/** + *The details of the policy grant.
+ * @public + */ +export interface CreateFormTypePolicyGrantDetail { /** - *The timestamp of the time series data points summary form.
+ *Specifies whether the policy grant is applied to child domain units.
* @public */ - timestamp: Date | undefined; + includeChildDomainUnits?: boolean; +} +/** + *The details of the policy grant.
+ * @public + */ +export interface CreateGlossaryPolicyGrantDetail { /** - *The content of the summary of the time series data points form.
+ *Specifies whether the policy grant is applied to child domain units.
* @public */ - contentSummary?: string; + includeChildDomainUnits?: boolean; +} +/** + *The details of the policy grant.
+ * @public + */ +export interface CreateProjectPolicyGrantDetail { /** - *The ID of the time series data points summary form.
+ *Specifies whether the policy grant is applied to child domain units.
* @public */ - id?: string; + includeChildDomainUnits?: boolean; } /** + *The grant details of the override domain unit owners policy.
* @public */ -export interface CreateAssetOutput { +export interface OverrideDomainUnitOwnersPolicyGrantDetail { /** - *The unique identifier of the created asset.
+ *Specifies whether the policy is inherited by child domain units.
* @public */ - id: string | undefined; + includeChildDomainUnits?: boolean; +} +/** + *The details of the override project owners policy grant.
+ * @public + */ +export interface OverrideProjectOwnersPolicyGrantDetail { /** - *The name of the created asset.
+ *Specifies whether the policy is inherited by child domain units.
* @public */ - name: string | undefined; + includeChildDomainUnits?: boolean; +} - /** - *The identifier of the created asset type.
- * @public - */ - typeIdentifier: string | undefined; +/** + *The details of the policy grant.
+ * @public + */ +export type PolicyGrantDetail = + | PolicyGrantDetail.AddToProjectMemberPoolMember + | PolicyGrantDetail.CreateAssetTypeMember + | PolicyGrantDetail.CreateDomainUnitMember + | PolicyGrantDetail.CreateEnvironmentMember + | PolicyGrantDetail.CreateEnvironmentProfileMember + | PolicyGrantDetail.CreateFormTypeMember + | PolicyGrantDetail.CreateGlossaryMember + | PolicyGrantDetail.CreateProjectMember + | PolicyGrantDetail.DelegateCreateEnvironmentProfileMember + | PolicyGrantDetail.OverrideDomainUnitOwnersMember + | PolicyGrantDetail.OverrideProjectOwnersMember + | PolicyGrantDetail.$UnknownMember; +/** + * @public + */ +export namespace PolicyGrantDetail { /** - *The revision type of the asset.
+ *Specifies that this is a create domain unit policy.
* @public */ - typeRevision: string | undefined; + export interface CreateDomainUnitMember { + createDomainUnit: CreateDomainUnitPolicyGrantDetail; + overrideDomainUnitOwners?: never; + addToProjectMemberPool?: never; + overrideProjectOwners?: never; + createGlossary?: never; + createFormType?: never; + createAssetType?: never; + createProject?: never; + createEnvironmentProfile?: never; + delegateCreateEnvironmentProfile?: never; + createEnvironment?: never; + $unknown?: never; + } /** - *The external identifier of the asset.
+ *Specifies whether to override domain unit owners.
* @public */ - externalIdentifier?: string; + export interface OverrideDomainUnitOwnersMember { + createDomainUnit?: never; + overrideDomainUnitOwners: OverrideDomainUnitOwnersPolicyGrantDetail; + addToProjectMemberPool?: never; + overrideProjectOwners?: never; + createGlossary?: never; + createFormType?: never; + createAssetType?: never; + createProject?: never; + createEnvironmentProfile?: never; + delegateCreateEnvironmentProfile?: never; + createEnvironment?: never; + $unknown?: never; + } /** - *The revision of the asset.
+ *Specifies that the policy grant is to be added to the members of the project.
* @public */ - revision: string | undefined; + export interface AddToProjectMemberPoolMember { + createDomainUnit?: never; + overrideDomainUnitOwners?: never; + addToProjectMemberPool: AddToProjectMemberPoolPolicyGrantDetail; + overrideProjectOwners?: never; + createGlossary?: never; + createFormType?: never; + createAssetType?: never; + createProject?: never; + createEnvironmentProfile?: never; + delegateCreateEnvironmentProfile?: never; + createEnvironment?: never; + $unknown?: never; + } /** - *The description of the created asset.
+ *Specifies whether to override project owners.
* @public */ - description?: string; + export interface OverrideProjectOwnersMember { + createDomainUnit?: never; + overrideDomainUnitOwners?: never; + addToProjectMemberPool?: never; + overrideProjectOwners: OverrideProjectOwnersPolicyGrantDetail; + createGlossary?: never; + createFormType?: never; + createAssetType?: never; + createProject?: never; + createEnvironmentProfile?: never; + delegateCreateEnvironmentProfile?: never; + createEnvironment?: never; + $unknown?: never; + } /** - *The timestamp of when the asset was created.
+ *Specifies that this is a create glossary policy.
* @public */ - createdAt?: Date; + export interface CreateGlossaryMember { + createDomainUnit?: never; + overrideDomainUnitOwners?: never; + addToProjectMemberPool?: never; + overrideProjectOwners?: never; + createGlossary: CreateGlossaryPolicyGrantDetail; + createFormType?: never; + createAssetType?: never; + createProject?: never; + createEnvironmentProfile?: never; + delegateCreateEnvironmentProfile?: never; + createEnvironment?: never; + $unknown?: never; + } /** - *The Amazon DataZone user that created this asset in the catalog.
+ *Specifies that this is a create form type policy.
* @public */ - createdBy?: string; + export interface CreateFormTypeMember { + createDomainUnit?: never; + overrideDomainUnitOwners?: never; + addToProjectMemberPool?: never; + overrideProjectOwners?: never; + createGlossary?: never; + createFormType: CreateFormTypePolicyGrantDetail; + createAssetType?: never; + createProject?: never; + createEnvironmentProfile?: never; + delegateCreateEnvironmentProfile?: never; + createEnvironment?: never; + $unknown?: never; + } /** - *The timestamp of when the first revision of the asset took place.
+ *Specifies that this is a create asset type policy.
* @public */ - firstRevisionCreatedAt?: Date; + export interface CreateAssetTypeMember { + createDomainUnit?: never; + overrideDomainUnitOwners?: never; + addToProjectMemberPool?: never; + overrideProjectOwners?: never; + createGlossary?: never; + createFormType?: never; + createAssetType: CreateAssetTypePolicyGrantDetail; + createProject?: never; + createEnvironmentProfile?: never; + delegateCreateEnvironmentProfile?: never; + createEnvironment?: never; + $unknown?: never; + } /** - *The Amazon DataZone user that made the first revision of the asset.
+ *Specifies that this is a create project policy.
* @public */ - firstRevisionCreatedBy?: string; + export interface CreateProjectMember { + createDomainUnit?: never; + overrideDomainUnitOwners?: never; + addToProjectMemberPool?: never; + overrideProjectOwners?: never; + createGlossary?: never; + createFormType?: never; + createAssetType?: never; + createProject: CreateProjectPolicyGrantDetail; + createEnvironmentProfile?: never; + delegateCreateEnvironmentProfile?: never; + createEnvironment?: never; + $unknown?: never; + } /** - *The glossary terms that are attached to the created asset.
+ *Specifies that this is a create environment profile policy.
* @public */ - glossaryTerms?: string[]; + export interface CreateEnvironmentProfileMember { + createDomainUnit?: never; + overrideDomainUnitOwners?: never; + addToProjectMemberPool?: never; + overrideProjectOwners?: never; + createGlossary?: never; + createFormType?: never; + createAssetType?: never; + createProject?: never; + createEnvironmentProfile: CreateEnvironmentProfilePolicyGrantDetail; + delegateCreateEnvironmentProfile?: never; + createEnvironment?: never; + $unknown?: never; + } /** - *The ID of the Amazon DataZone project that owns the created asset.
+ *Specifies that this is the delegation of the create environment profile policy.
* @public */ - owningProjectId: string | undefined; + export interface DelegateCreateEnvironmentProfileMember { + createDomainUnit?: never; + overrideDomainUnitOwners?: never; + addToProjectMemberPool?: never; + overrideProjectOwners?: never; + createGlossary?: never; + createFormType?: never; + createAssetType?: never; + createProject?: never; + createEnvironmentProfile?: never; + delegateCreateEnvironmentProfile: Unit; + createEnvironment?: never; + $unknown?: never; + } /** - *The ID of the Amazon DataZone domain in which the asset was created.
+ *Specifies that this is a create environment policy.
* @public */ - domainId: string | undefined; + export interface CreateEnvironmentMember { + createDomainUnit?: never; + overrideDomainUnitOwners?: never; + addToProjectMemberPool?: never; + overrideProjectOwners?: never; + createGlossary?: never; + createFormType?: never; + createAssetType?: never; + createProject?: never; + createEnvironmentProfile?: never; + delegateCreateEnvironmentProfile?: never; + createEnvironment: Unit; + $unknown?: never; + } /** - *The details of an asset published in an Amazon DataZone catalog.
* @public */ - listing?: AssetListingDetails; + export interface $UnknownMember { + createDomainUnit?: never; + overrideDomainUnitOwners?: never; + addToProjectMemberPool?: never; + overrideProjectOwners?: never; + createGlossary?: never; + createFormType?: never; + createAssetType?: never; + createProject?: never; + createEnvironmentProfile?: never; + delegateCreateEnvironmentProfile?: never; + createEnvironment?: never; + $unknown: [string, any]; + } - /** - *The metadata forms that are attached to the created asset.
- * @public - */ - formsOutput: FormOutput[] | undefined; + export interface VisitorThe read-only metadata forms that are attached to the created asset.
- * @public - */ - readOnlyFormsOutput?: FormOutput[]; + export const visit =The latest data point that was imported into the time series form for the asset.
- * @public - */ - latestTimeSeriesDataPointFormsOutput?: TimeSeriesDataPointSummaryFormOutput[]; +/** + * @public + * @enum + */ +export const TargetEntityType = { + DOMAIN_UNIT: "DOMAIN_UNIT", + ENVIRONMENT_BLUEPRINT_CONFIGURATION: "ENVIRONMENT_BLUEPRINT_CONFIGURATION", + ENVIRONMENT_PROFILE: "ENVIRONMENT_PROFILE", +} as const; - /** - *The configuration of the automatically generated business-friendly metadata for the - * asset.
- * @public - */ - predictionConfiguration?: PredictionConfiguration; -} +/** + * @public + */ +export type TargetEntityType = (typeof TargetEntityType)[keyof typeof TargetEntityType]; /** - *The request has exceeded the specified service quota.
* @public + * @enum */ -export class ServiceQuotaExceededException extends __BaseException { - readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeTe revised name of the asset.
- * @public - */ - name: string | undefined; +export type ManagedPolicyType = (typeof ManagedPolicyType)[keyof typeof ManagedPolicyType]; - /** - *The unique identifier of the domain where the asset is being revised.
- * @public - */ - domainIdentifier: string | undefined; +/** + * @public + * @enum + */ +export const DomainUnitDesignation = { + OWNER: "OWNER", +} as const; + +/** + * @public + */ +export type DomainUnitDesignation = (typeof DomainUnitDesignation)[keyof typeof DomainUnitDesignation]; + +/** + *The grant filter for all domain units.
+ * @public + */ +export interface AllDomainUnitsGrantFilter {} + +/** + *The grant filter for the domain unit. In the current release of Amazon DataZone, the only
+ * supported filter is the allDomainUnitsGrantFilter.
The identifier of the asset.
+ *Specifies a grant filter containing all domain units.
* @public */ - identifier: string | undefined; + export interface AllDomainUnitsGrantFilterMember { + allDomainUnitsGrantFilter: AllDomainUnitsGrantFilter; + $unknown?: never; + } /** - *The revision type of the asset.
* @public */ - typeRevision?: string; + export interface $UnknownMember { + allDomainUnitsGrantFilter?: never; + $unknown: [string, any]; + } + + export interface VisitorThe domain unit principal to whom the policy is granted.
+ * @public + */ +export interface DomainUnitPolicyGrantPrincipal { /** - *The revised description of the asset.
+ *Specifes the designation of the domain unit users.
* @public */ - description?: string; + domainUnitDesignation: DomainUnitDesignation | undefined; /** - *The glossary terms to be attached to the asset as part of asset revision.
+ *The ID of the domain unit.
* @public */ - glossaryTerms?: string[]; + domainUnitIdentifier?: string; /** - *The metadata forms to be attached to the asset as part of asset revision.
+ *The grant filter for the domain unit.
* @public */ - formsInput?: FormInput[]; + domainUnitGrantFilter?: DomainUnitGrantFilter; +} + +/** + *The group principal to whom the policy is granted.
+ * @public + */ +export type GroupPolicyGrantPrincipal = + | GroupPolicyGrantPrincipal.GroupIdentifierMember + | GroupPolicyGrantPrincipal.$UnknownMember; +/** + * @public + */ +export namespace GroupPolicyGrantPrincipal { /** - *The configuration of the automatically generated business-friendly metadata for the - * asset.
+ *The ID Of the group of the group principal.
* @public */ - predictionConfiguration?: PredictionConfiguration; + export interface GroupIdentifierMember { + groupIdentifier: string; + $unknown?: never; + } /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
* @public */ - clientToken?: string; + export interface $UnknownMember { + groupIdentifier?: never; + $unknown: [string, any]; + } + + export interface VisitorThe domain unit filter of the project grant filter.
+ * @public + */ +export interface DomainUnitFilterForProject { /** - *The unique identifier of the asset revision.
+ *The domain unit ID to use in the filter.
* @public */ - id: string | undefined; + domainUnit: string | undefined; /** - *The revised name of the asset.
+ *Specifies whether to include child domain units.
* @public */ - name: string | undefined; + includeChildDomainUnits?: boolean; +} + +/** + *The project grant filter.
+ * @public + */ +export type ProjectGrantFilter = ProjectGrantFilter.DomainUnitFilterMember | ProjectGrantFilter.$UnknownMember; +/** + * @public + */ +export namespace ProjectGrantFilter { /** - *The identifier of the revision type.
+ *The domain unit filter of the project grant filter.
* @public */ - typeIdentifier: string | undefined; + export interface DomainUnitFilterMember { + domainUnitFilter: DomainUnitFilterForProject; + $unknown?: never; + } /** - *The revision type of the asset.
* @public */ - typeRevision: string | undefined; + export interface $UnknownMember { + domainUnitFilter?: never; + $unknown: [string, any]; + } + + export interface VisitorThe project policy grant principal.
+ * @public + */ +export interface ProjectPolicyGrantPrincipal { /** - *The external identifier of the asset.
+ *The project designation of the project policy grant principal.
* @public */ - externalIdentifier?: string; + projectDesignation: ProjectDesignation | undefined; /** - *The revision of the asset.
+ *The project ID of the project policy grant principal.
* @public */ - revision: string | undefined; + projectIdentifier?: string; /** - *The revised asset description.
+ *The project grant filter of the project policy grant principal.
* @public */ - description?: string; + projectGrantFilter?: ProjectGrantFilter; +} + +/** + *The all users grant filter.
+ * @public + */ +export interface AllUsersGrantFilter {} + +/** + *The user policy grant principal.
+ * @public + */ +export type UserPolicyGrantPrincipal = + | UserPolicyGrantPrincipal.AllUsersGrantFilterMember + | UserPolicyGrantPrincipal.UserIdentifierMember + | UserPolicyGrantPrincipal.$UnknownMember; +/** + * @public + */ +export namespace UserPolicyGrantPrincipal { /** - *The timestamp of when the asset revision occured.
+ *The user ID of the user policy grant principal.
* @public */ - createdAt?: Date; + export interface UserIdentifierMember { + userIdentifier: string; + allUsersGrantFilter?: never; + $unknown?: never; + } /** - *The Amazon DataZone user who performed the asset revision.
+ *The all users grant filter of the user policy grant principal.
* @public */ - createdBy?: string; + export interface AllUsersGrantFilterMember { + userIdentifier?: never; + allUsersGrantFilter: AllUsersGrantFilter; + $unknown?: never; + } /** - *The timestamp of when the first asset revision occured.
* @public */ - firstRevisionCreatedAt?: Date; + export interface $UnknownMember { + userIdentifier?: never; + allUsersGrantFilter?: never; + $unknown: [string, any]; + } + + export interface VisitorThe policy grant principal.
+ * @public + */ +export type PolicyGrantPrincipal = + | PolicyGrantPrincipal.DomainUnitMember + | PolicyGrantPrincipal.GroupMember + | PolicyGrantPrincipal.ProjectMember + | PolicyGrantPrincipal.UserMember + | PolicyGrantPrincipal.$UnknownMember; +/** + * @public + */ +export namespace PolicyGrantPrincipal { /** - *The Amazon DataZone user who performed the first asset revision.
+ *The user of the policy grant principal.
* @public */ - firstRevisionCreatedBy?: string; + export interface UserMember { + user: UserPolicyGrantPrincipal; + group?: never; + project?: never; + domainUnit?: never; + $unknown?: never; + } /** - *The glossary terms that were attached to the asset as part of asset revision.
+ *The group of the policy grant principal.
* @public */ - glossaryTerms?: string[]; + export interface GroupMember { + user?: never; + group: GroupPolicyGrantPrincipal; + project?: never; + domainUnit?: never; + $unknown?: never; + } /** - *The unique identifier of the revised project that owns the asset.
+ *The project of the policy grant principal.
* @public */ - owningProjectId: string | undefined; + export interface ProjectMember { + user?: never; + group?: never; + project: ProjectPolicyGrantPrincipal; + domainUnit?: never; + $unknown?: never; + } /** - *The unique identifier of the Amazon DataZone domain where the asset was revised.
+ *The domain unit of the policy grant principal.
* @public */ - domainId: string | undefined; + export interface DomainUnitMember { + user?: never; + group?: never; + project?: never; + domainUnit: DomainUnitPolicyGrantPrincipal; + $unknown?: never; + } /** - *The details of an asset published in an Amazon DataZone catalog.
* @public */ - listing?: AssetListingDetails; + export interface $UnknownMember { + user?: never; + group?: never; + project?: never; + domainUnit?: never; + $unknown: [string, any]; + } + + export interface VisitorThe metadata forms that were attached to the asset as part of the asset revision.
+ *The ID of the domain where you want to add a policy grant.
* @public */ - formsOutput: FormOutput[] | undefined; + domainIdentifier: string | undefined; /** - *The read-only metadata forms that were attached to the asset as part of the asset - * revision.
+ *The type of entity (resource) to which the grant is added.
* @public */ - readOnlyFormsOutput?: FormOutput[]; + entityType: TargetEntityType | undefined; /** - *The latest data point that was imported into the time series form for the asset.
+ *The ID of the entity (resource) to which you want to add a policy grant.
* @public */ - latestTimeSeriesDataPointFormsOutput?: TimeSeriesDataPointSummaryFormOutput[]; + entityIdentifier: string | undefined; /** - *The configuration of the automatically generated business-friendly metadata for the - * asset.
+ *The type of policy that you want to grant.
* @public */ - predictionConfiguration?: PredictionConfiguration; -} + policyType: ManagedPolicyType | undefined; -/** - * @public - */ -export interface DeleteAssetInput { /** - *The ID of the Amazon DataZone domain in which the asset is deleted.
+ *The principal to whom the permissions are granted.
* @public */ - domainIdentifier: string | undefined; + principal: PolicyGrantPrincipal | undefined; /** - *The identifier of the asset that is deleted.
+ *The details of the policy grant.
* @public */ - identifier: string | undefined; + detail: PolicyGrantDetail | undefined; + + /** + *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
+ * @public + */ + clientToken?: string; } /** * @public */ -export interface DeleteAssetOutput {} +export interface AddPolicyGrantOutput {} /** * @public + * @enum */ -export interface GetAssetInput { - /** - *The ID of the Amazon DataZone domain to which the asset belongs.
- * @public - */ - domainIdentifier: string | undefined; +export const ListingStatus = { + ACTIVE: "ACTIVE", + CREATING: "CREATING", + INACTIVE: "INACTIVE", +} as const; + +/** + * @public + */ +export type ListingStatus = (typeof ListingStatus)[keyof typeof ListingStatus]; +/** + *The details of an asset published in an Amazon DataZone catalog.
+ * @public + */ +export interface AssetListingDetails { /** - *The ID of the Amazon DataZone asset.
+ *The identifier of an asset published in an Amazon DataZone catalog.
* @public */ - identifier: string | undefined; + listingId: string | undefined; /** - *The revision of the Amazon DataZone asset.
+ *The status of an asset published in an Amazon DataZone catalog.
* @public */ - revision?: string; + listingStatus: ListingStatus | undefined; } /** + *The details of a metadata form.
* @public */ -export interface GetAssetOutput { - /** - *The ID of the asset.
- * @public - */ - id: string | undefined; - +export interface FormInput { /** - *The name of the asset.
+ *The name of the metadata form.
* @public */ - name: string | undefined; + formName: string | undefined; /** - *The ID of the asset type.
+ *The ID of the metadata form type.
* @public */ - typeIdentifier: string | undefined; + typeIdentifier?: string; /** - *The revision of the asset type.
+ *The revision of the metadata form type.
* @public */ - typeRevision: string | undefined; + typeRevision?: string; /** - *The external ID of the asset.
+ *The content of the metadata form.
* @public */ - externalIdentifier?: string; + content?: string; +} +/** + *The configuration of the business name generation.
+ * @public + */ +export interface BusinessNameGenerationConfiguration { /** - *The revision of the asset.
+ *Specifies whether the business name generation is enabled.
* @public */ - revision: string | undefined; + enabled?: boolean; +} +/** + *The configuration of the prediction.
+ * @public + */ +export interface PredictionConfiguration { /** - *The description of the Amazon DataZone asset.
+ *The business name generation mechanism.
* @public */ - description?: string; + businessNameGeneration?: BusinessNameGenerationConfiguration; +} +/** + * @public + */ +export interface CreateAssetInput { /** - *The timestamp of when the asset was created.
+ *Asset name.
* @public */ - createdAt?: Date; + name: string | undefined; /** - *The Amazon DataZone user who created the asset.
+ *Amazon DataZone domain where the asset is created.
* @public */ - createdBy?: string; + domainIdentifier: string | undefined; /** - *The timestamp of when the first revision of the asset was created.
+ *The external identifier of the asset.
* @public */ - firstRevisionCreatedAt?: Date; + externalIdentifier?: string; /** - *The Amazon DataZone user who created the first revision of the asset.
+ *The unique identifier of this asset's type.
* @public */ - firstRevisionCreatedBy?: string; + typeIdentifier: string | undefined; /** - *The business glossary terms attached to the asset.
+ *The revision of this asset's type.
* @public */ - glossaryTerms?: string[]; + typeRevision?: string; /** - *The ID of the project that owns the asset.
+ *Asset description.
* @public */ - owningProjectId: string | undefined; + description?: string; /** - *The ID of the Amazon DataZone domain to which the asset belongs.
+ *Glossary terms attached to the asset.
* @public */ - domainId: string | undefined; + glossaryTerms?: string[]; /** - *The listing of the asset.
+ *Metadata forms attached to the asset.
* @public */ - listing?: AssetListingDetails; + formsInput?: FormInput[]; /** - *The metadata forms attached to the asset.
+ *The unique identifier of the project that owns this asset.
* @public */ - formsOutput: FormOutput[] | undefined; + owningProjectIdentifier: string | undefined; /** - *The read-only metadata forms attached to the asset.
+ *The configuration of the automatically generated business-friendly metadata for the + * asset.
* @public */ - readOnlyFormsOutput?: FormOutput[]; + predictionConfiguration?: PredictionConfiguration; /** - *The latest data point that was imported into the time series form for the asset.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - latestTimeSeriesDataPointFormsOutput?: TimeSeriesDataPointSummaryFormOutput[]; + clientToken?: string; } /** - *The column configuration of the asset filter.
+ *The details of a metadata form.
* @public */ -export interface ColumnFilterConfiguration { +export interface FormOutput { /** - *Specifies whether to include column names.
+ *The name of the metadata form.
* @public */ - includedColumnNames?: string[]; -} + formName: string | undefined; -/** - *Specifies whether the value is equal to an expression.
- * @public - */ -export interface EqualToExpression { /** - *The name of the column.
+ *The name of the metadata form type.
* @public */ - columnName: string | undefined; + typeName?: string; /** - *The value that might be equal to an expression.
+ *The revision of the metadata form type.
* @public */ - value: string | undefined; + typeRevision?: string; + + /** + *The content of the metadata form.
+ * @public + */ + content?: string; } /** - *Specifies whether the value is greater than an expression.
+ *The summary of the time series data points form.
* @public */ -export interface GreaterThanExpression { +export interface TimeSeriesDataPointSummaryFormOutput { /** - *The name of the column.
+ *The name of the time series data points summary form.
* @public */ - columnName: string | undefined; + formName: string | undefined; /** - *The value that might be greater than an expression.
+ *The type ID of the time series data points summary form.
* @public */ - value: string | undefined; -} + typeIdentifier: string | undefined; -/** - *Specifies whether the value is greater than or equal to an expression.
- * @public - */ -export interface GreaterThanOrEqualToExpression { /** - *The name of the column.
+ *The type revision of the time series data points summary form.
* @public */ - columnName: string | undefined; + typeRevision?: string; /** - *The value that might be greater than or equal to an expression.
+ *The timestamp of the time series data points summary form.
* @public */ - value: string | undefined; -} + timestamp: Date | undefined; -/** - *Specifies whether values are in the expression.
- * @public - */ -export interface InExpression { /** - *The name of the column.
+ *The content of the summary of the time series data points form.
* @public */ - columnName: string | undefined; + contentSummary?: string; /** - *The values that might be in the expression.
+ *The ID of the time series data points summary form.
* @public */ - values: string[] | undefined; + id?: string; } /** - *Specifies that the expression is not null.
* @public */ -export interface IsNotNullExpression { +export interface CreateAssetOutput { /** - *The name of the column.
+ *The unique identifier of the created asset.
* @public */ - columnName: string | undefined; -} + id: string | undefined; -/** - *Specifies that the expression is null.
- * @public - */ -export interface IsNullExpression { /** - *The name of the column.
+ *The name of the created asset.
* @public */ - columnName: string | undefined; -} + name: string | undefined; -/** - *Specifies that a value is less than an expression.
- * @public - */ -export interface LessThanExpression { /** - *The name of the column.
+ *The identifier of the created asset type.
* @public */ - columnName: string | undefined; + typeIdentifier: string | undefined; /** - *The value that might be less than the expression.
+ *The revision type of the asset.
* @public */ - value: string | undefined; -} + typeRevision: string | undefined; -/** - *Specifies that a value is less than or equal to an expression.
- * @public - */ -export interface LessThanOrEqualToExpression { /** - *The name of the column.
+ *The external identifier of the asset.
* @public */ - columnName: string | undefined; + externalIdentifier?: string; /** - *The value that might be less than or equal to an expression.
+ *The revision of the asset.
* @public */ - value: string | undefined; -} + revision: string | undefined; -/** - *Specifies that a value is like the expression.
- * @public - */ -export interface LikeExpression { /** - *The name of the column.
+ *The description of the created asset.
* @public */ - columnName: string | undefined; + description?: string; /** - *The value that might be like the expression.
+ *The timestamp of when the asset was created.
* @public */ - value: string | undefined; -} + createdAt?: Date; -/** - *Specifies that a value is not equal to the expression.
- * @public - */ -export interface NotEqualToExpression { /** - *The name of the column.
+ *The Amazon DataZone user that created this asset in the catalog.
* @public */ - columnName: string | undefined; + createdBy?: string; /** - *The value that might not be equal to the expression.
+ *The timestamp of when the first revision of the asset took place.
* @public */ - value: string | undefined; -} + firstRevisionCreatedAt?: Date; -/** - *Specifies that a value is not in the expression.
- * @public - */ -export interface NotInExpression { /** - *The name of the column.
+ *The Amazon DataZone user that made the first revision of the asset.
* @public */ - columnName: string | undefined; + firstRevisionCreatedBy?: string; /** - *The value that might not be in the expression.
+ *The glossary terms that are attached to the created asset.
* @public */ - values: string[] | undefined; -} + glossaryTerms?: string[]; -/** - *Specifies that a value might be not like the expression.
- * @public - */ -export interface NotLikeExpression { /** - *The name of the column.
+ *The ID of the Amazon DataZone project that owns the created asset.
* @public */ - columnName: string | undefined; + owningProjectId: string | undefined; /** - *The value that might not be like the expression.
+ *The ID of the Amazon DataZone domain in which the asset was created.
* @public */ - value: string | undefined; -} + domainId: string | undefined; -/** - *The row filter expression.
- * @public - */ -export type RowFilterExpression = - | RowFilterExpression.EqualToMember - | RowFilterExpression.GreaterThanMember - | RowFilterExpression.GreaterThanOrEqualToMember - | RowFilterExpression.InMember - | RowFilterExpression.IsNotNullMember - | RowFilterExpression.IsNullMember - | RowFilterExpression.LessThanMember - | RowFilterExpression.LessThanOrEqualToMember - | RowFilterExpression.LikeMember - | RowFilterExpression.NotEqualToMember - | RowFilterExpression.NotInMember - | RowFilterExpression.NotLikeMember - | RowFilterExpression.$UnknownMember; + /** + *The details of an asset published in an Amazon DataZone catalog.
+ * @public + */ + listing?: AssetListingDetails; -/** - * @public - */ -export namespace RowFilterExpression { /** - *The 'equal to' clause of the row filter expression.
+ *The metadata forms that are attached to the created asset.
* @public */ - export interface EqualToMember { - equalTo: EqualToExpression; - notEqualTo?: never; - greaterThan?: never; - lessThan?: never; - greaterThanOrEqualTo?: never; - lessThanOrEqualTo?: never; - isNull?: never; - isNotNull?: never; - in?: never; - notIn?: never; - like?: never; - notLike?: never; - $unknown?: never; - } + formsOutput: FormOutput[] | undefined; /** - *The 'no equal to' clause of the row filter expression.
+ *The read-only metadata forms that are attached to the created asset.
* @public */ - export interface NotEqualToMember { - equalTo?: never; - notEqualTo: NotEqualToExpression; - greaterThan?: never; - lessThan?: never; - greaterThanOrEqualTo?: never; - lessThanOrEqualTo?: never; - isNull?: never; - isNotNull?: never; - in?: never; - notIn?: never; - like?: never; - notLike?: never; - $unknown?: never; - } + readOnlyFormsOutput?: FormOutput[]; /** - *The 'greater than' clause of the row filter expression.
+ *The latest data point that was imported into the time series form for the asset.
* @public */ - export interface GreaterThanMember { - equalTo?: never; - notEqualTo?: never; - greaterThan: GreaterThanExpression; - lessThan?: never; - greaterThanOrEqualTo?: never; - lessThanOrEqualTo?: never; - isNull?: never; - isNotNull?: never; - in?: never; - notIn?: never; - like?: never; - notLike?: never; - $unknown?: never; - } + latestTimeSeriesDataPointFormsOutput?: TimeSeriesDataPointSummaryFormOutput[]; /** - *The 'less than' clause of the row filter expression.
+ *The configuration of the automatically generated business-friendly metadata for the + * asset.
* @public */ - export interface LessThanMember { - equalTo?: never; - notEqualTo?: never; - greaterThan?: never; - lessThan: LessThanExpression; - greaterThanOrEqualTo?: never; - lessThanOrEqualTo?: never; - isNull?: never; - isNotNull?: never; - in?: never; - notIn?: never; - like?: never; - notLike?: never; - $unknown?: never; - } + predictionConfiguration?: PredictionConfiguration; +} +/** + * @public + */ +export interface CreateAssetRevisionInput { /** - *The 'greater than or equal to' clause of the filter expression.
+ *Te revised name of the asset.
* @public */ - export interface GreaterThanOrEqualToMember { - equalTo?: never; - notEqualTo?: never; - greaterThan?: never; - lessThan?: never; - greaterThanOrEqualTo: GreaterThanOrEqualToExpression; - lessThanOrEqualTo?: never; - isNull?: never; - isNotNull?: never; - in?: never; - notIn?: never; - like?: never; - notLike?: never; - $unknown?: never; - } + name: string | undefined; /** - *The 'less than or equal to' clause of the row filter expression.
+ *The unique identifier of the domain where the asset is being revised.
* @public */ - export interface LessThanOrEqualToMember { - equalTo?: never; - notEqualTo?: never; - greaterThan?: never; - lessThan?: never; - greaterThanOrEqualTo?: never; - lessThanOrEqualTo: LessThanOrEqualToExpression; - isNull?: never; - isNotNull?: never; - in?: never; - notIn?: never; - like?: never; - notLike?: never; - $unknown?: never; - } + domainIdentifier: string | undefined; /** - *The 'is null' clause of the row filter expression.
+ *The identifier of the asset.
* @public */ - export interface IsNullMember { - equalTo?: never; - notEqualTo?: never; - greaterThan?: never; - lessThan?: never; - greaterThanOrEqualTo?: never; - lessThanOrEqualTo?: never; - isNull: IsNullExpression; - isNotNull?: never; - in?: never; - notIn?: never; - like?: never; - notLike?: never; - $unknown?: never; - } + identifier: string | undefined; /** - *The 'is not null' clause of the row filter expression.
+ *The revision type of the asset.
* @public */ - export interface IsNotNullMember { - equalTo?: never; - notEqualTo?: never; - greaterThan?: never; - lessThan?: never; - greaterThanOrEqualTo?: never; - lessThanOrEqualTo?: never; - isNull?: never; - isNotNull: IsNotNullExpression; - in?: never; - notIn?: never; - like?: never; - notLike?: never; - $unknown?: never; - } + typeRevision?: string; /** - *The 'in' clause of the row filter expression.
+ *The revised description of the asset.
* @public */ - export interface InMember { - equalTo?: never; - notEqualTo?: never; - greaterThan?: never; - lessThan?: never; - greaterThanOrEqualTo?: never; - lessThanOrEqualTo?: never; - isNull?: never; - isNotNull?: never; - in: InExpression; - notIn?: never; - like?: never; - notLike?: never; - $unknown?: never; - } + description?: string; /** - *The 'not in' clause of the row filter expression.
+ *The glossary terms to be attached to the asset as part of asset revision.
* @public */ - export interface NotInMember { - equalTo?: never; - notEqualTo?: never; - greaterThan?: never; - lessThan?: never; - greaterThanOrEqualTo?: never; - lessThanOrEqualTo?: never; - isNull?: never; - isNotNull?: never; - in?: never; - notIn: NotInExpression; - like?: never; - notLike?: never; - $unknown?: never; - } + glossaryTerms?: string[]; /** - *The 'like' clause of the row filter expression.
+ *The metadata forms to be attached to the asset as part of asset revision.
* @public */ - export interface LikeMember { - equalTo?: never; - notEqualTo?: never; - greaterThan?: never; - lessThan?: never; - greaterThanOrEqualTo?: never; - lessThanOrEqualTo?: never; - isNull?: never; - isNotNull?: never; - in?: never; - notIn?: never; - like: LikeExpression; - notLike?: never; - $unknown?: never; - } + formsInput?: FormInput[]; /** - *The 'not like' clause of the row filter expression.
+ *The configuration of the automatically generated business-friendly metadata for the + * asset.
* @public */ - export interface NotLikeMember { - equalTo?: never; - notEqualTo?: never; - greaterThan?: never; - lessThan?: never; - greaterThanOrEqualTo?: never; - lessThanOrEqualTo?: never; - isNull?: never; - isNotNull?: never; - in?: never; - notIn?: never; - like?: never; - notLike: NotLikeExpression; - $unknown?: never; - } + predictionConfiguration?: PredictionConfiguration; /** + *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - export interface $UnknownMember { - equalTo?: never; - notEqualTo?: never; - greaterThan?: never; - lessThan?: never; - greaterThanOrEqualTo?: never; - lessThanOrEqualTo?: never; - isNull?: never; - isNotNull?: never; - in?: never; - notIn?: never; - like?: never; - notLike?: never; - $unknown: [string, any]; - } - - export interface VisitorThe summary of the asset filter.
* @public */ -export interface AssetFilterSummary { +export interface CreateAssetRevisionOutput { /** - *The ID of the asset filter.
+ *The unique identifier of the asset revision.
* @public */ id: string | undefined; /** - *The ID of the domain where the asset filter lives.
- * @public - */ - domainId: string | undefined; - - /** - *The ID of the data asset.
+ *The revised name of the asset.
* @public */ - assetId: string | undefined; + name: string | undefined; /** - *The name of the asset filter.
+ *The identifier of the revision type.
* @public */ - name: string | undefined; + typeIdentifier: string | undefined; /** - *The description of the asset filter.
+ *The revision type of the asset.
* @public */ - description?: string; + typeRevision: string | undefined; /** - *The status of the asset filter.
+ *The external identifier of the asset.
* @public */ - status?: FilterStatus; + externalIdentifier?: string; /** - *The effective column names of the asset filter.
+ *The revision of the asset.
* @public */ - effectiveColumnNames?: string[]; + revision: string | undefined; /** - *The effective row filter of the asset filter.
+ *The revised asset description.
* @public */ - effectiveRowFilter?: string; + description?: string; /** - *The timestamp at which the asset filter was created.
+ *The timestamp of when the asset revision occured.
* @public */ createdAt?: Date; /** - *The error message that is displayed if the action does not succeed.
+ *The Amazon DataZone user who performed the asset revision.
* @public */ - errorMessage?: string; -} + createdBy?: string; -/** - *The additional attributes of an inventory asset.
- * @public - */ -export interface AssetItemAdditionalAttributes { /** - *The forms included in the additional attributes of an inventory asset.
+ *The timestamp of when the first asset revision occured.
* @public */ - formsOutput?: FormOutput[]; + firstRevisionCreatedAt?: Date; /** - *The read-only forms included in the additional attributes of an inventory asset.
+ *The Amazon DataZone user who performed the first asset revision.
* @public */ - readOnlyFormsOutput?: FormOutput[]; + firstRevisionCreatedBy?: string; /** - *The latest time series data points forms included in the additional attributes of an - * asset.
+ *The glossary terms that were attached to the asset as part of asset revision.
* @public */ - latestTimeSeriesDataPointFormsOutput?: TimeSeriesDataPointSummaryFormOutput[]; -} + glossaryTerms?: string[]; -/** - *A Amazon DataZone inventory asset.
- * @public - */ -export interface AssetItem { /** - *The identifier of the Amazon DataZone domain in which the inventory asset exists.
+ *The unique identifier of the revised project that owns the asset.
* @public */ - domainId: string | undefined; + owningProjectId: string | undefined; /** - *the identifier of the Amazon DataZone inventory asset.
+ *The unique identifier of the Amazon DataZone domain where the asset was revised.
* @public */ - identifier: string | undefined; + domainId: string | undefined; /** - *The name of the Amazon DataZone inventory asset.
+ *The details of an asset published in an Amazon DataZone catalog.
* @public */ - name: string | undefined; + listing?: AssetListingDetails; /** - *The identifier of the asset type of the specified Amazon DataZone inventory asset.
+ *The metadata forms that were attached to the asset as part of the asset revision.
* @public */ - typeIdentifier: string | undefined; + formsOutput: FormOutput[] | undefined; /** - *The revision of the inventory asset type.
+ *The read-only metadata forms that were attached to the asset as part of the asset + * revision.
* @public */ - typeRevision: string | undefined; + readOnlyFormsOutput?: FormOutput[]; /** - *The external identifier of the Amazon DataZone inventory asset.
+ *The latest data point that was imported into the time series form for the asset.
* @public */ - externalIdentifier?: string; + latestTimeSeriesDataPointFormsOutput?: TimeSeriesDataPointSummaryFormOutput[]; /** - *The description of an Amazon DataZone inventory asset.
+ *The configuration of the automatically generated business-friendly metadata for the + * asset.
* @public */ - description?: string; + predictionConfiguration?: PredictionConfiguration; +} +/** + * @public + */ +export interface DeleteAssetInput { /** - *The timestamp of when the Amazon DataZone inventory asset was created.
+ *The ID of the Amazon DataZone domain in which the asset is deleted.
* @public */ - createdAt?: Date; + domainIdentifier: string | undefined; /** - *The Amazon DataZone user who created the inventory asset.
+ *The identifier of the asset that is deleted.
* @public */ - createdBy?: string; + identifier: string | undefined; +} - /** - *The timestamp of when the first revision of the inventory asset was created.
- * @public - */ - firstRevisionCreatedAt?: Date; - - /** - *The Amazon DataZone user who created the first revision of the inventory asset.
- * @public - */ - firstRevisionCreatedBy?: string; +/** + * @public + */ +export interface DeleteAssetOutput {} +/** + * @public + */ +export interface GetAssetInput { /** - *The glossary terms attached to the Amazon DataZone inventory asset.
+ *The ID of the Amazon DataZone domain to which the asset belongs.
* @public */ - glossaryTerms?: string[]; + domainIdentifier: string | undefined; /** - *The identifier of the Amazon DataZone project that owns the inventory asset.
+ *The ID of the Amazon DataZone asset.
* @public */ - owningProjectId: string | undefined; + identifier: string | undefined; /** - *The additional attributes of a Amazon DataZone inventory asset.
+ *The revision of the Amazon DataZone asset.
* @public */ - additionalAttributes?: AssetItemAdditionalAttributes; + revision?: string; } /** - *An asset published in an Amazon DataZone catalog.
* @public */ -export interface AssetListing { +export interface GetAssetOutput { /** - *The identifier of an asset published in an Amazon DataZone catalog.
+ *The ID of the asset.
* @public */ - assetId?: string; + id: string | undefined; /** - *The revision of an asset published in an Amazon DataZone catalog.
+ *The name of the asset.
* @public */ - assetRevision?: string; + name: string | undefined; /** - *The type of an asset published in an Amazon DataZone catalog.
+ *The ID of the asset type.
* @public */ - assetType?: string; + typeIdentifier: string | undefined; /** - *The timestamp of when an asset published in an Amazon DataZone catalog was created.
+ *The revision of the asset type.
* @public */ - createdAt?: Date; + typeRevision: string | undefined; /** - *The metadata forms attached to an asset published in an Amazon DataZone catalog.
+ *The external ID of the asset.
* @public */ - forms?: string; + externalIdentifier?: string; /** - *The latest time series data points forms included in the additional attributes of an - * asset.
+ *The revision of the asset.
* @public */ - latestTimeSeriesDataPointForms?: TimeSeriesDataPointSummaryFormOutput[]; + revision: string | undefined; /** - *The glossary terms attached to an asset published in an Amazon DataZone catalog.
+ *The description of the Amazon DataZone asset.
* @public */ - glossaryTerms?: DetailedGlossaryTerm[]; + description?: string; /** - *The identifier of the project where an asset published in an Amazon DataZone catalog exists. - *
+ *The timestamp of when the asset was created.
* @public */ - owningProjectId?: string; -} + createdAt?: Date; -/** - *Additional attributes of an inventory asset.
- * @public - */ -export interface AssetListingItemAdditionalAttributes { /** - *The metadata forms that form additional attributes of the metadata asset.
+ *The Amazon DataZone user who created the asset.
* @public */ - forms?: string; + createdBy?: string; /** - *The latest time series data points forms included in the additional attributes of an - * asset.
+ *The timestamp of when the first revision of the asset was created.
* @public */ - latestTimeSeriesDataPointForms?: TimeSeriesDataPointSummaryFormOutput[]; -} + firstRevisionCreatedAt?: Date; -/** - *The details of an asset published in an Amazon DataZone catalog.
- * @public - */ -export interface AssetListingItem { /** - *The identifier of the listing (asset published in Amazon DataZone catalog).
+ *The Amazon DataZone user who created the first revision of the asset.
* @public */ - listingId?: string; + firstRevisionCreatedBy?: string; /** - *The revision of the listing (asset published in Amazon DataZone catalog).
+ *The business glossary terms attached to the asset.
* @public */ - listingRevision?: string; + glossaryTerms?: string[]; /** - *The name of the inventory asset.
+ *The ID of the project that owns the asset.
* @public */ - name?: string; + owningProjectId: string | undefined; /** - *The identifier of the inventory asset.
+ *The ID of the Amazon DataZone domain to which the asset belongs.
* @public */ - entityId?: string; + domainId: string | undefined; /** - *The revision of the inventory asset.
+ *The listing of the asset.
* @public */ - entityRevision?: string; + listing?: AssetListingDetails; /** - *The type of the inventory asset.
+ *The metadata forms attached to the asset.
* @public */ - entityType?: string; + formsOutput: FormOutput[] | undefined; /** - *The description of an asset published in an Amazon DataZone catalog.
+ *The read-only metadata forms attached to the asset.
* @public */ - description?: string; + readOnlyFormsOutput?: FormOutput[]; /** - *The timestamp of when an asset published in an Amazon DataZone catalog was created.
+ *The latest data point that was imported into the time series form for the asset.
* @public */ - createdAt?: Date; + latestTimeSeriesDataPointFormsOutput?: TimeSeriesDataPointSummaryFormOutput[]; +} +/** + *The column configuration of the asset filter.
+ * @public + */ +export interface ColumnFilterConfiguration { /** - *The Amazon DataZone user who created the listing.
+ *Specifies whether to include column names.
* @public */ - listingCreatedBy?: string; + includedColumnNames?: string[]; +} +/** + *Specifies whether the value is equal to an expression.
+ * @public + */ +export interface EqualToExpression { /** - *The Amazon DataZone user who updated the listing.
+ *The name of the column.
* @public */ - listingUpdatedBy?: string; + columnName: string | undefined; /** - *Glossary terms attached to the inventory asset.
+ *The value that might be equal to an expression.
* @public */ - glossaryTerms?: DetailedGlossaryTerm[]; + value: string | undefined; +} +/** + *Specifies whether the value is greater than an expression.
+ * @public + */ +export interface GreaterThanExpression { /** - *The identifier of the project that owns the inventory asset.
+ *The name of the column.
* @public */ - owningProjectId?: string; + columnName: string | undefined; /** - *The additional attributes of an asset published in an Amazon DataZone catalog.
+ *The value that might be greater than an expression.
* @public */ - additionalAttributes?: AssetListingItemAdditionalAttributes; + value: string | undefined; } /** - *The revision of an inventory asset.
+ *Specifies whether the value is greater than or equal to an expression.
* @public */ -export interface AssetRevision { - /** - *The Amazon DataZone user who created the inventory asset.
- * @public - */ - domainId?: string; - +export interface GreaterThanOrEqualToExpression { /** - *The identifier of the inventory asset revision.
+ *The name of the column.
* @public */ - id?: string; + columnName: string | undefined; /** - *The revision details of the inventory asset.
+ *The value that might be greater than or equal to an expression.
* @public */ - revision?: string; + value: string | undefined; +} +/** + *Specifies whether values are in the expression.
+ * @public + */ +export interface InExpression { /** - *The Amazon DataZone user who created the asset revision.
+ *The name of the column.
* @public */ - createdBy?: string; + columnName: string | undefined; /** - *The timestamp of when an inventory asset revison was created.
+ *The values that might be in the expression.
* @public */ - createdAt?: Date; + values: string[] | undefined; } /** - *The name map for assets.
+ *Specifies that the expression is not null.
* @public */ -export interface AssetTargetNameMap { - /** - *The identifier of the inventory asset.
- * @public - */ - assetId: string | undefined; - +export interface IsNotNullExpression { /** - *The target name in the asset target name map.
+ *The name of the column.
* @public */ - targetName: string | undefined; + columnName: string | undefined; } /** - *The details of the form entry.
+ *Specifies that the expression is null.
* @public */ -export interface FormEntryInput { +export interface IsNullExpression { /** - *The type ID of the form entry.
+ *The name of the column.
* @public */ - typeIdentifier: string | undefined; + columnName: string | undefined; +} +/** + *Specifies that a value is less than an expression.
+ * @public + */ +export interface LessThanExpression { /** - *The type revision of the form entry.
+ *The name of the column.
* @public */ - typeRevision: string | undefined; + columnName: string | undefined; /** - *Specifies whether a form entry is required.
+ *The value that might be less than the expression.
* @public */ - required?: boolean; + value: string | undefined; } /** + *Specifies that a value is less than or equal to an expression.
* @public */ -export interface CreateAssetTypeInput { +export interface LessThanOrEqualToExpression { /** - *The unique identifier of the Amazon DataZone domain where the custom asset type is being - * created.
+ *The name of the column.
* @public */ - domainIdentifier: string | undefined; + columnName: string | undefined; /** - *The name of the custom asset type.
+ *The value that might be less than or equal to an expression.
* @public */ - name: string | undefined; + value: string | undefined; +} +/** + *Specifies that a value is like the expression.
+ * @public + */ +export interface LikeExpression { /** - *The descripton of the custom asset type.
+ *The name of the column.
* @public */ - description?: string; + columnName: string | undefined; /** - *The metadata forms that are to be attached to the custom asset type.
+ *The value that might be like the expression.
* @public */ - formsInput: RecordThe identifier of the Amazon DataZone project that is to own the custom asset type.
- * @public - */ - owningProjectIdentifier: string | undefined; -} + value: string | undefined; +} /** - *The details of the form entry.
+ *Specifies that a value is not equal to the expression.
* @public */ -export interface FormEntryOutput { - /** - *The name of the type of the form entry.
- * @public - */ - typeName: string | undefined; - +export interface NotEqualToExpression { /** - *The type revision of the form entry.
+ *The name of the column.
* @public */ - typeRevision: string | undefined; + columnName: string | undefined; /** - *Specifies whether a form entry is required.
+ *The value that might not be equal to the expression.
* @public */ - required?: boolean; + value: string | undefined; } /** + *Specifies that a value is not in the expression.
* @public */ -export interface CreateAssetTypeOutput { - /** - *The ID of the Amazon DataZone domain in which the asset type was created.
- * @public - */ - domainId: string | undefined; - - /** - *The name of the asset type.
- * @public - */ - name: string | undefined; - - /** - *The revision of the custom asset type.
- * @public - */ - revision: string | undefined; - - /** - *The description of the custom asset type.
- * @public - */ - description?: string; - - /** - *The metadata forms that are attached to the asset type.
- * @public - */ - formsOutput: RecordThe ID of the Amazon DataZone project that currently owns this asset type.
- * @public - */ - owningProjectId?: string; - - /** - *The ID of the Amazon DataZone domain where the asset type was originally created.
- * @public - */ - originDomainId?: string; - - /** - *The ID of the Amazon DataZone project where the asset type was originally created.
- * @public - */ - originProjectId?: string; - - /** - *The timestamp of when the asset type is to be created.
- * @public - */ - createdAt?: Date; - - /** - *The Amazon DataZone user who creates this custom asset type.
- * @public - */ - createdBy?: string; - +export interface NotInExpression { /** - *The timestamp of when the custom type was created.
+ *The name of the column.
* @public */ - updatedAt?: Date; + columnName: string | undefined; /** - *The Amazon DataZone user that created the custom asset type.
+ *The value that might not be in the expression.
* @public */ - updatedBy?: string; + values: string[] | undefined; } /** + *Specifies that a value might be not like the expression.
* @public */ -export interface DeleteAssetTypeInput { +export interface NotLikeExpression { /** - *The ID of the Amazon DataZone domain in which the asset type is deleted.
+ *The name of the column.
* @public */ - domainIdentifier: string | undefined; + columnName: string | undefined; /** - *The identifier of the asset type that is deleted.
+ *The value that might not be like the expression.
* @public */ - identifier: string | undefined; + value: string | undefined; } /** + *The row filter expression.
* @public */ -export interface DeleteAssetTypeOutput {} +export type RowFilterExpression = + | RowFilterExpression.EqualToMember + | RowFilterExpression.GreaterThanMember + | RowFilterExpression.GreaterThanOrEqualToMember + | RowFilterExpression.InMember + | RowFilterExpression.IsNotNullMember + | RowFilterExpression.IsNullMember + | RowFilterExpression.LessThanMember + | RowFilterExpression.LessThanOrEqualToMember + | RowFilterExpression.LikeMember + | RowFilterExpression.NotEqualToMember + | RowFilterExpression.NotInMember + | RowFilterExpression.NotLikeMember + | RowFilterExpression.$UnknownMember; /** * @public */ -export interface GetAssetTypeInput { +export namespace RowFilterExpression { /** - *The ID of the Amazon DataZone domain in which the asset type exists.
+ *The 'equal to' clause of the row filter expression.
* @public */ - domainIdentifier: string | undefined; + export interface EqualToMember { + equalTo: EqualToExpression; + notEqualTo?: never; + greaterThan?: never; + lessThan?: never; + greaterThanOrEqualTo?: never; + lessThanOrEqualTo?: never; + isNull?: never; + isNotNull?: never; + in?: never; + notIn?: never; + like?: never; + notLike?: never; + $unknown?: never; + } /** - *The ID of the asset type.
+ *The 'no equal to' clause of the row filter expression.
* @public */ - identifier: string | undefined; + export interface NotEqualToMember { + equalTo?: never; + notEqualTo: NotEqualToExpression; + greaterThan?: never; + lessThan?: never; + greaterThanOrEqualTo?: never; + lessThanOrEqualTo?: never; + isNull?: never; + isNotNull?: never; + in?: never; + notIn?: never; + like?: never; + notLike?: never; + $unknown?: never; + } /** - *The revision of the asset type.
+ *The 'greater than' clause of the row filter expression.
* @public */ - revision?: string; -} + export interface GreaterThanMember { + equalTo?: never; + notEqualTo?: never; + greaterThan: GreaterThanExpression; + lessThan?: never; + greaterThanOrEqualTo?: never; + lessThanOrEqualTo?: never; + isNull?: never; + isNotNull?: never; + in?: never; + notIn?: never; + like?: never; + notLike?: never; + $unknown?: never; + } -/** - * @public - */ -export interface GetAssetTypeOutput { /** - *The ID of the Amazon DataZone domain in which the asset type exists.
+ *The 'less than' clause of the row filter expression.
* @public */ - domainId: string | undefined; + export interface LessThanMember { + equalTo?: never; + notEqualTo?: never; + greaterThan?: never; + lessThan: LessThanExpression; + greaterThanOrEqualTo?: never; + lessThanOrEqualTo?: never; + isNull?: never; + isNotNull?: never; + in?: never; + notIn?: never; + like?: never; + notLike?: never; + $unknown?: never; + } /** - *The name of the asset type.
+ *The 'greater than or equal to' clause of the filter expression.
* @public */ - name: string | undefined; + export interface GreaterThanOrEqualToMember { + equalTo?: never; + notEqualTo?: never; + greaterThan?: never; + lessThan?: never; + greaterThanOrEqualTo: GreaterThanOrEqualToExpression; + lessThanOrEqualTo?: never; + isNull?: never; + isNotNull?: never; + in?: never; + notIn?: never; + like?: never; + notLike?: never; + $unknown?: never; + } /** - *The revision of the asset type.
+ *The 'less than or equal to' clause of the row filter expression.
* @public */ - revision: string | undefined; + export interface LessThanOrEqualToMember { + equalTo?: never; + notEqualTo?: never; + greaterThan?: never; + lessThan?: never; + greaterThanOrEqualTo?: never; + lessThanOrEqualTo: LessThanOrEqualToExpression; + isNull?: never; + isNotNull?: never; + in?: never; + notIn?: never; + like?: never; + notLike?: never; + $unknown?: never; + } /** - *The description of the asset type.
+ *The 'is null' clause of the row filter expression.
* @public */ - description?: string; + export interface IsNullMember { + equalTo?: never; + notEqualTo?: never; + greaterThan?: never; + lessThan?: never; + greaterThanOrEqualTo?: never; + lessThanOrEqualTo?: never; + isNull: IsNullExpression; + isNotNull?: never; + in?: never; + notIn?: never; + like?: never; + notLike?: never; + $unknown?: never; + } /** - *The metadata forms attached to the asset type.
+ *The 'is not null' clause of the row filter expression.
* @public */ - formsOutput: RecordThe ID of the Amazon DataZone project that owns the asset type.
- * @public - */ - owningProjectId: string | undefined; - - /** - *The ID of the Amazon DataZone domain in which the asset type was originally created.
- * @public - */ - originDomainId?: string; - - /** - *The ID of the Amazon DataZone project in which the asset type was originally created.
- * @public - */ - originProjectId?: string; - - /** - *The timestamp of when the asset type was created.
- * @public - */ - createdAt?: Date; - - /** - *The Amazon DataZone user who created the asset type.
- * @public - */ - createdBy?: string; - - /** - *The timestamp of when the asset type was updated.
- * @public - */ - updatedAt?: Date; - - /** - *The Amazon DataZone user that updated the asset type.
- * @public - */ - updatedBy?: string; -} - -/** - *The details of the asset type.
- * @public - */ -export interface AssetTypeItem { - /** - *The identifier of the Amazon DataZone domain where the asset type exists.
- * @public - */ - domainId: string | undefined; - - /** - *The name of the asset type.
- * @public - */ - name: string | undefined; - - /** - *The revision of the asset type.
- * @public - */ - revision: string | undefined; - - /** - *The description of the asset type.
- * @public - */ - description?: string; - - /** - *The forms included in the details of the asset type.
- * @public - */ - formsOutput: RecordThe identifier of the Amazon DataZone project that owns the asset type.
- * @public - */ - owningProjectId: string | undefined; - - /** - *The identifier of the Amazon DataZone domain where the asset type was originally - * created.
- * @public - */ - originDomainId?: string; - - /** - *The identifier of the Amazon DataZone project where the asset type exists.
- * @public - */ - originProjectId?: string; - - /** - *The timestamp of when the asset type was created.
- * @public - */ - createdAt?: Date; - - /** - *The Amazon DataZone user who created the asset type.
- * @public - */ - createdBy?: string; - - /** - *The timestamp of when the asset type was updated.
- * @public - */ - updatedAt?: Date; - - /** - *The Amazon DataZone user who updated the asset type.
- * @public - */ - updatedBy?: string; -} - -/** - * @public - */ -export interface AssociateEnvironmentRoleInput { - /** - *The ID of the Amazon DataZone domain in which the environment role is associated.
- * @public - */ - domainIdentifier: string | undefined; - - /** - *The ID of the Amazon DataZone environment.
- * @public - */ - environmentIdentifier: string | undefined; - - /** - *The ARN of the environment role.
- * @public - */ - environmentRoleArn: string | undefined; -} - -/** - * @public - */ -export interface AssociateEnvironmentRoleOutput {} - -/** - * @public - * @enum - */ -export const AuthType = { - DISABLED: "DISABLED", - IAM_IDC: "IAM_IDC", -} as const; - -/** - * @public - */ -export type AuthType = (typeof AuthType)[keyof typeof AuthType]; - -/** - * @public - */ -export interface CancelMetadataGenerationRunInput { - /** - *The ID of the Amazon DataZone domain in which the metadata generation run is to be - * cancelled.
- * @public - */ - domainIdentifier: string | undefined; - - /** - *The ID of the metadata generation run.
- * @public - */ - identifier: string | undefined; -} - -/** - * @public - */ -export interface CancelMetadataGenerationRunOutput {} - -/** - * @public - */ -export interface CancelSubscriptionInput { - /** - *The unique identifier of the Amazon DataZone domain where the subscription request is being - * cancelled.
- * @public - */ - domainIdentifier: string | undefined; - - /** - *The unique identifier of the subscription that is being cancelled.
- * @public - */ - identifier: string | undefined; -} - -/** - * @public - * @enum - */ -export const SubscriptionStatus = { - APPROVED: "APPROVED", - CANCELLED: "CANCELLED", - REVOKED: "REVOKED", -} as const; - -/** - * @public - */ -export type SubscriptionStatus = (typeof SubscriptionStatus)[keyof typeof SubscriptionStatus]; - -/** - * @public - */ -export interface CancelSubscriptionOutput { - /** - *The identifier of the subscription.
- * @public - */ - id: string | undefined; - - /** - *Specifies the Amazon DataZone user who is cancelling the subscription.
- * @public - */ - createdBy: string | undefined; - - /** - *The Amazon DataZone user that cancelled the subscription.
- * @public - */ - updatedBy?: string; - - /** - *The unique identifier of the Amazon DataZone domain where the subscription is being - * cancelled.
- * @public - */ - domainId: string | undefined; - - /** - *The status of the request to cancel the subscription.
- * @public - */ - status: SubscriptionStatus | undefined; - - /** - *The timestamp that specifies when the request to cancel the subscription was - * created.
- * @public - */ - createdAt: Date | undefined; - - /** - *The timestamp that specifies when the subscription was cancelled.
- * @public - */ - updatedAt: Date | undefined; - - /** - *The Amazon DataZone user who is made a subscriber to the specified asset by the subscription - * that is being cancelled.
- * @public - */ - subscribedPrincipal: SubscribedPrincipal | undefined; - - /** - *The asset to which a subscription is being cancelled.
- * @public - */ - subscribedListing: SubscribedListing | undefined; - - /** - *The unique ID of the subscripton request for the subscription that is being - * cancelled.
- * @public - */ - subscriptionRequestId?: string; - - /** - *Specifies whether the permissions to the asset are retained after the subscription is - * cancelled.
- * @public - */ - retainPermissions?: boolean; -} - -/** - * @public - * @enum - */ -export const ChangeAction = { - PUBLISH: "PUBLISH", - UNPUBLISH: "UNPUBLISH", -} as const; - -/** - * @public - */ -export type ChangeAction = (typeof ChangeAction)[keyof typeof ChangeAction]; - -/** - *Part of the provisioning properties of the environment blueprint.
- * @public - */ -export interface CloudFormationProperties { - /** - *The template URL of the cloud formation provisioning properties of the environment - * blueprint.
- * @public - */ - templateUrl: string | undefined; -} - -/** - *The details of the parameters for the configurable environment action.
- * @public - */ -export interface ConfigurableActionParameter { - /** - *The key of the configurable action parameter.
- * @public - */ - key?: string; - - /** - *The value of the configurable action parameter.
- * @public - */ - value?: string; -} - -/** - * @public - * @enum - */ -export const ConfigurableActionTypeAuthorization = { - HTTPS: "HTTPS", - IAM: "IAM", -} as const; - -/** - * @public - */ -export type ConfigurableActionTypeAuthorization = - (typeof ConfigurableActionTypeAuthorization)[keyof typeof ConfigurableActionTypeAuthorization]; - -/** - *The configurable action of a Amazon DataZone environment.
- * @public - */ -export interface ConfigurableEnvironmentAction { - /** - *The type of a configurable action in a Amazon DataZone environment.
- * @public - */ - type: string | undefined; - - /** - *The authentication type of a configurable action of a Amazon DataZone environment.
- * @public - */ - auth?: ConfigurableActionTypeAuthorization; - - /** - *The parameters of a configurable action in a Amazon DataZone environment.
- * @public - */ - parameters: ConfigurableActionParameter[] | undefined; -} - -/** - * @public - * @enum - */ -export const DataProductItemType = { - ASSET: "ASSET", -} as const; - -/** - * @public - */ -export type DataProductItemType = (typeof DataProductItemType)[keyof typeof DataProductItemType]; - -/** - *The data product.
- * @public - */ -export interface DataProductItem { - /** - *The type of the data product.
- * @public - */ - itemType: DataProductItemType | undefined; - - /** - *The ID of the data product.
- * @public - */ - identifier: string | undefined; - - /** - *The revision of the data product.
- * @public - */ - revision?: string; - - /** - *The glossary terms of the data product.
- * @public - */ - glossaryTerms?: string[]; -} - -/** - * @public - */ -export interface CreateDataProductInput { - /** - *The ID of the domain where the data product is created.
- * @public - */ - domainIdentifier: string | undefined; - - /** - *The name of the data product.
- * @public - */ - name: string | undefined; - - /** - *The ID of the owning project of the data product.
- * @public - */ - owningProjectIdentifier: string | undefined; - - /** - *The description of the data product.
- * @public - */ - description?: string; - - /** - *The glossary terms of the data product.
- * @public - */ - glossaryTerms?: string[]; - - /** - *The metadata forms of the data product.
- * @public - */ - formsInput?: FormInput[]; - - /** - *The data assets of the data product.
- * @public - */ - items?: DataProductItem[]; - - /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
- * @public - */ - clientToken?: string; -} - -/** - * @public - * @enum - */ -export const DataProductStatus = { - CREATED: "CREATED", - CREATE_FAILED: "CREATE_FAILED", - CREATING: "CREATING", -} as const; - -/** - * @public - */ -export type DataProductStatus = (typeof DataProductStatus)[keyof typeof DataProductStatus]; - -/** - * @public - */ -export interface CreateDataProductOutput { - /** - *The ID of the domain where the data product lives.
- * @public - */ - domainId: string | undefined; - - /** - *The ID of the data product.
- * @public - */ - id: string | undefined; - - /** - *The revision of the data product.
- * @public - */ - revision: string | undefined; - - /** - *The ID of the owning project of the data product.
- * @public - */ - owningProjectId: string | undefined; - - /** - *The name of the data product.
- * @public - */ - name: string | undefined; - - /** - *The status of the data product.
- * @public - */ - status: DataProductStatus | undefined; - - /** - *The description of the data product.
- * @public - */ - description?: string; - - /** - *The glossary terms of the data product.
- * @public - */ - glossaryTerms?: string[]; - - /** - *The data assets of the data product.
- * @public - */ - items?: DataProductItem[]; - - /** - *The metadata forms of the data product.
- * @public - */ - formsOutput?: FormOutput[]; - - /** - *The timestamp at which the data product was created.
- * @public - */ - createdAt?: Date; - - /** - *The user who created the data product.
- * @public - */ - createdBy?: string; - - /** - *The timestamp at which the first revision of the data product was created.
- * @public - */ - firstRevisionCreatedAt?: Date; - - /** - *The user who created the first revision of the data product.
- * @public - */ - firstRevisionCreatedBy?: string; -} - -/** - * @public - */ -export interface CreateDataProductRevisionInput { - /** - *The ID of the domain where the data product revision is created.
- * @public - */ - domainIdentifier: string | undefined; - - /** - *The ID of the data product revision.
- * @public - */ - identifier: string | undefined; - - /** - *The name of the data product revision.
- * @public - */ - name: string | undefined; - - /** - *The description of the data product revision.
- * @public - */ - description?: string; - - /** - *The glossary terms of the data product revision.
- * @public - */ - glossaryTerms?: string[]; - - /** - *The data assets of the data product revision.
- * @public - */ - items?: DataProductItem[]; - - /** - *The metadata forms of the data product revision.
- * @public - */ - formsInput?: FormInput[]; - - /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
- * @public - */ - clientToken?: string; -} - -/** - * @public - */ -export interface CreateDataProductRevisionOutput { - /** - *The ID of the domain where data product revision is created.
- * @public - */ - domainId: string | undefined; - - /** - *The ID of the data product revision.
- * @public - */ - id: string | undefined; - - /** - *The revision of the data product revision.
- * @public - */ - revision: string | undefined; - - /** - *The ID of the owning project of the data product revision.
- * @public - */ - owningProjectId: string | undefined; - - /** - *The name of the data product revision.
- * @public - */ - name: string | undefined; - - /** - *The status of the data product revision.
- * @public - */ - status: DataProductStatus | undefined; - - /** - *The description of the data product revision.
- * @public - */ - description?: string; - - /** - *The glossary terms of the data product revision.
- * @public - */ - glossaryTerms?: string[]; - - /** - *The data assets of the data product revision.
- * @public - */ - items?: DataProductItem[]; - - /** - *The metadata forms of the data product revision.
- * @public - */ - formsOutput?: FormOutput[]; - - /** - *The timestamp at which the data product revision is created.
- * @public - */ - createdAt?: Date; - - /** - *The user who created the data product revision.
- * @public - */ - createdBy?: string; - - /** - *The timestamp at which the first revision of the data product is created.
- * @public - */ - firstRevisionCreatedAt?: Date; - - /** - *The user who created the first revision of the data product.
- * @public - */ - firstRevisionCreatedBy?: string; -} - -/** - * @public - * @enum - */ -export const FilterExpressionType = { - EXCLUDE: "EXCLUDE", - INCLUDE: "INCLUDE", -} as const; - -/** - * @public - */ -export type FilterExpressionType = (typeof FilterExpressionType)[keyof typeof FilterExpressionType]; - -/** - *A filter expression in Amazon DataZone.
- * @public - */ -export interface FilterExpression { - /** - *The search filter explresison type.
- * @public - */ - type: FilterExpressionType | undefined; - - /** - *The search filter expression.
- * @public - */ - expression: string | undefined; -} - -/** - *The relational filter configuration for the data source.
- * @public - */ -export interface RelationalFilterConfiguration { - /** - *The database name specified in the relational filter configuration for the data - * source.
- * @public - */ - databaseName: string | undefined; - - /** - *The schema name specified in the relational filter configuration for the data - * source.
- * @public - */ - schemaName?: string; - - /** - *The filter expressions specified in the relational filter configuration for the data - * source.
- * @public - */ - filterExpressions?: FilterExpression[]; -} - -/** - *The configuration details of the Amazon Web Services Glue data source.
- * @public - */ -export interface GlueRunConfigurationInput { - /** - *The data access role included in the configuration details of the Amazon Web Services Glue data - * source.
- * @public - */ - dataAccessRole?: string; - - /** - *The relational filter configurations included in the configuration details of the Amazon Web Services - * Glue data source.
- * @public - */ - relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; - - /** - *Specifies whether to automatically import data quality metrics as part of the data - * source run.
- * @public - */ - autoImportDataQualityResult?: boolean; -} - -/** - *The details of the credentials required to access an Amazon Redshift cluster.
- * @public - */ -export interface RedshiftCredentialConfiguration { - /** - *The ARN of a secret manager for an Amazon Redshift cluster.
- * @public - */ - secretManagerArn: string | undefined; -} - -/** - *The details of the Amazon Redshift cluster storage.
- * @public - */ -export interface RedshiftClusterStorage { - /** - *The name of an Amazon Redshift cluster.
- * @public - */ - clusterName: string | undefined; -} - -/** - *The details of the Amazon Redshift Serverless workgroup storage.
- * @public - */ -export interface RedshiftServerlessStorage { - /** - *The name of the Amazon Redshift Serverless workgroup.
- * @public - */ - workgroupName: string | undefined; -} - -/** - *The details of the Amazon Redshift storage as part of the configuration of an Amazon - * Redshift data source run.
- * @public - */ -export type RedshiftStorage = - | RedshiftStorage.RedshiftClusterSourceMember - | RedshiftStorage.RedshiftServerlessSourceMember - | RedshiftStorage.$UnknownMember; - -/** - * @public - */ -export namespace RedshiftStorage { - /** - *The details of the Amazon Redshift cluster source.
- * @public - */ - export interface RedshiftClusterSourceMember { - redshiftClusterSource: RedshiftClusterStorage; - redshiftServerlessSource?: never; + export interface IsNotNullMember { + equalTo?: never; + notEqualTo?: never; + greaterThan?: never; + lessThan?: never; + greaterThanOrEqualTo?: never; + lessThanOrEqualTo?: never; + isNull?: never; + isNotNull: IsNotNullExpression; + in?: never; + notIn?: never; + like?: never; + notLike?: never; $unknown?: never; } /** - *The details of the Amazon Redshift Serverless workgroup source.
+ *The 'in' clause of the row filter expression.
* @public */ - export interface RedshiftServerlessSourceMember { - redshiftClusterSource?: never; - redshiftServerlessSource: RedshiftServerlessStorage; + export interface InMember { + equalTo?: never; + notEqualTo?: never; + greaterThan?: never; + lessThan?: never; + greaterThanOrEqualTo?: never; + lessThanOrEqualTo?: never; + isNull?: never; + isNotNull?: never; + in: InExpression; + notIn?: never; + like?: never; + notLike?: never; $unknown?: never; } /** + *The 'not in' clause of the row filter expression.
* @public */ - export interface $UnknownMember { - redshiftClusterSource?: never; - redshiftServerlessSource?: never; - $unknown: [string, any]; - } - - export interface VisitorThe configuration details of the Amazon Redshift data source.
- * @public - */ -export interface RedshiftRunConfigurationInput { - /** - *The data access role included in the configuration details of the Amazon Redshift data - * source.
- * @public - */ - dataAccessRole?: string; - - /** - *The relational filger configurations included in the configuration details of the Amazon - * Redshift data source.
- * @public - */ - relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; - - /** - *The details of the credentials required to access an Amazon Redshift cluster.
- * @public - */ - redshiftCredentialConfiguration: RedshiftCredentialConfiguration | undefined; - - /** - *The details of the Amazon Redshift storage as part of the configuration of an Amazon - * Redshift data source run.
- * @public - */ - redshiftStorage: RedshiftStorage | undefined; -} - -/** - *The configuration of the data source.
- * @public - */ -export type DataSourceConfigurationInput = - | DataSourceConfigurationInput.GlueRunConfigurationMember - | DataSourceConfigurationInput.RedshiftRunConfigurationMember - | DataSourceConfigurationInput.$UnknownMember; - -/** - * @public - */ -export namespace DataSourceConfigurationInput { /** - *The configuration of the Amazon Web Services Glue data source.
+ *The 'like' clause of the row filter expression.
* @public */ - export interface GlueRunConfigurationMember { - glueRunConfiguration: GlueRunConfigurationInput; - redshiftRunConfiguration?: never; + export interface LikeMember { + equalTo?: never; + notEqualTo?: never; + greaterThan?: never; + lessThan?: never; + greaterThanOrEqualTo?: never; + lessThanOrEqualTo?: never; + isNull?: never; + isNotNull?: never; + in?: never; + notIn?: never; + like: LikeExpression; + notLike?: never; $unknown?: never; } /** - *The configuration of the Amazon Redshift data source.
+ *The 'not like' clause of the row filter expression.
* @public */ - export interface RedshiftRunConfigurationMember { - glueRunConfiguration?: never; - redshiftRunConfiguration: RedshiftRunConfigurationInput; + export interface NotLikeMember { + equalTo?: never; + notEqualTo?: never; + greaterThan?: never; + lessThan?: never; + greaterThanOrEqualTo?: never; + lessThanOrEqualTo?: never; + isNull?: never; + isNotNull?: never; + in?: never; + notIn?: never; + like?: never; + notLike: NotLikeExpression; $unknown?: never; } @@ -3589,21 +2909,50 @@ export namespace DataSourceConfigurationInput { * @public */ export interface $UnknownMember { - glueRunConfiguration?: never; - redshiftRunConfiguration?: never; + equalTo?: never; + notEqualTo?: never; + greaterThan?: never; + lessThan?: never; + greaterThanOrEqualTo?: never; + lessThanOrEqualTo?: never; + isNull?: never; + isNotNull?: never; + in?: never; + notIn?: never; + like?: never; + notLike?: never; $unknown: [string, any]; } export interface VisitorThe recommendation to be updated as part of the UpdateDataSource
- * action.
The summary of the asset filter.
* @public */ -export interface RecommendationConfiguration { +export interface AssetFilterSummary { /** - *Specifies whether automatic business name generation is to be enabled or not as part of - * the recommendation configuration.
+ *The ID of the asset filter.
* @public */ - enableBusinessNameGeneration?: boolean; -} - -/** - * @public - * @enum - */ -export const Timezone = { - AFRICA_JOHANNESBURG: "AFRICA_JOHANNESBURG", - AMERICA_MONTREAL: "AMERICA_MONTREAL", - AMERICA_SAO_PAULO: "AMERICA_SAO_PAULO", - ASIA_BAHRAIN: "ASIA_BAHRAIN", - ASIA_BANGKOK: "ASIA_BANGKOK", - ASIA_CALCUTTA: "ASIA_CALCUTTA", - ASIA_DUBAI: "ASIA_DUBAI", - ASIA_HONG_KONG: "ASIA_HONG_KONG", - ASIA_JAKARTA: "ASIA_JAKARTA", - ASIA_KUALA_LUMPUR: "ASIA_KUALA_LUMPUR", - ASIA_SEOUL: "ASIA_SEOUL", - ASIA_SHANGHAI: "ASIA_SHANGHAI", - ASIA_SINGAPORE: "ASIA_SINGAPORE", - ASIA_TAIPEI: "ASIA_TAIPEI", - ASIA_TOKYO: "ASIA_TOKYO", - AUSTRALIA_MELBOURNE: "AUSTRALIA_MELBOURNE", - AUSTRALIA_SYDNEY: "AUSTRALIA_SYDNEY", - CANADA_CENTRAL: "CANADA_CENTRAL", - CET: "CET", - CST6CDT: "CST6CDT", - ETC_GMT: "ETC_GMT", - ETC_GMT0: "ETC_GMT0", - ETC_GMT_ADD_0: "ETC_GMT_ADD_0", - ETC_GMT_ADD_1: "ETC_GMT_ADD_1", - ETC_GMT_ADD_10: "ETC_GMT_ADD_10", - ETC_GMT_ADD_11: "ETC_GMT_ADD_11", - ETC_GMT_ADD_12: "ETC_GMT_ADD_12", - ETC_GMT_ADD_2: "ETC_GMT_ADD_2", - ETC_GMT_ADD_3: "ETC_GMT_ADD_3", - ETC_GMT_ADD_4: "ETC_GMT_ADD_4", - ETC_GMT_ADD_5: "ETC_GMT_ADD_5", - ETC_GMT_ADD_6: "ETC_GMT_ADD_6", - ETC_GMT_ADD_7: "ETC_GMT_ADD_7", - ETC_GMT_ADD_8: "ETC_GMT_ADD_8", - ETC_GMT_ADD_9: "ETC_GMT_ADD_9", - ETC_GMT_NEG_0: "ETC_GMT_NEG_0", - ETC_GMT_NEG_1: "ETC_GMT_NEG_1", - ETC_GMT_NEG_10: "ETC_GMT_NEG_10", - ETC_GMT_NEG_11: "ETC_GMT_NEG_11", - ETC_GMT_NEG_12: "ETC_GMT_NEG_12", - ETC_GMT_NEG_13: "ETC_GMT_NEG_13", - ETC_GMT_NEG_14: "ETC_GMT_NEG_14", - ETC_GMT_NEG_2: "ETC_GMT_NEG_2", - ETC_GMT_NEG_3: "ETC_GMT_NEG_3", - ETC_GMT_NEG_4: "ETC_GMT_NEG_4", - ETC_GMT_NEG_5: "ETC_GMT_NEG_5", - ETC_GMT_NEG_6: "ETC_GMT_NEG_6", - ETC_GMT_NEG_7: "ETC_GMT_NEG_7", - ETC_GMT_NEG_8: "ETC_GMT_NEG_8", - ETC_GMT_NEG_9: "ETC_GMT_NEG_9", - EUROPE_DUBLIN: "EUROPE_DUBLIN", - EUROPE_LONDON: "EUROPE_LONDON", - EUROPE_PARIS: "EUROPE_PARIS", - EUROPE_STOCKHOLM: "EUROPE_STOCKHOLM", - EUROPE_ZURICH: "EUROPE_ZURICH", - ISRAEL: "ISRAEL", - MEXICO_GENERAL: "MEXICO_GENERAL", - MST7MDT: "MST7MDT", - PACIFIC_AUCKLAND: "PACIFIC_AUCKLAND", - US_CENTRAL: "US_CENTRAL", - US_EASTERN: "US_EASTERN", - US_MOUNTAIN: "US_MOUNTAIN", - US_PACIFIC: "US_PACIFIC", - UTC: "UTC", -} as const; - -/** - * @public - */ -export type Timezone = (typeof Timezone)[keyof typeof Timezone]; + id: string | undefined; -/** - *The details of the schedule of the data source runs.
- * @public - */ -export interface ScheduleConfiguration { /** - *The timezone of the data source run.
+ *The ID of the domain where the asset filter lives.
* @public */ - timezone?: Timezone; + domainId: string | undefined; /** - *The schedule of the data source runs.
+ *The ID of the data asset.
* @public */ - schedule?: string; -} + assetId: string | undefined; -/** - * @public - */ -export interface CreateDataSourceInput { /** - *The name of the data source.
+ *The name of the asset filter.
* @public */ name: string | undefined; /** - *The description of the data source.
+ *The description of the asset filter.
* @public */ description?: string; /** - *The ID of the Amazon DataZone domain where the data source is created.
+ *The status of the asset filter.
* @public */ - domainIdentifier: string | undefined; + status?: FilterStatus; /** - *The identifier of the Amazon DataZone project in which you want to add this data - * source.
+ *The effective column names of the asset filter.
* @public */ - projectIdentifier: string | undefined; + effectiveColumnNames?: string[]; /** - *The unique identifier of the Amazon DataZone environment to which the data source publishes - * assets.
+ *The effective row filter of the asset filter.
* @public */ - environmentIdentifier: string | undefined; + effectiveRowFilter?: string; /** - *The type of the data source.
+ *The timestamp at which the asset filter was created.
* @public */ - type: string | undefined; + createdAt?: Date; /** - *Specifies the configuration of the data source. It can be set to either
- * glueRunConfiguration or redshiftRunConfiguration.
The error message that is displayed if the action does not succeed.
* @public */ - configuration?: DataSourceConfigurationInput; + errorMessage?: string; +} + +/** + *The additional attributes of an inventory asset.
+ * @public + */ +export interface AssetItemAdditionalAttributes { + /** + *The forms included in the additional attributes of an inventory asset.
+ * @public + */ + formsOutput?: FormOutput[]; /** - *Specifies whether the business name generation is to be enabled for this data - * source.
+ *The read-only forms included in the additional attributes of an inventory asset.
+ * @public + */ + readOnlyFormsOutput?: FormOutput[]; + + /** + *The latest time series data points forms included in the additional attributes of an + * asset.
+ * @public + */ + latestTimeSeriesDataPointFormsOutput?: TimeSeriesDataPointSummaryFormOutput[]; +} + +/** + *A Amazon DataZone inventory asset.
+ * @public + */ +export interface AssetItem { + /** + *The identifier of the Amazon DataZone domain in which the inventory asset exists.
+ * @public + */ + domainId: string | undefined; + + /** + *the identifier of the Amazon DataZone inventory asset.
+ * @public + */ + identifier: string | undefined; + + /** + *The name of the Amazon DataZone inventory asset.
+ * @public + */ + name: string | undefined; + + /** + *The identifier of the asset type of the specified Amazon DataZone inventory asset.
* @public */ - recommendation?: RecommendationConfiguration; + typeIdentifier: string | undefined; /** - *Specifies whether the data source is enabled.
+ *The revision of the inventory asset type.
* @public */ - enableSetting?: EnableSetting; + typeRevision: string | undefined; /** - *The schedule of the data source runs.
+ *The external identifier of the Amazon DataZone inventory asset.
* @public */ - schedule?: ScheduleConfiguration; + externalIdentifier?: string; /** - *Specifies whether the assets that this data source creates in the inventory are to be - * also automatically published to the catalog.
+ *The description of an Amazon DataZone inventory asset.
* @public */ - publishOnImport?: boolean; + description?: string; /** - *The metadata forms that are to be attached to the assets that this data source works - * with.
+ *The timestamp of when the Amazon DataZone inventory asset was created.
* @public */ - assetFormsInput?: FormInput[]; + createdAt?: Date; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The Amazon DataZone user who created the inventory asset.
* @public */ - clientToken?: string; -} + createdBy?: string; -/** - *The configuration details of the Amazon Web Services Glue data source.
- * @public - */ -export interface GlueRunConfigurationOutput { /** - *The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data - * source.
+ *The timestamp of when the first revision of the inventory asset was created.
* @public */ - accountId?: string; + firstRevisionCreatedAt?: Date; /** - *The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source. - *
+ *The Amazon DataZone user who created the first revision of the inventory asset.
* @public */ - region?: string; + firstRevisionCreatedBy?: string; /** - *The data access role included in the configuration details of the Amazon Web Services Glue data - * source.
+ *The glossary terms attached to the Amazon DataZone inventory asset.
* @public */ - dataAccessRole?: string; + glossaryTerms?: string[]; /** - *The relational filter configurations included in the configuration details of the Amazon Web Services - * Glue data source.
+ *The identifier of the Amazon DataZone project that owns the inventory asset.
* @public */ - relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; + owningProjectId: string | undefined; /** - *Specifies whether to automatically import data quality metrics as part of the data - * source run.
+ *The additional attributes of a Amazon DataZone inventory asset.
* @public */ - autoImportDataQualityResult?: boolean; + additionalAttributes?: AssetItemAdditionalAttributes; } /** - *The configuration details of the Amazon Redshift data source.
+ *An asset published in an Amazon DataZone catalog.
* @public */ -export interface RedshiftRunConfigurationOutput { - /** - *The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift - * data source.
- * @public - */ - accountId?: string; - +export interface AssetListing { /** - *The Amazon Web Services region included in the configuration details of the Amazon Redshift data - * source.
+ *The identifier of an asset published in an Amazon DataZone catalog.
* @public */ - region?: string; + assetId?: string; /** - *The data access role included in the configuration details of the Amazon Redshift data - * source.
+ *The revision of an asset published in an Amazon DataZone catalog.
* @public */ - dataAccessRole?: string; + assetRevision?: string; /** - *The relational filger configurations included in the configuration details of the Amazon - * Redshift data source.
+ *The type of an asset published in an Amazon DataZone catalog.
* @public */ - relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; + assetType?: string; /** - *The details of the credentials required to access an Amazon Redshift cluster.
+ *The timestamp of when an asset published in an Amazon DataZone catalog was created.
* @public */ - redshiftCredentialConfiguration: RedshiftCredentialConfiguration | undefined; + createdAt?: Date; /** - *The details of the Amazon Redshift storage as part of the configuration of an Amazon - * Redshift data source run.
+ *The metadata forms attached to an asset published in an Amazon DataZone catalog.
* @public */ - redshiftStorage: RedshiftStorage | undefined; -} - -/** - *The configuration of the data source.
- * @public - */ -export type DataSourceConfigurationOutput = - | DataSourceConfigurationOutput.GlueRunConfigurationMember - | DataSourceConfigurationOutput.RedshiftRunConfigurationMember - | DataSourceConfigurationOutput.$UnknownMember; + forms?: string; -/** - * @public - */ -export namespace DataSourceConfigurationOutput { /** - *The configuration of the Amazon Web Services Glue data source.
+ *The latest time series data points forms included in the additional attributes of an + * asset.
* @public */ - export interface GlueRunConfigurationMember { - glueRunConfiguration: GlueRunConfigurationOutput; - redshiftRunConfiguration?: never; - $unknown?: never; - } + latestTimeSeriesDataPointForms?: TimeSeriesDataPointSummaryFormOutput[]; /** - *The configuration of the Amazon Redshift data source.
+ *The glossary terms attached to an asset published in an Amazon DataZone catalog.
* @public */ - export interface RedshiftRunConfigurationMember { - glueRunConfiguration?: never; - redshiftRunConfiguration: RedshiftRunConfigurationOutput; - $unknown?: never; - } + glossaryTerms?: DetailedGlossaryTerm[]; /** + *The identifier of the project where an asset published in an Amazon DataZone catalog exists. + *
* @public */ - export interface $UnknownMember { - glueRunConfiguration?: never; - redshiftRunConfiguration?: never; - $unknown: [string, any]; - } - - export interface VisitorThe details of the error message that is returned if the operation cannot be - * successfully completed.
+ *Additional attributes of an inventory asset.
* @public */ -export interface DataSourceErrorMessage { +export interface AssetListingItemAdditionalAttributes { /** - *The type of the error message that is returned if the operation cannot be successfully - * completed.
+ *The metadata forms that form additional attributes of the metadata asset.
* @public */ - errorType: DataSourceErrorType | undefined; + forms?: string; /** - *The details of the error message that is returned if the operation cannot be - * successfully completed.
+ *The latest time series data points forms included in the additional attributes of an + * asset.
* @public */ - errorDetail?: string; + latestTimeSeriesDataPointForms?: TimeSeriesDataPointSummaryFormOutput[]; } /** - * @public - * @enum - */ -export const DataSourceRunStatus = { - FAILED: "FAILED", - PARTIALLY_SUCCEEDED: "PARTIALLY_SUCCEEDED", - REQUESTED: "REQUESTED", - RUNNING: "RUNNING", - SUCCESS: "SUCCESS", -} as const; - -/** - * @public - */ -export type DataSourceRunStatus = (typeof DataSourceRunStatus)[keyof typeof DataSourceRunStatus]; - -/** - * @public - * @enum - */ -export const DataSourceStatus = { - CREATING: "CREATING", - DELETING: "DELETING", - FAILED_CREATION: "FAILED_CREATION", - FAILED_DELETION: "FAILED_DELETION", - FAILED_UPDATE: "FAILED_UPDATE", - READY: "READY", - RUNNING: "RUNNING", - UPDATING: "UPDATING", -} as const; - -/** - * @public - */ -export type DataSourceStatus = (typeof DataSourceStatus)[keyof typeof DataSourceStatus]; - -/** + *The details of an asset published in an Amazon DataZone catalog.
* @public */ -export interface CreateDataSourceOutput { - /** - *The unique identifier of the data source.
- * @public - */ - id: string | undefined; - - /** - *The status of the data source.
- * @public - */ - status?: DataSourceStatus; - +export interface AssetListingItem { /** - *The type of the data source.
+ *The identifier of the listing (asset published in Amazon DataZone catalog).
* @public */ - type?: string; + listingId?: string; /** - *The name of the data source.
+ *The revision of the listing (asset published in Amazon DataZone catalog).
* @public */ - name: string | undefined; + listingRevision?: string; /** - *The description of the data source.
+ *The name of the inventory asset.
* @public */ - description?: string; + name?: string; /** - *The ID of the Amazon DataZone domain in which the data source is created.
+ *The identifier of the inventory asset.
* @public */ - domainId: string | undefined; + entityId?: string; /** - *The ID of the Amazon DataZone project to which the data source is added.
+ *The revision of the inventory asset.
* @public */ - projectId: string | undefined; + entityRevision?: string; /** - *The unique identifier of the Amazon DataZone environment to which the data source publishes - * assets.
+ *The type of the inventory asset.
* @public */ - environmentId: string | undefined; + entityType?: string; /** - *Specifies the configuration of the data source. It can be set to either
- * glueRunConfiguration or redshiftRunConfiguration.
The description of an asset published in an Amazon DataZone catalog.
* @public */ - configuration?: DataSourceConfigurationOutput; + description?: string; /** - *Specifies whether the business name generation is to be enabled for this data - * source.
+ *The timestamp of when an asset published in an Amazon DataZone catalog was created.
* @public */ - recommendation?: RecommendationConfiguration; + createdAt?: Date; /** - *Specifies whether the data source is enabled.
+ *The Amazon DataZone user who created the listing.
* @public */ - enableSetting?: EnableSetting; + listingCreatedBy?: string; /** - *Specifies whether the assets that this data source creates in the inventory are to be - * also automatically published to the catalog.
+ *The Amazon DataZone user who updated the listing.
* @public */ - publishOnImport?: boolean; + listingUpdatedBy?: string; /** - *The metadata forms attached to the assets that this data source creates.
+ *Glossary terms attached to the inventory asset.
* @public */ - assetFormsOutput?: FormOutput[]; + glossaryTerms?: DetailedGlossaryTerm[]; /** - *The schedule of the data source runs.
+ *The identifier of the project that owns the inventory asset.
* @public */ - schedule?: ScheduleConfiguration; + owningProjectId?: string; /** - *The status of the last run of this data source.
+ *The additional attributes of an asset published in an Amazon DataZone catalog.
* @public */ - lastRunStatus?: DataSourceRunStatus; + additionalAttributes?: AssetListingItemAdditionalAttributes; +} +/** + *The revision of an inventory asset.
+ * @public + */ +export interface AssetRevision { /** - *The timestamp that specifies when the data source was last run.
+ *The Amazon DataZone user who created the inventory asset.
* @public */ - lastRunAt?: Date; + domainId?: string; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The identifier of the inventory asset revision.
* @public */ - lastRunErrorMessage?: DataSourceErrorMessage; + id?: string; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The revision details of the inventory asset.
* @public */ - errorMessage?: DataSourceErrorMessage; + revision?: string; /** - *The timestamp of when the data source was created.
+ *The Amazon DataZone user who created the asset revision.
* @public */ - createdAt?: Date; + createdBy?: string; /** - *The timestamp of when the data source was updated.
+ *The timestamp of when an inventory asset revison was created.
* @public */ - updatedAt?: Date; + createdAt?: Date; } /** + *The name map for assets.
* @public - * @enum */ -export const UserAssignment = { - AUTOMATIC: "AUTOMATIC", - MANUAL: "MANUAL", -} as const; +export interface AssetTargetNameMap { + /** + *The identifier of the inventory asset.
+ * @public + */ + assetId: string | undefined; -/** - * @public - */ -export type UserAssignment = (typeof UserAssignment)[keyof typeof UserAssignment]; + /** + *The target name in the asset target name map.
+ * @public + */ + targetName: string | undefined; +} /** - *The single sign-on details in Amazon DataZone.
+ *The details of the form entry.
* @public */ -export interface SingleSignOn { +export interface FormEntryInput { /** - *The type of single sign-on in Amazon DataZone.
+ *The type ID of the form entry.
* @public */ - type?: AuthType; + typeIdentifier: string | undefined; /** - *The single sign-on user assignment in Amazon DataZone.
+ *The type revision of the form entry.
* @public */ - userAssignment?: UserAssignment; + typeRevision: string | undefined; + + /** + *Specifies whether a form entry is required.
+ * @public + */ + required?: boolean; } /** * @public */ -export interface CreateDomainInput { +export interface CreateAssetTypeInput { /** - *The name of the Amazon DataZone domain.
+ *The unique identifier of the Amazon DataZone domain where the custom asset type is being + * created.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The name of the custom asset type.
* @public */ name: string | undefined; /** - *The description of the Amazon DataZone domain.
+ *The descripton of the custom asset type.
* @public */ description?: string; /** - *The single-sign on configuration of the Amazon DataZone domain.
+ *The metadata forms that are to be attached to the custom asset type.
* @public */ - singleSignOn?: SingleSignOn; + formsInput: RecordThe domain execution role that is created when an Amazon DataZone domain is created. The - * domain execution role is created in the Amazon Web Services account that houses the - * Amazon DataZone domain.
+ *The identifier of the Amazon DataZone project that is to own the custom asset type.
* @public */ - domainExecutionRole: string | undefined; + owningProjectIdentifier: string | undefined; +} +/** + *The details of the form entry.
+ * @public + */ +export interface FormEntryOutput { /** - *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 name of the type of the form entry.
* @public */ - kmsKeyIdentifier?: string; + typeName: string | undefined; /** - *The tags specified for the Amazon DataZone domain.
+ *The type revision of the form entry.
* @public */ - tags?: RecordA unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *Specifies whether a form entry is required.
* @public */ - clientToken?: string; + required?: boolean; } -/** - * @public - * @enum - */ -export const DomainStatus = { - AVAILABLE: "AVAILABLE", - CREATING: "CREATING", - CREATION_FAILED: "CREATION_FAILED", - DELETED: "DELETED", - DELETING: "DELETING", - DELETION_FAILED: "DELETION_FAILED", -} as const; - /** * @public */ -export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus]; +export interface CreateAssetTypeOutput { + /** + *The ID of the Amazon DataZone domain in which the asset type was created.
+ * @public + */ + domainId: string | undefined; -/** - * @public - */ -export interface CreateDomainOutput { /** - *The identifier of the Amazon DataZone domain.
+ *The name of the asset type.
* @public */ - id: string | undefined; + name: string | undefined; /** - *The name of the Amazon DataZone domain.
+ *The revision of the custom asset type.
* @public */ - name?: string; + revision: string | undefined; /** - *The description of the Amazon DataZone domain.
+ *The description of the custom asset type.
* @public */ description?: string; /** - *The single-sign on configuration of the Amazon DataZone domain.
+ *The metadata forms that are attached to the asset type.
* @public */ - singleSignOn?: SingleSignOn; + formsOutput: RecordThe domain execution role that is created when an Amazon DataZone domain is created. The - * domain execution role is created in the Amazon Web Services account that houses the - * Amazon DataZone domain.
+ *The ID of the Amazon DataZone project that currently owns this asset type.
* @public */ - domainExecutionRole?: string; + owningProjectId?: string; /** - *The ARN of the Amazon DataZone domain.
+ *The ID of the Amazon DataZone domain where the asset type was originally created.
* @public */ - arn?: string; + originDomainId?: string; /** - *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 ID of the Amazon DataZone project where the asset type was originally created.
* @public */ - kmsKeyIdentifier?: string; + originProjectId?: string; /** - *The status of the Amazon DataZone domain.
+ *The timestamp of when the asset type is to be created.
* @public */ - status?: DomainStatus; + createdAt?: Date; /** - *The URL of the data portal for this Amazon DataZone domain.
+ *The Amazon DataZone user who creates this custom asset type.
* @public */ - portalUrl?: string; + createdBy?: string; /** - *The tags specified for the Amazon DataZone domain.
+ *The timestamp of when the custom type was created.
* @public */ - tags?: RecordThe Amazon DataZone user that created the custom asset type.
+ * @public + */ + updatedBy?: string; } /** - *The parameter details of an evironment profile.
* @public */ -export interface EnvironmentParameter { +export interface DeleteAssetTypeInput { /** - *The name of an environment profile parameter.
+ *The ID of the Amazon DataZone domain in which the asset type is deleted.
* @public */ - name?: string; + domainIdentifier: string | undefined; /** - *The value of an environment profile parameter.
+ *The identifier of the asset type that is deleted.
* @public */ - value?: string; + identifier: string | undefined; } /** * @public */ -export interface CreateEnvironmentInput { +export interface DeleteAssetTypeOutput {} + +/** + * @public + */ +export interface GetAssetTypeInput { /** - *The identifier of the Amazon DataZone project in which this environment is created.
+ *The ID of the Amazon DataZone domain in which the asset type exists.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the asset type.
+ * @public + */ + identifier: string | undefined; + + /** + *The revision of the asset type.
+ * @public + */ + revision?: string; +} + +/** + * @public + */ +export interface GetAssetTypeOutput { + /** + *The ID of the Amazon DataZone domain in which the asset type exists.
* @public */ - projectIdentifier: string | undefined; + domainId: string | undefined; /** - *The identifier of the Amazon DataZone domain in which the environment is created.
+ *The name of the asset type.
* @public */ - domainIdentifier: string | undefined; + name: string | undefined; /** - *The description of the Amazon DataZone environment.
+ *The revision of the asset type.
* @public */ - description?: string; + revision: string | undefined; /** - *The name of the Amazon DataZone environment.
+ *The description of the asset type.
* @public */ - name: string | undefined; + description?: string; /** - *The identifier of the environment profile that is used to create this Amazon DataZone - * environment.
+ *The metadata forms attached to the asset type.
* @public */ - environmentProfileIdentifier: string | undefined; + formsOutput: RecordThe user parameters of this Amazon DataZone environment.
+ *The ID of the Amazon DataZone project that owns the asset type.
* @public */ - userParameters?: EnvironmentParameter[]; + owningProjectId: string | undefined; /** - *The glossary terms that can be used in this Amazon DataZone environment.
+ *The ID of the Amazon DataZone domain in which the asset type was originally created.
* @public */ - glossaryTerms?: string[]; + originDomainId?: string; /** - *The ID of the account in which the environment is being created.
+ *The ID of the Amazon DataZone project in which the asset type was originally created.
* @public */ - environmentAccountIdentifier?: string; + originProjectId?: string; /** - *The region of the account in which the environment is being created.
+ *The timestamp of when the asset type was created.
* @public */ - environmentAccountRegion?: string; + createdAt?: Date; /** - *The ID of the blueprint with which the environment is being created.
+ *The Amazon DataZone user who created the asset type.
* @public */ - environmentBlueprintIdentifier?: string; -} + createdBy?: string; -/** - *The deployment properties of the Amazon DataZone blueprint.
- * @public - */ -export interface DeploymentProperties { /** - *The start timeout of the environment blueprint deployment.
+ *The timestamp of when the asset type was updated.
* @public */ - startTimeoutMinutes?: number; + updatedAt?: Date; /** - *The end timeout of the environment blueprint deployment.
+ *The Amazon DataZone user that updated the asset type.
* @public */ - endTimeoutMinutes?: number; + updatedBy?: string; } /** - * @public - * @enum - */ -export const DeploymentStatus = { - FAILED: "FAILED", - IN_PROGRESS: "IN_PROGRESS", - PENDING_DEPLOYMENT: "PENDING_DEPLOYMENT", - SUCCESSFUL: "SUCCESSFUL", -} as const; - -/** - * @public - */ -export type DeploymentStatus = (typeof DeploymentStatus)[keyof typeof DeploymentStatus]; - -/** - * @public - * @enum - */ -export const DeploymentType = { - CREATE: "CREATE", - DELETE: "DELETE", - UPDATE: "UPDATE", -} as const; - -/** - * @public - */ -export type DeploymentType = (typeof DeploymentType)[keyof typeof DeploymentType]; - -/** - *The failure reasons for the environment deployment.
+ *The details of the asset type.
* @public */ -export interface EnvironmentError { +export interface AssetTypeItem { /** - *The error code for the failure reason for the environment deployment.
+ *The identifier of the Amazon DataZone domain where the asset type exists.
* @public */ - code?: string; + domainId: string | undefined; /** - *The error message for the failure reason for the environment deployment.
+ *The name of the asset type.
* @public */ - message: string | undefined; -} + name: string | undefined; -/** - *The details of the last deployment of the environment.
- * @public - */ -export interface Deployment { /** - *The identifier of the last deployment of the environment.
+ *The revision of the asset type.
* @public */ - deploymentId?: string; + revision: string | undefined; /** - *The type of the last deployment of the environment.
+ *The description of the asset type.
* @public */ - deploymentType?: DeploymentType; + description?: string; /** - *The status of the last deployment of the environment.
+ *The forms included in the details of the asset type.
* @public */ - deploymentStatus?: DeploymentStatus; + formsOutput: RecordThe failure reason of the last deployment of the environment.
+ *The identifier of the Amazon DataZone project that owns the asset type.
* @public */ - failureReason?: EnvironmentError; + owningProjectId: string | undefined; /** - *The messages of the last deployment of the environment.
+ *The identifier of the Amazon DataZone domain where the asset type was originally + * created.
* @public */ - messages?: string[]; + originDomainId?: string; /** - *Specifies whether the last deployment of the environment is complete.
+ *The identifier of the Amazon DataZone project where the asset type exists.
* @public */ - isDeploymentComplete?: boolean; -} + originProjectId?: string; -/** - *The details of a provisioned resource of this Amazon DataZone environment.
- * @public - */ -export interface Resource { /** - *The provider of a provisioned resource of this Amazon DataZone environment.
+ *The timestamp of when the asset type was created.
* @public */ - provider?: string; + createdAt?: Date; /** - *The name of a provisioned resource of this Amazon DataZone environment.
+ *The Amazon DataZone user who created the asset type.
* @public */ - name?: string; + createdBy?: string; /** - *The value of a provisioned resource of this Amazon DataZone environment.
+ *The timestamp of when the asset type was updated.
* @public */ - value: string | undefined; + updatedAt?: Date; /** - *The type of a provisioned resource of this Amazon DataZone environment.
+ *The Amazon DataZone user who updated the asset type.
* @public */ - type: string | undefined; + updatedBy?: string; } -/** - *The provisioning properties of an environment blueprint.
- * @public - */ -export type ProvisioningProperties = - | ProvisioningProperties.CloudFormationMember - | ProvisioningProperties.$UnknownMember; - /** * @public */ -export namespace ProvisioningProperties { +export interface AssociateEnvironmentRoleInput { /** - *The cloud formation properties included as part of the provisioning properties of an - * environment blueprint.
+ *The ID of the Amazon DataZone domain in which the environment role is associated.
* @public */ - export interface CloudFormationMember { - cloudFormation: CloudFormationProperties; - $unknown?: never; - } + domainIdentifier: string | undefined; /** + *The ID of the Amazon DataZone environment.
* @public */ - export interface $UnknownMember { - cloudFormation?: never; - $unknown: [string, any]; - } - - export interface VisitorThe ARN of the environment role.
+ * @public + */ + environmentRoleArn: string | undefined; } +/** + * @public + */ +export interface AssociateEnvironmentRoleOutput {} + /** * @public * @enum */ -export const EnvironmentStatus = { - ACTIVE: "ACTIVE", - CREATE_FAILED: "CREATE_FAILED", - CREATING: "CREATING", - DELETED: "DELETED", - DELETE_FAILED: "DELETE_FAILED", - DELETING: "DELETING", +export const AuthType = { DISABLED: "DISABLED", - EXPIRED: "EXPIRED", - INACCESSIBLE: "INACCESSIBLE", - SUSPENDED: "SUSPENDED", - UPDATE_FAILED: "UPDATE_FAILED", - UPDATING: "UPDATING", - VALIDATION_FAILED: "VALIDATION_FAILED", + IAM_IDC: "IAM_IDC", } as const; /** * @public */ -export type EnvironmentStatus = (typeof EnvironmentStatus)[keyof typeof EnvironmentStatus]; +export type AuthType = (typeof AuthType)[keyof typeof AuthType]; /** - *The details of user parameters of an environment blueprint.
* @public */ -export interface CustomParameter { +export interface CancelMetadataGenerationRunInput { /** - *The key name of the parameter.
+ *The ID of the Amazon DataZone domain in which the metadata generation run is to be + * cancelled.
* @public */ - keyName: string | undefined; + domainIdentifier: string | undefined; /** - *The description of the parameter.
+ *The ID of the metadata generation run.
* @public */ - description?: string; + identifier: string | undefined; +} - /** - *The filed type of the parameter.
- * @public - */ - fieldType: string | undefined; +/** + * @public + */ +export interface CancelMetadataGenerationRunOutput {} +/** + * @public + */ +export interface CancelSubscriptionInput { /** - *The default value of the parameter.
+ *The unique identifier of the Amazon DataZone domain where the subscription request is being + * cancelled.
* @public */ - defaultValue?: string; + domainIdentifier: string | undefined; /** - *Specifies whether the parameter is editable.
+ *The unique identifier of the subscription that is being cancelled.
* @public */ - isEditable?: boolean; + identifier: string | undefined; +} + +/** + * @public + * @enum + */ +export const SubscriptionStatus = { + APPROVED: "APPROVED", + CANCELLED: "CANCELLED", + REVOKED: "REVOKED", +} as const; - /** - *Specifies whether the custom parameter is optional.
- * @public - */ - isOptional?: boolean; -} +/** + * @public + */ +export type SubscriptionStatus = (typeof SubscriptionStatus)[keyof typeof SubscriptionStatus]; /** * @public */ -export interface CreateEnvironmentOutput { +export interface CancelSubscriptionOutput { /** - *The ID of the Amazon DataZone project in which this environment is created.
+ *The identifier of the subscription.
* @public */ - projectId: string | undefined; + id: string | undefined; /** - *The ID of this Amazon DataZone environment.
+ *Specifies the Amazon DataZone user who is cancelling the subscription.
* @public */ - id?: string; + createdBy: string | undefined; /** - *The identifier of the Amazon DataZone domain in which the environment is created.
+ *The Amazon DataZone user that cancelled the subscription.
* @public */ - domainId: string | undefined; + updatedBy?: string; /** - *The Amazon DataZone user who created this environment.
+ *The unique identifier of the Amazon DataZone domain where the subscription is being + * cancelled.
* @public */ - createdBy: string | undefined; + domainId: string | undefined; /** - *The timestamp of when the environment was created.
+ *The status of the request to cancel the subscription.
* @public */ - createdAt?: Date; + status: SubscriptionStatus | undefined; /** - *The timestamp of when this environment was updated.
+ *The timestamp that specifies when the request to cancel the subscription was + * created.
* @public */ - updatedAt?: Date; + createdAt: Date | undefined; /** - *The name of this environment.
+ *The timestamp that specifies when the subscription was cancelled.
* @public */ - name: string | undefined; + updatedAt: Date | undefined; /** - *The description of this Amazon DataZone environment.
+ *The Amazon DataZone user who is made a subscriber to the specified asset by the subscription + * that is being cancelled.
* @public */ - description?: string; + subscribedPrincipal: SubscribedPrincipal | undefined; /** - *The ID of the environment profile with which this Amazon DataZone environment was - * created.
+ *The asset to which a subscription is being cancelled.
* @public */ - environmentProfileId?: string; + subscribedListing: SubscribedListing | undefined; /** - *The Amazon Web Services account in which the Amazon DataZone environment is created.
+ *The unique ID of the subscripton request for the subscription that is being + * cancelled.
* @public */ - awsAccountId?: string; + subscriptionRequestId?: string; /** - *The Amazon Web Services region in which the Amazon DataZone environment is created.
+ *Specifies whether the permissions to the asset are retained after the subscription is + * cancelled.
* @public */ - awsAccountRegion?: string; + retainPermissions?: boolean; +} + +/** + * @public + * @enum + */ +export const ChangeAction = { + PUBLISH: "PUBLISH", + UNPUBLISH: "UNPUBLISH", +} as const; +/** + * @public + */ +export type ChangeAction = (typeof ChangeAction)[keyof typeof ChangeAction]; + +/** + *Part of the provisioning properties of the environment blueprint.
+ * @public + */ +export interface CloudFormationProperties { /** - *The provider of this Amazon DataZone environment.
+ *The template URL of the cloud formation provisioning properties of the environment + * blueprint.
* @public */ - provider: string | undefined; + templateUrl: string | undefined; +} +/** + *The details of the parameters for the configurable environment action.
+ * @public + */ +export interface ConfigurableActionParameter { /** - *The provisioned resources of this Amazon DataZone environment.
+ *The key of the configurable action parameter.
* @public */ - provisionedResources?: Resource[]; + key?: string; /** - *The status of this Amazon DataZone environment.
+ *The value of the configurable action parameter.
* @public */ - status?: EnvironmentStatus; + value?: string; +} + +/** + * @public + * @enum + */ +export const ConfigurableActionTypeAuthorization = { + HTTPS: "HTTPS", + IAM: "IAM", +} as const; + +/** + * @public + */ +export type ConfigurableActionTypeAuthorization = + (typeof ConfigurableActionTypeAuthorization)[keyof typeof ConfigurableActionTypeAuthorization]; +/** + *The configurable action of a Amazon DataZone environment.
+ * @public + */ +export interface ConfigurableEnvironmentAction { /** - *The configurable actions of this Amazon DataZone environment.
+ *The type of a configurable action in a Amazon DataZone environment.
* @public */ - environmentActions?: ConfigurableEnvironmentAction[]; + type: string | undefined; /** - *The glossary terms that can be used in this Amazon DataZone environment.
+ *The authentication type of a configurable action of a Amazon DataZone environment.
* @public */ - glossaryTerms?: string[]; + auth?: ConfigurableActionTypeAuthorization; /** - *The user parameters of this Amazon DataZone environment.
+ *The parameters of a configurable action in a Amazon DataZone environment.
* @public */ - userParameters?: CustomParameter[]; + parameters: ConfigurableActionParameter[] | undefined; +} + +/** + * @public + * @enum + */ +export const DataProductItemType = { + ASSET: "ASSET", +} as const; + +/** + * @public + */ +export type DataProductItemType = (typeof DataProductItemType)[keyof typeof DataProductItemType]; +/** + *The data product.
+ * @public + */ +export interface DataProductItem { /** - *The details of the last deployment of this Amazon DataZone environment.
+ *The type of the data product.
* @public */ - lastDeployment?: Deployment; + itemType: DataProductItemType | undefined; /** - *The provisioning properties of this Amazon DataZone environment.
+ *The ID of the data product.
* @public */ - provisioningProperties?: ProvisioningProperties; + identifier: string | undefined; /** - *The deployment properties of this Amazon DataZone environment.
+ *The revision of the data product.
* @public */ - deploymentProperties?: DeploymentProperties; + revision?: string; /** - *The ID of the blueprint with which this Amazon DataZone environment was created.
+ *The glossary terms of the data product.
* @public */ - environmentBlueprintId?: string; + glossaryTerms?: string[]; } /** * @public */ -export interface CreateEnvironmentActionInput { +export interface CreateDataProductInput { /** - *The ID of the Amazon DataZone domain in which the environment action is created.
+ *The ID of the domain where the data product is created.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the environment in which the environment action is created.
- * @public - */ - environmentIdentifier: string | undefined; - - /** - *The name of the environment action.
+ *The name of the data product.
* @public */ name: string | undefined; /** - *The parameters of the environment action.
+ *The ID of the owning project of the data product.
* @public */ - parameters: ActionParameters | undefined; + owningProjectIdentifier: string | undefined; /** - *The description of the environment action that is being created in the - * environment.
+ *The description of the data product.
* @public */ description?: string; -} -/** - * @public - */ -export interface CreateEnvironmentActionOutput { /** - *The ID of the domain in which the environment action is created.
+ *The glossary terms of the data product.
* @public */ - domainId: string | undefined; + glossaryTerms?: string[]; /** - *The ID of the environment in which the environment is created.
+ *The metadata forms of the data product.
* @public */ - environmentId: string | undefined; + formsInput?: FormInput[]; /** - *The ID of the environment action.
+ *The data assets of the data product.
* @public */ - id: string | undefined; + items?: DataProductItem[]; /** - *The name of the environment action.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - name: string | undefined; + clientToken?: string; +} - /** - *The parameters of the environment action.
- * @public - */ - parameters: ActionParameters | undefined; +/** + * @public + * @enum + */ +export const DataProductStatus = { + CREATED: "CREATED", + CREATE_FAILED: "CREATE_FAILED", + CREATING: "CREATING", +} as const; - /** - *The description of the environment action.
- * @public - */ - description?: string; -} +/** + * @public + */ +export type DataProductStatus = (typeof DataProductStatus)[keyof typeof DataProductStatus]; /** * @public */ -export interface CreateEnvironmentProfileInput { +export interface CreateDataProductOutput { /** - *The ID of the Amazon DataZone domain in which this environment profile is created.
+ *The ID of the domain where the data product lives.
* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *The name of this Amazon DataZone environment profile.
+ *The ID of the data product.
* @public */ - name: string | undefined; + id: string | undefined; /** - *The description of this Amazon DataZone environment profile.
+ *The revision of the data product.
* @public */ - description?: string; + revision: string | undefined; /** - *The ID of the blueprint with which this environment profile is created.
+ *The ID of the owning project of the data product.
* @public */ - environmentBlueprintIdentifier: string | undefined; + owningProjectId: string | undefined; /** - *The identifier of the project in which to create the environment profile.
+ *The name of the data product.
* @public */ - projectIdentifier: string | undefined; + name: string | undefined; /** - *The user parameters of this Amazon DataZone environment profile.
+ *The status of the data product.
* @public */ - userParameters?: EnvironmentParameter[]; + status: DataProductStatus | undefined; /** - *The Amazon Web Services account in which the Amazon DataZone environment is created.
+ *The description of the data product.
* @public */ - awsAccountId?: string; + description?: string; /** - *The Amazon Web Services region in which this environment profile is created.
+ *The glossary terms of the data product.
* @public */ - awsAccountRegion?: string; -} + glossaryTerms?: string[]; -/** - * @public - */ -export interface CreateEnvironmentProfileOutput { /** - *The ID of this Amazon DataZone environment profile.
+ *The data assets of the data product.
* @public */ - id: string | undefined; + items?: DataProductItem[]; /** - *The ID of the Amazon DataZone domain in which this environment profile is created.
+ *The metadata forms of the data product.
* @public */ - domainId: string | undefined; + formsOutput?: FormOutput[]; /** - *The Amazon Web Services account ID in which this Amazon DataZone environment profile is - * created.
+ *The timestamp at which the data product was created.
* @public */ - awsAccountId?: string; + createdAt?: Date; /** - *The Amazon Web Services region in which this Amazon DataZone environment profile is - * created.
+ *The user who created the data product.
* @public */ - awsAccountRegion?: string; + createdBy?: string; /** - *The Amazon DataZone user who created this environment profile.
+ *The timestamp at which the first revision of the data product was created.
* @public */ - createdBy: string | undefined; + firstRevisionCreatedAt?: Date; /** - *The timestamp of when this environment profile was created.
+ *The user who created the first revision of the data product.
* @public */ - createdAt?: Date; + firstRevisionCreatedBy?: string; +} +/** + * @public + */ +export interface CreateDataProductRevisionInput { /** - *The timestamp of when this environment profile was updated.
+ *The ID of the domain where the data product revision is created.
* @public */ - updatedAt?: Date; + domainIdentifier: string | undefined; /** - *The name of this Amazon DataZone environment profile.
+ *The ID of the data product revision.
* @public */ - name: string | undefined; + identifier: string | undefined; /** - *The description of this Amazon DataZone environment profile.
+ *The name of the data product revision.
* @public */ - description?: string; + name: string | undefined; /** - *The ID of the blueprint with which this environment profile is created.
+ *The description of the data product revision.
* @public */ - environmentBlueprintId: string | undefined; + description?: string; /** - *The ID of the Amazon DataZone project in which this environment profile is created.
+ *The glossary terms of the data product revision.
* @public */ - projectId?: string; + glossaryTerms?: string[]; /** - *The user parameters of this Amazon DataZone environment profile.
+ *The data assets of the data product revision.
* @public */ - userParameters?: CustomParameter[]; -} - -/** - *The model of the API.
- * @public - */ -export type Model = Model.SmithyMember | Model.$UnknownMember; + items?: DataProductItem[]; -/** - * @public - */ -export namespace Model { /** - *Indicates the smithy model of the API.
+ *The metadata forms of the data product revision.
* @public */ - export interface SmithyMember { - smithy: string; - $unknown?: never; - } + formsInput?: FormInput[]; /** + *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - export interface $UnknownMember { - smithy?: never; - $unknown: [string, any]; - } - - export interface VisitorThe ID of the domain where data product revision is created.
+ * @public + */ + domainId: string | undefined; -/** - * @public - */ -export interface CreateFormTypeInput { /** - *The ID of the Amazon DataZone domain in which this metadata form type is created.
+ *The ID of the data product revision.
* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *The name of this Amazon DataZone metadata form type.
+ *The revision of the data product revision.
* @public */ - name: string | undefined; + revision: string | undefined; /** - *The model of this Amazon DataZone metadata form type.
+ *The ID of the owning project of the data product revision.
* @public */ - model: Model | undefined; + owningProjectId: string | undefined; /** - *The ID of the Amazon DataZone project that owns this metadata form type.
+ *The name of the data product revision.
* @public */ - owningProjectIdentifier: string | undefined; + name: string | undefined; /** - *The status of this Amazon DataZone metadata form type.
+ *The status of the data product revision.
* @public */ - status?: FormTypeStatus; + status: DataProductStatus | undefined; /** - *The description of this Amazon DataZone metadata form type.
+ *The description of the data product revision.
* @public */ description?: string; -} -/** - * @public - */ -export interface CreateFormTypeOutput { /** - *The ID of the Amazon DataZone domain in which this metadata form type is created.
+ *The glossary terms of the data product revision.
* @public */ - domainId: string | undefined; + glossaryTerms?: string[]; /** - *The name of this Amazon DataZone metadata form type.
+ *The data assets of the data product revision.
* @public */ - name: string | undefined; + items?: DataProductItem[]; /** - *The revision of this Amazon DataZone metadata form type.
+ *The metadata forms of the data product revision.
* @public */ - revision: string | undefined; + formsOutput?: FormOutput[]; /** - *The description of this Amazon DataZone metadata form type.
+ *The timestamp at which the data product revision is created.
* @public */ - description?: string; + createdAt?: Date; /** - *The ID of the project that owns this Amazon DataZone metadata form type.
+ *The user who created the data product revision.
* @public */ - owningProjectId?: string; + createdBy?: string; /** - *The ID of the Amazon DataZone domain in which this metadata form type was originally - * created.
+ *The timestamp at which the first revision of the data product is created.
* @public */ - originDomainId?: string; + firstRevisionCreatedAt?: Date; /** - *The ID of the project in which this Amazon DataZone metadata form type was originally - * created.
+ *The user who created the first revision of the data product.
* @public */ - originProjectId?: string; + firstRevisionCreatedBy?: string; } /** * @public * @enum */ -export const GlossaryStatus = { - DISABLED: "DISABLED", - ENABLED: "ENABLED", +export const FilterExpressionType = { + EXCLUDE: "EXCLUDE", + INCLUDE: "INCLUDE", } as const; /** * @public */ -export type GlossaryStatus = (typeof GlossaryStatus)[keyof typeof GlossaryStatus]; +export type FilterExpressionType = (typeof FilterExpressionType)[keyof typeof FilterExpressionType]; /** + *A filter expression in Amazon DataZone.
* @public */ -export interface CreateGlossaryInput { - /** - *The ID of the Amazon DataZone domain in which this business glossary is created.
- * @public - */ - domainIdentifier: string | undefined; - - /** - *The name of this business glossary.
- * @public - */ - name: string | undefined; - - /** - *The ID of the project that currently owns business glossary.
- * @public - */ - owningProjectIdentifier: string | undefined; - - /** - *The description of this business glossary.
- * @public - */ - description?: string; - +export interface FilterExpression { /** - *The status of this business glossary.
+ *The search filter explresison type.
* @public */ - status?: GlossaryStatus; + type: FilterExpressionType | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The search filter expression.
* @public */ - clientToken?: string; + expression: string | undefined; } /** + *The relational filter configuration for the data source.
* @public */ -export interface CreateGlossaryOutput { +export interface RelationalFilterConfiguration { /** - *The ID of the Amazon DataZone domain in which this business glossary is created.
+ *The database name specified in the relational filter configuration for the data + * source.
* @public */ - domainId: string | undefined; + databaseName: string | undefined; /** - *The ID of this business glossary.
+ *The schema name specified in the relational filter configuration for the data + * source.
* @public */ - id: string | undefined; + schemaName?: string; /** - *The name of this business glossary.
+ *The filter expressions specified in the relational filter configuration for the data + * source.
* @public */ - name: string | undefined; + filterExpressions?: FilterExpression[]; +} +/** + *The configuration details of the Amazon Web Services Glue data source.
+ * @public + */ +export interface GlueRunConfigurationInput { /** - *The ID of the project that currently owns this business glossary.
+ *The data access role included in the configuration details of the Amazon Web Services Glue data + * source.
* @public */ - owningProjectId: string | undefined; + dataAccessRole?: string; /** - *The description of this business glossary.
+ *The relational filter configurations included in the configuration details of the Amazon Web Services + * Glue data source.
* @public */ - description?: string; + relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; /** - *The status of this business glossary.
+ *Specifies whether to automatically import data quality metrics as part of the data + * source run.
* @public */ - status?: GlossaryStatus; + autoImportDataQualityResult?: boolean; } /** - * @public - * @enum - */ -export const GlossaryTermStatus = { - DISABLED: "DISABLED", - ENABLED: "ENABLED", -} as const; - -/** + *The details of the credentials required to access an Amazon Redshift cluster.
* @public */ -export type GlossaryTermStatus = (typeof GlossaryTermStatus)[keyof typeof GlossaryTermStatus]; +export interface RedshiftCredentialConfiguration { + /** + *The ARN of a secret manager for an Amazon Redshift cluster.
+ * @public + */ + secretManagerArn: string | undefined; +} /** - *The details of the term relations.
+ *The details of the Amazon Redshift cluster storage.
* @public */ -export interface TermRelations { +export interface RedshiftClusterStorage { /** - *The isA property of the term relations.
The name of an Amazon Redshift cluster.
* @public */ - isA?: string[]; + clusterName: string | undefined; +} +/** + *The details of the Amazon Redshift Serverless workgroup storage.
+ * @public + */ +export interface RedshiftServerlessStorage { /** - *The classifies of the term relations.
+ *The name of the Amazon Redshift Serverless workgroup.
* @public */ - classifies?: string[]; + workgroupName: string | undefined; } /** + *The details of the Amazon Redshift storage as part of the configuration of an Amazon + * Redshift data source run.
* @public */ -export interface CreateGlossaryTermInput { - /** - *The ID of the Amazon DataZone domain in which this business glossary term is created.
- * @public - */ - domainIdentifier: string | undefined; +export type RedshiftStorage = + | RedshiftStorage.RedshiftClusterSourceMember + | RedshiftStorage.RedshiftServerlessSourceMember + | RedshiftStorage.$UnknownMember; +/** + * @public + */ +export namespace RedshiftStorage { /** - *The ID of the business glossary in which this term is created.
+ *The details of the Amazon Redshift cluster source.
* @public */ - glossaryIdentifier: string | undefined; + export interface RedshiftClusterSourceMember { + redshiftClusterSource: RedshiftClusterStorage; + redshiftServerlessSource?: never; + $unknown?: never; + } /** - *The name of this business glossary term.
+ *The details of the Amazon Redshift Serverless workgroup source.
* @public */ - name: string | undefined; + export interface RedshiftServerlessSourceMember { + redshiftClusterSource?: never; + redshiftServerlessSource: RedshiftServerlessStorage; + $unknown?: never; + } /** - *The status of this business glossary term.
* @public */ - status?: GlossaryTermStatus; + export interface $UnknownMember { + redshiftClusterSource?: never; + redshiftServerlessSource?: never; + $unknown: [string, any]; + } + + export interface VisitorThe configuration details of the Amazon Redshift data source.
+ * @public + */ +export interface RedshiftRunConfigurationInput { /** - *The short description of this business glossary term.
+ *The data access role included in the configuration details of the Amazon Redshift data + * source.
* @public */ - shortDescription?: string; + dataAccessRole?: string; /** - *The long description of this business glossary term.
+ *The relational filger configurations included in the configuration details of the Amazon + * Redshift data source.
* @public */ - longDescription?: string; + relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; /** - *The term relations of this business glossary term.
+ *The details of the credentials required to access an Amazon Redshift cluster.
* @public */ - termRelations?: TermRelations; + redshiftCredentialConfiguration: RedshiftCredentialConfiguration | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The details of the Amazon Redshift storage as part of the configuration of an Amazon + * Redshift data source run.
* @public */ - clientToken?: string; + redshiftStorage: RedshiftStorage | undefined; } /** + *The configuration of the data source.
* @public */ -export interface CreateGlossaryTermOutput { - /** - *The ID of this business glossary term.
- * @public - */ - id: string | undefined; +export type DataSourceConfigurationInput = + | DataSourceConfigurationInput.GlueRunConfigurationMember + | DataSourceConfigurationInput.RedshiftRunConfigurationMember + | DataSourceConfigurationInput.$UnknownMember; +/** + * @public + */ +export namespace DataSourceConfigurationInput { /** - *The ID of the Amazon DataZone domain in which this business glossary term is created.
+ *The configuration of the Amazon Web Services Glue data source.
* @public */ - domainId: string | undefined; + export interface GlueRunConfigurationMember { + glueRunConfiguration: GlueRunConfigurationInput; + redshiftRunConfiguration?: never; + $unknown?: never; + } /** - *The ID of the business glossary in which this term is created.
+ *The configuration of the Amazon Redshift data source.
* @public */ - glossaryId: string | undefined; + export interface RedshiftRunConfigurationMember { + glueRunConfiguration?: never; + redshiftRunConfiguration: RedshiftRunConfigurationInput; + $unknown?: never; + } /** - *The name of this business glossary term.
* @public */ - name: string | undefined; + export interface $UnknownMember { + glueRunConfiguration?: never; + redshiftRunConfiguration?: never; + $unknown: [string, any]; + } + + export interface VisitorThe recommendation to be updated as part of the UpdateDataSource
+ * action.
The status of this business glossary term.
+ *Specifies whether automatic business name generation is to be enabled or not as part of + * the recommendation configuration.
* @public */ - status: GlossaryTermStatus | undefined; + enableBusinessNameGeneration?: boolean; +} + +/** + * @public + * @enum + */ +export const Timezone = { + AFRICA_JOHANNESBURG: "AFRICA_JOHANNESBURG", + AMERICA_MONTREAL: "AMERICA_MONTREAL", + AMERICA_SAO_PAULO: "AMERICA_SAO_PAULO", + ASIA_BAHRAIN: "ASIA_BAHRAIN", + ASIA_BANGKOK: "ASIA_BANGKOK", + ASIA_CALCUTTA: "ASIA_CALCUTTA", + ASIA_DUBAI: "ASIA_DUBAI", + ASIA_HONG_KONG: "ASIA_HONG_KONG", + ASIA_JAKARTA: "ASIA_JAKARTA", + ASIA_KUALA_LUMPUR: "ASIA_KUALA_LUMPUR", + ASIA_SEOUL: "ASIA_SEOUL", + ASIA_SHANGHAI: "ASIA_SHANGHAI", + ASIA_SINGAPORE: "ASIA_SINGAPORE", + ASIA_TAIPEI: "ASIA_TAIPEI", + ASIA_TOKYO: "ASIA_TOKYO", + AUSTRALIA_MELBOURNE: "AUSTRALIA_MELBOURNE", + AUSTRALIA_SYDNEY: "AUSTRALIA_SYDNEY", + CANADA_CENTRAL: "CANADA_CENTRAL", + CET: "CET", + CST6CDT: "CST6CDT", + ETC_GMT: "ETC_GMT", + ETC_GMT0: "ETC_GMT0", + ETC_GMT_ADD_0: "ETC_GMT_ADD_0", + ETC_GMT_ADD_1: "ETC_GMT_ADD_1", + ETC_GMT_ADD_10: "ETC_GMT_ADD_10", + ETC_GMT_ADD_11: "ETC_GMT_ADD_11", + ETC_GMT_ADD_12: "ETC_GMT_ADD_12", + ETC_GMT_ADD_2: "ETC_GMT_ADD_2", + ETC_GMT_ADD_3: "ETC_GMT_ADD_3", + ETC_GMT_ADD_4: "ETC_GMT_ADD_4", + ETC_GMT_ADD_5: "ETC_GMT_ADD_5", + ETC_GMT_ADD_6: "ETC_GMT_ADD_6", + ETC_GMT_ADD_7: "ETC_GMT_ADD_7", + ETC_GMT_ADD_8: "ETC_GMT_ADD_8", + ETC_GMT_ADD_9: "ETC_GMT_ADD_9", + ETC_GMT_NEG_0: "ETC_GMT_NEG_0", + ETC_GMT_NEG_1: "ETC_GMT_NEG_1", + ETC_GMT_NEG_10: "ETC_GMT_NEG_10", + ETC_GMT_NEG_11: "ETC_GMT_NEG_11", + ETC_GMT_NEG_12: "ETC_GMT_NEG_12", + ETC_GMT_NEG_13: "ETC_GMT_NEG_13", + ETC_GMT_NEG_14: "ETC_GMT_NEG_14", + ETC_GMT_NEG_2: "ETC_GMT_NEG_2", + ETC_GMT_NEG_3: "ETC_GMT_NEG_3", + ETC_GMT_NEG_4: "ETC_GMT_NEG_4", + ETC_GMT_NEG_5: "ETC_GMT_NEG_5", + ETC_GMT_NEG_6: "ETC_GMT_NEG_6", + ETC_GMT_NEG_7: "ETC_GMT_NEG_7", + ETC_GMT_NEG_8: "ETC_GMT_NEG_8", + ETC_GMT_NEG_9: "ETC_GMT_NEG_9", + EUROPE_DUBLIN: "EUROPE_DUBLIN", + EUROPE_LONDON: "EUROPE_LONDON", + EUROPE_PARIS: "EUROPE_PARIS", + EUROPE_STOCKHOLM: "EUROPE_STOCKHOLM", + EUROPE_ZURICH: "EUROPE_ZURICH", + ISRAEL: "ISRAEL", + MEXICO_GENERAL: "MEXICO_GENERAL", + MST7MDT: "MST7MDT", + PACIFIC_AUCKLAND: "PACIFIC_AUCKLAND", + US_CENTRAL: "US_CENTRAL", + US_EASTERN: "US_EASTERN", + US_MOUNTAIN: "US_MOUNTAIN", + US_PACIFIC: "US_PACIFIC", + UTC: "UTC", +} as const; - /** - *The short description of this business glossary term.
- * @public - */ - shortDescription?: string; +/** + * @public + */ +export type Timezone = (typeof Timezone)[keyof typeof Timezone]; +/** + *The details of the schedule of the data source runs.
+ * @public + */ +export interface ScheduleConfiguration { /** - *The long description of this business glossary term.
+ *The timezone of the data source run.
* @public */ - longDescription?: string; + timezone?: Timezone; /** - *The term relations of this business glossary term.
+ *The schedule of the data source runs.
* @public */ - termRelations?: TermRelations; + schedule?: string; } /** * @public */ -export interface CreateGroupProfileInput { +export interface CreateDataSourceInput { /** - *The identifier of the Amazon DataZone domain in which the group profile is created.
+ *The name of the data source.
* @public */ - domainIdentifier: string | undefined; + name: string | undefined; /** - *The identifier of the group for which the group profile is created.
+ *The description of the data source.
* @public */ - groupIdentifier: string | undefined; + description?: string; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The ID of the Amazon DataZone domain where the data source is created.
* @public */ - clientToken?: string; -} - -/** - * @public - * @enum - */ -export const GroupProfileStatus = { - ASSIGNED: "ASSIGNED", - NOT_ASSIGNED: "NOT_ASSIGNED", -} as const; - -/** - * @public - */ -export type GroupProfileStatus = (typeof GroupProfileStatus)[keyof typeof GroupProfileStatus]; + domainIdentifier: string | undefined; -/** - * @public - */ -export interface CreateGroupProfileOutput { /** - *The identifier of the Amazon DataZone domain in which the group profile is created.
+ *The identifier of the Amazon DataZone project in which you want to add this data + * source.
* @public */ - domainId?: string; + projectIdentifier: string | undefined; /** - *The identifier of the group profile.
+ *The unique identifier of the Amazon DataZone environment to which the data source publishes + * assets.
* @public */ - id?: string; + environmentIdentifier: string | undefined; /** - *The status of the group profile.
+ *The type of the data source.
* @public */ - status?: GroupProfileStatus; + type: string | undefined; /** - *The name of the group for which group profile is created.
+ *Specifies the configuration of the data source. It can be set to either
+ * glueRunConfiguration or redshiftRunConfiguration.
The ID of the Amazon DataZone domain.
+ *Specifies whether the business name generation is to be enabled for this data + * source.
* @public */ - domainIdentifier: string | undefined; + recommendation?: RecommendationConfiguration; /** - *The ID of the asset.
+ *Specifies whether the data source is enabled.
* @public */ - entityIdentifier: string | undefined; + enableSetting?: EnableSetting; /** - *The type of an entity.
+ *The schedule of the data source runs.
* @public */ - entityType: EntityType | undefined; + schedule?: ScheduleConfiguration; /** - *The revision of an asset.
+ *Specifies whether the assets that this data source creates in the inventory are to be + * also automatically published to the catalog.
* @public */ - entityRevision?: string; + publishOnImport?: boolean; /** - *Specifies whether to publish or unpublish a listing.
+ *The metadata forms that are to be attached to the assets that this data source works + * with.
* @public */ - action: ChangeAction | undefined; + assetFormsInput?: FormInput[]; /** *A unique, case-sensitive identifier that is provided to ensure the idempotency of the @@ -5515,630 +4810,622 @@ export interface CreateListingChangeSetInput { } /** + *
The configuration details of the Amazon Web Services Glue data source.
* @public */ -export interface CreateListingChangeSetOutput { - /** - *The ID of the listing (a record of an asset at a given time).
- * @public - */ - listingId: string | undefined; - - /** - *The revision of a listing.
- * @public - */ - listingRevision: string | undefined; - +export interface GlueRunConfigurationOutput { /** - *Specifies the status of the listing.
+ *The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data + * source.
* @public */ - status: ListingStatus | undefined; -} + accountId?: string; -/** - * @public - */ -export interface CreateProjectInput { /** - *The ID of the Amazon DataZone domain in which this project is created.
+ *The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source. + *
* @public */ - domainIdentifier: string | undefined; + region?: string; /** - *The name of the Amazon DataZone project.
+ *The data access role included in the configuration details of the Amazon Web Services Glue data + * source.
* @public */ - name: string | undefined; + dataAccessRole?: string; /** - *The description of the Amazon DataZone project.
+ *The relational filter configurations included in the configuration details of the Amazon Web Services + * Glue data source.
* @public */ - description?: string; + relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; /** - *The glossary terms that can be used in this Amazon DataZone project.
+ *Specifies whether to automatically import data quality metrics as part of the data + * source run.
* @public */ - glossaryTerms?: string[]; + autoImportDataQualityResult?: boolean; } /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The configuration details of the Amazon Redshift data source.
* @public */ -export interface ProjectDeletionError { +export interface RedshiftRunConfigurationOutput { /** - *The code of the project deletion error.
+ *The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift + * data source.
* @public */ - code?: string; + accountId?: string; /** - *The message of the project deletion error.
+ *The Amazon Web Services region included in the configuration details of the Amazon Redshift data + * source.
* @public */ - message?: string; -} - -/** - * @public - * @enum - */ -export const ProjectStatus = { - ACTIVE: "ACTIVE", - DELETE_FAILED: "DELETE_FAILED", - DELETING: "DELETING", -} as const; - -/** - * @public - */ -export type ProjectStatus = (typeof ProjectStatus)[keyof typeof ProjectStatus]; + region?: string; -/** - * @public - */ -export interface CreateProjectOutput { /** - *The identifier of the Amazon DataZone domain in which the project was created.
+ *The data access role included in the configuration details of the Amazon Redshift data + * source.
* @public */ - domainId: string | undefined; + dataAccessRole?: string; /** - *The ID of the Amazon DataZone project.
+ *The relational filger configurations included in the configuration details of the Amazon + * Redshift data source.
* @public */ - id: string | undefined; + relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; /** - *The name of the project.
+ *The details of the credentials required to access an Amazon Redshift cluster.
* @public */ - name: string | undefined; + redshiftCredentialConfiguration: RedshiftCredentialConfiguration | undefined; /** - *The description of the project.
+ *The details of the Amazon Redshift storage as part of the configuration of an Amazon + * Redshift data source run.
* @public */ - description?: string; + redshiftStorage: RedshiftStorage | undefined; +} - /** - *The status of the Amazon DataZone project that was created.
- * @public - */ - projectStatus?: ProjectStatus; +/** + *The configuration of the data source.
+ * @public + */ +export type DataSourceConfigurationOutput = + | DataSourceConfigurationOutput.GlueRunConfigurationMember + | DataSourceConfigurationOutput.RedshiftRunConfigurationMember + | DataSourceConfigurationOutput.$UnknownMember; - /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+/** + * @public + */ +export namespace DataSourceConfigurationOutput { + /** + *The configuration of the Amazon Web Services Glue data source.
* @public */ - failureReasons?: ProjectDeletionError[]; + export interface GlueRunConfigurationMember { + glueRunConfiguration: GlueRunConfigurationOutput; + redshiftRunConfiguration?: never; + $unknown?: never; + } /** - *The Amazon DataZone user who created the project.
+ *The configuration of the Amazon Redshift data source.
* @public */ - createdBy: string | undefined; + export interface RedshiftRunConfigurationMember { + glueRunConfiguration?: never; + redshiftRunConfiguration: RedshiftRunConfigurationOutput; + $unknown?: never; + } /** - *The timestamp of when the project was created.
* @public */ - createdAt?: Date; + export interface $UnknownMember { + glueRunConfiguration?: never; + redshiftRunConfiguration?: never; + $unknown: [string, any]; + } + + export interface VisitorThe details of the error message that is returned if the operation cannot be + * successfully completed.
+ * @public + */ +export interface DataSourceErrorMessage { /** - *The timestamp of when the project was last updated.
+ *The type of the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - lastUpdatedAt?: Date; + errorType: DataSourceErrorType | undefined; /** - *The glossary terms that can be used in the project.
+ *The details of the error message that is returned if the operation cannot be + * successfully completed.
* @public */ - glossaryTerms?: string[]; + errorDetail?: string; } /** * @public * @enum */ -export const UserDesignation = { - PROJECT_CONTRIBUTOR: "PROJECT_CONTRIBUTOR", - PROJECT_OWNER: "PROJECT_OWNER", +export const DataSourceRunStatus = { + FAILED: "FAILED", + PARTIALLY_SUCCEEDED: "PARTIALLY_SUCCEEDED", + REQUESTED: "REQUESTED", + RUNNING: "RUNNING", + SUCCESS: "SUCCESS", } as const; /** * @public */ -export type UserDesignation = (typeof UserDesignation)[keyof typeof UserDesignation]; +export type DataSourceRunStatus = (typeof DataSourceRunStatus)[keyof typeof DataSourceRunStatus]; /** - *The details about a project member.
* @public + * @enum */ -export type Member = Member.GroupIdentifierMember | Member.UserIdentifierMember | Member.$UnknownMember; +export const DataSourceStatus = { + CREATING: "CREATING", + DELETING: "DELETING", + FAILED_CREATION: "FAILED_CREATION", + FAILED_DELETION: "FAILED_DELETION", + FAILED_UPDATE: "FAILED_UPDATE", + READY: "READY", + RUNNING: "RUNNING", + UPDATING: "UPDATING", +} as const; /** * @public */ -export namespace Member { +export type DataSourceStatus = (typeof DataSourceStatus)[keyof typeof DataSourceStatus]; + +/** + * @public + */ +export interface CreateDataSourceOutput { /** - *The user ID of a project member.
+ *The unique identifier of the data source.
* @public */ - export interface UserIdentifierMember { - userIdentifier: string; - groupIdentifier?: never; - $unknown?: never; - } + id: string | undefined; /** - *The ID of the group of a project member.
+ *The status of the data source.
* @public */ - export interface GroupIdentifierMember { - userIdentifier?: never; - groupIdentifier: string; - $unknown?: never; - } + status?: DataSourceStatus; /** + *The type of the data source.
* @public */ - export interface $UnknownMember { - userIdentifier?: never; - groupIdentifier?: never; - $unknown: [string, any]; - } - - export interface VisitorThe ID of the Amazon DataZone domain in which project membership is created.
+ *The name of the data source.
* @public */ - domainIdentifier: string | undefined; + name: string | undefined; /** - *The ID of the project for which this project membership was created.
+ *The description of the data source.
* @public */ - projectIdentifier: string | undefined; + description?: string; /** - *The project member whose project membership was created.
+ *The ID of the Amazon DataZone domain in which the data source is created.
* @public */ - member: Member | undefined; + domainId: string | undefined; /** - *The designation of the project membership.
+ *The ID of the Amazon DataZone project to which the data source is added.
* @public */ - designation: UserDesignation | undefined; -} - -/** - * @public - */ -export interface CreateProjectMembershipOutput {} + projectId: string | undefined; -/** - *A revision to be made to an asset published in a Amazon DataZone catalog.
- * @public - */ -export interface ListingRevisionInput { /** - *An identifier of revision to be made to an asset published in a Amazon DataZone - * catalog.
+ *The unique identifier of the Amazon DataZone environment to which the data source publishes + * assets.
* @public */ - identifier: string | undefined; + environmentId: string | undefined; /** - *The details of a revision to be made to an asset published in a Amazon DataZone - * catalog.
+ *Specifies the configuration of the data source. It can be set to either
+ * glueRunConfiguration or redshiftRunConfiguration.
The details of a listing for which a subscription is to be granted.
- * @public - */ -export type GrantedEntityInput = GrantedEntityInput.ListingMember | GrantedEntityInput.$UnknownMember; + configuration?: DataSourceConfigurationOutput; -/** - * @public - */ -export namespace GrantedEntityInput { /** - *The listing for which a subscription is to be granted.
+ *Specifies whether the business name generation is to be enabled for this data + * source.
* @public */ - export interface ListingMember { - listing: ListingRevisionInput; - $unknown?: never; - } + recommendation?: RecommendationConfiguration; /** + *Specifies whether the data source is enabled.
* @public */ - export interface $UnknownMember { - listing?: never; - $unknown: [string, any]; - } - - export interface VisitorSpecifies whether the assets that this data source creates in the inventory are to be + * also automatically published to the catalog.
+ * @public + */ + publishOnImport?: boolean; -/** - * @public - */ -export interface CreateSubscriptionGrantInput { /** - *The ID of the Amazon DataZone domain in which the subscription grant is created.
+ *The metadata forms attached to the assets that this data source creates.
* @public */ - domainIdentifier: string | undefined; + assetFormsOutput?: FormOutput[]; /** - *The ID of the environment in which the subscription grant is created.
+ *The schedule of the data source runs.
* @public */ - environmentIdentifier: string | undefined; + schedule?: ScheduleConfiguration; /** - *The ID of the subscription target for which the subscription grant is created.
+ *The status of the last run of this data source.
* @public */ - subscriptionTargetIdentifier: string | undefined; + lastRunStatus?: DataSourceRunStatus; /** - *The entity to which the subscription is to be granted.
+ *The timestamp that specifies when the data source was last run.
* @public */ - grantedEntity: GrantedEntityInput | undefined; + lastRunAt?: Date; /** - *The names of the assets for which the subscription grant is created.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - assetTargetNames?: AssetTargetNameMap[]; + lastRunErrorMessage?: DataSourceErrorMessage; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
+ * @public + */ + errorMessage?: DataSourceErrorMessage; + + /** + *The timestamp of when the data source was created.
* @public */ - clientToken?: string; -} + createdAt?: Date; -/** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
- * @public - */ -export interface FailureCause { /** - *The description of the error message.
+ *The timestamp of when the data source was updated.
* @public */ - message?: string; + updatedAt?: Date; } /** * @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", +export const UserAssignment = { + AUTOMATIC: "AUTOMATIC", + MANUAL: "MANUAL", } as const; /** * @public */ -export type SubscriptionGrantStatus = (typeof SubscriptionGrantStatus)[keyof typeof SubscriptionGrantStatus]; +export type UserAssignment = (typeof UserAssignment)[keyof typeof UserAssignment]; /** - *The details of the asset for which the subscription grant is created.
+ *The single sign-on details in Amazon DataZone.
* @public */ -export interface SubscribedAsset { +export interface SingleSignOn { /** - *The identifier of the asset for which the subscription grant is created.
+ *The type of single sign-on in Amazon DataZone.
* @public */ - assetId: string | undefined; + type?: AuthType; /** - *The revision of the asset for which the subscription grant is created.
+ *The single sign-on user assignment in Amazon DataZone.
* @public */ - assetRevision: string | undefined; + userAssignment?: UserAssignment; +} +/** + * @public + */ +export interface CreateDomainInput { /** - *The status of the asset for which the subscription grant is created.
+ *The name of the Amazon DataZone domain.
* @public */ - status: SubscriptionGrantStatus | undefined; + name: string | undefined; /** - *The target name of the asset for which the subscription grant is created.
+ *The description of the Amazon DataZone domain.
* @public */ - targetName?: string; + description?: string; /** - *The failure cause included in the details of the asset for which the subscription grant - * is created.
+ *The single-sign on configuration of the Amazon DataZone domain.
* @public */ - failureCause?: FailureCause; + singleSignOn?: SingleSignOn; /** - *The timestamp of when the subscription grant to the asset is created.
+ *The domain execution role that is created when an Amazon DataZone domain is created. The + * domain execution role is created in the Amazon Web Services account that houses the + * Amazon DataZone domain.
* @public */ - grantedTimestamp?: Date; + domainExecutionRole: string | undefined; /** - *The failure timestamp included in the details of the asset for which the subscription - * grant is created.
+ *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 */ - failureTimestamp?: Date; -} + kmsKeyIdentifier?: string; -/** - *A revision of an asset published in a Amazon DataZone catalog.
- * @public - */ -export interface ListingRevision { /** - *An identifier of a revision of an asset published in a Amazon DataZone catalog.
+ *The tags specified for the Amazon DataZone domain.
* @public */ - id: string | undefined; + tags?: RecordThe details of a revision of an asset published in a Amazon DataZone catalog.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - revision: string | undefined; + clientToken?: string; } /** - *The details of a listing for which a subscription is granted.
* @public + * @enum */ -export type GrantedEntity = GrantedEntity.ListingMember | GrantedEntity.$UnknownMember; +export const DomainStatus = { + AVAILABLE: "AVAILABLE", + CREATING: "CREATING", + CREATION_FAILED: "CREATION_FAILED", + DELETED: "DELETED", + DELETING: "DELETING", + DELETION_FAILED: "DELETION_FAILED", +} as const; /** * @public */ -export namespace GrantedEntity { +export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus]; + +/** + * @public + */ +export interface CreateDomainOutput { /** - *The listing for which a subscription is granted.
+ *The identifier of the Amazon DataZone domain.
* @public */ - export interface ListingMember { - listing: ListingRevision; - $unknown?: never; - } + id: string | undefined; /** + *The ID of the root domain unit.
* @public */ - export interface $UnknownMember { - listing?: never; - $unknown: [string, any]; - } - - export interface VisitorThe name of the Amazon DataZone domain.
+ * @public + */ + name?: string; -/** - * @public - * @enum - */ -export const SubscriptionGrantOverallStatus = { - COMPLETED: "COMPLETED", - GRANT_AND_REVOKE_FAILED: "GRANT_AND_REVOKE_FAILED", - GRANT_FAILED: "GRANT_FAILED", - INACCESSIBLE: "INACCESSIBLE", - IN_PROGRESS: "IN_PROGRESS", - PENDING: "PENDING", - REVOKE_FAILED: "REVOKE_FAILED", -} as const; + /** + *The description of the Amazon DataZone domain.
+ * @public + */ + description?: string; -/** - * @public - */ -export type SubscriptionGrantOverallStatus = - (typeof SubscriptionGrantOverallStatus)[keyof typeof SubscriptionGrantOverallStatus]; + /** + *The single-sign on configuration of the Amazon DataZone domain.
+ * @public + */ + singleSignOn?: SingleSignOn; -/** - * @public - */ -export interface CreateSubscriptionGrantOutput { /** - *The ID of the subscription grant.
+ *The domain execution role that is created when an Amazon DataZone domain is created. The + * domain execution role is created in the Amazon Web Services account that houses the + * Amazon DataZone domain.
* @public */ - id: string | undefined; + domainExecutionRole?: string; /** - *The Amazon DataZone user who created the subscription grant.
+ *The ARN of the Amazon DataZone domain.
* @public */ - createdBy: string | undefined; + arn?: string; /** - *The Amazon DataZone user who updated the subscription grant.
+ *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 */ - updatedBy?: string; + kmsKeyIdentifier?: string; /** - *The ID of the Amazon DataZone domain in which the subscription grant is created.
+ *The status of the Amazon DataZone domain.
* @public */ - domainId: string | undefined; + status?: DomainStatus; /** - *A timestamp of when the subscription grant is created.
+ *The URL of the data portal for this Amazon DataZone domain.
* @public */ - createdAt: Date | undefined; + portalUrl?: string; /** - *A timestamp of when the subscription grant was updated.
+ *The tags specified for the Amazon DataZone domain.
* @public */ - updatedAt: Date | undefined; + tags?: RecordThe ID of the subscription target for which the subscription grant is created.
+ *The ID of the domain where you want to crate a domain unit.
* @public */ - subscriptionTargetId: string | undefined; + domainIdentifier: string | undefined; /** - *The entity to which the subscription is granted.
+ *The name of the domain unit.
* @public */ - grantedEntity: GrantedEntity | undefined; + name: string | undefined; /** - *The status of the subscription grant.
+ *The ID of the parent domain unit.
* @public */ - status: SubscriptionGrantOverallStatus | undefined; + parentDomainUnitIdentifier: string | undefined; /** - *The assets for which the subscription grant is created.
+ *The description of the domain unit.
* @public */ - assets?: SubscribedAsset[]; + description?: string; /** - * @deprecated - * - *The identifier of the subscription grant.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - subscriptionId?: string; + clientToken?: string; } /** - *The published asset for which the subscription grant is to be created.
+ *The properties of a domain unit group.
* @public */ -export interface SubscribedListingInput { +export interface DomainUnitGroupProperties { /** - *The identifier of the published asset for which the subscription grant is to be - * created.
+ *The ID of the domain unit group.
* @public */ - identifier: string | undefined; + groupId?: string; } /** - *The project that is to be given a subscription grant.
+ *The properties of the domain unit user.
* @public */ -export interface SubscribedProjectInput { +export interface DomainUnitUserProperties { /** - *The identifier of the project that is to be given a subscription grant.
+ *The ID of teh domain unit user.
* @public */ - identifier?: string; + userId?: string; } /** - *The principal that is to be given a subscriptiong grant.
+ *The properties of the domain unit owner.
* @public */ -export type SubscribedPrincipalInput = SubscribedPrincipalInput.ProjectMember | SubscribedPrincipalInput.$UnknownMember; +export type DomainUnitOwnerProperties = + | DomainUnitOwnerProperties.GroupMember + | DomainUnitOwnerProperties.UserMember + | DomainUnitOwnerProperties.$UnknownMember; /** * @public */ -export namespace SubscribedPrincipalInput { +export namespace DomainUnitOwnerProperties { /** - *The project that is to be given a subscription grant.
+ *Indicates that the domain unit owner is a user.
* @public */ - export interface ProjectMember { - project: SubscribedProjectInput; + export interface UserMember { + user: DomainUnitUserProperties; + group?: never; + $unknown?: never; + } + + /** + *Indicates that the domain unit owner is a group.
+ * @public + */ + export interface GroupMember { + user?: never; + group: DomainUnitGroupProperties; $unknown?: never; } @@ -6146,977 +5433,1071 @@ export namespace SubscribedPrincipalInput { * @public */ export interface $UnknownMember { - project?: never; + user?: never; + group?: never; $unknown: [string, any]; } export interface VisitorThe ID of the domain unit.
+ * @public + */ + id: string | undefined; + + /** + *The ID of the domain where the domain unit was created.
+ * @public + */ + domainId: string | undefined; + + /** + *The name of the domain unit.
+ * @public + */ + name: string | undefined; + + /** + *The ID of the parent domain unit.
+ * @public + */ + parentDomainUnitId?: string; + /** - *The ID of the Amazon DataZone domain in which the subscription request is created.
+ *The description of the domain unit.
* @public */ - domainIdentifier: string | undefined; + description?: string; /** - *The Amazon DataZone principals for whom the subscription request is created.
+ *The owners of the domain unit.
* @public */ - subscribedPrincipals: SubscribedPrincipalInput[] | undefined; + owners: DomainUnitOwnerProperties[] | undefined; /** - *The published asset for which the subscription grant is to be created.
+ *The IDs of the ancestor domain units.
* @public */ - subscribedListings: SubscribedListingInput[] | undefined; + ancestorDomainUnitIds: string[] | undefined; /** - *The reason for the subscription request.
+ *The timestamp at which the domain unit was created.
* @public */ - requestReason: string | undefined; + createdAt?: Date; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The user who created the domain unit.
* @public */ - clientToken?: string; + createdBy?: string; } /** + *The parameter details of an evironment profile.
* @public */ -export interface CreateSubscriptionRequestOutput { +export interface EnvironmentParameter { /** - *The ID of the subscription request.
+ *The name of an environment profile parameter.
* @public */ - id: string | undefined; + name?: string; /** - *The Amazon DataZone user who created the subscription request.
+ *The value of an environment profile parameter.
* @public */ - createdBy: string | undefined; + value?: string; +} +/** + * @public + */ +export interface CreateEnvironmentInput { /** - *The Amazon DataZone user who updated the subscription request.
+ *The identifier of the Amazon DataZone project in which this environment is created.
* @public */ - updatedBy?: string; + projectIdentifier: string | undefined; /** - *The ID of the Amazon DataZone domain in whcih the subscription request is created.
+ *The identifier of the Amazon DataZone domain in which the environment is created.
* @public */ - domainId: string | undefined; + domainIdentifier: string | undefined; /** - *The status of the subscription request.
+ *The description of the Amazon DataZone environment.
* @public */ - status: SubscriptionRequestStatus | undefined; + description?: string; /** - *A timestamp of when the subscription request is created.
+ *The name of the Amazon DataZone environment.
* @public */ - createdAt: Date | undefined; + name: string | undefined; /** - *The timestamp of when the subscription request was updated.
+ *The identifier of the environment profile that is used to create this Amazon DataZone + * environment.
* @public */ - updatedAt: Date | undefined; + environmentProfileIdentifier: string | undefined; /** - *The reason for the subscription request.
+ *The user parameters of this Amazon DataZone environment.
* @public */ - requestReason: string | undefined; + userParameters?: EnvironmentParameter[]; /** - *The subscribed principals of the subscription request.
+ *The glossary terms that can be used in this Amazon DataZone environment.
* @public */ - subscribedPrincipals: SubscribedPrincipal[] | undefined; + glossaryTerms?: string[]; /** - *The published asset for which the subscription grant is to be created.
+ *The ID of the account in which the environment is being created.
* @public */ - subscribedListings: SubscribedListing[] | undefined; + environmentAccountIdentifier?: string; /** - *The ID of the reviewer of the subscription request.
+ *The region of the account in which the environment is being created.
* @public */ - reviewerId?: string; + environmentAccountRegion?: string; /** - *The decision comment of the subscription request.
+ *The ID of the blueprint with which the environment is being created.
* @public */ - decisionComment?: string; + environmentBlueprintIdentifier?: string; } /** - *The details of the subscription target configuration.
+ *The deployment properties of the Amazon DataZone blueprint.
* @public */ -export interface SubscriptionTargetForm { +export interface DeploymentProperties { /** - *The form name included in the subscription target configuration.
+ *The start timeout of the environment blueprint deployment.
* @public */ - formName: string | undefined; + startTimeoutMinutes?: number; /** - *The content of the subscription target configuration.
+ *The end timeout of the environment blueprint deployment.
* @public */ - content: string | undefined; + endTimeoutMinutes?: number; } /** * @public + * @enum */ -export interface CreateSubscriptionTargetInput { +export const DeploymentStatus = { + FAILED: "FAILED", + IN_PROGRESS: "IN_PROGRESS", + PENDING_DEPLOYMENT: "PENDING_DEPLOYMENT", + SUCCESSFUL: "SUCCESSFUL", +} as const; + +/** + * @public + */ +export type DeploymentStatus = (typeof DeploymentStatus)[keyof typeof DeploymentStatus]; + +/** + * @public + * @enum + */ +export const DeploymentType = { + CREATE: "CREATE", + DELETE: "DELETE", + UPDATE: "UPDATE", +} as const; + +/** + * @public + */ +export type DeploymentType = (typeof DeploymentType)[keyof typeof DeploymentType]; + +/** + *The failure reasons for the environment deployment.
+ * @public + */ +export interface EnvironmentError { /** - *The ID of the Amazon DataZone domain in which subscription target is created.
+ *The error code for the failure reason for the environment deployment.
* @public */ - domainIdentifier: string | undefined; + code?: string; /** - *The ID of the environment in which subscription target is created.
+ *The error message for the failure reason for the environment deployment.
* @public */ - environmentIdentifier: string | undefined; + message: string | undefined; +} +/** + *The details of the last deployment of the environment.
+ * @public + */ +export interface Deployment { /** - *The name of the subscription target.
+ *The identifier of the last deployment of the environment.
* @public */ - name: string | undefined; + deploymentId?: string; /** - *The type of the subscription target.
+ *The type of the last deployment of the environment.
* @public */ - type: string | undefined; + deploymentType?: DeploymentType; /** - *The configuration of the subscription target.
+ *The status of the last deployment of the environment.
* @public */ - subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + deploymentStatus?: DeploymentStatus; /** - *The authorized principals of the subscription target.
+ *The failure reason of the last deployment of the environment.
* @public */ - authorizedPrincipals: string[] | undefined; + failureReason?: EnvironmentError; /** - *The manage access role that is used to create the subscription target.
+ *The messages of the last deployment of the environment.
* @public */ - manageAccessRole: string | undefined; + messages?: string[]; /** - *The asset types that can be included in the subscription target.
+ *Specifies whether the last deployment of the environment is complete.
* @public */ - applicableAssetTypes: string[] | undefined; + isDeploymentComplete?: boolean; +} +/** + *The details of a provisioned resource of this Amazon DataZone environment.
+ * @public + */ +export interface Resource { /** - *The provider of the subscription target.
+ *The provider of a provisioned resource of this Amazon DataZone environment.
* @public */ provider?: string; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The name of a provisioned resource of this Amazon DataZone environment.
* @public */ - clientToken?: string; -} + name?: string; -/** - * @public - */ -export interface CreateSubscriptionTargetOutput { /** - *The ID of the subscription target.
+ *The value of a provisioned resource of this Amazon DataZone environment.
* @public */ - id: string | undefined; + value: string | undefined; /** - *The authorised principals of the subscription target.
+ *The type of a provisioned resource of this Amazon DataZone environment.
* @public */ - authorizedPrincipals: string[] | undefined; + type: string | undefined; +} + +/** + *The provisioning properties of an environment blueprint.
+ * @public + */ +export type ProvisioningProperties = + | ProvisioningProperties.CloudFormationMember + | ProvisioningProperties.$UnknownMember; +/** + * @public + */ +export namespace ProvisioningProperties { /** - *The ID of the Amazon DataZone domain in which the subscription target was created.
+ *The cloud formation properties included as part of the provisioning properties of an + * environment blueprint.
* @public */ - domainId: string | undefined; + export interface CloudFormationMember { + cloudFormation: CloudFormationProperties; + $unknown?: never; + } /** - *???
* @public */ - projectId: string | undefined; + export interface $UnknownMember { + cloudFormation?: never; + $unknown: [string, any]; + } + + export interface VisitorThe details of user parameters of an environment blueprint.
+ * @public + */ +export interface CustomParameter { /** - *The ID of the environment in which the subscription target was created.
+ *The key name of the parameter.
* @public */ - environmentId: string | undefined; + keyName: string | undefined; /** - *The name of the subscription target.
+ *The description of the parameter.
* @public */ - name: string | undefined; + description?: string; /** - *The type of the subscription target.
+ *The filed type of the parameter.
* @public */ - type: string | undefined; + fieldType: string | undefined; /** - *The Amazon DataZone user who created the subscription target.
+ *The default value of the parameter.
* @public */ - createdBy: string | undefined; + defaultValue?: string; /** - *The Amazon DataZone user who updated the subscription target.
+ *Specifies whether the parameter is editable.
* @public */ - updatedBy?: string; + isEditable?: boolean; /** - *The timestamp of when the subscription target was created.
+ *Specifies whether the custom parameter is optional.
* @public */ - createdAt: Date | undefined; + isOptional?: boolean; +} +/** + * @public + */ +export interface CreateEnvironmentOutput { /** - *The timestamp of when the subscription target was updated.
+ *The ID of the Amazon DataZone project in which this environment is created.
* @public */ - updatedAt?: Date; + projectId: string | undefined; /** - *The manage access role with which the subscription target was created.
+ *The ID of this Amazon DataZone environment.
* @public */ - manageAccessRole: string | undefined; + id?: string; /** - *The asset types that can be included in the subscription target.
+ *The identifier of the Amazon DataZone domain in which the environment is created.
* @public */ - applicableAssetTypes: string[] | undefined; + domainId: string | undefined; /** - *The configuration of the subscription target.
+ *The Amazon DataZone user who created this environment.
* @public */ - subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + createdBy: string | undefined; /** - *The provider of the subscription target.
+ *The timestamp of when the environment was created.
* @public */ - provider: string | 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]; + createdAt?: Date; -/** - * @public - */ -export interface CreateUserProfileInput { /** - *The identifier of the Amazon DataZone domain in which a user profile is created.
+ *The timestamp of when this environment was updated.
* @public */ - domainIdentifier: string | undefined; + updatedAt?: Date; /** - *The identifier of the user for which the user profile is created.
+ *The name of this environment.
* @public */ - userIdentifier: string | undefined; + name: string | undefined; /** - *The user type of the user for which the user profile is created.
+ *The description of this Amazon DataZone environment.
* @public */ - userType?: UserType; + description?: string; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The ID of the environment profile with which this Amazon DataZone environment was + * created.
* @public */ - clientToken?: string; -} + environmentProfileId?: string; -/** - *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 Amazon Web Services account in which the Amazon DataZone environment is created.
* @public */ - arn?: string; -} + awsAccountId?: string; -/** - *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.
+ *The Amazon Web Services region in which the Amazon DataZone environment is created.
* @public */ - username?: string; + awsAccountRegion?: string; /** - *The first name included in the single sign-on details of the user profile.
+ *The provider of this Amazon DataZone environment.
* @public */ - firstName?: string; + provider: string | undefined; /** - *The last name included in the single sign-on details of the user profile.
+ *The provisioned resources of this Amazon DataZone environment.
* @public */ - lastName?: string; -} - -/** - *The details of the user profile in Amazon DataZone.
- * @public - */ -export type UserProfileDetails = - | UserProfileDetails.IamMember - | UserProfileDetails.SsoMember - | UserProfileDetails.$UnknownMember; + provisionedResources?: Resource[]; -/** - * @public - */ -export namespace UserProfileDetails { /** - *The IAM details included in the user profile details.
+ *The status of this Amazon DataZone environment.
* @public */ - export interface IamMember { - iam: IamUserProfileDetails; - sso?: never; - $unknown?: never; - } + status?: EnvironmentStatus; /** - *The single sign-on details included in the user profile details.
+ *The configurable actions of this Amazon DataZone environment.
* @public */ - export interface SsoMember { - iam?: never; - sso: SsoUserProfileDetails; - $unknown?: never; - } + environmentActions?: ConfigurableEnvironmentAction[]; /** + *The glossary terms that can be used in this Amazon DataZone environment.
* @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 user parameters of this Amazon DataZone environment.
* @public */ - domainId?: string; + userParameters?: CustomParameter[]; /** - *The identifier of the user profile.
+ *The details of the last deployment of this Amazon DataZone environment.
* @public */ - id?: string; + lastDeployment?: Deployment; /** - *The type of the user profile.
+ *The provisioning properties of this Amazon DataZone environment.
* @public */ - type?: UserProfileType; + provisioningProperties?: ProvisioningProperties; /** - *The status of the user profile.
+ *The deployment properties of this Amazon DataZone environment.
* @public */ - status?: UserProfileStatus; + deploymentProperties?: DeploymentProperties; /** - *The details of the user profile in Amazon DataZone.
+ *The ID of the blueprint with which this Amazon DataZone environment was created.
* @public */ - details?: UserProfileDetails; + environmentBlueprintId?: string; } -/** - * @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]; - /** * @public */ -export interface DeleteDataProductInput { +export interface CreateEnvironmentActionInput { /** - *The ID of the Amazon DataZone domain in which the data product is deleted.
+ *The ID of the Amazon DataZone domain in which the environment action is created.
* @public */ domainIdentifier: string | undefined; /** - *The identifier of the data product that is deleted.
+ *The ID of the environment in which the environment action is created.
* @public */ - identifier: string | undefined; -} - -/** - * @public - */ -export interface DeleteDataProductOutput {} + environmentIdentifier: string | undefined; -/** - * @public - */ -export interface GetDataProductInput { /** - *The ID of the domain where the data product lives.
+ *The name of the environment action.
* @public */ - domainIdentifier: string | undefined; + name: string | undefined; /** - *The ID of the data product.
+ *The parameters of the environment action.
* @public */ - identifier: string | undefined; + parameters: ActionParameters | undefined; /** - *The revision of the data product.
+ *The description of the environment action that is being created in the + * environment.
* @public */ - revision?: string; + description?: string; } /** * @public */ -export interface GetDataProductOutput { +export interface CreateEnvironmentActionOutput { /** - *The ID of the domain where the data product lives.
+ *The ID of the domain in which the environment action is created.
* @public */ domainId: string | undefined; /** - *The ID of the data product.
+ *The ID of the environment in which the environment is created.
* @public */ - id: string | undefined; + environmentId: string | undefined; /** - *The revision of the data product.
+ *The ID of the environment action.
* @public */ - revision: string | undefined; + id: string | undefined; /** - *The ID of the owning project of the data product.
+ *The name of the environment action.
* @public */ - owningProjectId: string | undefined; + name: string | undefined; /** - *The name of the data product.
+ *The parameters of the environment action.
* @public */ - name: string | undefined; + parameters: ActionParameters | undefined; /** - *The status of the data product.
+ *The description of the environment action.
* @public */ - status: DataProductStatus | undefined; + description?: string; +} +/** + * @public + */ +export interface CreateEnvironmentProfileInput { /** - *The description of the data product.
+ *The ID of the Amazon DataZone domain in which this environment profile is created.
* @public */ - description?: string; + domainIdentifier: string | undefined; /** - *The glossary terms of the data product.
+ *The name of this Amazon DataZone environment profile.
* @public */ - glossaryTerms?: string[]; + name: string | undefined; /** - *The data assets of the data product.
+ *The description of this Amazon DataZone environment profile.
* @public */ - items?: DataProductItem[]; + description?: string; /** - *The metadata forms of the data product.
+ *The ID of the blueprint with which this environment profile is created.
* @public */ - formsOutput?: FormOutput[]; + environmentBlueprintIdentifier: string | undefined; /** - *The timestamp at which the data product is created.
+ *The identifier of the project in which to create the environment profile.
* @public */ - createdAt?: Date; + projectIdentifier: string | undefined; /** - *The user who created the data product.
+ *The user parameters of this Amazon DataZone environment profile.
* @public */ - createdBy?: string; + userParameters?: EnvironmentParameter[]; /** - *The timestamp at which the first revision of the data product is created.
+ *The Amazon Web Services account in which the Amazon DataZone environment is created.
* @public */ - firstRevisionCreatedAt?: Date; + awsAccountId?: string; /** - *The user who created the first revision of the data product.
+ *The Amazon Web Services region in which this environment profile is created.
* @public */ - firstRevisionCreatedBy?: string; + awsAccountRegion?: string; } /** - *The summary of the listing of the data product.
* @public */ -export interface ListingSummary { +export interface CreateEnvironmentProfileOutput { /** - *The ID of the data product listing.
+ *The ID of this Amazon DataZone environment profile.
* @public */ - listingId?: string; + id: string | undefined; /** - *The revision of the data product listing.
+ *The ID of the Amazon DataZone domain in which this environment profile is created.
* @public */ - listingRevision?: string; + domainId: string | undefined; /** - *The glossary terms of the data product.
+ *The Amazon Web Services account ID in which this Amazon DataZone environment profile is + * created.
* @public */ - glossaryTerms?: DetailedGlossaryTerm[]; -} + awsAccountId?: string; -/** - *The data product listing.
- * @public - */ -export interface DataProductListing { /** - *The ID of the data product listing.
+ *The Amazon Web Services region in which this Amazon DataZone environment profile is + * created.
* @public */ - dataProductId?: string; + awsAccountRegion?: string; /** - *The revision of the data product listing.
+ *The Amazon DataZone user who created this environment profile.
* @public */ - dataProductRevision?: string; + createdBy: string | undefined; /** - *The timestamp at which the data product listing was created.
+ *The timestamp of when this environment profile was created.
* @public */ createdAt?: Date; /** - *The metadata forms of the data product listing.
+ *The timestamp of when this environment profile was updated.
* @public */ - forms?: string; + updatedAt?: Date; /** - *The glossary terms of the data product listing.
+ *The name of this Amazon DataZone environment profile.
* @public */ - glossaryTerms?: DetailedGlossaryTerm[]; + name: string | undefined; /** - *The ID of the owning project of the data product listing.
+ *The description of this Amazon DataZone environment profile.
* @public */ - owningProjectId?: string; + description?: string; /** - *The data assets of the data product listing.
+ *The ID of the blueprint with which this environment profile is created.
* @public */ - items?: ListingSummary[]; + environmentBlueprintId: string | undefined; + + /** + *The ID of the Amazon DataZone project in which this environment profile is created.
+ * @public + */ + projectId?: string; + + /** + *The user parameters of this Amazon DataZone environment profile.
+ * @public + */ + userParameters?: CustomParameter[]; } /** - *The additional attributes of the asset of the data product.
+ *The model of the API.
* @public */ -export interface DataProductListingItemAdditionalAttributes { +export type Model = Model.SmithyMember | Model.$UnknownMember; + +/** + * @public + */ +export namespace Model { /** - *The metadata forms of the asset of the data product.
+ *Indicates the smithy model of the API.
* @public */ - forms?: string; + export interface SmithyMember { + smithy: string; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + smithy?: never; + $unknown: [string, any]; + } + + export interface VisitorThe results of the data product summary.
* @public + * @enum */ -export interface ListingSummaryItem { +export const FormTypeStatus = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type FormTypeStatus = (typeof FormTypeStatus)[keyof typeof FormTypeStatus]; + +/** + * @public + */ +export interface CreateFormTypeInput { /** - *The ID of the data product listing.
+ *The ID of the Amazon DataZone domain in which this metadata form type is created.
* @public */ - listingId?: string; + domainIdentifier: string | undefined; /** - *The revision of the data product listing.
+ *The name of this Amazon DataZone metadata form type.
* @public */ - listingRevision?: string; + name: string | undefined; /** - *The glossary terms of the data product listing.
+ *The model of this Amazon DataZone metadata form type.
* @public */ - glossaryTerms?: DetailedGlossaryTerm[]; + model: Model | undefined; + + /** + *The ID of the Amazon DataZone project that owns this metadata form type.
+ * @public + */ + owningProjectIdentifier: string | undefined; + + /** + *The status of this Amazon DataZone metadata form type.
+ * @public + */ + status?: FormTypeStatus; + + /** + *The description of this Amazon DataZone metadata form type.
+ * @public + */ + description?: string; } /** - *The asset of the data product listing.
* @public */ -export interface DataProductListingItem { +export interface CreateFormTypeOutput { /** - *The ID of the listing.
+ *The ID of the Amazon DataZone domain in which this metadata form type is created.
* @public */ - listingId?: string; + domainId: string | undefined; /** - *The revision of the listing.
+ *The name of this Amazon DataZone metadata form type.
* @public */ - listingRevision?: string; + name: string | undefined; /** - *The name of the asset of the data product.
+ *The revision of this Amazon DataZone metadata form type.
* @public */ - name?: string; + revision: string | undefined; /** - *The entity ID of the asset of the asset of the data product.
+ *The description of this Amazon DataZone metadata form type.
* @public */ - entityId?: string; + description?: string; /** - *The revision of the asset of the asset of the data product.
+ *The ID of the project that owns this Amazon DataZone metadata form type.
* @public */ - entityRevision?: string; + owningProjectId?: string; /** - *The description of the asset of the asset of the data product.
+ *The ID of the Amazon DataZone domain in which this metadata form type was originally + * created.
* @public */ - description?: string; + originDomainId?: string; /** - *The timestamp at which the asset of the data product listing was created.
+ *The ID of the project in which this Amazon DataZone metadata form type was originally + * created.
* @public */ - createdAt?: Date; + originProjectId?: string; +} + +/** + * @public + * @enum + */ +export const GlossaryStatus = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type GlossaryStatus = (typeof GlossaryStatus)[keyof typeof GlossaryStatus]; +/** + * @public + */ +export interface CreateGlossaryInput { /** - *The timestamp at which the listing was created.
+ *The ID of the Amazon DataZone domain in which this business glossary is created.
* @public */ - listingCreatedBy?: string; + domainIdentifier: string | undefined; /** - *The user who updated the listing.
+ *The name of this business glossary.
* @public */ - listingUpdatedBy?: string; + name: string | undefined; /** - *The glossary terms of the asset of the asset of the data product.
+ *The ID of the project that currently owns business glossary.
* @public */ - glossaryTerms?: DetailedGlossaryTerm[]; + owningProjectIdentifier: string | undefined; /** - *The ID of the owning project of the asset of the data product.
+ *The description of this business glossary.
* @public */ - owningProjectId?: string; + description?: string; /** - *The additional attributes of the asset of the data product.
+ *The status of this business glossary.
* @public */ - additionalAttributes?: DataProductListingItemAdditionalAttributes; + status?: GlossaryStatus; /** - *The data of the asset of the data product.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - items?: ListingSummaryItem[]; + clientToken?: string; } /** - *The data product.
* @public */ -export interface DataProductResultItem { +export interface CreateGlossaryOutput { /** - *The ID of the domain where the data product lives.
+ *The ID of the Amazon DataZone domain in which this business glossary is created.
* @public */ domainId: string | undefined; /** - *The ID of the data product.
+ *The ID of this business glossary.
* @public */ id: string | undefined; /** - *The name of the data product.
+ *The name of this business glossary.
* @public */ name: string | undefined; /** - *The ID of the owning project of the data product.
+ *The ID of the project that currently owns this business glossary.
* @public */ owningProjectId: string | undefined; /** - *The description of the data product.
+ *The description of this business glossary.
* @public */ description?: string; /** - *The glossary terms of the data product.
+ *The status of this business glossary.
* @public */ - glossaryTerms?: string[]; + status?: GlossaryStatus; +} - /** - *The timestamp at which the data product was created.
- * @public - */ - createdAt?: Date; +/** + * @public + * @enum + */ +export const GlossaryTermStatus = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; - /** - *The user who created the data product.
- * @public - */ - createdBy?: string; +/** + * @public + */ +export type GlossaryTermStatus = (typeof GlossaryTermStatus)[keyof typeof GlossaryTermStatus]; +/** + *The details of the term relations.
+ * @public + */ +export interface TermRelations { /** - *The timestamp at which first revision of the data product was created.
+ *The isA property of the term relations.
The user who created the first revision of the data product.
+ *The classifies of the term relations.
* @public */ - firstRevisionCreatedBy?: string; + classifies?: string[]; } /** - *The data product revision.
* @public */ -export interface DataProductRevision { +export interface CreateGlossaryTermInput { /** - *The ID of the domain where the data product revision lives.
+ *The ID of the Amazon DataZone domain in which this business glossary term is created.
* @public */ - domainId?: string; + domainIdentifier: string | undefined; /** - *The ID of the data product revision.
+ *The ID of the business glossary in which this term is created.
* @public */ - id?: string; + glossaryIdentifier: string | undefined; /** - *The data product revision.
+ *The name of this business glossary term.
* @public */ - revision?: string; + name: string | undefined; /** - *The timestamp at which the data product revision was created.
+ *The status of this business glossary term.
* @public */ - createdAt?: Date; + status?: GlossaryTermStatus; /** - *The user who created the data product revision.
+ *The short description of this business glossary term.
* @public */ - createdBy?: string; -} + shortDescription?: string; -/** - * @public - */ -export interface DeleteDataSourceInput { /** - *The ID of the Amazon DataZone domain in which the data source is deleted.
+ *The long description of this business glossary term.
* @public */ - domainIdentifier: string | undefined; + longDescription?: string; /** - *The identifier of the data source that is deleted.
+ *The term relations of this business glossary term.
* @public */ - identifier: string | undefined; + termRelations?: TermRelations; /** *A unique, case-sensitive identifier that is provided to ensure the idempotency of the @@ -7124,2250 +6505,2409 @@ export interface DeleteDataSourceInput { * @public */ clientToken?: string; - - /** - *
Specifies that the granted permissions are retained in case of a self-subscribe - * functionality failure for a data source.
- * @public - */ - retainPermissionsOnRevokeFailure?: boolean; } /** * @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; +export interface CreateGlossaryTermOutput { + /** + *The ID of this business glossary term.
+ * @public + */ + id: string | undefined; -/** - * @public - */ -export type SelfGrantStatus = (typeof SelfGrantStatus)[keyof typeof SelfGrantStatus]; + /** + *The ID of the Amazon DataZone domain in which this business glossary term is created.
+ * @public + */ + domainId: string | undefined; -/** - *The details for the self granting status.
- * @public - */ -export interface SelfGrantStatusDetail { /** - *The name of the database used for the data source.
+ *The ID of the business glossary in which this term is created.
* @public */ - databaseName: string | undefined; + glossaryId: string | undefined; /** - *The name of the schema used in the data source.
+ *The name of this business glossary term.
* @public */ - schemaName?: string; + name: string | undefined; /** - *The self granting status of the data source.
+ *The status of this business glossary term.
* @public */ - status: SelfGrantStatus | undefined; + status: GlossaryTermStatus | undefined; /** - *The reason for why the operation failed.
+ *The short description of this business glossary term.
* @public */ - failureCause?: string; -} + shortDescription?: string; -/** - *The details of the self granting status.
- * @public - */ -export interface GlueSelfGrantStatusOutput { /** - *The details for the self granting status for a Glue data source.
+ *The long description of this business glossary term.
* @public */ - selfGrantStatusDetails: SelfGrantStatusDetail[] | undefined; -} + longDescription?: string; -/** - *The details for the self granting status for an Amazon Redshift data source.
- * @public - */ -export interface RedshiftSelfGrantStatusOutput { /** - *The details for the self granting status for an Amazon Redshift data source.
+ *The term relations of this business glossary term.
* @public */ - selfGrantStatusDetails: SelfGrantStatusDetail[] | undefined; + termRelations?: TermRelations; } -/** - *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 { +export interface CreateGroupProfileInput { /** - *The details for the self granting status for a Glue data source.
+ *The identifier of the Amazon DataZone domain in which the group profile is created.
* @public */ - export interface GlueSelfGrantStatusMember { - glueSelfGrantStatus: GlueSelfGrantStatusOutput; - redshiftSelfGrantStatus?: never; - $unknown?: never; - } + domainIdentifier: string | undefined; /** - *The details for the self granting status for an Amazon Redshift data source.
+ *The identifier of the group for which the group profile is created.
* @public */ - export interface RedshiftSelfGrantStatusMember { - glueSelfGrantStatus?: never; - redshiftSelfGrantStatus: RedshiftSelfGrantStatusOutput; - $unknown?: never; - } + groupIdentifier: string | undefined; /** + *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - export interface $UnknownMember { - glueSelfGrantStatus?: never; - redshiftSelfGrantStatus?: never; - $unknown: [string, any]; - } - - export interface VisitorThe ID of the data source that is deleted.
- * @public - */ - id: string | undefined; +export type GroupProfileStatus = (typeof GroupProfileStatus)[keyof typeof GroupProfileStatus]; +/** + * @public + */ +export interface CreateGroupProfileOutput { /** - *The status of this data source.
+ *The identifier of the Amazon DataZone domain in which the group profile is created.
* @public */ - status?: DataSourceStatus; + domainId?: string; /** - *The type of this data source.
+ *The identifier of the group profile.
* @public */ - type?: string; + id?: string; /** - *The name of the data source that is deleted.
+ *The status of the group profile.
* @public */ - name: string | undefined; + status?: GroupProfileStatus; /** - *The description of the data source that is deleted.
+ *The name of the group for which group profile is created.
* @public */ - description?: string; + groupName?: string; +} - /** - *The ID of the Amazon DataZone domain in which the data source is deleted.
- * @public - */ - domainId: string | undefined; +/** + * @public + * @enum + */ +export const EntityType = { + ASSET: "ASSET", + DATA_PRODUCT: "DATA_PRODUCT", +} as const; - /** - *The ID of the project in which this data source exists and from which it's - * deleted.
- * @public - */ - projectId: string | undefined; +/** + * @public + */ +export type EntityType = (typeof EntityType)[keyof typeof EntityType]; +/** + * @public + */ +export interface CreateListingChangeSetInput { /** - *The ID of the environemnt associated with this data source.
+ *The ID of the Amazon DataZone domain.
* @public */ - environmentId: string | undefined; + domainIdentifier: string | undefined; /** - *The configuration of the data source that is deleted.
+ *The ID of the asset.
* @public */ - configuration?: DataSourceConfigurationOutput; + entityIdentifier: string | undefined; /** - *The enable setting of the data source that specifies whether the data source is enabled - * or disabled.
+ *The type of an entity.
* @public */ - enableSetting?: EnableSetting; + entityType: EntityType | undefined; /** - *Specifies whether the assets that this data source creates in the inventory are to be - * also automatically published to the catalog.
+ *The revision of an asset.
* @public */ - publishOnImport?: boolean; + entityRevision?: string; /** - *The asset data forms associated with this data source.
+ *Specifies whether to publish or unpublish a listing.
* @public */ - assetFormsOutput?: FormOutput[]; + action: ChangeAction | undefined; /** - *The schedule of runs for this data source.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - schedule?: ScheduleConfiguration; + clientToken?: string; +} +/** + * @public + */ +export interface CreateListingChangeSetOutput { /** - *The status of the last run of this data source.
+ *The ID of the listing (a record of an asset at a given time).
* @public */ - lastRunStatus?: DataSourceRunStatus; + listingId: string | undefined; /** - *The timestamp of when the data source was last run.
+ *The revision of a listing.
* @public */ - lastRunAt?: Date; + listingRevision: string | undefined; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *Specifies the status of the listing.
* @public */ - lastRunErrorMessage?: DataSourceErrorMessage; + status: ListingStatus | undefined; +} +/** + * @public + */ +export interface CreateProjectInput { /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The ID of the Amazon DataZone domain in which this project is created.
* @public */ - errorMessage?: DataSourceErrorMessage; + domainIdentifier: string | undefined; /** - *The timestamp of when this data source was created.
+ *The name of the Amazon DataZone project.
* @public */ - createdAt?: Date; + name: string | undefined; /** - *The timestamp of when this data source was updated.
+ *The description of the Amazon DataZone project.
* @public */ - updatedAt?: Date; + description?: string; /** - *Specifies the status of the self-granting functionality.
+ *The glossary terms that can be used in this Amazon DataZone project.
* @public */ - selfGrantStatus?: SelfGrantStatusOutput; + glossaryTerms?: string[]; /** - *Specifies that the granted permissions are retained in case of a self-subscribe - * functionality failure for a data source.
+ *The ID of the domain unit. This parameter is not required and if it is not specified, then + * the project is created at the root domain unit level.
* @public */ - retainPermissionsOnRevokeFailure?: boolean; + domainUnitId?: string; } /** + *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ -export interface GetDataSourceInput { +export interface ProjectDeletionError { /** - *The ID of the Amazon DataZone domain in which the data source exists.
+ *The code of the project deletion error.
* @public */ - domainIdentifier: string | undefined; + code?: string; /** - *The ID of the Amazon DataZone data source.
+ *The message of the project deletion error.
* @public */ - identifier: string | undefined; + message?: string; } /** * @public + * @enum */ -export interface GetDataSourceOutput { - /** - *The ID of the data source.
- * @public - */ - id: string | undefined; +export const ProjectStatus = { + ACTIVE: "ACTIVE", + DELETE_FAILED: "DELETE_FAILED", + DELETING: "DELETING", +} as const; + +/** + * @public + */ +export type ProjectStatus = (typeof ProjectStatus)[keyof typeof ProjectStatus]; +/** + * @public + */ +export interface CreateProjectOutput { /** - *The status of the data source.
+ *The identifier of the Amazon DataZone domain in which the project was created.
* @public */ - status?: DataSourceStatus; + domainId: string | undefined; /** - *The type of the data source.
+ *The ID of the Amazon DataZone project.
* @public */ - type?: string; + id: string | undefined; /** - *The name of the data source.
+ *The name of the project.
* @public */ name: string | undefined; /** - *The description of the data source.
+ *The description of the project.
* @public */ description?: string; /** - *The ID of the Amazon DataZone domain in which the data source exists.
+ *The status of the Amazon DataZone project that was created.
* @public */ - domainId: string | undefined; + projectStatus?: ProjectStatus; /** - *The ID of the project where the data source creates and publishes assets.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - projectId: string | undefined; + failureReasons?: ProjectDeletionError[]; /** - *The ID of the environment where this data source creates and publishes assets,
+ *The Amazon DataZone user who created the project.
* @public */ - environmentId: string | undefined; + createdBy: string | undefined; /** - *The configuration of the data source.
+ *The timestamp of when the project was created.
* @public */ - configuration?: DataSourceConfigurationOutput; + createdAt?: Date; /** - *The recommendation configuration of the data source.
+ *The timestamp of when the project was last updated.
* @public */ - recommendation?: RecommendationConfiguration; + lastUpdatedAt?: Date; /** - *Specifies whether this data source is enabled or not.
+ *The glossary terms that can be used in the project.
* @public */ - enableSetting?: EnableSetting; + glossaryTerms?: string[]; /** - *Specifies whether the assets that this data source creates in the inventory are to be - * also automatically published to the catalog.
+ *The ID of the domain unit.
* @public */ - publishOnImport?: boolean; + domainUnitId?: string; +} + +/** + * @public + * @enum + */ +export const UserDesignation = { + PROJECT_CONTRIBUTOR: "PROJECT_CONTRIBUTOR", + PROJECT_OWNER: "PROJECT_OWNER", +} as const; +/** + * @public + */ +export type UserDesignation = (typeof UserDesignation)[keyof typeof UserDesignation]; + +/** + *The details about a project member.
+ * @public + */ +export type Member = Member.GroupIdentifierMember | Member.UserIdentifierMember | Member.$UnknownMember; + +/** + * @public + */ +export namespace Member { /** - *The metadata forms attached to the assets created by this data source.
+ *The user ID of a project member.
* @public */ - assetFormsOutput?: FormOutput[]; + export interface UserIdentifierMember { + userIdentifier: string; + groupIdentifier?: never; + $unknown?: never; + } /** - *The schedule of the data source runs.
+ *The ID of the group of a project member.
* @public */ - schedule?: ScheduleConfiguration; + export interface GroupIdentifierMember { + userIdentifier?: never; + groupIdentifier: string; + $unknown?: never; + } /** - *The status of the last run of the data source.
* @public */ - lastRunStatus?: DataSourceRunStatus; + export interface $UnknownMember { + userIdentifier?: never; + groupIdentifier?: never; + $unknown: [string, any]; + } + + export interface VisitorThe timestamp of the last run of the data source.
+ *The ID of the Amazon DataZone domain in which project membership is created.
* @public */ - lastRunAt?: Date; + domainIdentifier: string | undefined; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The ID of the project for which this project membership was created.
* @public */ - lastRunErrorMessage?: DataSourceErrorMessage; + projectIdentifier: string | undefined; /** - *The number of assets created by the data source during its last run.
+ *The project member whose project membership was created.
* @public */ - lastRunAssetCount?: number; + member: Member | undefined; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The designation of the project membership.
* @public */ - errorMessage?: DataSourceErrorMessage; + designation: UserDesignation | undefined; +} - /** - *The timestamp of when the data source was created.
- * @public - */ - createdAt?: Date; +/** + * @public + */ +export interface CreateProjectMembershipOutput {} +/** + *A revision to be made to an asset published in a Amazon DataZone catalog.
+ * @public + */ +export interface ListingRevisionInput { /** - *The timestamp of when the data source was updated.
+ *An identifier of revision to be made to an asset published in a Amazon DataZone + * catalog.
* @public */ - updatedAt?: Date; + identifier: string | undefined; /** - *Specifies the status of the self-granting functionality.
+ *The details of a revision to be made to an asset published in a Amazon DataZone + * catalog.
* @public */ - selfGrantStatus?: SelfGrantStatusOutput; + revision: string | undefined; } /** + *The details of a listing for which a subscription is to be granted.
* @public */ -export interface ListDataSourcesInput { +export type GrantedEntityInput = GrantedEntityInput.ListingMember | GrantedEntityInput.$UnknownMember; + +/** + * @public + */ +export namespace GrantedEntityInput { /** - *The identifier of the Amazon DataZone domain in which to list the data sources.
+ *The listing for which a subscription is to be granted.
* @public */ - domainIdentifier: string | undefined; + export interface ListingMember { + listing: ListingRevisionInput; + $unknown?: never; + } /** - *The identifier of the project in which to list data sources.
* @public */ - projectIdentifier: string | undefined; + export interface $UnknownMember { + listing?: never; + $unknown: [string, any]; + } + + export interface VisitorThe identifier of the environment in which to list the data sources.
+ *The ID of the Amazon DataZone domain in which the subscription grant is created.
* @public */ - environmentIdentifier?: string; + domainIdentifier: string | undefined; /** - *The type of the data source.
+ *The ID of the environment in which the subscription grant is created.
* @public */ - type?: string; + environmentIdentifier: string | undefined; /** - *The status of the data source.
+ *The ID of the subscription target for which the subscription grant is created.
* @public */ - status?: DataSourceStatus; + subscriptionTargetIdentifier: string | undefined; /** - *The name of the data source.
+ *The entity to which the subscription is to be granted.
* @public */ - name?: string; + grantedEntity: GrantedEntityInput | 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 names of the assets for which the subscription grant is created.
* @public */ - nextToken?: string; + assetTargetNames?: AssetTargetNameMap[]; /** - *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.
A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - maxResults?: number; + clientToken?: string; } /** - *The details of the data source.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ -export interface DataSourceSummary { +export interface FailureCause { /** - *The ID of the Amazon DataZone domain in which the data source exists.
+ *The description of the error message.
* @public */ - domainId: string | undefined; + message?: string; +} + +/** + * @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; + +/** + * @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 ID of the environment in which the data source exists.
+ *The identifier of the asset for which the subscription grant is created.
* @public */ - environmentId: string | undefined; + assetId: string | undefined; /** - *The ID of the data source.
+ *The revision of the asset for which the subscription grant is created.
* @public */ - dataSourceId: string | undefined; + assetRevision: string | undefined; /** - *The name of the data source.
+ *The status of the asset for which the subscription grant is created.
* @public */ - name: string | undefined; + status: SubscriptionGrantStatus | undefined; /** - *The type of the data source.
+ *The target name of the asset for which the subscription grant is created.
* @public */ - type: string | undefined; + targetName?: string; /** - *The status of the data source.
+ *The failure cause included in the details of the asset for which the subscription grant + * is created.
* @public */ - status: DataSourceStatus | undefined; + failureCause?: FailureCause; /** - *Specifies whether the data source is enabled.
+ *The timestamp of when the subscription grant to the asset is created.
* @public */ - enableSetting?: EnableSetting; + grantedTimestamp?: Date; /** - *The details of the schedule of the data source runs.
+ *The failure timestamp included in the details of the asset for which the subscription + * grant is created.
* @public */ - schedule?: ScheduleConfiguration; + failureTimestamp?: Date; +} +/** + *A revision of an asset published in a Amazon DataZone catalog.
+ * @public + */ +export interface ListingRevision { /** - *The status of the last data source run.
+ *An identifier of a revision of an asset published in a Amazon DataZone catalog.
* @public */ - lastRunStatus?: DataSourceRunStatus; + id: string | undefined; /** - *The timestamp of when the data source run was last performed.
+ *The details of a revision of an asset published in a Amazon DataZone catalog.
* @public */ - lastRunAt?: Date; + revision: string | undefined; +} +/** + *The details of a listing for which a subscription is granted.
+ * @public + */ +export type GrantedEntity = GrantedEntity.ListingMember | GrantedEntity.$UnknownMember; + +/** + * @public + */ +export namespace GrantedEntity { /** - *The details of the error message that is returned if the operation cannot be - * successfully completed.
+ *The listing for which a subscription is granted.
* @public */ - lastRunErrorMessage?: DataSourceErrorMessage; + export interface ListingMember { + listing: ListingRevision; + $unknown?: never; + } /** - *The count of the assets created during the last data source run.
* @public */ - lastRunAssetCount?: number; + export interface $UnknownMember { + listing?: never; + $unknown: [string, any]; + } + export interface VisitorThe timestamp of when the data source was created.
+ *The ID of the subscription grant.
* @public */ - createdAt?: Date; + id: string | undefined; /** - *The timestamp of when the data source was updated.
+ *The Amazon DataZone user who created the subscription grant.
* @public */ - updatedAt?: Date; -} + createdBy: string | undefined; -/** - * @public - */ -export interface ListDataSourcesOutput { /** - *The results of the ListDataSources action.
The Amazon DataZone user who updated the subscription grant.
* @public */ - items: DataSourceSummary[] | undefined; + updatedBy?: string; /** - *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 ID of the Amazon DataZone domain in which the subscription grant is created.
* @public */ - nextToken?: string; -} + domainId: string | undefined; -/** - * @public - */ -export interface UpdateDataSourceInput { /** - *The identifier of the domain in which to update a data source.
+ *A timestamp of when the subscription grant is created.
* @public */ - domainIdentifier: string | undefined; + createdAt: Date | undefined; /** - *The identifier of the data source to be updated.
+ *A timestamp of when the subscription grant was updated.
* @public */ - identifier: string | undefined; + updatedAt: Date | undefined; /** - *The name to be updated as part of the UpdateDataSource action.
The ID of the subscription target for which the subscription grant is created.
* @public */ - name?: string; + subscriptionTargetId: string | undefined; /** - *The description to be updated as part of the UpdateDataSource
- * action.
The entity to which the subscription is granted.
* @public */ - description?: string; + grantedEntity: GrantedEntity | undefined; /** - *The enable setting to be updated as part of the UpdateDataSource
- * action.
The status of the subscription grant.
* @public */ - enableSetting?: EnableSetting; + status: SubscriptionGrantOverallStatus | undefined; /** - *The publish on import setting to be updated as part of the UpdateDataSource
- * action.
The assets for which the subscription grant is created.
* @public */ - publishOnImport?: boolean; + assets?: SubscribedAsset[]; /** - *The asset forms to be updated as part of the UpdateDataSource
- * action.
The identifier of the subscription grant.
* @public */ - assetFormsInput?: FormInput[]; + subscriptionId?: string; +} +/** + *The published asset for which the subscription grant is to be created.
+ * @public + */ +export interface SubscribedListingInput { /** - *The schedule to be updated as part of the UpdateDataSource action.
The identifier of the published asset for which the subscription grant is to be + * created.
* @public */ - schedule?: ScheduleConfiguration; + identifier: string | undefined; +} +/** + *The project that is to be given a subscription grant.
+ * @public + */ +export interface SubscribedProjectInput { /** - *The configuration to be updated as part of the UpdateDataSource
- * action.
The identifier of the project that is to be given a subscription grant.
* @public */ - configuration?: DataSourceConfigurationInput; + identifier?: string; +} + +/** + *The principal that is to be given a subscriptiong grant.
+ * @public + */ +export type SubscribedPrincipalInput = SubscribedPrincipalInput.ProjectMember | SubscribedPrincipalInput.$UnknownMember; +/** + * @public + */ +export namespace SubscribedPrincipalInput { /** - *The recommendation to be updated as part of the UpdateDataSource
- * action.
The project that is to be given a subscription grant.
* @public */ - recommendation?: RecommendationConfiguration; + export interface ProjectMember { + project: SubscribedProjectInput; + $unknown?: never; + } /** - *Specifies that the granted permissions are retained in case of a self-subscribe - * functionality failure for a data source.
* @public */ - retainPermissionsOnRevokeFailure?: boolean; + export interface $UnknownMember { + project?: never; + $unknown: [string, any]; + } + + export interface VisitorThe identifier of the data source to be updated.
+ *The ID of the Amazon DataZone domain in which the subscription request is created.
* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *The status to be updated as part of the UpdateDataSource action.
The Amazon DataZone principals for whom the subscription request is created.
* @public */ - status?: DataSourceStatus; + subscribedPrincipals: SubscribedPrincipalInput[] | undefined; /** - *The type to be updated as part of the UpdateDataSource action.
The published asset for which the subscription grant is to be created.
* @public */ - type?: string; + subscribedListings: SubscribedListingInput[] | undefined; /** - *The name to be updated as part of the UpdateDataSource action.
The reason for the subscription request.
* @public */ - name: string | undefined; + requestReason: string | undefined; /** - *The description to be updated as part of the UpdateDataSource
- * action.
A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - description?: string; + clientToken?: string; +} +/** + * @public + */ +export interface CreateSubscriptionRequestOutput { /** - *The identifier of the Amazon DataZone domain in which a data source is to be updated.
+ *The ID of the subscription request.
* @public */ - domainId: string | undefined; + id: string | undefined; /** - *The identifier of the project where data source is to be updated.
+ *The Amazon DataZone user who created the subscription request.
* @public */ - projectId: string | undefined; + createdBy: string | undefined; /** - *The identifier of the environment in which a data source is to be updated.
+ *The Amazon DataZone user who updated the subscription request.
* @public */ - environmentId: string | undefined; + updatedBy?: string; /** - *The configuration to be updated as part of the UpdateDataSource
- * action.
The ID of the Amazon DataZone domain in whcih the subscription request is created.
* @public */ - configuration?: DataSourceConfigurationOutput; + domainId: string | undefined; /** - *The recommendation to be updated as part of the UpdateDataSource
- * action.
The status of the subscription request.
* @public */ - recommendation?: RecommendationConfiguration; + status: SubscriptionRequestStatus | undefined; /** - *The enable setting to be updated as part of the UpdateDataSource
- * action.
A timestamp of when the subscription request is created.
* @public */ - enableSetting?: EnableSetting; + createdAt: Date | undefined; /** - *The publish on import setting to be updated as part of the UpdateDataSource
- * action.
The timestamp of when the subscription request was updated.
* @public */ - publishOnImport?: boolean; + updatedAt: Date | undefined; /** - *The asset forms to be updated as part of the UpdateDataSource
- * action.
The reason for the subscription request.
* @public */ - assetFormsOutput?: FormOutput[]; + requestReason: string | undefined; /** - *The schedule to be updated as part of the UpdateDataSource action.
The subscribed principals of the subscription request.
* @public */ - schedule?: ScheduleConfiguration; + subscribedPrincipals: SubscribedPrincipal[] | undefined; /** - *The last run status of the data source.
+ *The published asset for which the subscription grant is to be created.
* @public */ - lastRunStatus?: DataSourceRunStatus; + subscribedListings: SubscribedListing[] | undefined; /** - *The timestamp of when the data source was last run.
+ *The ID of the reviewer of the subscription request.
* @public */ - lastRunAt?: Date; + reviewerId?: string; /** - *The last run error message of the data source.
+ *The decision comment of the subscription request.
* @public */ - lastRunErrorMessage?: DataSourceErrorMessage; + decisionComment?: string; +} +/** + *The details of the subscription target configuration.
+ * @public + */ +export interface SubscriptionTargetForm { /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The form name included in the subscription target configuration.
* @public */ - errorMessage?: DataSourceErrorMessage; + formName: string | undefined; /** - *The timestamp of when the data source was updated.
+ *The content of the subscription target configuration.
* @public */ - createdAt?: Date; + content: string | undefined; +} +/** + * @public + */ +export interface CreateSubscriptionTargetInput { /** - *The timestamp of when the data source was updated.
+ *The ID of the Amazon DataZone domain in which subscription target is created.
* @public */ - updatedAt?: Date; + domainIdentifier: string | undefined; /** - *Specifies the status of the self-granting functionality.
+ *The ID of the environment in which subscription target is created.
* @public */ - selfGrantStatus?: SelfGrantStatusOutput; + environmentIdentifier: string | undefined; /** - *Specifies that the granted permissions are retained in case of a self-subscribe - * functionality failure for a data source.
+ *The name of the subscription target.
* @public */ - retainPermissionsOnRevokeFailure?: boolean; -} - -/** - * @public - * @enum - */ -export const DataSourceRunType = { - PRIORITIZED: "PRIORITIZED", - SCHEDULED: "SCHEDULED", -} as const; - -/** - * @public - */ -export type DataSourceRunType = (typeof DataSourceRunType)[keyof typeof DataSourceRunType]; + name: string | undefined; -/** - * @public - */ -export interface GetDataSourceRunInput { /** - *The ID of the domain in which this data source run was performed.
+ *The type of the subscription target.
* @public */ - domainIdentifier: string | undefined; + type: string | undefined; /** - *The ID of the data source run.
+ *The configuration of the subscription target.
* @public */ - identifier: string | undefined; -} + subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; -/** - *The asset statistics from the data source run.
- * @public - */ -export interface RunStatisticsForAssets { /** - *The added statistic for the data source run.
The authorized principals of the subscription target.
* @public */ - added?: number; + authorizedPrincipals: string[] | undefined; /** - *The updated statistic for the data source run.
The manage access role that is used to create the subscription target.
* @public */ - updated?: number; + manageAccessRole: string | undefined; /** - *The unchanged statistic for the data source run.
The asset types that can be included in the subscription target.
* @public */ - unchanged?: number; + applicableAssetTypes: string[] | undefined; /** - *The skipped statistic for the data source run.
The provider of the subscription target.
* @public */ - skipped?: number; + provider?: string; /** - *The failed statistic for the data source run.
A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - failed?: number; + clientToken?: string; } /** * @public */ -export interface GetDataSourceRunOutput { +export interface CreateSubscriptionTargetOutput { /** - *The ID of the domain in which this data source run was performed.
+ *The ID of the subscription target.
* @public */ - domainId: string | undefined; + id: string | undefined; /** - *The ID of the data source for this data source run.
+ *The authorised principals of the subscription target.
* @public */ - dataSourceId: string | undefined; + authorizedPrincipals: string[] | undefined; /** - *The ID of the data source run.
+ *The ID of the Amazon DataZone domain in which the subscription target was created.
* @public */ - id: string | undefined; + domainId: string | undefined; /** - *The ID of the project in which this data source run occured.
+ *???
* @public */ projectId: string | undefined; /** - *The status of this data source run.
+ *The ID of the environment in which the subscription target was created.
* @public */ - status: DataSourceRunStatus | undefined; + environmentId: string | undefined; /** - *The type of this data source run.
+ *The name of the subscription target.
* @public */ - type: DataSourceRunType | undefined; + name: string | undefined; /** - *The configuration snapshot of the data source run.
+ *The type of the subscription target.
* @public */ - dataSourceConfigurationSnapshot?: string; + type: string | undefined; /** - *The asset statistics from this data source run.
+ *The Amazon DataZone user who created the subscription target.
* @public */ - runStatisticsForAssets?: RunStatisticsForAssets; + createdBy: string | undefined; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The Amazon DataZone user who updated the subscription target.
* @public */ - errorMessage?: DataSourceErrorMessage; + updatedBy?: string; /** - *The timestamp of when the data source run was created.
+ *The timestamp of when the subscription target was created.
* @public */ createdAt: Date | undefined; /** - *The timestamp of when this data source run was updated.
+ *The timestamp of when the subscription target was updated.
* @public */ - updatedAt: Date | undefined; + updatedAt?: Date; /** - *The timestamp of when this data source run started.
+ *The manage access role with which the subscription target was created.
* @public */ - startedAt?: Date; + manageAccessRole: string | undefined; /** - *The timestamp of when this data source run stopped.
+ *The asset types that can be included in the subscription target.
* @public */ - stoppedAt?: Date; + applicableAssetTypes: string[] | undefined; + + /** + *The configuration of the subscription target.
+ * @public + */ + subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + + /** + *The provider of the subscription target.
+ * @public + */ + provider: string | undefined; } /** * @public + * @enum */ -export interface ListDataSourceRunsInput { +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 { /** - *The identifier of the Amazon DataZone domain in which to invoke the
- * ListDataSourceRuns action.
The identifier of the Amazon DataZone domain in which a user profile is created.
* @public */ domainIdentifier: string | undefined; /** - *The identifier of the data source.
+ *The identifier of the user for which the user profile is created.
* @public */ - dataSourceIdentifier: string | undefined; + userIdentifier: string | undefined; /** - *The status of the data source.
+ *The user type of the user for which the user profile is created.
* @public */ - status?: DataSourceRunStatus; + userType?: UserType; /** - *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.
A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - nextToken?: string; + clientToken?: string; +} +/** + *The details of an IAM user profile in Amazon DataZone.
+ * @public + */ +export interface IamUserProfileDetails { /** - *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 ARN of an IAM user profile in Amazon DataZone.
* @public */ - maxResults?: number; + arn?: string; } /** - *The details of a data source run.
+ *The single sign-on details of the user profile.
* @public */ -export interface DataSourceRunSummary { +export interface SsoUserProfileDetails { /** - *The identifier of the data source run.
+ *The username included in the single sign-on details of the user profile.
* @public */ - id: string | undefined; + username?: string; /** - *The identifier of the data source of the data source run.
+ *The first name included in the single sign-on details of the user profile.
* @public */ - dataSourceId: string | undefined; + firstName?: string; /** - *The type of the data source run.
+ *The last name included in the single sign-on details of the user profile.
* @public */ - type: DataSourceRunType | undefined; + lastName?: string; +} + +/** + *The details of the user profile in Amazon DataZone.
+ * @public + */ +export type UserProfileDetails = + | UserProfileDetails.IamMember + | UserProfileDetails.SsoMember + | UserProfileDetails.$UnknownMember; +/** + * @public + */ +export namespace UserProfileDetails { /** - *The status of the data source run.
+ *The IAM details included in the user profile details.
* @public */ - status: DataSourceRunStatus | undefined; + export interface IamMember { + iam: IamUserProfileDetails; + sso?: never; + $unknown?: never; + } /** - *The project ID of the data source run.
+ *The single sign-on details included in the user profile details.
* @public */ - projectId: string | undefined; + export interface SsoMember { + iam?: never; + sso: SsoUserProfileDetails; + $unknown?: never; + } /** - *The asset statistics from the data source run.
* @public */ - runStatisticsForAssets?: RunStatisticsForAssets; + export interface $UnknownMember { + iam?: never; + sso?: never; + $unknown: [string, any]; + } + + export interface VisitorThe details of the error message that is returned if the operation cannot be - * successfully completed.
+ *The identifier of the Amazon DataZone domain in which a user profile is created.
* @public */ - errorMessage?: DataSourceErrorMessage; + domainId?: string; /** - *The timestamp of when a data source run was created.
+ *The identifier of the user profile.
* @public */ - createdAt: Date | undefined; + id?: string; /** - *The timestamp of when a data source run was updated.
+ *The type of the user profile.
* @public */ - updatedAt: Date | undefined; + type?: UserProfileType; /** - *The timestamp of when a data source run was started.
+ *The status of the user profile.
* @public */ - startedAt?: Date; + status?: UserProfileStatus; /** - *The timestamp of when a data source run was stopped.
+ *The details of the user profile in Amazon DataZone.
* @public */ - stoppedAt?: Date; + details?: UserProfileDetails; } /** * @public + * @enum */ -export interface ListDataSourceRunsOutput { +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]; + +/** + * @public + */ +export interface DeleteDataProductInput { /** - *The results of the ListDataSourceRuns action.
The ID of the Amazon DataZone domain in which the data product is deleted.
* @public */ - items: DataSourceRunSummary[] | undefined; + domainIdentifier: 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 identifier of the data product that is deleted.
* @public */ - nextToken?: string; + identifier: string | undefined; } /** * @public */ -export interface StartDataSourceRunInput { +export interface DeleteDataProductOutput {} + +/** + * @public + */ +export interface GetDataProductInput { /** - *The identifier of the Amazon DataZone domain in which to start a data source run.
+ *The ID of the domain where the data product lives.
* @public */ domainIdentifier: string | undefined; /** - *The identifier of the data source.
+ *The ID of the data product.
* @public */ - dataSourceIdentifier: string | undefined; + identifier: string | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The revision of the data product.
* @public */ - clientToken?: string; + revision?: string; } /** * @public */ -export interface StartDataSourceRunOutput { +export interface GetDataProductOutput { /** - *The identifier of the Amazon DataZone domain in which to start a data source run.
+ *The ID of the domain where the data product lives.
* @public */ domainId: string | undefined; /** - *The identifier of the data source.
+ *The ID of the data product.
* @public */ - dataSourceId: string | undefined; + id: string | undefined; /** - *The identifier of the data source run.
+ *The revision of the data product.
* @public */ - id: string | undefined; + revision: string | undefined; /** - *The identifier of the project.
+ *The ID of the owning project of the data product.
* @public */ - projectId: string | undefined; + owningProjectId: string | undefined; /** - *The status of the data source run.
+ *The name of the data product.
* @public */ - status: DataSourceRunStatus | undefined; + name: string | undefined; /** - *The type of the data source run.
+ *The status of the data product.
* @public */ - type: DataSourceRunType | undefined; + status: DataProductStatus | undefined; /** - *The configuration snapshot of the data source that is being run.
+ *The description of the data product.
* @public */ - dataSourceConfigurationSnapshot?: string; + description?: string; /** - *Specifies run statistics for assets.
+ *The glossary terms of the data product.
* @public */ - runStatisticsForAssets?: RunStatisticsForAssets; + glossaryTerms?: string[]; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The data assets of the data product.
* @public */ - errorMessage?: DataSourceErrorMessage; + items?: DataProductItem[]; /** - *The timestamp of when data source run was created.
+ *The metadata forms of the data product.
* @public */ - createdAt: Date | undefined; + formsOutput?: FormOutput[]; /** - *The timestamp of when the data source run was updated.
+ *The timestamp at which the data product is created.
* @public */ - updatedAt: Date | undefined; + createdAt?: Date; /** - *The timestamp of when the data source run was started.
+ *The user who created the data product.
* @public */ - startedAt?: Date; + createdBy?: string; /** - *The timestamp of when the data source run was stopped.
+ *The timestamp at which the first revision of the data product is created.
* @public */ - stoppedAt?: Date; + firstRevisionCreatedAt?: Date; + + /** + *The user who created the first revision of the data product.
+ * @public + */ + firstRevisionCreatedBy?: string; } /** - *The activity details of the data source run.
+ *The summary of the listing of the data product.
* @public */ -export interface DataSourceRunActivity { +export interface ListingSummary { /** - *The database included in the data source run activity.
+ *The ID of the data product listing.
* @public */ - database: string | undefined; + listingId?: string; /** - *The identifier of the data source for the data source run activity.
+ *The revision of the data product listing.
* @public */ - dataSourceRunId: string | undefined; + listingRevision?: string; /** - *The technical name included in the data source run activity.
+ *The glossary terms of the data product.
* @public */ - technicalName: string | undefined; + glossaryTerms?: DetailedGlossaryTerm[]; +} +/** + *The data product listing.
+ * @public + */ +export interface DataProductListing { /** - *The status of the asset included in the data source run activity.
+ *The ID of the data product listing.
* @public */ - dataAssetStatus: DataAssetActivityStatus | undefined; + dataProductId?: string; /** - *The project ID included in the data source run activity.
+ *The revision of the data product listing.
* @public */ - projectId: string | undefined; + dataProductRevision?: string; /** - *The identifier of the asset included in the data source run activity.
+ *The timestamp at which the data product listing was created.
* @public */ - dataAssetId?: string; + createdAt?: Date; /** - *The technical description included in the data source run activity.
+ *The metadata forms of the data product listing.
* @public */ - technicalDescription?: string; + forms?: string; /** - *The details of the error message that is returned if the operation cannot be - * successfully completed.
+ *The glossary terms of the data product listing.
* @public */ - errorMessage?: DataSourceErrorMessage; + glossaryTerms?: DetailedGlossaryTerm[]; /** - *The timestamp of when data source run activity was created.
+ *The ID of the owning project of the data product listing.
* @public */ - createdAt: Date | undefined; + owningProjectId?: string; /** - *The timestamp of when data source run activity was updated.
+ *The data assets of the data product listing.
* @public */ - updatedAt: Date | undefined; + items?: ListingSummary[]; } /** + *The additional attributes of the asset of the data product.
* @public */ -export interface DeleteAssetFilterInput { +export interface DataProductListingItemAdditionalAttributes { /** - *The ID of the domain where you want to delete an asset filter.
+ *The metadata forms of the asset of the data product.
* @public */ - domainIdentifier: string | undefined; + forms?: string; +} + +/** + *The results of the data product summary.
+ * @public + */ +export interface ListingSummaryItem { + /** + *The ID of the data product listing.
+ * @public + */ + listingId?: string; /** - *The ID of the data asset.
+ *The revision of the data product listing.
* @public */ - assetIdentifier: string | undefined; + listingRevision?: string; /** - *The ID of the asset filter that you want to delete.
+ *The glossary terms of the data product listing.
* @public */ - identifier: string | undefined; + glossaryTerms?: DetailedGlossaryTerm[]; } /** + *The asset of the data product listing.
* @public */ -export interface DeleteEnvironmentInput { +export interface DataProductListingItem { /** - *The ID of the Amazon DataZone domain in which the environment is deleted.
+ *The ID of the listing.
* @public */ - domainIdentifier: string | undefined; + listingId?: string; /** - *The identifier of the environment that is to be deleted.
+ *The revision of the listing.
* @public */ - identifier: string | undefined; -} + listingRevision?: string; -/** - * @public - */ -export interface DeleteEnvironmentActionInput { /** - *The ID of the Amazon DataZone domain in which an environment action is deleted.
+ *The name of the asset of the data product.
* @public */ - domainIdentifier: string | undefined; + name?: string; /** - *The ID of the environment where an environment action is deleted.
+ *The entity ID of the asset of the asset of the data product.
* @public */ - environmentIdentifier: string | undefined; + entityId?: string; /** - *The ID of the environment action that is deleted.
+ *The revision of the asset of the asset of the data product.
* @public */ - identifier: string | undefined; -} + entityRevision?: string; -/** - * @public - */ -export interface DeleteEnvironmentProfileInput { /** - *The ID of the Amazon DataZone domain in which the environment profile is deleted.
+ *The description of the asset of the asset of the data product.
* @public */ - domainIdentifier: string | undefined; + description?: string; /** - *The ID of the environment profile that is deleted.
+ *The timestamp at which the asset of the data product listing was created.
* @public */ - identifier: string | undefined; -} - -/** - * @public - */ -export interface DeleteProjectInput { + createdAt?: Date; + /** - *The ID of the Amazon DataZone domain in which the project is deleted.
+ *The timestamp at which the listing was created.
* @public */ - domainIdentifier: string | undefined; + listingCreatedBy?: string; /** - *The identifier of the project that is to be deleted.
+ *The user who updated the listing.
* @public */ - identifier: string | undefined; + listingUpdatedBy?: string; /** - *Specifies the optional flag to delete all child entities within the project.
+ *The glossary terms of the asset of the asset of the data product.
* @public */ - skipDeletionCheck?: boolean; -} - -/** - * @public - */ -export interface DeleteProjectOutput {} + glossaryTerms?: DetailedGlossaryTerm[]; -/** - * @public - */ -export interface DeleteProjectMembershipInput { /** - *The ID of the Amazon DataZone domain where project membership is deleted.
+ *The ID of the owning project of the asset of the data product.
* @public */ - domainIdentifier: string | undefined; + owningProjectId?: string; /** - *The ID of the Amazon DataZone project the membership to which is deleted.
+ *The additional attributes of the asset of the data product.
* @public */ - projectIdentifier: string | undefined; + additionalAttributes?: DataProductListingItemAdditionalAttributes; /** - *The project member whose project membership is deleted.
+ *The data of the asset of the data product.
* @public */ - member: Member | undefined; + items?: ListingSummaryItem[]; } /** + *The data product.
* @public */ -export interface DeleteProjectMembershipOutput {} - -/** - * @public - */ -export interface DeleteSubscriptionGrantInput { +export interface DataProductResultItem { /** - *The ID of the Amazon DataZone domain where the subscription grant is deleted.
+ *The ID of the domain where the data product lives.
* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *The ID of the subscription grant that is deleted.
+ *The ID of the data product.
* @public */ - identifier: string | undefined; -} + id: string | undefined; -/** - * @public - */ -export interface DeleteSubscriptionGrantOutput { /** - *The ID of the subscription grant that is deleted.
+ *The name of the data product.
* @public */ - id: string | undefined; + name: string | undefined; /** - *The Amazon DataZone user who created the subscription grant that is deleted.
+ *The ID of the owning project of the data product.
* @public */ - createdBy: string | undefined; + owningProjectId: string | undefined; /** - *The Amazon DataZone user who updated the subscription grant that is deleted.
+ *The description of the data product.
* @public */ - updatedBy?: string; + description?: string; /** - *The ID of the Amazon DataZone domain in which the subscription grant is deleted.
+ *The glossary terms of the data product.
* @public */ - domainId: string | undefined; + glossaryTerms?: string[]; /** - *The timestamp of when the subscription grant that is deleted was created.
+ *The timestamp at which the data product was created.
* @public */ - createdAt: Date | undefined; + createdAt?: Date; /** - *The timestamp of when the subscription grant that is deleted was updated.
+ *The user who created the data product.
* @public */ - updatedAt: Date | undefined; + createdBy?: string; /** - *The ID of the subscription target associated with the subscription grant that is - * deleted.
+ *The timestamp at which first revision of the data product was created.
* @public */ - subscriptionTargetId: string | undefined; + firstRevisionCreatedAt?: Date; /** - *The entity to which the subscription is deleted.
+ *The user who created the first revision of the data product.
* @public */ - grantedEntity: GrantedEntity | undefined; + firstRevisionCreatedBy?: string; +} +/** + *The data product revision.
+ * @public + */ +export interface DataProductRevision { /** - *The status of the subscription grant that is deleted.
+ *The ID of the domain where the data product revision lives.
* @public */ - status: SubscriptionGrantOverallStatus | undefined; + domainId?: string; /** - *The assets for which the subsctiption grant that is deleted gave access.
+ *The ID of the data product revision.
* @public */ - assets?: SubscribedAsset[]; + id?: string; /** - * @deprecated - * - *The identifier of the subsctiption whose subscription grant is to be deleted.
+ *The data product revision.
* @public */ - subscriptionId?: string; -} + revision?: string; -/** - * @public - */ -export interface DeleteSubscriptionRequestInput { /** - *The ID of the Amazon DataZone domain in which the subscription request is deleted.
+ *The timestamp at which the data product revision was created.
* @public */ - domainIdentifier: string | undefined; + createdAt?: Date; /** - *The ID of the subscription request that is deleted.
+ *The user who created the data product revision.
* @public */ - identifier: string | undefined; + createdBy?: string; } /** * @public */ -export interface DeleteSubscriptionTargetInput { +export interface DeleteDataSourceInput { /** - *The ID of the Amazon DataZone domain in which the subscription target is deleted.
+ *The ID of the Amazon DataZone domain in which the data source is deleted.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the Amazon DataZone environment in which the subscription target is deleted.
+ *The identifier of the data source that is deleted.
* @public */ - environmentIdentifier: string | undefined; + identifier: 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; + + /** + *Specifies that the granted permissions are retained in case of a self-subscribe + * functionality failure for a data source.
+ * @public + */ + retainPermissionsOnRevokeFailure?: boolean; } /** * @public * @enum */ -export const TimeSeriesEntityType = { - ASSET: "ASSET", - LISTING: "LISTING", +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 TimeSeriesEntityType = (typeof TimeSeriesEntityType)[keyof typeof TimeSeriesEntityType]; +export type SelfGrantStatus = (typeof SelfGrantStatus)[keyof typeof SelfGrantStatus]; /** + *The details for the self granting status.
* @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; - +export interface SelfGrantStatusDetail { /** - *The ID of the asset for which you want to delete a time series form.
+ *The name of the database used for the data source.
* @public */ - entityIdentifier: string | undefined; + databaseName: string | undefined; /** - *The type of the asset for which you want to delete a time series form.
+ *The name of the schema used in the data source.
* @public */ - entityType: TimeSeriesEntityType | undefined; + schemaName?: string; /** - *The name of the time series form that you want to delete.
+ *The self granting status of the data source.
* @public */ - formName: string | undefined; + status: SelfGrantStatus | undefined; /** - *A unique, case-sensitive identifier to ensure idempotency of the request. This field is - * automatically populated if not provided.
+ *The reason for why the operation failed.
* @public */ - clientToken?: string; + failureCause?: string; } /** + *The details of the self granting status.
* @public */ -export interface DeleteTimeSeriesDataPointsOutput {} - -/** - * @public - */ -export interface DisassociateEnvironmentRoleInput { - /** - *The ID of the Amazon DataZone domain in which an environment role is disassociated.
- * @public - */ - domainIdentifier: string | undefined; - +export interface GlueSelfGrantStatusOutput { /** - *The ID of the environment.
+ *The details for the self granting status for a Glue data source.
* @public */ - environmentIdentifier: string | undefined; + selfGrantStatusDetails: SelfGrantStatusDetail[] | undefined; +} +/** + *The details for the self granting status for an Amazon Redshift data source.
+ * @public + */ +export interface RedshiftSelfGrantStatusOutput { /** - *The ARN of the environment role.
+ *The details for the self granting status for an Amazon Redshift data source.
* @public */ - environmentRoleArn: string | undefined; + selfGrantStatusDetails: SelfGrantStatusDetail[] | undefined; } /** + *The details for the self granting status for a data source.
* @public */ -export interface DisassociateEnvironmentRoleOutput {} +export type SelfGrantStatusOutput = + | SelfGrantStatusOutput.GlueSelfGrantStatusMember + | SelfGrantStatusOutput.RedshiftSelfGrantStatusMember + | SelfGrantStatusOutput.$UnknownMember; /** * @public */ -export interface DeleteDomainInput { - /** - *The identifier of the Amazon Web Services domain that is to be deleted.
- * @public - */ - identifier: string | undefined; - - /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
- * @public - */ - clientToken?: string; - +export namespace SelfGrantStatusOutput { /** - *Specifies the optional flag to delete all child entities within the domain.
+ *The details for the self granting status for a Glue data source.
* @public */ - skipDeletionCheck?: boolean; -} + export interface GlueSelfGrantStatusMember { + glueSelfGrantStatus: GlueSelfGrantStatusOutput; + redshiftSelfGrantStatus?: never; + $unknown?: never; + } -/** - * @public - */ -export interface DeleteDomainOutput { /** - *The status of the domain.
+ *The details for the self granting status for an Amazon Redshift data source.
* @public */ - status: DomainStatus | undefined; -} - -/** - * @public - */ -export interface GetDomainInput { + export interface RedshiftSelfGrantStatusMember { + glueSelfGrantStatus?: never; + redshiftSelfGrantStatus: RedshiftSelfGrantStatusOutput; + $unknown?: never; + } + /** - *The identifier of the specified Amazon DataZone domain.
* @public */ - identifier: string | undefined; + export interface $UnknownMember { + glueSelfGrantStatus?: never; + redshiftSelfGrantStatus?: never; + $unknown: [string, any]; + } + + export interface VisitorThe identifier of the specified Amazon DataZone domain.
+ *The ID of the data source that is deleted.
* @public */ id: string | undefined; /** - *The name of the Amazon DataZone domain.
- * @public - */ - name?: string; - - /** - *The description of the Amazon DataZone domain.
+ *The status of this data source.
* @public */ - description?: string; + status?: DataSourceStatus; /** - *The single sing-on option of the specified Amazon DataZone domain.
+ *The type of this data source.
* @public */ - singleSignOn?: SingleSignOn; + type?: string; /** - *The domain execution role with which the Amazon DataZone domain is created.
+ *The name of the data source that is deleted.
* @public */ - domainExecutionRole: string | undefined; + name: string | undefined; /** - *The ARN of the specified Amazon DataZone domain.
+ *The description of the data source that is deleted.
* @public */ - arn?: string; + description?: string; /** - *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 ID of the Amazon DataZone domain in which the data source is deleted.
* @public */ - kmsKeyIdentifier?: string; + domainId: string | undefined; /** - *The status of the specified Amazon DataZone domain.
+ *The ID of the project in which this data source exists and from which it's + * deleted.
* @public */ - status: DomainStatus | undefined; + projectId: string | undefined; /** - *The URL of the data portal for this Amazon DataZone domain.
+ *The ID of the environemnt associated with this data source.
* @public */ - portalUrl?: string; + environmentId: string | undefined; /** - *The timestamp of when the Amazon DataZone domain was created.
+ *The configuration of the data source that is deleted.
* @public */ - createdAt?: Date; + configuration?: DataSourceConfigurationOutput; /** - *The timestamp of when the Amazon DataZone domain was last updated.
+ *The enable setting of the data source that specifies whether the data source is enabled + * or disabled.
* @public */ - lastUpdatedAt?: Date; + enableSetting?: EnableSetting; /** - *The tags specified for the Amazon DataZone domain.
+ *Specifies whether the assets that this data source creates in the inventory are to be + * also automatically published to the catalog.
* @public */ - tags?: RecordThe status of the data source.
+ *The asset data forms associated with this data source.
* @public */ - status?: DomainStatus; + assetFormsOutput?: FormOutput[]; /** - *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 schedule of runs for this data source.
* @public */ - maxResults?: number; + schedule?: ScheduleConfiguration; /** - *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 status of the last run of this data source.
* @public */ - nextToken?: string; -} + lastRunStatus?: DataSourceRunStatus; -/** - *A summary of a Amazon DataZone domain.
- * @public - */ -export interface DomainSummary { /** - *The ID of the Amazon DataZone domain.
+ *The timestamp of when the data source was last run.
* @public */ - id: string | undefined; + lastRunAt?: Date; /** - *A name of an Amazon DataZone domain.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - name: string | undefined; + lastRunErrorMessage?: DataSourceErrorMessage; /** - *A description of an Amazon DataZone domain.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - description?: string; + errorMessage?: DataSourceErrorMessage; /** - *The ARN of the Amazon DataZone domain.
+ *The timestamp of when this data source was created.
* @public */ - arn: string | undefined; + createdAt?: Date; /** - *The identifier of the Amazon Web Services account that manages the domain.
+ *The timestamp of when this data source was updated.
* @public */ - managedAccountId: string | undefined; + updatedAt?: Date; /** - *The status of the Amazon DataZone domain.
+ *Specifies the status of the self-granting functionality.
* @public */ - status: DomainStatus | undefined; + selfGrantStatus?: SelfGrantStatusOutput; /** - *The data portal URL for the Amazon DataZone domain.
+ *Specifies that the granted permissions are retained in case of a self-subscribe + * functionality failure for a data source.
* @public */ - portalUrl?: string; + retainPermissionsOnRevokeFailure?: boolean; +} +/** + * @public + */ +export interface GetDataSourceInput { /** - *A timestamp of when a Amazon DataZone domain was created.
+ *The ID of the Amazon DataZone domain in which the data source exists.
* @public */ - createdAt: Date | undefined; + domainIdentifier: string | undefined; /** - *A timestamp of when a Amazon DataZone domain was last updated.
+ *The ID of the Amazon DataZone data source.
* @public */ - lastUpdatedAt?: Date; + identifier: string | undefined; } /** * @public */ -export interface ListDomainsOutput { +export interface GetDataSourceOutput { /** - *The results of the ListDomains action.
The ID of the data source.
* @public */ - items: DomainSummary[] | undefined; + id: 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 status of the data source.
* @public */ - nextToken?: string; -} + status?: DataSourceStatus; -/** - * @public - */ -export interface UpdateDomainInput { /** - *The ID of the Amazon Web Services domain that is to be updated.
+ *The type of the data source.
* @public */ - identifier: string | undefined; + type?: string; /** - *The description to be updated as part of the UpdateDomain action.
The name of the data source.
* @public */ - description?: string; + name: string | undefined; /** - *The single sign-on option to be updated as part of the UpdateDomain
- * action.
The description of the data source.
* @public */ - singleSignOn?: SingleSignOn; + description?: string; /** - *The domain execution role to be updated as part of the UpdateDomain
- * action.
The ID of the Amazon DataZone domain in which the data source exists.
* @public */ - domainExecutionRole?: string; + domainId: string | undefined; /** - *The name to be updated as part of the UpdateDomain action.
The ID of the project where the data source creates and publishes assets.
* @public */ - name?: string; + projectId: string | undefined; /** - *A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.
+ *The ID of the environment where this data source creates and publishes assets,
* @public */ - clientToken?: string; -} + environmentId: string | undefined; -/** - * @public - */ -export interface UpdateDomainOutput { /** - *The identifier of the Amazon DataZone domain.
+ *The configuration of the data source.
* @public */ - id: string | undefined; + configuration?: DataSourceConfigurationOutput; /** - *The description to be updated as part of the UpdateDomain action.
The recommendation configuration of the data source.
* @public */ - description?: string; + recommendation?: RecommendationConfiguration; /** - *The single sign-on option of the Amazon DataZone domain.
+ *Specifies whether this data source is enabled or not.
* @public */ - singleSignOn?: SingleSignOn; + enableSetting?: EnableSetting; /** - *The domain execution role to be updated as part of the UpdateDomain
- * action.
Specifies whether the assets that this data source creates in the inventory are to be + * also automatically published to the catalog.
* @public */ - domainExecutionRole?: string; + publishOnImport?: boolean; /** - *The name to be updated as part of the UpdateDomain action.
The metadata forms attached to the assets created by this data source.
* @public */ - name?: string; + assetFormsOutput?: FormOutput[]; /** - *Specifies the timestamp of when the domain was last updated.
+ *The schedule of the data source runs.
* @public */ - lastUpdatedAt?: Date; -} + schedule?: ScheduleConfiguration; -/** - * @public - */ -export interface DeleteEnvironmentBlueprintConfigurationInput { /** - *The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.
+ *The status of the last run of the data source.
* @public */ - domainIdentifier: string | undefined; + lastRunStatus?: DataSourceRunStatus; /** - *The ID of the blueprint the configuration of which is deleted.
+ *The timestamp of the last run of the data source.
* @public */ - environmentBlueprintIdentifier: string | undefined; -} - -/** - * @public - */ -export interface DeleteEnvironmentBlueprintConfigurationOutput {} + lastRunAt?: Date; -/** - * @public - */ -export interface GetEnvironmentBlueprintConfigurationInput { /** - *The ID of the Amazon DataZone domain where this blueprint exists.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - domainIdentifier: string | undefined; + lastRunErrorMessage?: DataSourceErrorMessage; /** - *He ID of the blueprint.
+ *The number of assets created by the data source during its last run.
* @public */ - environmentBlueprintIdentifier: string | undefined; -} + lastRunAssetCount?: number; -/** - *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.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - locationRegistrationRole?: string; + errorMessage?: DataSourceErrorMessage; /** - *Specifies certain Amazon S3 locations if you do not want Amazon DataZone to - * automatically register them in hybrid mode.
+ *The timestamp of when the data source was created.
* @public */ - locationRegistrationExcludeS3Locations?: string[]; -} - -/** - *The provisioning configuration of the blueprint.
- * @public - */ -export type ProvisioningConfiguration = - | ProvisioningConfiguration.LakeFormationConfigurationMember - | ProvisioningConfiguration.$UnknownMember; + createdAt?: Date; -/** - * @public - */ -export namespace ProvisioningConfiguration { /** - *The Lake Formation configuration of the Data Lake blueprint.
+ *The timestamp of when the data source was updated.
* @public */ - export interface LakeFormationConfigurationMember { - lakeFormationConfiguration: LakeFormationConfiguration; - $unknown?: never; - } + updatedAt?: Date; /** + *Specifies the status of the self-granting functionality.
* @public */ - export interface $UnknownMember { - lakeFormationConfiguration?: never; - $unknown: [string, any]; - } - - export interface VisitorThe ID of the Amazon DataZone domain where this blueprint exists.
- * @public - */ - domainId: string | undefined; - +export interface ListDataSourcesInput { /** - *The ID of the blueprint.
+ *The identifier of the Amazon DataZone domain in which to list the data sources.
* @public */ - environmentBlueprintId: string | undefined; + domainIdentifier: string | undefined; /** - *The ARN of the provisioning role with which this blueprint is created.
+ *The identifier of the project in which to list data sources.
* @public */ - provisioningRoleArn?: string; + projectIdentifier: string | undefined; /** - *The ARN of the manage access role with which this blueprint is created.
+ *The identifier of the environment in which to list the data sources.
* @public */ - manageAccessRoleArn?: string; + environmentIdentifier?: string; /** - *The Amazon Web Services regions in which this blueprint is enabled.
+ *The type of the data source.
* @public */ - enabledRegions?: string[]; + type?: string; /** - *The regional parameters of the blueprint.
+ *The status of the data source.
* @public */ - regionalParameters?: RecordThe timestamp of when this blueprint was created.
+ *The name of the data source.
* @public */ - createdAt?: Date; + name?: string; /** - *The timestamp of when this blueprint was upated.
+ *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 provisioning configuration of a blueprint.
+ *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 ListEnvironmentBlueprintConfigurationsInput { +export interface DataSourceSummary { /** - *The identifier of the Amazon DataZone domain.
+ *The ID of the Amazon DataZone domain in which the data source exists.
* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *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 ID of the environment in which the data source exists.
* @public */ - maxResults?: number; + environmentId: 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 ID of the data source.
* @public */ - nextToken?: string; -} + dataSourceId: string | undefined; -/** - *The configuration details of an environment blueprint.
- * @public - */ -export interface EnvironmentBlueprintConfigurationItem { /** - *The identifier of the Amazon DataZone domain in which an environment blueprint exists.
+ *The name of the data source.
* @public */ - domainId: string | undefined; + name: string | undefined; /** - *The identifier of the environment blueprint.
+ *The type of the data source.
* @public */ - environmentBlueprintId: string | undefined; + type: string | undefined; /** - *The ARN of the provisioning role specified in the environment blueprint - * configuration.
+ *The status of the data source.
* @public */ - provisioningRoleArn?: string; + status: DataSourceStatus | undefined; /** - *The ARN of the manage access role specified in the environment blueprint - * configuration.
+ *Specifies whether the data source is enabled.
* @public */ - manageAccessRoleArn?: string; + enableSetting?: EnableSetting; /** - *The enabled Amazon Web Services Regions specified in a blueprint configuration.
+ *The details of the schedule of the data source runs.
* @public */ - enabledRegions?: string[]; + schedule?: ScheduleConfiguration; /** - *The regional parameters of the environment blueprint.
+ *The status of the last data source run.
* @public */ - regionalParameters?: RecordThe timestamp of when an environment blueprint was created.
+ *The timestamp of when the data source run was last performed.
* @public */ - createdAt?: Date; + lastRunAt?: Date; + + /** + *The details of the error message that is returned if the operation cannot be + * successfully completed.
+ * @public + */ + lastRunErrorMessage?: DataSourceErrorMessage; /** - *The timestamp of when the environment blueprint was updated.
+ *The count of the assets created during the last data source run.
* @public */ - updatedAt?: Date; + lastRunAssetCount?: number; /** - *The provisioning configuration of a blueprint.
+ *The timestamp of when the data source was created.
+ * @public + */ + createdAt?: Date; + + /** + *The timestamp of when the data source was updated.
* @public */ - provisioningConfigurations?: ProvisioningConfiguration[]; + updatedAt?: Date; } /** * @public */ -export interface ListEnvironmentBlueprintConfigurationsOutput { +export interface ListDataSourcesOutput { /** - *The results of the ListEnvironmentBlueprintConfigurations action.
The results of the ListDataSources action.
When the number of blueprint configurations is greater than the default value for the + *
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 configurations, the response
+ * 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
- * ListEnvironmentBlueprintConfigurations to list the next set of
- * configurations.
NextToken value in a subsequent call to ListDataSources to
+ * list the next set of data sources.
* @public
*/
nextToken?: string;
@@ -9376,1018 +8916,1084 @@ export interface ListEnvironmentBlueprintConfigurationsOutput {
/**
* @public
*/
-export interface PutEnvironmentBlueprintConfigurationInput {
+export interface UpdateDataSourceInput {
/**
- * The identifier of the Amazon DataZone domain.
+ *The identifier of the domain in which to update a data source.
* @public */ domainIdentifier: string | undefined; /** - *The identifier of the environment blueprint.
+ *The identifier of the data source to be updated.
* @public */ - environmentBlueprintIdentifier: string | undefined; + identifier: string | undefined; + + /** + *The name to be updated as part of the UpdateDataSource action.
The description to be updated as part of the UpdateDataSource
+ * action.
The enable setting to be updated as part of the UpdateDataSource
+ * action.
The publish on import setting to be updated as part of the UpdateDataSource
+ * action.
The ARN of the provisioning role.
+ *The asset forms to be updated as part of the UpdateDataSource
+ * action.
The ARN of the manage access role.
+ *The schedule to be updated as part of the UpdateDataSource action.
Specifies the enabled Amazon Web Services Regions.
+ *The configuration to be updated as part of the UpdateDataSource
+ * action.
The regional parameters in the environment blueprint.
+ *The recommendation to be updated as part of the UpdateDataSource
+ * action.
The provisioning configuration of a blueprint.
+ *Specifies that the granted permissions are retained in case of a self-subscribe + * functionality failure for a data source.
* @public */ - provisioningConfigurations?: ProvisioningConfiguration[]; + retainPermissionsOnRevokeFailure?: boolean; } /** * @public */ -export interface PutEnvironmentBlueprintConfigurationOutput { +export interface UpdateDataSourceOutput { /** - *The identifier of the Amazon DataZone domain.
+ *The identifier of the data source to be updated.
* @public */ - domainId: string | undefined; + id: string | undefined; /** - *The identifier of the environment blueprint.
+ *The status to be updated as part of the UpdateDataSource action.
The ARN of the provisioning role.
+ *The type to be updated as part of the UpdateDataSource action.
The ARN of the manage access role.
+ *The name to be updated as part of the UpdateDataSource action.
Specifies the enabled Amazon Web Services Regions.
+ *The description to be updated as part of the UpdateDataSource
+ * action.
The regional parameters in the environment blueprint.
+ *The identifier of the Amazon DataZone domain in which a data source is to be updated.
* @public */ - regionalParameters?: RecordThe timestamp of when the environment blueprint was created.
+ *The identifier of the project where data source is to be updated.
* @public */ - createdAt?: Date; + projectId: string | undefined; /** - *The timestamp of when the environment blueprint was updated.
+ *The identifier of the environment in which a data source is to be updated.
* @public */ - updatedAt?: Date; + environmentId: string | undefined; /** - *The provisioning configuration of a blueprint.
+ *The configuration to be updated as part of the UpdateDataSource
+ * action.
The ID of the Amazon DataZone domain in which the metadata form type is deleted.
+ *The recommendation to be updated as part of the UpdateDataSource
+ * action.
The ID of the metadata form type that is deleted.
+ *The enable setting to be updated as part of the UpdateDataSource
+ * action.
The ID of the Amazon DataZone domain in which this metadata form type exists.
+ *The publish on import setting to be updated as part of the UpdateDataSource
+ * action.
The ID of the metadata form type.
+ *The asset forms to be updated as part of the UpdateDataSource
+ * action.
The revision of this metadata form type.
+ *The schedule to be updated as part of the UpdateDataSource action.
The details of the import of the metadata form type.
- * @public - */ -export interface Import { /** - *The name of the import.
+ *The last run status of the data source.
* @public */ - name: string | undefined; + lastRunStatus?: DataSourceRunStatus; /** - *The revision of the import.
+ *The timestamp of when the data source was last run.
* @public */ - revision: string | undefined; -} + lastRunAt?: Date; + + /** + *The last run error message of the data source.
+ * @public + */ + lastRunErrorMessage?: DataSourceErrorMessage; -/** - * @public - */ -export interface GetFormTypeOutput { /** - *The ID of the Amazon DataZone domain in which this metadata form type exists.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - domainId: string | undefined; + errorMessage?: DataSourceErrorMessage; /** - *The name of the metadata form type.
+ *The timestamp of when the data source was updated.
* @public */ - name: string | undefined; + createdAt?: Date; /** - *The revision of the metadata form type.
+ *The timestamp of when the data source was updated.
* @public */ - revision: string | undefined; + updatedAt?: Date; /** - *The model of the metadata form type.
+ *Specifies the status of the self-granting functionality.
* @public */ - model: Model | undefined; + selfGrantStatus?: SelfGrantStatusOutput; /** - *The ID of the project that owns this metadata form type.
+ *Specifies that the granted permissions are retained in case of a self-subscribe + * functionality failure for a data source.
* @public */ - owningProjectId?: string; + retainPermissionsOnRevokeFailure?: boolean; +} + +/** + * @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 ID of the Amazon DataZone domain in which the metadata form type was originally - * created.
+ *The ID of the domain in which this data source run was performed.
* @public */ - originDomainId?: string; + domainIdentifier: string | undefined; /** - *The ID of the project in which this metadata form type was originally created.
+ *The ID of the data source run.
* @public */ - originProjectId?: string; + identifier: string | undefined; +} +/** + *The asset statistics from the data source run.
+ * @public + */ +export interface RunStatisticsForAssets { /** - *The status of the metadata form type.
+ *The added statistic for the data source run.
The timestamp of when this metadata form type was created.
+ *The updated statistic for the data source run.
The Amazon DataZone user who created this metadata form type.
+ *The unchanged statistic for the data source run.
The description of the metadata form type.
+ *The skipped statistic for the data source run.
The imports of the metadata form type.
+ *The failed statistic for the data source run.
The ID of the domain where you want to get 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.
+ *The ID of the data source run.
* @public */ - identifier: string | undefined; -} + id: string | undefined; -/** - * @public - */ -export interface GetEnvironmentInput { /** - *The ID of the Amazon DataZone domain where the environment exists.
+ *The ID of the project in which this data source run occured.
* @public */ - domainIdentifier: string | undefined; + projectId: string | undefined; /** - *The ID of the Amazon DataZone environment.
+ *The status of this data source run.
* @public */ - identifier: string | undefined; -} + status: DataSourceRunStatus | undefined; -/** - * @public - */ -export interface GetEnvironmentOutput { /** - *The ID of the Amazon DataZone project in which this environment is created.
+ *The type of this data source run.
* @public */ - projectId: string | undefined; + type: DataSourceRunType | undefined; /** - *The ID of the environment.
+ *The configuration snapshot of the data source run.
* @public */ - id?: string; + dataSourceConfigurationSnapshot?: string; /** - *The ID of the Amazon DataZone domain where the environment exists.
+ *The asset statistics from this data source run.
* @public */ - domainId: string | undefined; + runStatisticsForAssets?: RunStatisticsForAssets; /** - *The Amazon DataZone user who created the environment.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - createdBy: string | undefined; + errorMessage?: DataSourceErrorMessage; /** - *The timestamp of when the environment was created.
+ *The timestamp of when the data source run was created.
* @public */ - createdAt?: Date; + createdAt: Date | undefined; /** - *The timestamp of when this environment was updated.
+ *The timestamp of when this data source run was updated.
* @public */ - updatedAt?: Date; + updatedAt: Date | undefined; /** - *The name of the environment.
+ *The timestamp of when this data source run started.
* @public */ - name: string | undefined; + startedAt?: Date; /** - *The description of the environment.
+ *The timestamp of when this data source run stopped.
* @public */ - description?: string; + stoppedAt?: Date; +} +/** + * @public + */ +export interface ListDataSourceRunsInput { /** - *The ID of the environment profile with which the environment is created.
+ *The identifier of the Amazon DataZone domain in which to invoke the
+ * ListDataSourceRuns action.
The ID of the Amazon Web Services account where the environment exists.
+ *The identifier of the data source.
* @public */ - awsAccountId?: string; + dataSourceIdentifier: string | undefined; /** - *The Amazon Web Services region where the environment exists.
+ *The status of the data source.
* @public */ - awsAccountRegion?: string; + status?: DataSourceRunStatus; /** - *The provider of this Amazon DataZone environment.
+ *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 provisioned resources of this Amazon DataZone environment.
+ *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 DataSourceRunSummary { /** - *The status of this Amazon DataZone environment.
+ *The identifier of the data source run.
* @public */ - status?: EnvironmentStatus; + id: string | undefined; /** - *The actions of the environment.
+ *The identifier of the data source of the data source run.
* @public */ - environmentActions?: ConfigurableEnvironmentAction[]; + dataSourceId: string | undefined; /** - *The business glossary terms that can be used in this environment.
+ *The type of the data source run.
* @public */ - glossaryTerms?: string[]; + type: DataSourceRunType | undefined; /** - *The user parameters of this Amazon DataZone environment.
+ *The status of the data source run.
* @public */ - userParameters?: CustomParameter[]; + status: DataSourceRunStatus | undefined; /** - *The details of the last deployment of the environment.
+ *The project ID of the data source run.
* @public */ - lastDeployment?: Deployment; + projectId: string | undefined; /** - *The provisioning properties of this Amazon DataZone environment.
+ *The asset statistics from the data source run.
* @public */ - provisioningProperties?: ProvisioningProperties; + runStatisticsForAssets?: RunStatisticsForAssets; /** - *The deployment properties of the environment.
+ *The details of the error message that is returned if the operation cannot be + * successfully completed.
* @public */ - deploymentProperties?: DeploymentProperties; + errorMessage?: DataSourceErrorMessage; /** - *The blueprint with which the environment is created.
+ *The timestamp of when a data source run was created.
* @public */ - environmentBlueprintId?: string; -} + createdAt: Date | undefined; -/** - * @public - */ -export interface GetEnvironmentActionInput { /** - *The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is
- * invoked.
The timestamp of when a data source run was updated.
* @public */ - domainIdentifier: string | undefined; + updatedAt: Date | undefined; /** - *The environment ID of the environment action.
+ *The timestamp of when a data source run was started.
* @public */ - environmentIdentifier: string | undefined; + startedAt?: Date; /** - *The ID of the environment action
+ *The timestamp of when a data source run was stopped.
* @public */ - identifier: string | undefined; + stoppedAt?: Date; } /** * @public */ -export interface GetEnvironmentActionOutput { - /** - *The ID of the Amazon DataZone domain in which the environment action lives.
- * @public - */ - domainId: string | undefined; - +export interface ListDataSourceRunsOutput { /** - *The environment ID of the environment action.
+ *The results of the ListDataSourceRuns action.
The ID of the environment action.
+ *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 name of the environment action.
+ *The identifier of the Amazon DataZone domain in which to start a data source run.
* @public */ - name: string | undefined; + domainIdentifier: string | undefined; /** - *The parameters of the environment action.
+ *The identifier of the data source.
* @public */ - parameters: ActionParameters | undefined; + dataSourceIdentifier: string | undefined; /** - *The description of the environment action.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - description?: string; + clientToken?: string; } /** * @public */ -export interface GetEnvironmentBlueprintInput { +export interface StartDataSourceRunOutput { /** - *The identifier of the domain in which this blueprint exists.
+ *The identifier of the Amazon DataZone domain in which to start a data source run.
* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *The ID of this Amazon DataZone blueprint.
+ *The identifier of the data source.
* @public */ - identifier: string | undefined; -} + dataSourceId: string | undefined; -/** - * @public - */ -export interface GetEnvironmentBlueprintOutput { /** - *The ID of this Amazon DataZone blueprint.
+ *The identifier of the data source run.
* @public */ id: string | undefined; /** - *The name of this Amazon DataZone blueprint.
+ *The identifier of the project.
+ * @public + */ + projectId: string | undefined; + + /** + *The status of the data source run.
* @public */ - name: string | undefined; + status: DataSourceRunStatus | undefined; /** - *The description of this Amazon DataZone blueprint.
+ *The type of the data source run.
* @public */ - description?: string; + type: DataSourceRunType | undefined; /** - *The provider of this Amazon DataZone blueprint.
+ *The configuration snapshot of the data source that is being run.
* @public */ - provider: string | undefined; + dataSourceConfigurationSnapshot?: string; /** - *The provisioning properties of this Amazon DataZone blueprint.
+ *Specifies run statistics for assets.
* @public */ - provisioningProperties: ProvisioningProperties | undefined; + runStatisticsForAssets?: RunStatisticsForAssets; /** - *The deployment properties of this Amazon DataZone blueprint.
+ *Specifies the error message that is returned if the operation cannot be successfully + * completed.
* @public */ - deploymentProperties?: DeploymentProperties; + errorMessage?: DataSourceErrorMessage; /** - *The user parameters of this blueprint.
+ *The timestamp of when data source run was created.
* @public */ - userParameters?: CustomParameter[]; + createdAt: Date | undefined; /** - *The glossary terms attached to this Amazon DataZone blueprint.
+ *The timestamp of when the data source run was updated.
* @public */ - glossaryTerms?: string[]; + updatedAt: Date | undefined; /** - *A timestamp of when this blueprint was created.
+ *The timestamp of when the data source run was started.
* @public */ - createdAt?: Date; + startedAt?: Date; /** - *The timestamp of when this blueprint was updated.
+ *The timestamp of when the data source run was stopped.
* @public */ - updatedAt?: Date; + stoppedAt?: Date; } /** + *The activity details of the data source run.
* @public */ -export interface GetEnvironmentCredentialsInput { +export interface DataSourceRunActivity { /** - *The ID of the Amazon DataZone domain in which this environment and its credentials - * exist.
+ *The database included in the data source run activity.
* @public */ - domainIdentifier: string | undefined; + database: string | undefined; /** - *The ID of the environment whose credentials this operation gets.
+ *The identifier of the data source for the data source run activity.
* @public */ - environmentIdentifier: string | undefined; -} + dataSourceRunId: string | undefined; -/** - * @public - */ -export interface GetEnvironmentCredentialsOutput { /** - *The access key ID of the environment.
+ *The technical name included in the data source run activity.
* @public */ - accessKeyId?: string; + technicalName: string | undefined; /** - *The secret access key of the environment credentials.
+ *The status of the asset included in the data source run activity.
* @public */ - secretAccessKey?: string; + dataAssetStatus: DataAssetActivityStatus | undefined; /** - *The session token of the environment credentials.
+ *The project ID included in the data source run activity.
* @public */ - sessionToken?: string; + projectId: string | undefined; /** - *The expiration timestamp of the environment credentials.
+ *The identifier of the asset included in the data source run activity.
* @public */ - expiration?: Date; -} + dataAssetId?: string; -/** - * @public - */ -export interface GetEnvironmentProfileInput { /** - *The ID of the Amazon DataZone domain in which this environment profile exists.
+ *The technical description included in the data source run activity.
* @public */ - domainIdentifier: string | undefined; + technicalDescription?: string; /** - *The ID of the environment profile.
+ *The details of the error message that is returned if the operation cannot be + * successfully completed.
* @public */ - identifier: string | undefined; -} + errorMessage?: DataSourceErrorMessage; -/** - * @public - */ -export interface GetEnvironmentProfileOutput { /** - *The ID of the environment profile.
+ *The timestamp of when data source run activity was created.
* @public */ - id: string | undefined; + createdAt: Date | undefined; /** - *The ID of the Amazon DataZone domain in which this environment profile exists.
+ *The timestamp of when data source run activity was updated.
* @public */ - domainId: string | undefined; + updatedAt: Date | undefined; +} +/** + * @public + */ +export interface DeleteAssetFilterInput { /** - *The ID of the Amazon Web Services account where this environment profile exists.
+ *The ID of the domain where you want to delete an asset filter.
* @public */ - awsAccountId?: string; + domainIdentifier: string | undefined; /** - *The Amazon Web Services region where this environment profile exists.
+ *The ID of the data asset.
* @public */ - awsAccountRegion?: string; + assetIdentifier: string | undefined; /** - *The Amazon DataZone user who created this environment profile.
+ *The ID of the asset filter that you want to delete.
* @public */ - createdBy: string | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface DeleteEnvironmentInput { /** - *The timestamp of when this environment profile was created.
+ *The ID of the Amazon DataZone domain in which the environment is deleted.
* @public */ - createdAt?: Date; + domainIdentifier: string | undefined; /** - *The timestamp of when this environment profile was upated.
+ *The identifier of the environment that is to be deleted.
* @public */ - updatedAt?: Date; + identifier: string | undefined; +} +/** + * @public + */ +export interface DeleteEnvironmentActionInput { /** - *The name of the environment profile.
+ *The ID of the Amazon DataZone domain in which an environment action is deleted.
* @public */ - name: string | undefined; + domainIdentifier: string | undefined; /** - *The description of the environment profile.
+ *The ID of the environment where an environment action is deleted.
* @public */ - description?: string; + environmentIdentifier: string | undefined; /** - *The ID of the blueprint with which this environment profile is created.
+ *The ID of the environment action that is deleted.
* @public */ - environmentBlueprintId: string | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface DeleteEnvironmentProfileInput { /** - *The ID of the Amazon DataZone project in which this environment profile is created.
+ *The ID of the Amazon DataZone domain in which the environment profile is deleted.
* @public */ - projectId?: string; + domainIdentifier: string | undefined; /** - *The user parameters of the environment profile.
+ *The ID of the environment profile that is deleted.
* @public */ - userParameters?: CustomParameter[]; + identifier: string | undefined; } /** * @public */ -export interface GetGroupProfileInput { +export interface DeleteProjectInput { /** - *The identifier of the Amazon DataZone domain in which the group profile exists.
+ *The ID of the Amazon DataZone domain in which the project is deleted.
* @public */ domainIdentifier: string | undefined; /** - *The identifier of the group profile.
+ *The identifier of the project that is to be deleted.
* @public */ - groupIdentifier: string | undefined; + identifier: string | undefined; + + /** + *Specifies the optional flag to delete all child entities within the project.
+ * @public + */ + skipDeletionCheck?: boolean; } /** * @public */ -export interface GetGroupProfileOutput { - /** - *The identifier of the Amazon DataZone domain in which the group profile exists.
- * @public - */ - domainId?: string; +export interface DeleteProjectOutput {} +/** + * @public + */ +export interface DeleteProjectMembershipInput { /** - *The identifier of the group profile.
+ *The ID of the Amazon DataZone domain where project membership is deleted.
* @public */ - id?: string; + domainIdentifier: string | undefined; /** - *The identifier of the group profile.
+ *The ID of the Amazon DataZone project the membership to which is deleted.
* @public */ - status?: GroupProfileStatus; + projectIdentifier: string | undefined; /** - *The name of the group for which the specified group profile exists.
+ *The project member whose project membership is deleted.
* @public */ - groupName?: string; + member: Member | undefined; } /** * @public */ -export interface GetIamPortalLoginUrlInput { - /** - *the ID of the Amazon DataZone domain the data portal of which you want to get.
- * @public - */ - domainIdentifier: string | undefined; -} +export interface DeleteProjectMembershipOutput {} /** * @public */ -export interface GetIamPortalLoginUrlOutput { +export interface DeleteSubscriptionGrantInput { /** - *The data portal URL of the specified Amazon DataZone domain.
+ *The ID of the Amazon DataZone domain where the subscription grant is deleted.
* @public */ - authCodeUrl?: string; + domainIdentifier: string | undefined; /** - *The ID of the user profile.
+ *The ID of the subscription grant that is deleted.
* @public */ - userProfileId: string | undefined; + identifier: string | undefined; } /** * @public */ -export interface GetLineageNodeInput { +export interface DeleteSubscriptionGrantOutput { /** - *The ID of the domain in which you want to get the data lineage node.
+ *The ID of the subscription grant that is deleted.
* @public */ - domainIdentifier: string | undefined; + id: string | 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 Amazon DataZone user who created the subscription grant that is deleted.
* @public */ - identifier: string | undefined; + createdBy: string | undefined; /** - *The event time stamp for which you want to get the data lineage node.
+ *The Amazon DataZone user who updated the subscription grant that is deleted.
* @public */ - eventTimestamp?: Date; -} + updatedBy?: string; -/** - *The reference details for the data lineage node.
- * @public - */ -export interface LineageNodeReference { /** - *The ID of the data lineage node.
+ *The ID of the Amazon DataZone domain in which the subscription grant is deleted.
* @public */ - id?: string; + domainId: string | undefined; /** - *The event timestamp of the data lineage node.
+ *The timestamp of when the subscription grant that is deleted was created.
* @public */ - eventTimestamp?: Date; -} + createdAt: Date | undefined; -/** - * @public - */ -export interface GetLineageNodeOutput { /** - *The ID of the domain where you're getting the data lineage node.
+ *The timestamp of when the subscription grant that is deleted was updated.
* @public */ - domainId: string | undefined; + updatedAt: Date | undefined; + + /** + *The ID of the subscription target associated with the subscription grant that is + * deleted.
+ * @public + */ + subscriptionTargetId: string | undefined; /** - *The name of the data lineage node.
+ *The entity to which the subscription is deleted.
* @public */ - name?: string; + grantedEntity: GrantedEntity | undefined; /** - *The description of the data lineage node.
+ *The status of the subscription grant that is deleted.
* @public */ - description?: string; + status: SubscriptionGrantOverallStatus | undefined; /** - *The timestamp at which the data lineage node was created.
+ *The assets for which the subsctiption grant that is deleted gave access.
* @public */ - createdAt?: Date; + assets?: SubscribedAsset[]; /** - *The user who created the data lineage node.
+ * @deprecated + * + *The identifier of the subsctiption whose subscription grant is to be deleted.
* @public */ - createdBy?: string; + subscriptionId?: string; +} +/** + * @public + */ +export interface DeleteSubscriptionRequestInput { /** - *The timestamp at which the data lineage node was updated.
+ *The ID of the Amazon DataZone domain in which the subscription request is deleted.
* @public */ - updatedAt?: Date; + domainIdentifier: string | undefined; /** - *The user who updated the data lineage node.
+ *The ID of the subscription request that is deleted.
* @public */ - updatedBy?: string; + identifier: string | undefined; +} +/** + * @public + */ +export interface DeleteSubscriptionTargetInput { /** - *The ID of the data lineage node.
+ *The ID of the Amazon DataZone domain in which the subscription target is deleted.
* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *The name of the type of the specified data lineage node.
+ *The ID of the Amazon DataZone environment in which the subscription target is deleted.
* @public */ - typeName: string | undefined; + environmentIdentifier: string | undefined; /** - *The revision type of the specified data lineage node.
+ *The ID of the subscription target that is deleted.
* @public */ - typeRevision?: string; + identifier: 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 source identifier of the data lineage node.
+ *The ID of the Amazon DataZone domain that houses the asset for which you want to delete + * a time series form.
* @public */ - sourceIdentifier?: string; + domainIdentifier: string | undefined; /** - *The timestamp of the event described in the data lineage node.
+ *The ID of the asset for which you want to delete a time series form.
* @public */ - eventTimestamp?: Date; + entityIdentifier: string | undefined; /** - *The metadata of the specified data lineage node.
+ *The type of the asset for which you want to delete a time series form.
* @public */ - formsOutput?: FormOutput[]; + entityType: TimeSeriesEntityType | undefined; /** - *The upstream nodes of the specified data lineage node.
+ *The name of the time series form that you want to delete.
* @public */ - upstreamNodes?: LineageNodeReference[]; + formName: string | undefined; /** - *The downsteam nodes of the specified data lineage node.
+ *A unique, case-sensitive identifier to ensure idempotency of the request. This field is + * automatically populated if not provided.
* @public */ - downstreamNodes?: LineageNodeReference[]; + clientToken?: string; } /** * @public */ -export interface GetProjectInput { - /** - *The ID of the Amazon DataZone domain in which the project exists.
- * @public - */ - domainIdentifier: string | undefined; - - /** - *The ID of the project.
- * @public - */ - identifier: string | undefined; -} +export interface DeleteTimeSeriesDataPointsOutput {} /** * @public */ -export interface GetProjectOutput { - /** - *The ID of the Amazon DataZone domain in which the project exists.
- * @public - */ - domainId: string | undefined; - - /** - *>The ID of the project.
- * @public - */ - id: string | undefined; - - /** - *The name of the project.
- * @public - */ - name: string | undefined; - +export interface DisassociateEnvironmentRoleInput { /** - *The description of the project.
+ *The ID of the Amazon DataZone domain in which an environment role is disassociated.
* @public */ - description?: string; + domainIdentifier: string | undefined; /** - *The status of the project.
+ *The ID of the environment.
* @public */ - projectStatus?: ProjectStatus; + environmentIdentifier: string | undefined; /** - *Specifies the error message that is returned if the operation cannot be successfully - * completed.
+ *The ARN of the environment role.
* @public */ - failureReasons?: ProjectDeletionError[]; + environmentRoleArn: string | undefined; +} - /** - *The Amazon DataZone user who created the project.
- * @public - */ - createdBy: string | undefined; +/** + * @public + */ +export interface DisassociateEnvironmentRoleOutput {} +/** + * @public + */ +export interface DeleteDomainInput { /** - *The timestamp of when the project was created.
+ *The identifier of the Amazon Web Services domain that is to be deleted.
* @public */ - createdAt?: Date; + identifier: string | undefined; /** - *The timestamp of when the project was last updated.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - lastUpdatedAt?: Date; + clientToken?: string; /** - *The business glossary terms that can be used in the project.
+ *Specifies the optional flag to delete all child entities within the domain.
* @public */ - glossaryTerms?: string[]; + skipDeletionCheck?: boolean; } /** * @public */ -export interface GetSubscriptionInput { +export interface DeleteDomainOutput { /** - *The ID of the Amazon DataZone domain in which the subscription exists.
+ *The status of the domain.
* @public */ - domainIdentifier: string | undefined; + status: DomainStatus | undefined; +} +/** + * @public + */ +export interface GetDomainInput { /** - *The ID of the subscription.
+ *The identifier of the specified Amazon DataZone domain.
* @public */ identifier: string | undefined; @@ -10396,277 +10002,305 @@ export interface GetSubscriptionInput { /** * @public */ -export interface GetSubscriptionOutput { +export interface GetDomainOutput { /** - *The ID of the subscription.
+ *The identifier of the specified Amazon DataZone domain.
* @public */ id: string | undefined; /** - *The Amazon DataZone user who created the subscription.
+ *The ID of the root domain in Amazon Datazone.
* @public */ - createdBy: string | undefined; + rootDomainUnitId?: string; /** - *The Amazon DataZone user who updated the subscription.
+ *The name of the Amazon DataZone domain.
* @public */ - updatedBy?: string; + name?: string; /** - *The ID of the Amazon DataZone domain in which the subscription exists.
+ *The description of the Amazon DataZone domain.
* @public */ - domainId: string | undefined; + description?: string; /** - *The status of the subscription.
+ *The single sing-on option of the specified Amazon DataZone domain.
* @public */ - status: SubscriptionStatus | undefined; + singleSignOn?: SingleSignOn; /** - *The timestamp of when the subscription was created.
+ *The domain execution role with which the Amazon DataZone domain is created.
* @public */ - createdAt: Date | undefined; + domainExecutionRole: string | undefined; /** - *The timestamp of when the subscription was updated.
+ *The ARN of the specified Amazon DataZone domain.
* @public */ - updatedAt: Date | undefined; + arn?: string; /** - *The principal that owns the subscription.
+ *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 */ - subscribedPrincipal: SubscribedPrincipal | undefined; + kmsKeyIdentifier?: string; /** - *The details of the published asset for which the subscription grant is created.
+ *The status of the specified Amazon DataZone domain.
* @public */ - subscribedListing: SubscribedListing | undefined; + status: DomainStatus | undefined; /** - *The ID of the subscription request.
+ *The URL of the data portal for this Amazon DataZone domain.
* @public */ - subscriptionRequestId?: string; + portalUrl?: string; /** - *The retain permissions of the subscription.
+ *The timestamp of when the Amazon DataZone domain was created.
* @public */ - retainPermissions?: boolean; -} + createdAt?: Date; -/** - * @public - */ -export interface GetSubscriptionGrantInput { /** - *The ID of the Amazon DataZone domain in which the subscription grant exists.
+ *The timestamp of when the Amazon DataZone domain was last updated.
* @public */ - domainIdentifier: string | undefined; + lastUpdatedAt?: Date; /** - *The ID of the subscription grant.
+ *The tags specified for the Amazon DataZone domain.
* @public */ - identifier: string | undefined; + tags?: RecordThe ID of the subscription grant.
+ *The status of the data source.
* @public */ - id: string | undefined; + status?: DomainStatus; /** - *The Amazon DataZone user who created the subscription grant.
+ *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 Amazon DataZone user who updated the subscription grant.
+ *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 DomainSummary { /** - *The ID of the Amazon DataZone domain in which the subscription grant exists.
+ *The ID of the Amazon DataZone domain.
* @public */ - domainId: string | undefined; + id: string | undefined; /** - *The timestamp of when the subscription grant is created.
+ *A name of an Amazon DataZone domain.
* @public */ - createdAt: Date | undefined; + name: string | undefined; /** - *The timestamp of when the subscription grant was upated.
+ *A description of an Amazon DataZone domain.
* @public */ - updatedAt: Date | undefined; + description?: string; /** - *The subscription target ID associated with the subscription grant.
+ *The ARN of the Amazon DataZone domain.
* @public */ - subscriptionTargetId: string | undefined; + arn: string | undefined; /** - *The entity to which the subscription is granted.
+ *The identifier of the Amazon Web Services account that manages the domain.
* @public */ - grantedEntity: GrantedEntity | undefined; + managedAccountId: string | undefined; /** - *The status of the subscription grant.
+ *The status of the Amazon DataZone domain.
* @public */ - status: SubscriptionGrantOverallStatus | undefined; + status: DomainStatus | undefined; /** - *The assets for which the subscription grant is created.
+ *The data portal URL for the Amazon DataZone domain.
* @public */ - assets?: SubscribedAsset[]; + portalUrl?: string; /** - * @deprecated - * - *The identifier of the subscription.
+ *A timestamp of when a Amazon DataZone domain was created.
* @public */ - subscriptionId?: string; + createdAt: Date | undefined; + + /** + *A timestamp of when a Amazon DataZone domain was last updated.
+ * @public + */ + lastUpdatedAt?: Date; } /** * @public */ -export interface GetSubscriptionRequestDetailsInput { +export interface ListDomainsOutput { /** - *The identifier of the Amazon DataZone domain in which to get the subscription request - * details.
+ *The results of the ListDomains action.
The identifier of the subscription request the details of which to get.
+ *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 identifier of the subscription request.
+ *The ID of the Amazon Web Services domain that is to be updated.
* @public */ - id: string | undefined; + identifier: string | undefined; /** - *The Amazon DataZone user who created the subscription request.
+ *The description to be updated as part of the UpdateDomain action.
The Amazon DataZone user who updated the subscription request.
+ *The single sign-on option to be updated as part of the UpdateDomain
+ * action.
The Amazon DataZone domain of the subscription request.
+ *The domain execution role to be updated as part of the UpdateDomain
+ * action.
The status of the subscription request.
+ *The name to be updated as part of the UpdateDomain action.
The timestamp of when the specified subscription request was created.
+ *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
* @public */ - createdAt: Date | undefined; + clientToken?: string; +} +/** + * @public + */ +export interface UpdateDomainOutput { /** - *The timestamp of when the subscription request was updated.
+ *The identifier of the Amazon DataZone domain.
* @public */ - updatedAt: Date | undefined; + id: string | undefined; /** - *The reason for the subscription request.
+ *The ID of the root domain unit.
* @public */ - requestReason: string | undefined; + rootDomainUnitId?: string; /** - *The subscribed principals in the subscription request.
+ *The description to be updated as part of the UpdateDomain action.
The single sign-on option of the Amazon DataZone domain.
+ * @public + */ + singleSignOn?: SingleSignOn; /** - *The subscribed listings in the subscription request.
+ *The domain execution role to be updated as part of the UpdateDomain
+ * action.
The identifier of the Amazon DataZone user who reviewed the subscription request.
+ *The name to be updated as part of the UpdateDomain action.
The decision comment of the subscription request.
+ *Specifies the timestamp of when the domain was last updated.
* @public */ - decisionComment?: string; + lastUpdatedAt?: Date; } /** * @public */ -export interface GetSubscriptionTargetInput { +export interface DeleteDomainUnitInput { /** - *The ID of the Amazon DataZone domain in which the subscription target exists.
+ *The ID of the domain where you want to delete a domain unit.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the environment associated with the subscription target.
- * @public - */ - environmentIdentifier: string | undefined; - - /** - *The ID of the subscription target.
+ *The ID of the domain unit that you want to delete.
* @public */ identifier: string | undefined; @@ -10675,286 +10309,297 @@ export interface GetSubscriptionTargetInput { /** * @public */ -export interface GetSubscriptionTargetOutput { - /** - *The ID of the subscription target.
- * @public - */ - id: string | undefined; +export interface DeleteDomainUnitOutput {} +/** + * @public + */ +export interface GetDomainUnitInput { /** - *The authorized principals of the subscription target.
+ *The ID of the domain where you want to get a domain unit.
* @public */ - authorizedPrincipals: string[] | undefined; + domainIdentifier: string | undefined; /** - *The ID of the Amazon DataZone domain in which the subscription target exists.
+ *The identifier of the domain unit that you want to get.
* @public */ - domainId: string | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetDomainUnitOutput { /** - *The ID of the project associated with the subscription target.
+ *The ID of the domain unit.
* @public */ - projectId: string | undefined; + id: string | undefined; /** - *The ID of the environment associated with the subscription target.
+ *The ID of the domain in which the domain unit lives.
* @public */ - environmentId: string | undefined; + domainId: string | undefined; /** - *The name of the subscription target.
+ *The name of the domain unit.
* @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.
+ *The ID of the parent domain unit.
* @public */ - updatedBy?: string; + parentDomainUnitId?: string; /** - *The timestamp of when the subscription target was created.
+ *The description of the domain unit.
* @public */ - createdAt: Date | undefined; + description?: string; /** - *The timestamp of when the subscription target was updated.
+ *The owners of the domain unit.
* @public */ - updatedAt?: Date; + owners: DomainUnitOwnerProperties[] | undefined; /** - *The manage access role with which the subscription target was created.
+ *The time stamp at which the domain unit was created.
* @public */ - manageAccessRole: string | undefined; + createdAt?: Date; /** - *The asset types associated with the subscription target.
+ *The timestamp at which the domain unit was last updated.
* @public */ - applicableAssetTypes: string[] | undefined; + lastUpdatedAt?: Date; /** - *The configuration of teh subscription target.
+ *The user who created the domain unit.
* @public */ - subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + createdBy?: string; /** - *The provider of the subscription target.
+ *The user who last updated the domain unit.
* @public */ - provider: string | undefined; + lastUpdatedBy?: string; } /** * @public */ -export interface GetTimeSeriesDataPointInput { +export interface ListDomainUnitsForParentInput { /** - *The ID of the Amazon DataZone domain that houses the asset for which you want to get the - * data point.
+ *The ID of the domain in which you want to list domain units for a parent domain + * unit.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the asset for which you want to get the data point.
+ *The ID of the parent domain unit.
* @public */ - entityIdentifier: string | undefined; + parentDomainUnitIdentifier: string | undefined; /** - *The type of the asset for which you want to get the data point.
+ *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 */ - entityType: TimeSeriesEntityType | undefined; + maxResults?: number; /** - *The ID of the data point that you want to get.
+ *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 */ - identifier: string | undefined; + nextToken?: string; +} + +/** + *The summary of the domain unit.
+ * @public + */ +export interface DomainUnitSummary { + /** + *The name of the domain unit summary.
+ * @public + */ + name: string | undefined; /** - *The name of the time series form that houses the data point that you want to get.
+ *The ID of the domain unit summary.
* @public */ - formName: string | undefined; + id: string | undefined; } /** - *The time series data points form.
* @public */ -export interface TimeSeriesDataPointFormOutput { +export interface ListDomainUnitsForParentOutput { /** - *The name of the time series data points form.
+ *The results returned by this action.
* @public */ - formName: string | undefined; + items: DomainUnitSummary[] | undefined; /** - *The ID of the type of the time series data points form.
+ *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 */ - typeIdentifier: string | undefined; + nextToken?: string; +} +/** + * @public + */ +export interface UpdateDomainUnitInput { /** - *The revision type of the time series data points form.
+ *The ID of the domain where you want to update a domain unit.
* @public */ - typeRevision?: string; + domainIdentifier: string | undefined; /** - *The timestamp of the time series data points form.
+ *The ID of the domain unit that you want to update.
* @public */ - timestamp: Date | undefined; + identifier: string | undefined; /** - *The content of the time series data points form.
+ *The description of the domain unit that you want to update.
* @public */ - content?: string; + description?: string; /** - *The ID of the time series data points form.
+ *The name of the domain unit that you want to update.
* @public */ - id?: string; + name?: string; } /** * @public */ -export interface GetTimeSeriesDataPointOutput { - /** - *The ID of the Amazon DataZone domain that houses the asset data point that you want to - * get.
- * @public - */ - domainId?: string; - +export interface UpdateDomainUnitOutput { /** - *The ID of the asset for which you want to get the data point.
+ *The ID of the domain unit that you want to update.
* @public */ - entityId?: string; + id: string | undefined; /** - *The type of the asset for which you want to get the data point.
+ *The ID of the domain where you want to update the domain unit.
* @public */ - entityType?: TimeSeriesEntityType; + domainId: string | undefined; /** - *The name of the time series form that houses the data point that you want to get.
+ *The name of the domain unit that you want to update.
* @public */ - formName?: string; + name: string | undefined; /** - *The time series form that houses the data point that you want to get.
+ *The owners of the domain unit that you want to update.
* @public */ - form?: TimeSeriesDataPointFormOutput; -} + owners: DomainUnitOwnerProperties[] | undefined; -/** - * @public - */ -export interface GetUserProfileInput { /** - *the ID of the Amazon DataZone domain the data portal of which you want to get.
+ *The description of the domain unit that you want to update.
* @public */ - domainIdentifier: string | undefined; + description?: string; /** - *The identifier of the user for which you want to get the user profile.
+ *The ID of the parent domain unit.
* @public */ - userIdentifier: string | undefined; + parentDomainUnitId?: string; /** - *The type of the user profile.
+ *The time stamp at which the domain unit that you want to update was created.
* @public */ - type?: UserProfileType; -} + createdAt?: Date; -/** - * @public - */ -export interface GetUserProfileOutput { /** - *the identifier of the Amazon DataZone domain of which you want to get the user - * profile.
+ *The timestamp at which the domain unit was last updated.
* @public */ - domainId?: string; + lastUpdatedAt?: Date; /** - *The identifier of the user profile.
+ *The user who created the domain unit that you want to update.
* @public */ - id?: string; + createdBy?: string; /** - *The type of the user profile.
+ *The user who last updated the domain unit.
* @public */ - type?: UserProfileType; + lastUpdatedBy?: string; +} +/** + * @public + */ +export interface DeleteEnvironmentBlueprintConfigurationInput { /** - *The status of the user profile.
+ *The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.
* @public */ - status?: UserProfileStatus; + domainIdentifier: string | undefined; /** - *The details of the user profile in Amazon DataZone.
+ *The ID of the blueprint the configuration of which is deleted.
* @public */ - details?: UserProfileDetails; + environmentBlueprintIdentifier: string | undefined; } /** * @public */ -export interface DeleteGlossaryInput { +export interface DeleteEnvironmentBlueprintConfigurationOutput {} + +/** + * @public + */ +export interface GetEnvironmentBlueprintConfigurationInput { /** - *The ID of the Amazon DataZone domain in which the business glossary is deleted.
+ *The ID of the Amazon DataZone domain where this blueprint exists.
* @public */ domainIdentifier: string | undefined; /** - *The ID of the business glossary that is deleted.
+ *He ID of the blueprint.
* @public */ - identifier: string | undefined; + environmentBlueprintIdentifier: string | undefined; } /** @@ -11342,6 +10987,25 @@ export const CreateDataSourceOutputFilterSensitiveLog = (obj: CreateDataSourceOu ...(obj.schedule && { schedule: SENSITIVE_STRING }), }); +/** + * @internal + */ +export const CreateDomainUnitInputFilterSensitiveLog = (obj: CreateDomainUnitInput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const CreateDomainUnitOutputFilterSensitiveLog = (obj: CreateDomainUnitOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.owners && { owners: obj.owners.map((item) => item) }), +}); + /** * @internal */ @@ -11715,131 +11379,28 @@ export const ListDomainsOutputFilterSensitiveLog = (obj: ListDomainsOutput): any /** * @internal */ -export const ImportFilterSensitiveLog = (obj: Import): any => ({ - ...obj, - ...(obj.name && { name: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const GetFormTypeOutputFilterSensitiveLog = (obj: GetFormTypeOutput): any => ({ - ...obj, - ...(obj.name && { name: SENSITIVE_STRING }), - ...(obj.model && { model: SENSITIVE_STRING }), - ...(obj.description && { description: SENSITIVE_STRING }), - ...(obj.imports && { imports: obj.imports.map((item) => ImportFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const GetEnvironmentOutputFilterSensitiveLog = (obj: GetEnvironmentOutput): any => ({ +export const GetDomainUnitOutputFilterSensitiveLog = (obj: GetDomainUnitOutput): any => ({ ...obj, ...(obj.name && { name: SENSITIVE_STRING }), ...(obj.description && { description: SENSITIVE_STRING }), - ...(obj.userParameters && { - userParameters: obj.userParameters.map((item) => CustomParameterFilterSensitiveLog(item)), - }), - ...(obj.provisioningProperties && { provisioningProperties: obj.provisioningProperties }), + ...(obj.owners && { owners: obj.owners.map((item) => item) }), }); /** * @internal */ -export const GetEnvironmentBlueprintOutputFilterSensitiveLog = (obj: GetEnvironmentBlueprintOutput): any => ({ +export const UpdateDomainUnitInputFilterSensitiveLog = (obj: UpdateDomainUnitInput): any => ({ ...obj, ...(obj.description && { description: SENSITIVE_STRING }), - ...(obj.provisioningProperties && { provisioningProperties: obj.provisioningProperties }), - ...(obj.userParameters && { - userParameters: obj.userParameters.map((item) => CustomParameterFilterSensitiveLog(item)), - }), -}); - -/** - * @internal - */ -export const GetEnvironmentCredentialsOutputFilterSensitiveLog = (obj: GetEnvironmentCredentialsOutput): any => ({ - ...obj, -}); - -/** - * @internal - */ -export const GetEnvironmentProfileOutputFilterSensitiveLog = (obj: GetEnvironmentProfileOutput): any => ({ - ...obj, ...(obj.name && { name: SENSITIVE_STRING }), - ...(obj.description && { description: SENSITIVE_STRING }), - ...(obj.userParameters && { - userParameters: obj.userParameters.map((item) => CustomParameterFilterSensitiveLog(item)), - }), -}); - -/** - * @internal - */ -export const GetGroupProfileOutputFilterSensitiveLog = (obj: GetGroupProfileOutput): any => ({ - ...obj, - ...(obj.groupName && { groupName: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const GetLineageNodeOutputFilterSensitiveLog = (obj: GetLineageNodeOutput): any => ({ - ...obj, - ...(obj.formsOutput && { formsOutput: obj.formsOutput.map((item) => FormOutputFilterSensitiveLog(item)) }), }); /** * @internal */ -export const GetProjectOutputFilterSensitiveLog = (obj: GetProjectOutput): any => ({ +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 - */ -export const GetSubscriptionOutputFilterSensitiveLog = (obj: GetSubscriptionOutput): any => ({ - ...obj, - ...(obj.subscribedPrincipal && { - subscribedPrincipal: SubscribedPrincipalFilterSensitiveLog(obj.subscribedPrincipal), - }), - ...(obj.subscribedListing && { subscribedListing: SubscribedListingFilterSensitiveLog(obj.subscribedListing) }), -}); - -/** - * @internal - */ -export const GetSubscriptionRequestDetailsOutputFilterSensitiveLog = ( - obj: GetSubscriptionRequestDetailsOutput -): any => ({ - ...obj, - ...(obj.requestReason && { requestReason: SENSITIVE_STRING }), - ...(obj.subscribedPrincipals && { - subscribedPrincipals: obj.subscribedPrincipals.map((item) => SubscribedPrincipalFilterSensitiveLog(item)), - }), - ...(obj.subscribedListings && { - subscribedListings: obj.subscribedListings.map((item) => SubscribedListingFilterSensitiveLog(item)), - }), - ...(obj.decisionComment && { decisionComment: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const GetSubscriptionTargetOutputFilterSensitiveLog = (obj: GetSubscriptionTargetOutput): any => ({ - ...obj, - ...(obj.name && { name: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const GetUserProfileOutputFilterSensitiveLog = (obj: GetUserProfileOutput): any => ({ - ...obj, - ...(obj.details && { details: UserProfileDetailsFilterSensitiveLog(obj.details) }), -}); diff --git a/clients/client-datazone/src/models/models_1.ts b/clients/client-datazone/src/models/models_1.ts index f8be6d6f68bb..246c4b36c6dd 100644 --- a/clients/client-datazone/src/models/models_1.ts +++ b/clients/client-datazone/src/models/models_1.ts @@ -28,6 +28,7 @@ import { DataProductRevision, DataSourceRunActivity, DataSourceRunActivityFilterSensitiveLog, + DataZoneEntityType, Deployment, DeploymentProperties, EnvironmentParameter, @@ -36,15 +37,19 @@ import { FilterStatus, FormEntryOutput, FormEntryOutputFilterSensitiveLog, + FormOutput, + FormOutputFilterSensitiveLog, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GrantedEntity, GroupProfileStatus, - Import, - ImportFilterSensitiveLog, ListingStatus, + ManagedPolicyType, Model, + OwnerProperties, + PolicyGrantDetail, + PolicyGrantPrincipal, ProjectDeletionError, ProjectStatus, ProvisioningProperties, @@ -60,8 +65,8 @@ import { SubscriptionRequestStatus, SubscriptionStatus, SubscriptionTargetForm, + TargetEntityType, TermRelations, - TimeSeriesDataPointFormOutput, TimeSeriesDataPointSummaryFormOutput, TimeSeriesEntityType, UserDesignation, @@ -71,6 +76,1835 @@ import { UserProfileType, } from "./models_0"; +/** + *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.
+ * @public + */ + locationRegistrationRole?: string; + + /** + *Specifies certain Amazon S3 locations if you do not want Amazon DataZone to + * automatically register them in hybrid mode.
+ * @public + */ + locationRegistrationExcludeS3Locations?: string[]; +} + +/** + *The provisioning configuration of the blueprint.
+ * @public + */ +export type ProvisioningConfiguration = + | ProvisioningConfiguration.LakeFormationConfigurationMember + | ProvisioningConfiguration.$UnknownMember; + +/** + * @public + */ +export namespace ProvisioningConfiguration { + /** + *The Lake Formation configuration of the Data Lake blueprint.
+ * @public + */ + export interface LakeFormationConfigurationMember { + lakeFormationConfiguration: LakeFormationConfiguration; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + lakeFormationConfiguration?: never; + $unknown: [string, any]; + } + + export interface VisitorThe ID of the Amazon DataZone domain where this blueprint exists.
+ * @public + */ + domainId: string | undefined; + + /** + *The ID of the blueprint.
+ * @public + */ + environmentBlueprintId: string | undefined; + + /** + *The ARN of the provisioning role with which this blueprint is created.
+ * @public + */ + provisioningRoleArn?: string; + + /** + *The ARN of the manage access role with which this blueprint is created.
+ * @public + */ + manageAccessRoleArn?: string; + + /** + *The Amazon Web Services regions in which this blueprint is enabled.
+ * @public + */ + enabledRegions?: string[]; + + /** + *The regional parameters of the blueprint.
+ * @public + */ + regionalParameters?: RecordThe timestamp of when this blueprint was created.
+ * @public + */ + createdAt?: Date; + + /** + *The timestamp of when this blueprint was upated.
+ * @public + */ + updatedAt?: Date; + + /** + *The provisioning configuration of a blueprint.
+ * @public + */ + provisioningConfigurations?: ProvisioningConfiguration[]; +} + +/** + * @public + */ +export interface ListEnvironmentBlueprintConfigurationsInput { + /** + *The identifier of the Amazon DataZone domain.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *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.
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 identifier of the Amazon DataZone domain in which an environment blueprint exists.
+ * @public + */ + domainId: string | undefined; + + /** + *The identifier of the environment blueprint.
+ * @public + */ + environmentBlueprintId: string | undefined; + + /** + *The ARN of the provisioning role specified in the environment blueprint + * configuration.
+ * @public + */ + provisioningRoleArn?: string; + + /** + *The ARN of the manage access role specified in the environment blueprint + * configuration.
+ * @public + */ + manageAccessRoleArn?: string; + + /** + *The enabled Amazon Web Services Regions specified in a blueprint configuration.
+ * @public + */ + enabledRegions?: string[]; + + /** + *The regional parameters of the environment blueprint.
+ * @public + */ + regionalParameters?: RecordThe timestamp of when an environment blueprint was created.
+ * @public + */ + createdAt?: Date; + + /** + *The timestamp of when the environment blueprint was updated.
+ * @public + */ + updatedAt?: Date; + + /** + *The provisioning configuration of a blueprint.
+ * @public + */ + provisioningConfigurations?: ProvisioningConfiguration[]; +} + +/** + * @public + */ +export interface ListEnvironmentBlueprintConfigurationsOutput { + /** + *The results of the ListEnvironmentBlueprintConfigurations 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.
The identifier of the Amazon DataZone domain.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The identifier of the environment blueprint.
+ * @public + */ + environmentBlueprintIdentifier: string | undefined; + + /** + *The ARN of the provisioning role.
+ * @public + */ + provisioningRoleArn?: string; + + /** + *The ARN of the manage access role.
+ * @public + */ + manageAccessRoleArn?: string; + + /** + *Specifies the enabled Amazon Web Services Regions.
+ * @public + */ + enabledRegions: string[] | undefined; + + /** + *The regional parameters in the environment blueprint.
+ * @public + */ + regionalParameters?: RecordThe provisioning configuration of a blueprint.
+ * @public + */ + provisioningConfigurations?: ProvisioningConfiguration[]; +} + +/** + * @public + */ +export interface PutEnvironmentBlueprintConfigurationOutput { + /** + *The identifier of the Amazon DataZone domain.
+ * @public + */ + domainId: string | undefined; + + /** + *The identifier of the environment blueprint.
+ * @public + */ + environmentBlueprintId: string | undefined; + + /** + *The ARN of the provisioning role.
+ * @public + */ + provisioningRoleArn?: string; + + /** + *The ARN of the manage access role.
+ * @public + */ + manageAccessRoleArn?: string; + + /** + *Specifies the enabled Amazon Web Services Regions.
+ * @public + */ + enabledRegions?: string[]; + + /** + *The regional parameters in the environment blueprint.
+ * @public + */ + regionalParameters?: RecordThe timestamp of when the environment blueprint was created.
+ * @public + */ + createdAt?: Date; + + /** + *The timestamp of when the environment blueprint was updated.
+ * @public + */ + updatedAt?: Date; + + /** + *The provisioning configuration of a blueprint.
+ * @public + */ + provisioningConfigurations?: ProvisioningConfiguration[]; +} + +/** + * @public + */ +export interface DeleteFormTypeInput { + /** + *The ID of the Amazon DataZone domain in which the metadata form type is deleted.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the metadata form type that is deleted.
+ * @public + */ + formTypeIdentifier: string | undefined; +} + +/** + * @public + */ +export interface DeleteFormTypeOutput {} + +/** + * @public + */ +export interface GetFormTypeInput { + /** + *The ID of the Amazon DataZone domain in which this metadata form type exists.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the metadata form type.
+ * @public + */ + formTypeIdentifier: string | undefined; + + /** + *The revision of this metadata form type.
+ * @public + */ + revision?: string; +} + +/** + *The details of the import of the metadata form type.
+ * @public + */ +export interface Import { + /** + *The name of the import.
+ * @public + */ + name: string | undefined; + + /** + *The revision of the import.
+ * @public + */ + revision: string | undefined; +} + +/** + * @public + */ +export interface GetFormTypeOutput { + /** + *The ID of the Amazon DataZone domain in which this metadata form type exists.
+ * @public + */ + domainId: string | undefined; + + /** + *The name of the metadata form type.
+ * @public + */ + name: string | undefined; + + /** + *The revision of the metadata form type.
+ * @public + */ + revision: string | undefined; + + /** + *The model of the metadata form type.
+ * @public + */ + model: Model | undefined; + + /** + *The ID of the project that owns this metadata form type.
+ * @public + */ + owningProjectId?: string; + + /** + *The ID of the Amazon DataZone domain in which the metadata form type was originally + * created.
+ * @public + */ + originDomainId?: string; + + /** + *The ID of the project in which this metadata form type was originally created.
+ * @public + */ + originProjectId?: string; + + /** + *The status of the metadata form type.
+ * @public + */ + status?: FormTypeStatus; + + /** + *The timestamp of when this metadata form type was created.
+ * @public + */ + createdAt?: Date; + + /** + *The Amazon DataZone user who created this metadata form type.
+ * @public + */ + createdBy?: string; + + /** + *The description of the metadata form type.
+ * @public + */ + description?: string; + + /** + *The imports of the metadata form type.
+ * @public + */ + imports?: Import[]; +} + +/** + * @public + */ +export interface GetAssetFilterInput { + /** + *The ID of the domain where you want to get an asset filter.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the data asset.
+ * @public + */ + assetIdentifier: string | undefined; + + /** + *The ID of the asset filter.
+ * @public + */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface GetEnvironmentInput { + /** + *The ID of the Amazon DataZone domain where the environment exists.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the Amazon DataZone environment.
+ * @public + */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface GetEnvironmentOutput { + /** + *The ID of the Amazon DataZone project in which this environment is created.
+ * @public + */ + projectId: string | undefined; + + /** + *The ID of the environment.
+ * @public + */ + id?: string; + + /** + *The ID of the Amazon DataZone domain where 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; + + /** + *The timestamp of when this environment was updated.
+ * @public + */ + updatedAt?: Date; + + /** + *The name of the environment.
+ * @public + */ + name: string | undefined; + + /** + *The description of the environment.
+ * @public + */ + description?: string; + + /** + *The ID of the environment profile with which the environment is created.
+ * @public + */ + environmentProfileId?: string; + + /** + *The ID of the Amazon Web Services account where the environment exists.
+ * @public + */ + awsAccountId?: string; + + /** + *The Amazon Web Services region where the environment exists.
+ * @public + */ + awsAccountRegion?: string; + + /** + *The provider of this Amazon DataZone environment.
+ * @public + */ + provider: string | undefined; + + /** + *The provisioned resources of this Amazon DataZone environment.
+ * @public + */ + provisionedResources?: Resource[]; + + /** + *The status of this Amazon DataZone environment.
+ * @public + */ + status?: EnvironmentStatus; + + /** + *The actions of the environment.
+ * @public + */ + environmentActions?: ConfigurableEnvironmentAction[]; + + /** + *The business glossary terms that can be used in this environment.
+ * @public + */ + glossaryTerms?: string[]; + + /** + *The user parameters of this Amazon DataZone environment.
+ * @public + */ + userParameters?: CustomParameter[]; + + /** + *The details of the last deployment of the environment.
+ * @public + */ + lastDeployment?: Deployment; + + /** + *The provisioning properties of this Amazon DataZone environment.
+ * @public + */ + provisioningProperties?: ProvisioningProperties; + + /** + *The deployment properties of the environment.
+ * @public + */ + deploymentProperties?: DeploymentProperties; + + /** + *The blueprint with which the environment is created.
+ * @public + */ + environmentBlueprintId?: string; +} + +/** + * @public + */ +export interface GetEnvironmentActionInput { + /** + *The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is
+ * invoked.
The environment ID of the environment action.
+ * @public + */ + environmentIdentifier: string | undefined; + + /** + *The ID of the environment action
+ * @public + */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface GetEnvironmentActionOutput { + /** + *The ID of the Amazon DataZone domain in which the environment action lives.
+ * @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 description of the environment action.
+ * @public + */ + description?: string; +} + +/** + * @public + */ +export interface GetEnvironmentBlueprintInput { + /** + *The identifier of the domain in which this blueprint exists.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of this Amazon DataZone blueprint.
+ * @public + */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface GetEnvironmentBlueprintOutput { + /** + *The ID of this Amazon DataZone blueprint.
+ * @public + */ + id: string | undefined; + + /** + *The name of this Amazon DataZone blueprint.
+ * @public + */ + name: string | undefined; + + /** + *The description of this Amazon DataZone blueprint.
+ * @public + */ + description?: string; + + /** + *The provider of this Amazon DataZone blueprint.
+ * @public + */ + provider: string | undefined; + + /** + *The provisioning properties of this Amazon DataZone blueprint.
+ * @public + */ + provisioningProperties: ProvisioningProperties | undefined; + + /** + *The deployment properties of this Amazon DataZone blueprint.
+ * @public + */ + deploymentProperties?: DeploymentProperties; + + /** + *The user parameters of this blueprint.
+ * @public + */ + userParameters?: CustomParameter[]; + + /** + *The glossary terms attached to this Amazon DataZone blueprint.
+ * @public + */ + glossaryTerms?: string[]; + + /** + *A timestamp of when this blueprint was created.
+ * @public + */ + createdAt?: Date; + + /** + *The timestamp of when this blueprint was updated.
+ * @public + */ + updatedAt?: Date; +} + +/** + * @public + */ +export interface GetEnvironmentCredentialsInput { + /** + *The ID of the Amazon DataZone domain in which this environment and its credentials + * exist.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the environment whose credentials this operation gets.
+ * @public + */ + environmentIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetEnvironmentCredentialsOutput { + /** + *The access key ID of the environment.
+ * @public + */ + accessKeyId?: string; + + /** + *The secret access key of the environment credentials.
+ * @public + */ + secretAccessKey?: string; + + /** + *The session token of the environment credentials.
+ * @public + */ + sessionToken?: string; + + /** + *The expiration timestamp of the environment credentials.
+ * @public + */ + expiration?: Date; +} + +/** + * @public + */ +export interface GetEnvironmentProfileInput { + /** + *The ID of the Amazon DataZone domain in which this environment profile exists.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the environment profile.
+ * @public + */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface GetEnvironmentProfileOutput { + /** + *The ID of the environment profile.
+ * @public + */ + id: string | undefined; + + /** + *The ID of the Amazon DataZone domain in which this environment profile exists.
+ * @public + */ + domainId: string | undefined; + + /** + *The ID of the Amazon Web Services account where this environment profile exists.
+ * @public + */ + awsAccountId?: string; + + /** + *The Amazon Web Services region where this environment profile exists.
+ * @public + */ + awsAccountRegion?: string; + + /** + *The Amazon DataZone user who created this environment profile.
+ * @public + */ + createdBy: string | undefined; + + /** + *The timestamp of when this environment profile was created.
+ * @public + */ + createdAt?: Date; + + /** + *The timestamp of when this environment profile was upated.
+ * @public + */ + updatedAt?: Date; + + /** + *The name of the environment profile.
+ * @public + */ + name: string | undefined; + + /** + *The description of the environment profile.
+ * @public + */ + description?: string; + + /** + *The ID of the blueprint with which this environment profile is created.
+ * @public + */ + environmentBlueprintId: string | undefined; + + /** + *The ID of the Amazon DataZone project in which this environment profile is created.
+ * @public + */ + projectId?: string; + + /** + *The user parameters of the environment profile.
+ * @public + */ + userParameters?: CustomParameter[]; +} + +/** + * @public + */ +export interface GetGroupProfileInput { + /** + *The identifier of the Amazon DataZone domain in which the group profile exists.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The identifier of the group profile.
+ * @public + */ + groupIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetGroupProfileOutput { + /** + *The identifier of the Amazon DataZone domain in which the group profile exists.
+ * @public + */ + domainId?: string; + + /** + *The identifier of the group profile.
+ * @public + */ + id?: string; + + /** + *The identifier of the group profile.
+ * @public + */ + status?: GroupProfileStatus; + + /** + *The name of the group for which the specified group profile exists.
+ * @public + */ + groupName?: string; +} + +/** + * @public + */ +export interface GetIamPortalLoginUrlInput { + /** + *the ID of the Amazon DataZone domain the data portal of which you want to get.
+ * @public + */ + domainIdentifier: string | undefined; +} + +/** + * @public + */ +export interface GetIamPortalLoginUrlOutput { + /** + *The data portal URL of the specified Amazon DataZone domain.
+ * @public + */ + authCodeUrl?: string; + + /** + *The ID of the user profile.
+ * @public + */ + userProfileId: string | undefined; +} + +/** + * @public + */ +export interface GetLineageNodeInput { + /** + *The ID of the domain in which you want to get the data lineage node.
+ * @public + */ + domainIdentifier: string | 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; +} + +/** + *The reference details for the data lineage node.
+ * @public + */ +export interface LineageNodeReference { + /** + *The ID of the data lineage node.
+ * @public + */ + id?: string; + + /** + *The event timestamp of the data lineage node.
+ * @public + */ + eventTimestamp?: Date; +} + +/** + * @public + */ +export interface GetLineageNodeOutput { + /** + *The ID of the domain where you're getting the data lineage node.
+ * @public + */ + domainId: string | undefined; + + /** + *The name of the data lineage node.
+ * @public + */ + name?: string; + + /** + *The description of the data lineage node.
+ * @public + */ + description?: string; + + /** + *The timestamp at which the data lineage node was created.
+ * @public + */ + createdAt?: Date; + + /** + *The user who created the data lineage node.
+ * @public + */ + createdBy?: string; + + /** + *The timestamp at which the data lineage node was updated.
+ * @public + */ + updatedAt?: Date; + + /** + *The user who updated the data lineage node.
+ * @public + */ + updatedBy?: string; + + /** + *The ID of the data lineage node.
+ * @public + */ + id: string | undefined; + + /** + *The name of the type of the specified data lineage node.
+ * @public + */ + typeName: string | undefined; + + /** + *The revision type of the specified data lineage node.
+ * @public + */ + typeRevision?: string; + + /** + *The source identifier of the data lineage node.
+ * @public + */ + sourceIdentifier?: string; + + /** + *The timestamp of the event described in the data lineage node.
+ * @public + */ + eventTimestamp?: Date; + + /** + *The metadata of the specified data lineage node.
+ * @public + */ + formsOutput?: FormOutput[]; + + /** + *The upstream nodes of the specified data lineage node.
+ * @public + */ + upstreamNodes?: LineageNodeReference[]; + + /** + *The downsteam nodes of the specified data lineage node.
+ * @public + */ + downstreamNodes?: LineageNodeReference[]; +} + +/** + * @public + */ +export interface GetProjectInput { + /** + *The ID of the Amazon DataZone domain in which the project exists.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the project.
+ * @public + */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface GetProjectOutput { + /** + *The ID of the Amazon DataZone domain in which the project exists.
+ * @public + */ + domainId: string | undefined; + + /** + *>The ID of the project.
+ * @public + */ + id: string | undefined; + + /** + *The name of the project.
+ * @public + */ + name: string | undefined; + + /** + *The description of the project.
+ * @public + */ + description?: string; + + /** + *The status of the project.
+ * @public + */ + projectStatus?: ProjectStatus; + + /** + *Specifies the error message that is returned if the operation cannot be successfully + * completed.
+ * @public + */ + failureReasons?: ProjectDeletionError[]; + + /** + *The Amazon DataZone user who created the project.
+ * @public + */ + createdBy: string | undefined; + + /** + *The timestamp of when the project was created.
+ * @public + */ + createdAt?: Date; + + /** + *The timestamp of when the project was last updated.
+ * @public + */ + lastUpdatedAt?: Date; + + /** + *The business glossary terms that can be used in the project.
+ * @public + */ + glossaryTerms?: string[]; + + /** + *The ID of the domain unit.
+ * @public + */ + domainUnitId?: string; +} + +/** + * @public + */ +export interface GetSubscriptionInput { + /** + *The ID of the Amazon DataZone domain in which the subscription exists.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the subscription.
+ * @public + */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface GetSubscriptionOutput { + /** + *The ID of the subscription.
+ * @public + */ + id: string | undefined; + + /** + *The Amazon DataZone user who created the subscription.
+ * @public + */ + createdBy: string | undefined; + + /** + *The Amazon DataZone user who updated the subscription.
+ * @public + */ + updatedBy?: string; + + /** + *The ID of the Amazon DataZone domain in which the subscription exists.
+ * @public + */ + domainId: string | undefined; + + /** + *The status of the subscription.
+ * @public + */ + status: SubscriptionStatus | undefined; + + /** + *The timestamp of when the subscription was created.
+ * @public + */ + createdAt: Date | undefined; + + /** + *The timestamp of when the subscription was updated.
+ * @public + */ + updatedAt: Date | undefined; + + /** + *The principal that owns the subscription.
+ * @public + */ + subscribedPrincipal: SubscribedPrincipal | undefined; + + /** + *The details of the published asset for which the subscription grant is created.
+ * @public + */ + subscribedListing: SubscribedListing | undefined; + + /** + *The ID of the subscription request.
+ * @public + */ + subscriptionRequestId?: string; + + /** + *The retain permissions of the subscription.
+ * @public + */ + retainPermissions?: boolean; +} + +/** + * @public + */ +export interface GetSubscriptionGrantInput { + /** + *The ID of the Amazon DataZone domain in which the subscription grant exists.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the subscription grant.
+ * @public + */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface GetSubscriptionGrantOutput { + /** + *The ID of the subscription grant.
+ * @public + */ + id: string | undefined; + + /** + *The Amazon DataZone user who created the subscription grant.
+ * @public + */ + createdBy: string | undefined; + + /** + *The Amazon DataZone user who updated the subscription grant.
+ * @public + */ + updatedBy?: string; + + /** + *The ID of the Amazon DataZone domain in which the subscription grant exists.
+ * @public + */ + domainId: string | undefined; + + /** + *The timestamp of when the subscription grant is created.
+ * @public + */ + createdAt: Date | undefined; + + /** + *The timestamp of when the subscription grant was upated.
+ * @public + */ + updatedAt: Date | undefined; + + /** + *The subscription target ID associated with the subscription grant.
+ * @public + */ + subscriptionTargetId: string | undefined; + + /** + *The entity to which the subscription is granted.
+ * @public + */ + grantedEntity: GrantedEntity | undefined; + + /** + *The status of the subscription grant.
+ * @public + */ + status: SubscriptionGrantOverallStatus | undefined; + + /** + *The assets for which the subscription grant is created.
+ * @public + */ + assets?: SubscribedAsset[]; + + /** + * @deprecated + * + *The identifier of the subscription.
+ * @public + */ + subscriptionId?: string; +} + +/** + * @public + */ +export interface GetSubscriptionRequestDetailsInput { + /** + *The identifier of the Amazon DataZone domain in which to get the subscription request + * details.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The identifier of the subscription request the details of which to get.
+ * @public + */ + identifier: 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; + + /** + *The Amazon DataZone user who updated the subscription request.
+ * @public + */ + updatedBy?: string; + + /** + *The Amazon DataZone domain of the subscription request.
+ * @public + */ + domainId: string | undefined; + + /** + *The status of the subscription request.
+ * @public + */ + status: SubscriptionRequestStatus | undefined; + + /** + *The timestamp of when the specified subscription request was created.
+ * @public + */ + createdAt: Date | undefined; + + /** + *The timestamp of when the subscription request was updated.
+ * @public + */ + updatedAt: Date | undefined; + + /** + *The reason for the subscription request.
+ * @public + */ + requestReason: string | undefined; + + /** + *The subscribed principals in the subscription request.
+ * @public + */ + subscribedPrincipals: SubscribedPrincipal[] | undefined; + + /** + *The subscribed listings in the subscription request.
+ * @public + */ + subscribedListings: SubscribedListing[] | undefined; + + /** + *The identifier of the Amazon DataZone user who reviewed the subscription request.
+ * @public + */ + reviewerId?: string; + + /** + *The decision comment of the subscription request.
+ * @public + */ + decisionComment?: string; +} + +/** + * @public + */ +export interface GetSubscriptionTargetInput { + /** + *The ID of the Amazon DataZone domain in which the subscription target exists.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the environment associated with the subscription target.
+ * @public + */ + environmentIdentifier: string | undefined; + + /** + *The ID of the subscription target.
+ * @public + */ + identifier: string | undefined; +} + +/** + * @public + */ +export interface GetSubscriptionTargetOutput { + /** + *The ID of the subscription target.
+ * @public + */ + id: string | undefined; + + /** + *The authorized principals of the subscription target.
+ * @public + */ + authorizedPrincipals: string[] | undefined; + + /** + *The ID of the Amazon DataZone domain in which the subscription target exists.
+ * @public + */ + domainId: string | undefined; + + /** + *The ID of the project associated with the subscription target.
+ * @public + */ + projectId: string | undefined; + + /** + *The ID of the environment associated with 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 + */ + updatedBy?: string; + + /** + *The timestamp of when the subscription target was created.
+ * @public + */ + createdAt: Date | undefined; + + /** + *The timestamp of when the subscription target was updated.
+ * @public + */ + updatedAt?: Date; + + /** + *The manage access role with which the subscription target was created.
+ * @public + */ + manageAccessRole: string | undefined; + + /** + *The asset types associated with the subscription target.
+ * @public + */ + applicableAssetTypes: string[] | undefined; + + /** + *The configuration of teh subscription target.
+ * @public + */ + subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + + /** + *The provider of the subscription target.
+ * @public + */ + provider: string | undefined; +} + +/** + * @public + */ +export interface GetTimeSeriesDataPointInput { + /** + *The ID of the Amazon DataZone domain that houses the asset for which you want to get the + * data point.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the asset for which you want to get the data point.
+ * @public + */ + entityIdentifier: string | undefined; + + /** + *The type of the asset for which you want to get the data point.
+ * @public + */ + entityType: TimeSeriesEntityType | undefined; + + /** + *The ID of the data point that you want to get.
+ * @public + */ + identifier: string | undefined; + + /** + *The name of the time series form that houses the data point that you want to get.
+ * @public + */ + formName: string | undefined; +} + +/** + *The time series data points form.
+ * @public + */ +export interface TimeSeriesDataPointFormOutput { + /** + *The name of the time series data points form.
+ * @public + */ + formName: string | undefined; + + /** + *The ID of the type of the time series data points form.
+ * @public + */ + typeIdentifier: string | undefined; + + /** + *The revision type of the time series data points form.
+ * @public + */ + typeRevision?: string; + + /** + *The timestamp of the time series data points form.
+ * @public + */ + timestamp: Date | undefined; + + /** + *The content of the time series data points form.
+ * @public + */ + content?: string; + + /** + *The ID of the time series data points form.
+ * @public + */ + id?: string; +} + +/** + * @public + */ +export interface GetTimeSeriesDataPointOutput { + /** + *The ID of the Amazon DataZone domain that houses the asset data point that you want to + * get.
+ * @public + */ + domainId?: string; + + /** + *The ID of the asset for which you want to get the data point.
+ * @public + */ + entityId?: string; + + /** + *The type of the asset for which you want to get the data point.
+ * @public + */ + entityType?: TimeSeriesEntityType; + + /** + *The name of the time series form that houses the data point that you want to get.
+ * @public + */ + formName?: string; + + /** + *The time series form that houses the data point that you want to get.
+ * @public + */ + form?: TimeSeriesDataPointFormOutput; +} + +/** + * @public + */ +export interface GetUserProfileInput { + /** + *the ID of the Amazon DataZone domain the data portal of which you want to get.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The identifier of the user for which you want to get the user profile.
+ * @public + */ + userIdentifier: string | undefined; + + /** + *The type of the user profile.
+ * @public + */ + type?: UserProfileType; +} + +/** + * @public + */ +export interface GetUserProfileOutput { + /** + *the identifier of the Amazon DataZone domain of which you want to get the user + * profile.
+ * @public + */ + domainId?: string; + + /** + *The identifier of the user profile.
+ * @public + */ + id?: string; + + /** + *The type of the user profile.
+ * @public + */ + type?: UserProfileType; + + /** + *The status of the user profile.
+ * @public + */ + status?: UserProfileStatus; + + /** + *The details of the user profile in Amazon DataZone.
+ * @public + */ + details?: UserProfileDetails; +} + +/** + * @public + */ +export interface DeleteGlossaryInput { + /** + *The ID of the Amazon DataZone domain in which the business glossary is deleted.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The ID of the business glossary that is deleted.
+ * @public + */ + identifier: string | undefined; +} + /** * @public */ @@ -729,6 +2563,151 @@ export interface ListDataSourceRunActivitiesOutput { nextToken?: string; } +/** + * @public + */ +export interface ListEntityOwnersInput { + /** + *The ID of the domain where you want to list entity owners.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The type of the entity that you want to list.
+ * @public + */ + entityType: DataZoneEntityType | undefined; + + /** + *The ID of the entity that you want to list.
+ * @public + */ + entityIdentifier: string | undefined; + + /** + *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.
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 ID of the domain unit owners group.
+ * @public + */ + groupId?: string; +} + +/** + *The properties of the owner user.
+ * @public + */ +export interface OwnerUserPropertiesOutput { + /** + *The ID of the owner user.
+ * @public + */ + userId?: string; +} + +/** + *The ID of the domain unit owners group.
+ * @public + */ +export type OwnerPropertiesOutput = + | OwnerPropertiesOutput.GroupMember + | OwnerPropertiesOutput.UserMember + | OwnerPropertiesOutput.$UnknownMember; + +/** + * @public + */ +export namespace OwnerPropertiesOutput { + /** + *Specifies that the domain unit owner is a user.
+ * @public + */ + export interface UserMember { + user: OwnerUserPropertiesOutput; + group?: never; + $unknown?: never; + } + + /** + *Specifies that the domain unit owner is a group.
+ * @public + */ + export interface GroupMember { + user?: never; + group: OwnerGroupPropertiesOutput; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + user?: never; + group?: never; + $unknown: [string, any]; + } + + export interface VisitorThe owners of the entity.
+ * @public + */ + owners: OwnerPropertiesOutput[] | undefined; + + /** + *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 details of the resource mentioned in a notification.
+ *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 type of the notification.
+ * @public + */ + type: NotificationType | undefined; + + /** + *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 + */ + message: string | undefined; + + /** + *The status included in the notification.
+ * @public + */ + status?: TaskStatus; + + /** + *The action link included in the notification.
+ * @public + */ + actionLink: string | undefined; + + /** + *The timestamp of when a notification was created.
+ * @public + */ + creationTimestamp: Date | undefined; + + /** + *The timestamp of when the notification was last updated.
+ * @public + */ + lastUpdatedTimestamp: Date | undefined; + + /** + *The metadata included in the notification.
+ * @public + */ + metadata?: RecordThe results of the ListNotifications action.
The role of the resource mentioned in a notification.
+ *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 a notification generated in Amazon DataZone.
* @public */ -export interface NotificationOutput { - /** - *The identifier of the notification.
- * @public - */ - identifier: string | undefined; - +export interface ListPolicyGrantsInput { /** - *The identifier of a Amazon DataZone domain in which the notification exists.
+ *The ID of the domain where you want to list policy grants.
* @public */ domainIdentifier: string | undefined; /** - *The type of the notification.
+ *The type of entity for which you want to list policy grants.
* @public */ - type: NotificationType | undefined; + entityType: TargetEntityType | undefined; /** - *The topic of the notification.
+ *The ID of the entity for which you want to list policy grants.
* @public */ - topic: Topic | undefined; + entityIdentifier: string | undefined; /** - *The title of the notification.
+ *The type of policy that you want to list.
* @public */ - title: string | undefined; + policyType: ManagedPolicyType | undefined; /** - *The message included in the notification.
+ *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 status included in the notification.
+ *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 action link included in the notification.
+ *The principal of the policy grant member.
* @public */ - actionLink: string | undefined; + principal?: PolicyGrantPrincipal; /** - *The timestamp of when a notification was created.
+ *The details of the policy grant member.
* @public */ - creationTimestamp: Date | undefined; + detail?: PolicyGrantDetail; /** - *The timestamp of when the notification was last updated.
+ *Specifies the timestamp at which policy grant member was created.
* @public */ - lastUpdatedTimestamp: Date | undefined; + createdAt?: Date; /** - *The metadata included in the notification.
+ *Specifies the user who created the policy grant member.
* @public */ - metadata?: RecordThe results of the ListNotifications action.
The results of this action - the listed grants.
* @public */ - notifications?: NotificationOutput[]; + grantList: PolicyGrantMember[] | undefined; /** - *When the number of notifications is greater than the default value for the + *
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 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 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.
* @public
*/
nextToken?: string;
@@ -2210,6 +4291,12 @@ export interface ProjectSummary {
* @public
*/
updatedAt?: Date;
+
+ /**
+ * The ID of the domain unit.
+ * @public + */ + domainUnitId?: string; } /** @@ -3746,6 +5833,94 @@ export interface RejectSubscriptionRequestOutput { decisionComment?: string; } +/** + * @public + */ +export interface RemoveEntityOwnerInput { + /** + *The ID of the domain where you want to remove an owner from an entity.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The type of the entity from which you want to remove an owner.
+ * @public + */ + entityType: DataZoneEntityType | undefined; + + /** + *The ID of the entity from which you want to remove an owner.
+ * @public + */ + entityIdentifier: string | undefined; + + /** + *The owner that you want to remove from an entity.
+ * @public + */ + owner: OwnerProperties | undefined; + + /** + *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
+ * @public + */ + clientToken?: string; +} + +/** + * @public + */ +export interface RemoveEntityOwnerOutput {} + +/** + * @public + */ +export interface RemovePolicyGrantInput { + /** + *The ID of the domain where you want to remove a policy grant.
+ * @public + */ + domainIdentifier: string | undefined; + + /** + *The type of the entity from which you want to remove a policy grant.
+ * @public + */ + entityType: TargetEntityType | undefined; + + /** + *The ID of the entity from which you want to remove a policy grant.
+ * @public + */ + entityIdentifier: string | undefined; + + /** + *The type of the policy that you want to remove.
+ * @public + */ + policyType: ManagedPolicyType | undefined; + + /** + *The principal from which you want to remove a policy grant.
+ * @public + */ + principal: PolicyGrantPrincipal | undefined; + + /** + *A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.
+ * @public + */ + clientToken?: string; +} + +/** + * @public + */ +export interface RemovePolicyGrantOutput {} + /** * @public */ @@ -5244,7 +7419,7 @@ export interface UpdateGroupProfileOutput { */ export interface UpdateProjectInput { /** - *The identifier of the Amazon DataZone domain in which a project is to be updated.
+ *The ID of the Amazon DataZone domain where a project is being updated.
* @public */ domainIdentifier: string | undefined; @@ -5339,6 +7514,12 @@ export interface UpdateProjectOutput { * @public */ glossaryTerms?: string[]; + + /** + *The ID of the domain unit.
+ * @public + */ + domainUnitId?: string; } /** @@ -6518,6 +8699,138 @@ export interface UpdateAssetFilterOutput { effectiveRowFilter?: string; } +/** + * @internal + */ +export const ImportFilterSensitiveLog = (obj: Import): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetFormTypeOutputFilterSensitiveLog = (obj: GetFormTypeOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.model && { model: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.imports && { imports: obj.imports.map((item) => ImportFilterSensitiveLog(item)) }), +}); + +/** + * @internal + */ +export const GetEnvironmentOutputFilterSensitiveLog = (obj: GetEnvironmentOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.userParameters && { + userParameters: obj.userParameters.map((item) => CustomParameterFilterSensitiveLog(item)), + }), + ...(obj.provisioningProperties && { provisioningProperties: obj.provisioningProperties }), +}); + +/** + * @internal + */ +export const GetEnvironmentBlueprintOutputFilterSensitiveLog = (obj: GetEnvironmentBlueprintOutput): any => ({ + ...obj, + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.provisioningProperties && { provisioningProperties: obj.provisioningProperties }), + ...(obj.userParameters && { + userParameters: obj.userParameters.map((item) => CustomParameterFilterSensitiveLog(item)), + }), +}); + +/** + * @internal + */ +export const GetEnvironmentCredentialsOutputFilterSensitiveLog = (obj: GetEnvironmentCredentialsOutput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const GetEnvironmentProfileOutputFilterSensitiveLog = (obj: GetEnvironmentProfileOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.userParameters && { + userParameters: obj.userParameters.map((item) => CustomParameterFilterSensitiveLog(item)), + }), +}); + +/** + * @internal + */ +export const GetGroupProfileOutputFilterSensitiveLog = (obj: GetGroupProfileOutput): any => ({ + ...obj, + ...(obj.groupName && { groupName: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetLineageNodeOutputFilterSensitiveLog = (obj: GetLineageNodeOutput): any => ({ + ...obj, + ...(obj.formsOutput && { formsOutput: obj.formsOutput.map((item) => FormOutputFilterSensitiveLog(item)) }), +}); + +/** + * @internal + */ +export const GetProjectOutputFilterSensitiveLog = (obj: GetProjectOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetSubscriptionOutputFilterSensitiveLog = (obj: GetSubscriptionOutput): any => ({ + ...obj, + ...(obj.subscribedPrincipal && { + subscribedPrincipal: SubscribedPrincipalFilterSensitiveLog(obj.subscribedPrincipal), + }), + ...(obj.subscribedListing && { subscribedListing: SubscribedListingFilterSensitiveLog(obj.subscribedListing) }), +}); + +/** + * @internal + */ +export const GetSubscriptionRequestDetailsOutputFilterSensitiveLog = ( + obj: GetSubscriptionRequestDetailsOutput +): any => ({ + ...obj, + ...(obj.requestReason && { requestReason: SENSITIVE_STRING }), + ...(obj.subscribedPrincipals && { + subscribedPrincipals: obj.subscribedPrincipals.map((item) => SubscribedPrincipalFilterSensitiveLog(item)), + }), + ...(obj.subscribedListings && { + subscribedListings: obj.subscribedListings.map((item) => SubscribedListingFilterSensitiveLog(item)), + }), + ...(obj.decisionComment && { decisionComment: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetSubscriptionTargetOutputFilterSensitiveLog = (obj: GetSubscriptionTargetOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const GetUserProfileOutputFilterSensitiveLog = (obj: GetUserProfileOutput): any => ({ + ...obj, + ...(obj.details && { details: UserProfileDetailsFilterSensitiveLog(obj.details) }), +}); + /** * @internal */ diff --git a/clients/client-datazone/src/pagination/ListDomainUnitsForParentPaginator.ts b/clients/client-datazone/src/pagination/ListDomainUnitsForParentPaginator.ts new file mode 100644 index 000000000000..bfd896d1c26b --- /dev/null +++ b/clients/client-datazone/src/pagination/ListDomainUnitsForParentPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListDomainUnitsForParentCommand, + ListDomainUnitsForParentCommandInput, + ListDomainUnitsForParentCommandOutput, +} from "../commands/ListDomainUnitsForParentCommand"; +import { DataZoneClient } from "../DataZoneClient"; +import { DataZonePaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListDomainUnitsForParent: ( + config: DataZonePaginationConfiguration, + input: ListDomainUnitsForParentCommandInput, + ...rest: any[] +) => PaginatorThe parameters of the environment action.
" } }, + "com.amazonaws.datazone#AddEntityOwner": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#AddEntityOwnerInput" + }, + "output": { + "target": "com.amazonaws.datazone#AddEntityOwnerOutput" + }, + "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": "Adds the owner of an entity (a domain unit).
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/addOwner" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["Administration"] + } + }, + "com.amazonaws.datazone#AddEntityOwnerInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain in which you want to add the entity owner.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.datazone#DataZoneEntityType", + "traits": { + "smithy.api#documentation": "The type of an entity.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the entity to which you want to add an owner.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "owner": { + "target": "com.amazonaws.datazone#OwnerProperties", + "traits": { + "smithy.api#documentation": "The owner that you want to add to the entity.
", + "smithy.api#required": {} + } + }, + "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#AddEntityOwnerOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#AddPolicyGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#AddPolicyGrantInput" + }, + "output": { + "target": "com.amazonaws.datazone#AddPolicyGrantOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds a policy grant (an authorization policy) to a specified entity, including domain\n units, environment blueprint configurations, or environment profiles.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/addGrant" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["Administration"] + } + }, + "com.amazonaws.datazone#AddPolicyGrantInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where you want to add a policy grant.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.datazone#TargetEntityType", + "traits": { + "smithy.api#documentation": "The type of entity (resource) to which the grant is added.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the entity (resource) to which you want to add a policy grant.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.datazone#ManagedPolicyType", + "traits": { + "smithy.api#documentation": "The type of policy that you want to grant.
", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.datazone#PolicyGrantPrincipal", + "traits": { + "smithy.api#documentation": "The principal to whom the permissions are granted.
", + "smithy.api#required": {} + } + }, + "detail": { + "target": "com.amazonaws.datazone#PolicyGrantDetail", + "traits": { + "smithy.api#documentation": "The details of the policy grant.
", + "smithy.api#required": {} + } + }, + "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#AddPolicyGrantOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#AddToProjectMemberPoolPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the policy grant is applied to child domain units.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the policy grant.
" + } + }, + "com.amazonaws.datazone#AllDomainUnitsGrantFilter": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The grant filter for all domain units.
" + } + }, + "com.amazonaws.datazone#AllUsersGrantFilter": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The all users grant filter.
" + } + }, "com.amazonaws.datazone#ApplicableAssetTypes": { "type": "list", "member": { @@ -2528,6 +2757,20 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#CreateAssetTypePolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the policy grant is applied to child domain units.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the policy grant.
" + } + }, "com.amazonaws.datazone#CreateDataProduct": { "type": "operation", "input": { @@ -3302,6 +3545,12 @@ "smithy.api#required": {} } }, + "rootDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the root domain unit.
" + } + }, "name": { "target": "smithy.api#String", "traits": { @@ -3361,13 +3610,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#CreateEnvironment": { + "com.amazonaws.datazone#CreateDomainUnit": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#CreateEnvironmentInput" + "target": "com.amazonaws.datazone#CreateDomainUnitInput" }, "output": { - "target": "com.amazonaws.datazone#CreateEnvironmentOutput" + "target": "com.amazonaws.datazone#CreateDomainUnitOutput" }, "errors": [ { @@ -3380,7 +3629,7 @@ "target": "com.amazonaws.datazone#InternalServerException" }, { - "target": "com.amazonaws.datazone#ResourceNotFoundException" + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" }, { "target": "com.amazonaws.datazone#ThrottlingException" @@ -3390,72 +3639,235 @@ } ], "traits": { - "smithy.api#documentation": "Create an Amazon DataZone environment.
", + "smithy.api#documentation": "Creates a domain unit in Amazon DataZone.
", "smithy.api#http": { "code": 201, "method": "POST", - "uri": "/v2/domains/{domainIdentifier}/environments" - } - } - }, - "com.amazonaws.datazone#CreateEnvironmentAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.datazone#CreateEnvironmentActionInput" - }, - "output": { - "target": "com.amazonaws.datazone#CreateEnvironmentActionOutput" - }, - "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" + "uri": "/v2/domains/{domainIdentifier}/domain-units" }, - { - "target": "com.amazonaws.datazone#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an action for the environment, for example, creates a console link for an\n analytics tool that is available in this environment.
", - "smithy.api#http": { - "code": 201, - "method": "POST", - "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions" - } + "smithy.api#idempotent": {}, + "smithy.api#tags": ["Administration"] } }, - "com.amazonaws.datazone#CreateEnvironmentActionInput": { + "com.amazonaws.datazone#CreateDomainUnitInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the environment action is created.
", + "smithy.api#documentation": "The ID of the domain where you want to crate a domain unit.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "environmentIdentifier": { - "target": "com.amazonaws.datazone#EnvironmentId", + "name": { + "target": "com.amazonaws.datazone#DomainUnitName", "traits": { - "smithy.api#documentation": "The ID of the environment in which the environment action is created.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The name of the domain unit.
", "smithy.api#required": {} } }, - "name": { - "target": "smithy.api#String", + "parentDomainUnitIdentifier": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the parent domain unit.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#DomainUnitDescription", + "traits": { + "smithy.api#documentation": "The description of the domain unit.
" + } + }, + "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#CreateDomainUnitOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the domain unit.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where the domain unit was created.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#DomainUnitName", + "traits": { + "smithy.api#documentation": "The name of the domain unit.
", + "smithy.api#required": {} + } + }, + "parentDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the parent domain unit.
" + } + }, + "description": { + "target": "com.amazonaws.datazone#DomainUnitDescription", + "traits": { + "smithy.api#documentation": "The description of the domain unit.
" + } + }, + "owners": { + "target": "com.amazonaws.datazone#DomainUnitOwners", + "traits": { + "smithy.api#documentation": "The owners of the domain unit.
", + "smithy.api#required": {} + } + }, + "ancestorDomainUnitIds": { + "target": "com.amazonaws.datazone#DomainUnitIds", + "traits": { + "smithy.api#documentation": "The IDs of the ancestor domain units.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the domain unit was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The user who created the domain unit.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#CreateDomainUnitPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the policy grant is applied to child domain units.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the policy grant.
" + } + }, + "com.amazonaws.datazone#CreateEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateEnvironmentInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateEnvironmentOutput" + }, + "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": "Create an Amazon DataZone environment.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/environments" + } + } + }, + "com.amazonaws.datazone#CreateEnvironmentAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateEnvironmentActionInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateEnvironmentActionOutput" + }, + "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": "Creates an action for the environment, for example, creates a console link for an\n analytics tool that is available in this environment.
", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions" + } + } + }, + "com.amazonaws.datazone#CreateEnvironmentActionInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the environment action is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the environment in which the environment action is created.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the environment action.
", "smithy.api#required": {} @@ -3932,6 +4344,20 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#CreateEnvironmentProfilePolicyGrantDetail": { + "type": "structure", + "members": { + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the domain unit.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the policy grant.
" + } + }, "com.amazonaws.datazone#CreateFormType": { "type": "operation", "input": { @@ -4071,6 +4497,20 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#CreateFormTypePolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the policy grant is applied to child domain units.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the policy grant.
" + } + }, "com.amazonaws.datazone#CreateGlossary": { "type": "operation", "input": { @@ -4206,6 +4646,20 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#CreateGlossaryPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the policy grant is applied to child domain units.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the policy grant.
" + } + }, "com.amazonaws.datazone#CreateGlossaryTerm": { "type": "operation", "input": { @@ -4652,6 +5106,12 @@ "traits": { "smithy.api#documentation": "The glossary terms that can be used in this Amazon DataZone project.
" } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the domain unit. This parameter is not required and if it is not specified, then\n the project is created at the root domain unit level.
" + } } }, "traits": { @@ -4802,12 +5262,32 @@ "traits": { "smithy.api#documentation": "The glossary terms that can be used in the project.
" } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the domain unit.
" + } } }, "traits": { "smithy.api#output": {} } }, + "com.amazonaws.datazone#CreateProjectPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the policy grant is applied to child domain units.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the policy grant.
" + } + }, "com.amazonaws.datazone#CreateSubscriptionGrant": { "type": "operation", "input": { @@ -6728,6 +7208,12 @@ { "target": "com.amazonaws.datazone#AcceptSubscriptionRequest" }, + { + "target": "com.amazonaws.datazone#AddEntityOwner" + }, + { + "target": "com.amazonaws.datazone#AddPolicyGrant" + }, { "target": "com.amazonaws.datazone#AssociateEnvironmentRole" }, @@ -6863,6 +7349,9 @@ { "target": "com.amazonaws.datazone#ListDataSourceRunActivities" }, + { + "target": "com.amazonaws.datazone#ListEntityOwners" + }, { "target": "com.amazonaws.datazone#ListEnvironmentActions" }, @@ -6881,6 +7370,9 @@ { "target": "com.amazonaws.datazone#ListNotifications" }, + { + "target": "com.amazonaws.datazone#ListPolicyGrants" + }, { "target": "com.amazonaws.datazone#ListProjectMemberships" }, @@ -6917,6 +7409,12 @@ { "target": "com.amazonaws.datazone#RejectSubscriptionRequest" }, + { + "target": "com.amazonaws.datazone#RemoveEntityOwner" + }, + { + "target": "com.amazonaws.datazone#RemovePolicyGrant" + }, { "target": "com.amazonaws.datazone#RevokeSubscription" }, @@ -6991,6 +7489,9 @@ { "target": "com.amazonaws.datazone#Domain" }, + { + "target": "com.amazonaws.datazone#DomainUnit" + }, { "target": "com.amazonaws.datazone#EnvironmentBlueprintConfiguration" }, @@ -7434,6 +7935,17 @@ } } }, + "com.amazonaws.datazone#DataZoneEntityType": { + "type": "enum", + "members": { + "DOMAIN_UNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_UNIT" + } + } + } + }, "com.amazonaws.datazone#DateTime": { "type": "timestamp", "traits": { @@ -8033,18 +8545,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#DeleteEnvironment": { + "com.amazonaws.datazone#DeleteDomainUnit": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#DeleteEnvironmentInput" + "target": "com.amazonaws.datazone#DeleteDomainUnitInput" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.datazone#DeleteDomainUnitOutput" }, "errors": [ { "target": "com.amazonaws.datazone#AccessDeniedException" }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, { "target": "com.amazonaws.datazone#InternalServerException" }, @@ -8059,20 +8574,87 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an environment in Amazon DataZone.
", + "smithy.api#documentation": "Deletes a domain unit.
", "smithy.api#http": { "code": 204, "method": "DELETE", - "uri": "/v2/domains/{domainIdentifier}/environments/{identifier}" + "uri": "/v2/domains/{domainIdentifier}/domain-units/{identifier}" }, - "smithy.api#idempotent": {} + "smithy.api#idempotent": {}, + "smithy.api#tags": ["Administration"] } }, - "com.amazonaws.datazone#DeleteEnvironmentAction": { - "type": "operation", - "input": { - "target": "com.amazonaws.datazone#DeleteEnvironmentActionInput" - }, + "com.amazonaws.datazone#DeleteDomainUnitInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where you want to delete a domain unit.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the domain unit that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteDomainUnitOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#DeleteEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteEnvironmentInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "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": "Deletes an environment in Amazon DataZone.
", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/environments/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteEnvironmentAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteEnvironmentActionInput" + }, "output": { "target": "smithy.api#Unit" }, @@ -9346,6 +9928,9 @@ "id": { "target": "com.amazonaws.datazone#DomainId" }, + "rootDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId" + }, "status": { "target": "com.amazonaws.datazone#DomainStatus" }, @@ -9511,158 +10096,429 @@ "smithy.api#documentation": "A summary of a Amazon DataZone domain.
" } }, - "com.amazonaws.datazone#EdgeDirection": { - "type": "enum", - "members": { - "UPSTREAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPSTREAM" - } + "com.amazonaws.datazone#DomainUnit": { + "type": "resource", + "identifiers": { + "identifier": { + "target": "com.amazonaws.datazone#DomainUnitId" + } + }, + "properties": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" }, - "DOWNSTREAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOWNSTREAM" - } + "parentDomainUnitIdentifier": { + "target": "com.amazonaws.datazone#DomainUnitId" + }, + "name": { + "target": "com.amazonaws.datazone#DomainUnitName" + }, + "description": { + "target": "com.amazonaws.datazone#DomainUnitDescription" + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken" + }, + "owners": { + "target": "com.amazonaws.datazone#DomainUnitOwners" + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId" + }, + "id": { + "target": "com.amazonaws.datazone#DomainUnitId" + }, + "parentDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId" + }, + "ancestorDomainUnitIds": { + "target": "com.amazonaws.datazone#DomainUnitIds" + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt" + }, + "lastUpdatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt" + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy" + }, + "lastUpdatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy" } + }, + "create": { + "target": "com.amazonaws.datazone#CreateDomainUnit" + }, + "read": { + "target": "com.amazonaws.datazone#GetDomainUnit" + }, + "update": { + "target": "com.amazonaws.datazone#UpdateDomainUnit" + }, + "delete": { + "target": "com.amazonaws.datazone#DeleteDomainUnit" + }, + "list": { + "target": "com.amazonaws.datazone#ListDomainUnitsForParent" } }, - "com.amazonaws.datazone#EditedValue": { + "com.amazonaws.datazone#DomainUnitDescription": { "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 5000 + "max": 2048 }, "smithy.api#sensitive": {} } }, - "com.amazonaws.datazone#EnableSetting": { + "com.amazonaws.datazone#DomainUnitDesignation": { "type": "enum", "members": { - "ENABLED": { + "OWNER": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "OWNER" + } + } + } + }, + "com.amazonaws.datazone#DomainUnitFilterForProject": { + "type": "structure", + "members": { + "domainUnit": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The domain unit ID to use in the filter.
", + "smithy.api#required": {} } }, - "DISABLED": { - "target": "smithy.api#Unit", + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#addedDefault": {}, + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether to include child domain units.
" } } + }, + "traits": { + "smithy.api#documentation": "The domain unit filter of the project grant filter.
" } }, - "com.amazonaws.datazone#EnabledRegionList": { - "type": "list", - "member": { - "target": "com.amazonaws.datazone#RegionName" + "com.amazonaws.datazone#DomainUnitGrantFilter": { + "type": "union", + "members": { + "allDomainUnitsGrantFilter": { + "target": "com.amazonaws.datazone#AllDomainUnitsGrantFilter", + "traits": { + "smithy.api#documentation": "Specifies a grant filter containing all domain units.
" + } + } }, "traits": { - "smithy.api#length": { - "min": 0 + "smithy.api#documentation": "The grant filter for the domain unit. In the current release of Amazon DataZone, the only\nsupported filter is the allDomainUnitsGrantFilter.
The ID of the domain unit group.
" + } } + }, + "traits": { + "smithy.api#documentation": "The properties of a domain unit group.
" } }, - "com.amazonaws.datazone#EntityId": { + "com.amazonaws.datazone#DomainUnitId": { "type": "string", "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-z0-9_\\-]+$" } }, - "com.amazonaws.datazone#EntityIdentifier": { + "com.amazonaws.datazone#DomainUnitIds": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#DomainUnitId" + } + }, + "com.amazonaws.datazone#DomainUnitName": { "type": "string", "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[\\w -]+$", + "smithy.api#sensitive": {} } }, - "com.amazonaws.datazone#EntityType": { - "type": "enum", + "com.amazonaws.datazone#DomainUnitOwnerProperties": { + "type": "union", "members": { - "ASSET": { - "target": "smithy.api#Unit", + "user": { + "target": "com.amazonaws.datazone#DomainUnitUserProperties", "traits": { - "smithy.api#enumValue": "ASSET" + "smithy.api#documentation": "Indicates that the domain unit owner is a user.
" } }, - "DATA_PRODUCT": { - "target": "smithy.api#Unit", + "group": { + "target": "com.amazonaws.datazone#DomainUnitGroupProperties", "traits": { - "smithy.api#enumValue": "DATA_PRODUCT" + "smithy.api#documentation": "Indicates that the domain unit owner is a group.
" } } - } - }, - "com.amazonaws.datazone#EnvironmentActionId": { - "type": "string", + }, "traits": { - "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + "smithy.api#documentation": "The properties of the domain unit owner.
" } }, - "com.amazonaws.datazone#EnvironmentActionList": { + "com.amazonaws.datazone#DomainUnitOwners": { "type": "list", "member": { - "target": "com.amazonaws.datazone#ConfigurableEnvironmentAction" + "target": "com.amazonaws.datazone#DomainUnitOwnerProperties" + }, + "traits": { + "smithy.api#length": { + "max": 20 + } } }, - "com.amazonaws.datazone#EnvironmentActionSummary": { + "com.amazonaws.datazone#DomainUnitPolicyGrantPrincipal": { "type": "structure", "members": { - "domainId": { - "target": "com.amazonaws.datazone#DomainId", + "domainUnitDesignation": { + "target": "com.amazonaws.datazone#DomainUnitDesignation", "traits": { - "smithy.api#documentation": "The Amazon DataZone domain ID of the environment action.
", + "smithy.api#documentation": "Specifes the designation of the domain unit users.
", "smithy.api#required": {} } }, - "environmentId": { - "target": "com.amazonaws.datazone#EnvironmentId", + "domainUnitIdentifier": { + "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#documentation": "The environment ID of the environment action.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the domain unit.
" } }, - "id": { - "target": "com.amazonaws.datazone#EnvironmentActionId", + "domainUnitGrantFilter": { + "target": "com.amazonaws.datazone#DomainUnitGrantFilter", "traits": { - "smithy.api#documentation": "The ID of the environment action.
", - "smithy.api#required": {} + "smithy.api#documentation": "The grant filter for the domain unit.
" } - }, + } + }, + "traits": { + "smithy.api#documentation": "The domain unit principal to whom the policy is granted.
" + } + }, + "com.amazonaws.datazone#DomainUnitSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#DomainUnitSummary" + } + }, + "com.amazonaws.datazone#DomainUnitSummary": { + "type": "structure", + "members": { "name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The name of the environment action.
", + "smithy.api#documentation": "The name of the domain unit summary.
", "smithy.api#required": {} } }, - "parameters": { - "target": "com.amazonaws.datazone#ActionParameters", + "id": { + "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#documentation": "The parameters of the environment action.
", + "smithy.api#documentation": "The ID of the domain unit summary.
", "smithy.api#required": {} } - }, - "description": { + } + }, + "traits": { + "smithy.api#documentation": "The summary of the domain unit.
" + } + }, + "com.amazonaws.datazone#DomainUnitUserProperties": { + "type": "structure", + "members": { + "userId": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The environment action description.
" + "smithy.api#documentation": "The ID of teh domain unit user.
" } } }, "traits": { - "smithy.api#documentation": "The details about the specified action configured for an environment. For example, the\n details of the specified console links for an analytics tool that is available in this\n environment.
" + "smithy.api#documentation": "The properties of the domain unit user.
" } }, - "com.amazonaws.datazone#EnvironmentBlueprintConfiguration": { - "type": "resource", - "identifiers": { - "domainIdentifier": { - "target": "com.amazonaws.datazone#DomainId" - }, - "environmentBlueprintIdentifier": { + "com.amazonaws.datazone#EdgeDirection": { + "type": "enum", + "members": { + "UPSTREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPSTREAM" + } + }, + "DOWNSTREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOWNSTREAM" + } + } + } + }, + "com.amazonaws.datazone#EditedValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#EnableSetting": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.datazone#EnabledRegionList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#RegionName" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.datazone#EntityId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#EntityIdentifier": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#EntityOwners": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#OwnerPropertiesOutput" + } + }, + "com.amazonaws.datazone#EntityType": { + "type": "enum", + "members": { + "ASSET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSET" + } + }, + "DATA_PRODUCT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_PRODUCT" + } + } + } + }, + "com.amazonaws.datazone#EnvironmentActionId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#EnvironmentActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#ConfigurableEnvironmentAction" + } + }, + "com.amazonaws.datazone#EnvironmentActionSummary": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The Amazon DataZone domain ID of the environment action.
", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The environment ID of the environment action.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#EnvironmentActionId", + "traits": { + "smithy.api#documentation": "The ID of the environment action.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the environment action.
", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.datazone#ActionParameters", + "traits": { + "smithy.api#documentation": "The parameters of the environment action.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The environment action description.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details about the specified action configured for an environment. For example, the\n details of the specified console links for an analytics tool that is available in this\n environment.
" + } + }, + "com.amazonaws.datazone#EnvironmentBlueprintConfiguration": { + "type": "resource", + "identifiers": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId" + }, + "environmentBlueprintIdentifier": { "target": "com.amazonaws.datazone#EnvironmentBlueprintId" } }, @@ -11872,6 +12728,12 @@ "smithy.api#required": {} } }, + "rootDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the root domain in Amazon Datazone.
" + } + }, "name": { "target": "smithy.api#String", "traits": { @@ -11945,48 +12807,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#GetEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.datazone#GetEnvironmentInput" - }, - "output": { - "target": "com.amazonaws.datazone#GetEnvironmentOutput" - }, - "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 an Amazon DataZone environment.
", - "smithy.api#http": { - "code": 200, - "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/environments/{identifier}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.datazone#GetEnvironmentAction": { + "com.amazonaws.datazone#GetDomainUnit": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#GetEnvironmentActionInput" + "target": "com.amazonaws.datazone#GetDomainUnitInput" }, "output": { - "target": "com.amazonaws.datazone#GetEnvironmentActionOutput" + "target": "com.amazonaws.datazone#GetDomainUnitOutput" }, "errors": [ { @@ -12006,38 +12833,31 @@ } ], "traits": { - "smithy.api#documentation": "Gets the specified environment action.
", + "smithy.api#documentation": "Gets the details of the specified domain unit.
", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions/{identifier}" + "uri": "/v2/domains/{domainIdentifier}/domain-units/{identifier}" }, - "smithy.api#readonly": {} + "smithy.api#readonly": {}, + "smithy.api#tags": ["Administration"] } }, - "com.amazonaws.datazone#GetEnvironmentActionInput": { + "com.amazonaws.datazone#GetDomainUnitInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is\n invoked.
The environment ID of the environment action.
", + "smithy.api#documentation": "The ID of the domain where you want to get a domain unit.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "identifier": { - "target": "smithy.api#String", + "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#documentation": "The ID of the environment action
", + "smithy.api#documentation": "The identifier of the domain unit that you want to get.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12047,48 +12867,222 @@ "smithy.api#input": {} } }, - "com.amazonaws.datazone#GetEnvironmentActionOutput": { + "com.amazonaws.datazone#GetDomainUnitOutput": { "type": "structure", "members": { + "id": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the domain unit.
", + "smithy.api#required": {} + } + }, "domainId": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the environment action lives.
", + "smithy.api#documentation": "The ID of the domain in which the domain unit lives.
", "smithy.api#required": {} } }, - "environmentId": { - "target": "com.amazonaws.datazone#EnvironmentId", + "name": { + "target": "com.amazonaws.datazone#DomainUnitName", "traits": { - "smithy.api#documentation": "The environment ID of the environment action.
", + "smithy.api#documentation": "The name of the domain unit.
", "smithy.api#required": {} } }, - "id": { - "target": "com.amazonaws.datazone#EnvironmentActionId", + "parentDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", "traits": { - "smithy.api#documentation": "The ID of the environment action.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the parent domain unit.
" } }, - "name": { - "target": "smithy.api#String", + "description": { + "target": "com.amazonaws.datazone#DomainUnitDescription", "traits": { - "smithy.api#documentation": "The name of the environment action.
", - "smithy.api#required": {} + "smithy.api#documentation": "The description of the domain unit.
" } }, - "parameters": { - "target": "com.amazonaws.datazone#ActionParameters", + "owners": { + "target": "com.amazonaws.datazone#DomainUnitOwners", "traits": { - "smithy.api#documentation": "The parameters of the environment action.
", + "smithy.api#documentation": "The owners of the domain unit.
", "smithy.api#required": {} } }, - "description": { - "target": "smithy.api#String", + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", "traits": { - "smithy.api#documentation": "The description of the environment action.
" + "smithy.api#documentation": "The time stamp at which the domain unit was created.
" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the domain unit was last updated.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The user who created the domain unit.
" + } + }, + "lastUpdatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The user who last updated the domain unit.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#GetEnvironment": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetEnvironmentInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetEnvironmentOutput" + }, + "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 an Amazon DataZone environment.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environments/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetEnvironmentActionInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetEnvironmentActionOutput" + }, + "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 specified environment action.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentActionInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is\n invoked.
The environment ID of the environment action.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the environment action
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetEnvironmentActionOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the environment action lives.
", + "smithy.api#required": {} + } + }, + "environmentId": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The environment ID of the environment action.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.datazone#EnvironmentActionId", + "traits": { + "smithy.api#documentation": "The ID of the environment action.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the environment action.
", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "com.amazonaws.datazone#ActionParameters", + "traits": { + "smithy.api#documentation": "The parameters of the environment action.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the environment action.
" } } }, @@ -13904,6 +14898,12 @@ "traits": { "smithy.api#documentation": "The business glossary terms that can be used in the project.
" } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the domain unit.
" + } } }, "traits": { @@ -15299,13 +16299,27 @@ "com.amazonaws.datazone#GroupIdentifier": { "type": "string", "traits": { - "smithy.api#pattern": "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$|[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+)" + "smithy.api#pattern": "(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\t\\n\\r ]+)" + } + }, + "com.amazonaws.datazone#GroupPolicyGrantPrincipal": { + "type": "union", + "members": { + "groupIdentifier": { + "target": "com.amazonaws.datazone#GroupIdentifier", + "traits": { + "smithy.api#documentation": "The ID Of the group of the group principal.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The group principal to whom the policy is granted.
" } }, "com.amazonaws.datazone#GroupProfileId": { "type": "string", "traits": { - "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + "smithy.api#pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$" } }, "com.amazonaws.datazone#GroupProfileName": { @@ -16531,30 +17545,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#ListDomains": { + "com.amazonaws.datazone#ListDomainUnitsForParent": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#ListDomainsInput" + "target": "com.amazonaws.datazone#ListDomainUnitsForParentInput" }, "output": { - "target": "com.amazonaws.datazone#ListDomainsOutput" + "target": "com.amazonaws.datazone#ListDomainUnitsForParentOutput" }, "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" }, @@ -16563,11 +17568,11 @@ } ], "traits": { - "smithy.api#documentation": "Lists Amazon DataZone domains.
", + "smithy.api#documentation": "Lists child domain units for the specified parent domain unit.
", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains" + "uri": "/v2/domains/{domainIdentifier}/domain-units" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -16575,30 +17580,40 @@ "pageSize": "maxResults", "items": "items" }, - "smithy.api#readonly": {} + "smithy.api#readonly": {}, + "smithy.api#tags": ["Administration"] } }, - "com.amazonaws.datazone#ListDomainsInput": { + "com.amazonaws.datazone#ListDomainUnitsForParentInput": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.datazone#DomainStatus", + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "The status of the data source.
", - "smithy.api#httpQuery": "status" + "smithy.api#documentation": "The ID of the domain in which you want to list domain units for a parent domain\n unit.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "parentDomainUnitIdentifier": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the parent domain unit.
", + "smithy.api#httpQuery": "parentDomainUnitIdentifier", + "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.datazone#MaxResultsForListDomains", "traits": { - "smithy.api#documentation": "The maximum number of domains to return in a single call to ListDomains.\n When the number of domains to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that you\n can use in a subsequent call to ListDomains to list the next set of\n domains.
The maximum number of domain units to return in a single call to\n ListDomainUnitsForParent. When the number of domain units to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that you can use in a\n subsequent call to ListDomainUnitsForParent to list the next set of domain units.
", "smithy.api#httpQuery": "maxResults" } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "When the number of domains 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 domains, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDomains to list the next set of\n domains.
When the number of domain units is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of domain units, the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set\n of domain units.
", "smithy.api#httpQuery": "nextToken" } } @@ -16607,20 +17622,20 @@ "smithy.api#input": {} } }, - "com.amazonaws.datazone#ListDomainsOutput": { + "com.amazonaws.datazone#ListDomainUnitsForParentOutput": { "type": "structure", "members": { "items": { - "target": "com.amazonaws.datazone#DomainSummaries", + "target": "com.amazonaws.datazone#DomainUnitSummaries", "traits": { - "smithy.api#documentation": "The results of the ListDomains action.
The results returned by this action.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "When the number of domains 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 domains, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDomains to list the next set of\n domains.
When the number of domain units is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of domain units, the response includes a pagination token named NextToken. You can specify\n this NextToken value in a subsequent call to ListDomainUnitsForParent to list the next set\n of domain units.
" } } }, @@ -16628,27 +17643,30 @@ "smithy.api#output": {} } }, - "com.amazonaws.datazone#ListEnvironmentActionSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.datazone#EnvironmentActionSummary" - } - }, - "com.amazonaws.datazone#ListEnvironmentActions": { + "com.amazonaws.datazone#ListDomains": { "type": "operation", "input": { - "target": "com.amazonaws.datazone#ListEnvironmentActionsInput" + "target": "com.amazonaws.datazone#ListDomainsInput" }, "output": { - "target": "com.amazonaws.datazone#ListEnvironmentActionsOutput" + "target": "com.amazonaws.datazone#ListDomainsOutput" }, "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" }, @@ -16657,11 +17675,11 @@ } ], "traits": { - "smithy.api#documentation": "Lists existing environment actions.
", + "smithy.api#documentation": "Lists Amazon DataZone domains.
", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions" + "uri": "/v2/domains" }, "smithy.api#paginated": { "inputToken": "nextToken", @@ -16672,45 +17690,245 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.datazone#ListEnvironmentActionsInput": { + "com.amazonaws.datazone#ListDomainsInput": { "type": "structure", "members": { - "domainIdentifier": { - "target": "com.amazonaws.datazone#DomainId", + "status": { + "target": "com.amazonaws.datazone#DomainStatus", "traits": { - "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the environment actions are listed.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The status of the data source.
", + "smithy.api#httpQuery": "status" } }, - "environmentIdentifier": { - "target": "com.amazonaws.datazone#EnvironmentId", + "maxResults": { + "target": "com.amazonaws.datazone#MaxResultsForListDomains", "traits": { - "smithy.api#documentation": "The ID of the envrironment whose environment actions are listed.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The maximum number of domains to return in a single call to ListDomains.\n When the number of domains to be listed is greater than the value of\n MaxResults, the response contains a NextToken value that you\n can use in a subsequent call to ListDomains to list the next set of\n domains.
When the number of environment actions 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 environment actions, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEnvironmentActions\n to list the next set of environment actions.
When the number of domains 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 domains, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDomains to list the next set of\n domains.
The maximum number of environment actions to return in a single call to\n ListEnvironmentActions. When the number of environment actions 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 ListEnvironmentActions to list the next set of environment actions.
The results of the ListDomains action.
When the number of domains 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 domains, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListDomains to list the next set of\n domains.
Lists the entity (domain units) owners.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/owners" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "owners" + }, + "smithy.api#readonly": {}, + "smithy.api#tags": ["Administration"] + } + }, + "com.amazonaws.datazone#ListEntityOwnersInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where you want to list entity owners.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.datazone#DataZoneEntityType", + "traits": { + "smithy.api#documentation": "The type of the entity that you want to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the entity that you want to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResultsForListDomains", + "traits": { + "smithy.api#documentation": "The maximum number of entities to return in a single call to\n ListEntityOwners. When the number of entities to be listed is greater than\n the value of MaxResults, the response contains a NextToken value\n that you can use in a subsequent call to ListEntityOwners to list the next set\n of entities.
When the number of entities 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 entities, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEntityOwners to\n list the next set of entities.
The owners of the entity.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of entities 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 entities, the response includes\n a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEntityOwners to\n list the next set of entities.
Lists existing environment actions.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListEnvironmentActionsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon DataZone domain in which the environment actions are listed.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentIdentifier": { + "target": "com.amazonaws.datazone#EnvironmentId", + "traits": { + "smithy.api#documentation": "The ID of the envrironment whose environment actions are listed.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of environment actions 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 environment actions, the\n response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListEnvironmentActions\n to list the next set of environment actions.
The maximum number of environment actions to return in a single call to\n ListEnvironmentActions. When the number of environment actions 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 ListEnvironmentActions to list the next set of environment actions.
Lists all members of the specified project.
", + "smithy.api#documentation": "Lists policy grants.
", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/projects/{projectIdentifier}/memberships" + "uri": "/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/grants" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", - "items": "members" + "items": "grantList" }, - "smithy.api#readonly": {} + "smithy.api#readonly": {}, + "smithy.api#tags": ["Administration"] } }, - "com.amazonaws.datazone#ListProjectMembershipsInput": { + "com.amazonaws.datazone#ListPolicyGrantsInput": { "type": "structure", "members": { "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which you want to list project\n memberships.
", + "smithy.api#documentation": "The ID of the domain where you want to list policy grants.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "projectIdentifier": { - "target": "com.amazonaws.datazone#ProjectId", + "entityType": { + "target": "com.amazonaws.datazone#TargetEntityType", "traits": { - "smithy.api#documentation": "The identifier of the project whose memberships you want to list.
", + "smithy.api#documentation": "The type of entity for which you want to list policy grants.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "sortBy": { - "target": "com.amazonaws.datazone#SortFieldProject", + "entityIdentifier": { + "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The method by which you want to sort the project memberships.
", - "smithy.api#httpQuery": "sortBy" + "smithy.api#documentation": "The ID of the entity for which you want to list policy grants.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "sortOrder": { - "target": "com.amazonaws.datazone#SortOrder", + "policyType": { + "target": "com.amazonaws.datazone#ManagedPolicyType", "traits": { - "smithy.api#documentation": "The sort order of the project memberships.
", - "smithy.api#httpQuery": "sortOrder" + "smithy.api#documentation": "The type of policy that you want to list.
", + "smithy.api#httpQuery": "policyType", + "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.datazone#PaginationToken", + "maxResults": { + "target": "com.amazonaws.datazone#MaxResultsForListDomains", "traits": { - "smithy.api#documentation": "When the number of memberships 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 memberships, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListProjectMemberships\n to list the next set of memberships.
The maximum number of grants to return in a single call to\n ListPolicyGrants. When the number of grants to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that\n you can use in a subsequent call to ListPolicyGrants to list the next set of\n grants.
The maximum number of memberships to return in a single call to\n ListProjectMemberships. When the number of memberships to be listed is\n greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListProjectMemberships to list the next set of memberships.
When the number of 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 grants, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListPolicyGrants to list the next set of\n grants.
The members of the project.
", + "smithy.api#documentation": "The results of this action - the listed grants.
", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.datazone#PaginationToken", "traits": { - "smithy.api#documentation": "When the number of memberships 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 memberships, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListProjectMemberships\n to list the next set of memberships.
When the number of 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 grants, the response includes a\n pagination token named NextToken. You can specify this NextToken\n value in a subsequent call to ListPolicyGrants to list the next set of\n grants.
Lists Amazon DataZone projects.
", + "smithy.api#documentation": "Lists all members of the specified project.
", "smithy.api#http": { "code": 200, "method": "GET", - "uri": "/v2/domains/{domainIdentifier}/projects" + "uri": "/v2/domains/{domainIdentifier}/projects/{projectIdentifier}/memberships" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", - "items": "items" + "items": "members" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListProjectMembershipsInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which you want to list project\n memberships.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "projectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The identifier of the project whose memberships you want to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.datazone#SortFieldProject", + "traits": { + "smithy.api#documentation": "The method by which you want to sort the project memberships.
", + "smithy.api#httpQuery": "sortBy" + } + }, + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order of the project memberships.
", + "smithy.api#httpQuery": "sortOrder" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of memberships 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 memberships, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListProjectMemberships\n to list the next set of memberships.
The maximum number of memberships to return in a single call to\n ListProjectMemberships. When the number of memberships to be listed is\n greater than the value of MaxResults, the response contains a\n NextToken value that you can use in a subsequent call to\n ListProjectMemberships to list the next set of memberships.
The members of the project.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of memberships 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 memberships, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListProjectMemberships\n to list the next set of memberships.
Lists Amazon DataZone projects.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/projects" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" }, "smithy.api#readonly": {} } @@ -18718,6 +20050,77 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#ManagedPolicyType": { + "type": "enum", + "members": { + "CREATE_DOMAIN_UNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_DOMAIN_UNIT" + } + }, + "OVERRIDE_DOMAIN_UNIT_OWNERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDE_DOMAIN_UNIT_OWNERS" + } + }, + "ADD_TO_PROJECT_MEMBER_POOL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADD_TO_PROJECT_MEMBER_POOL" + } + }, + "OVERRIDE_PROJECT_OWNERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERRIDE_PROJECT_OWNERS" + } + }, + "CREATE_GLOSSARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_GLOSSARY" + } + }, + "CREATE_FORM_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_FORM_TYPE" + } + }, + "CREATE_ASSET_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_ASSET_TYPE" + } + }, + "CREATE_PROJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_PROJECT" + } + }, + "CREATE_ENVIRONMENT_PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_ENVIRONMENT_PROFILE" + } + }, + "DELEGATE_CREATE_ENVIRONMENT_PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELEGATE_CREATE_ENVIRONMENT_PROFILE" + } + }, + "CREATE_ENVIRONMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_ENVIRONMENT" + } + } + } + }, "com.amazonaws.datazone#MaxResults": { "type": "integer", "traits": { @@ -19158,134 +20561,404 @@ "smithy.api#required": {} } }, - "lastUpdatedTimestamp": { - "target": "smithy.api#Timestamp", + "lastUpdatedTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the notification was last updated.
", + "smithy.api#required": {} + } + }, + "metadata": { + "target": "com.amazonaws.datazone#MetadataMap", + "traits": { + "smithy.api#documentation": "The metadata included in the notification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a notification generated in Amazon DataZone.
" + } + }, + "com.amazonaws.datazone#NotificationResource": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.datazone#NotificationResourceType", + "traits": { + "smithy.api#documentation": "The type of the resource mentioned in a notification.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the resource mentioned in a notification.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the resource mentioned in a notification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the resource mentioned in a notification.
" + } + }, + "com.amazonaws.datazone#NotificationResourceType": { + "type": "enum", + "members": { + "PROJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT" + } + } + } + }, + "com.amazonaws.datazone#NotificationRole": { + "type": "enum", + "members": { + "PROJECT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_OWNER" + } + }, + "PROJECT_CONTRIBUTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_CONTRIBUTOR" + } + }, + "PROJECT_VIEWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_VIEWER" + } + }, + "DOMAIN_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_OWNER" + } + }, + "PROJECT_SUBSCRIBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROJECT_SUBSCRIBER" + } + } + } + }, + "com.amazonaws.datazone#NotificationSubjects": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.datazone#NotificationType": { + "type": "enum", + "members": { + "TASK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TASK" + } + }, + "EVENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EVENT" + } + } + } + }, + "com.amazonaws.datazone#NotificationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#NotificationOutput" + } + }, + "com.amazonaws.datazone#OverrideDomainUnitOwnersPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the policy is inherited by child domain units.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The grant details of the override domain unit owners policy.
" + } + }, + "com.amazonaws.datazone#OverrideProjectOwnersPolicyGrantDetail": { + "type": "structure", + "members": { + "includeChildDomainUnits": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the policy is inherited by child domain units.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of the override project owners policy grant.
" + } + }, + "com.amazonaws.datazone#OwnerGroupProperties": { + "type": "structure", + "members": { + "groupIdentifier": { + "target": "com.amazonaws.datazone#GroupIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the domain unit owners group.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The properties of the domain unit owners group.
" + } + }, + "com.amazonaws.datazone#OwnerGroupPropertiesOutput": { + "type": "structure", + "members": { + "groupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the domain unit owners group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties of the domain unit owners group.
" + } + }, + "com.amazonaws.datazone#OwnerProperties": { + "type": "union", + "members": { + "user": { + "target": "com.amazonaws.datazone#OwnerUserProperties", + "traits": { + "smithy.api#documentation": "Specifies that the domain unit owner is a user.
" + } + }, + "group": { + "target": "com.amazonaws.datazone#OwnerGroupProperties", + "traits": { + "smithy.api#documentation": "Specifies that the domain unit owner is a group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties of a domain unit's owner.
" + } + }, + "com.amazonaws.datazone#OwnerPropertiesOutput": { + "type": "union", + "members": { + "user": { + "target": "com.amazonaws.datazone#OwnerUserPropertiesOutput", + "traits": { + "smithy.api#documentation": "Specifies that the domain unit owner is a user.
" + } + }, + "group": { + "target": "com.amazonaws.datazone#OwnerGroupPropertiesOutput", + "traits": { + "smithy.api#documentation": "Specifies that the domain unit owner is a group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The ID of the domain unit owners group.
" + } + }, + "com.amazonaws.datazone#OwnerUserProperties": { + "type": "structure", + "members": { + "userIdentifier": { + "target": "com.amazonaws.datazone#UserIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the owner user.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The properties of the owner user.
" + } + }, + "com.amazonaws.datazone#OwnerUserPropertiesOutput": { + "type": "structure", + "members": { + "userId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the owner user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties of the owner user.
" + } + }, + "com.amazonaws.datazone#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + } + } + }, + "com.amazonaws.datazone#PolicyGrantDetail": { + "type": "union", + "members": { + "createDomainUnit": { + "target": "com.amazonaws.datazone#CreateDomainUnitPolicyGrantDetail", + "traits": { + "smithy.api#documentation": "Specifies that this is a create domain unit policy.
" + } + }, + "overrideDomainUnitOwners": { + "target": "com.amazonaws.datazone#OverrideDomainUnitOwnersPolicyGrantDetail", + "traits": { + "smithy.api#documentation": "Specifies whether to override domain unit owners.
" + } + }, + "addToProjectMemberPool": { + "target": "com.amazonaws.datazone#AddToProjectMemberPoolPolicyGrantDetail", + "traits": { + "smithy.api#documentation": "Specifies that the policy grant is to be added to the members of the project.
" + } + }, + "overrideProjectOwners": { + "target": "com.amazonaws.datazone#OverrideProjectOwnersPolicyGrantDetail", + "traits": { + "smithy.api#documentation": "Specifies whether to override project owners.
" + } + }, + "createGlossary": { + "target": "com.amazonaws.datazone#CreateGlossaryPolicyGrantDetail", + "traits": { + "smithy.api#documentation": "Specifies that this is a create glossary policy.
" + } + }, + "createFormType": { + "target": "com.amazonaws.datazone#CreateFormTypePolicyGrantDetail", + "traits": { + "smithy.api#documentation": "Specifies that this is a create form type policy.
" + } + }, + "createAssetType": { + "target": "com.amazonaws.datazone#CreateAssetTypePolicyGrantDetail", "traits": { - "smithy.api#documentation": "The timestamp of when the notification was last updated.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies that this is a create asset type policy.
" } }, - "metadata": { - "target": "com.amazonaws.datazone#MetadataMap", + "createProject": { + "target": "com.amazonaws.datazone#CreateProjectPolicyGrantDetail", "traits": { - "smithy.api#documentation": "The metadata included in the notification.
" + "smithy.api#documentation": "Specifies that this is a create project policy.
" } - } - }, - "traits": { - "smithy.api#documentation": "The details of a notification generated in Amazon DataZone.
" - } - }, - "com.amazonaws.datazone#NotificationResource": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.datazone#NotificationResourceType", + }, + "createEnvironmentProfile": { + "target": "com.amazonaws.datazone#CreateEnvironmentProfilePolicyGrantDetail", "traits": { - "smithy.api#documentation": "The type of the resource mentioned in a notification.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies that this is a create environment profile policy.
" } }, - "id": { - "target": "smithy.api#String", + "delegateCreateEnvironmentProfile": { + "target": "com.amazonaws.datazone#Unit", "traits": { - "smithy.api#documentation": "The ID of the resource mentioned in a notification.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies that this is the delegation of the create environment profile policy.
" } }, - "name": { - "target": "smithy.api#String", + "createEnvironment": { + "target": "com.amazonaws.datazone#Unit", "traits": { - "smithy.api#documentation": "The name of the resource mentioned in a notification.
" + "smithy.api#documentation": "Specifies that this is a create environment policy.
" } } }, "traits": { - "smithy.api#documentation": "The details of the resource mentioned in a notification.
" + "smithy.api#documentation": "The details of the policy grant.
" } }, - "com.amazonaws.datazone#NotificationResourceType": { - "type": "enum", - "members": { - "PROJECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROJECT" - } - } + "com.amazonaws.datazone#PolicyGrantList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#PolicyGrantMember" } }, - "com.amazonaws.datazone#NotificationRole": { - "type": "enum", + "com.amazonaws.datazone#PolicyGrantMember": { + "type": "structure", "members": { - "PROJECT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROJECT_OWNER" - } - }, - "PROJECT_CONTRIBUTOR": { - "target": "smithy.api#Unit", + "principal": { + "target": "com.amazonaws.datazone#PolicyGrantPrincipal", "traits": { - "smithy.api#enumValue": "PROJECT_CONTRIBUTOR" + "smithy.api#documentation": "The principal of the policy grant member.
" } }, - "PROJECT_VIEWER": { - "target": "smithy.api#Unit", + "detail": { + "target": "com.amazonaws.datazone#PolicyGrantDetail", "traits": { - "smithy.api#enumValue": "PROJECT_VIEWER" + "smithy.api#documentation": "The details of the policy grant member.
" } }, - "DOMAIN_OWNER": { - "target": "smithy.api#Unit", + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", "traits": { - "smithy.api#enumValue": "DOMAIN_OWNER" + "smithy.api#documentation": "Specifies the timestamp at which policy grant member was created.
" } }, - "PROJECT_SUBSCRIBER": { - "target": "smithy.api#Unit", + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", "traits": { - "smithy.api#enumValue": "PROJECT_SUBSCRIBER" + "smithy.api#documentation": "Specifies the user who created the policy grant member.
" } } + }, + "traits": { + "smithy.api#documentation": "A member of the policy grant list.
" } }, - "com.amazonaws.datazone#NotificationSubjects": { - "type": "list", - "member": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.datazone#NotificationType": { - "type": "enum", + "com.amazonaws.datazone#PolicyGrantPrincipal": { + "type": "union", "members": { - "TASK": { - "target": "smithy.api#Unit", + "user": { + "target": "com.amazonaws.datazone#UserPolicyGrantPrincipal", "traits": { - "smithy.api#enumValue": "TASK" + "smithy.api#documentation": "The user of the policy grant principal.
" } }, - "EVENT": { - "target": "smithy.api#Unit", + "group": { + "target": "com.amazonaws.datazone#GroupPolicyGrantPrincipal", "traits": { - "smithy.api#enumValue": "EVENT" + "smithy.api#documentation": "The group of the policy grant principal.
" + } + }, + "project": { + "target": "com.amazonaws.datazone#ProjectPolicyGrantPrincipal", + "traits": { + "smithy.api#documentation": "The project of the policy grant principal.
" + } + }, + "domainUnit": { + "target": "com.amazonaws.datazone#DomainUnitPolicyGrantPrincipal", + "traits": { + "smithy.api#documentation": "The domain unit of the policy grant principal.
" } } - } - }, - "com.amazonaws.datazone#NotificationsList": { - "type": "list", - "member": { - "target": "com.amazonaws.datazone#NotificationOutput" - } - }, - "com.amazonaws.datazone#PaginationToken": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 8192 - } + "smithy.api#documentation": "The policy grant principal.
" } }, "com.amazonaws.datazone#PostLineageEvent": { @@ -19527,6 +21200,37 @@ "smithy.api#documentation": "Specifies the error message that is returned if the operation cannot be successfully\n completed.
" } }, + "com.amazonaws.datazone#ProjectDesignation": { + "type": "enum", + "members": { + "OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OWNER" + } + }, + "CONTRIBUTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTRIBUTOR" + } + } + } + }, + "com.amazonaws.datazone#ProjectGrantFilter": { + "type": "union", + "members": { + "domainUnitFilter": { + "target": "com.amazonaws.datazone#DomainUnitFilterForProject", + "traits": { + "smithy.api#documentation": "The domain unit filter of the project grant filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The project grant filter.
" + } + }, "com.amazonaws.datazone#ProjectId": { "type": "string", "traits": { @@ -19572,6 +21276,33 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#ProjectPolicyGrantPrincipal": { + "type": "structure", + "members": { + "projectDesignation": { + "target": "com.amazonaws.datazone#ProjectDesignation", + "traits": { + "smithy.api#documentation": "The project designation of the project policy grant principal.
", + "smithy.api#required": {} + } + }, + "projectIdentifier": { + "target": "com.amazonaws.datazone#ProjectId", + "traits": { + "smithy.api#documentation": "The project ID of the project policy grant principal.
" + } + }, + "projectGrantFilter": { + "target": "com.amazonaws.datazone#ProjectGrantFilter", + "traits": { + "smithy.api#documentation": "The project grant filter of the project policy grant principal.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The project policy grant principal.
" + } + }, "com.amazonaws.datazone#ProjectStatus": { "type": "enum", "members": { @@ -19663,6 +21394,12 @@ "smithy.api#documentation": "The timestamp of when the project was updated.
", "smithy.api#timestampFormat": "date-time" } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the domain unit.
" + } } }, "traits": { @@ -20418,62 +22155,244 @@ "smithy.api#required": {} } }, - "reviewerId": { - "target": "smithy.api#String", + "reviewerId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier of the subscription request reviewer.
" + } + }, + "decisionComment": { + "target": "com.amazonaws.datazone#DecisionComment", + "traits": { + "smithy.api#documentation": "The decision comment of the rejected subscription request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.datazone#RelationalFilterConfiguration": { + "type": "structure", + "members": { + "databaseName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The database name specified in the relational filter configuration for the data\n source.
", + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#required": {} + } + }, + "schemaName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The schema name specified in the relational filter configuration for the data\n source.
", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "filterExpressions": { + "target": "com.amazonaws.datazone#FilterExpressions", + "traits": { + "smithy.api#documentation": "The filter expressions specified in the relational filter configuration for the data\n source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The relational filter configuration for the data source.
" + } + }, + "com.amazonaws.datazone#RelationalFilterConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#RelationalFilterConfiguration" + } + }, + "com.amazonaws.datazone#RemoveEntityOwner": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#RemoveEntityOwnerInput" + }, + "output": { + "target": "com.amazonaws.datazone#RemoveEntityOwnerOutput" + }, + "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": "Removes an owner from an entity.
", + "smithy.api#http": { + "code": 204, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/removeOwner" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["Administration"] + } + }, + "com.amazonaws.datazone#RemoveEntityOwnerInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where you want to remove an owner from an entity.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityType": { + "target": "com.amazonaws.datazone#DataZoneEntityType", + "traits": { + "smithy.api#documentation": "The type of the entity from which you want to remove an owner.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The ID of the entity from which you want to remove an owner.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "owner": { + "target": "com.amazonaws.datazone#OwnerProperties", "traits": { - "smithy.api#documentation": "The identifier of the subscription request reviewer.
" + "smithy.api#documentation": "The owner that you want to remove from an entity.
", + "smithy.api#required": {} } }, - "decisionComment": { - "target": "com.amazonaws.datazone#DecisionComment", + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", "traits": { - "smithy.api#documentation": "The decision comment of the rejected subscription request.
" + "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#RemoveEntityOwnerOutput": { + "type": "structure", + "members": {}, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.datazone#RelationalFilterConfiguration": { + "com.amazonaws.datazone#RemovePolicyGrant": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#RemovePolicyGrantInput" + }, + "output": { + "target": "com.amazonaws.datazone#RemovePolicyGrantOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes a policy grant.
", + "smithy.api#http": { + "code": 204, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/removeGrant" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["Administration"] + } + }, + "com.amazonaws.datazone#RemovePolicyGrantInput": { "type": "structure", "members": { - "databaseName": { - "target": "smithy.api#String", + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "The database name specified in the relational filter configuration for the data\n source.
", - "smithy.api#length": { - "min": 1, - "max": 128 - }, + "smithy.api#documentation": "The ID of the domain where you want to remove a policy grant.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "schemaName": { + "entityType": { + "target": "com.amazonaws.datazone#TargetEntityType", + "traits": { + "smithy.api#documentation": "The type of the entity from which you want to remove a policy grant.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "entityIdentifier": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "The schema name specified in the relational filter configuration for the data\n source.
", - "smithy.api#length": { - "min": 1, - "max": 128 - } + "smithy.api#documentation": "The ID of the entity from which you want to remove a policy grant.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "filterExpressions": { - "target": "com.amazonaws.datazone#FilterExpressions", + "policyType": { + "target": "com.amazonaws.datazone#ManagedPolicyType", "traits": { - "smithy.api#documentation": "The filter expressions specified in the relational filter configuration for the data\n source.
" + "smithy.api#documentation": "The type of the policy that you want to remove.
", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.datazone#PolicyGrantPrincipal", + "traits": { + "smithy.api#documentation": "The principal from which you want to remove a policy grant.
", + "smithy.api#required": {} + } + }, + "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#documentation": "The relational filter configuration for the data source.
" + "smithy.api#input": {} } }, - "com.amazonaws.datazone#RelationalFilterConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.datazone#RelationalFilterConfiguration" + "com.amazonaws.datazone#RemovePolicyGrantOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.datazone#RequestReason": { @@ -23259,6 +25178,29 @@ "target": "com.amazonaws.datazone#TagValue" } }, + "com.amazonaws.datazone#TargetEntityType": { + "type": "enum", + "members": { + "DOMAIN_UNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_UNIT" + } + }, + "ENVIRONMENT_BLUEPRINT_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENVIRONMENT_BLUEPRINT_CONFIGURATION" + } + }, + "ENVIRONMENT_PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENVIRONMENT_PROFILE" + } + } + } + }, "com.amazonaws.datazone#TaskId": { "type": "string", "traits": { @@ -23996,6 +25938,13 @@ "smithy.api#httpError": 401 } }, + "com.amazonaws.datazone#Unit": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The details of the policy of creating an environment.
" + } + }, "com.amazonaws.datazone#UntagResource": { "type": "operation", "input": { @@ -24586,6 +26535,12 @@ "smithy.api#required": {} } }, + "rootDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the root domain unit.
" + } + }, "description": { "target": "smithy.api#String", "traits": { @@ -24621,6 +26576,153 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#UpdateDomainUnit": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateDomainUnitInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateDomainUnitOutput" + }, + "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": "Updates the domain unit.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/v2/domains/{domainIdentifier}/domain-units/{identifier}" + }, + "smithy.api#idempotent": {}, + "smithy.api#tags": ["Administration"] + } + }, + "com.amazonaws.datazone#UpdateDomainUnitInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where you want to update a domain unit.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the domain unit that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#DomainUnitDescription", + "traits": { + "smithy.api#documentation": "The description of the domain unit that you want to update.
" + } + }, + "name": { + "target": "com.amazonaws.datazone#DomainUnitName", + "traits": { + "smithy.api#documentation": "The name of the domain unit that you want to update.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateDomainUnitOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the domain unit that you want to update.
", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where you want to update the domain unit.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#DomainUnitName", + "traits": { + "smithy.api#documentation": "The name of the domain unit that you want to update.
", + "smithy.api#required": {} + } + }, + "owners": { + "target": "com.amazonaws.datazone#DomainUnitOwners", + "traits": { + "smithy.api#documentation": "The owners of the domain unit that you want to update.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#DomainUnitDescription", + "traits": { + "smithy.api#documentation": "The description of the domain unit that you want to update.
" + } + }, + "parentDomainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the parent domain unit.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The time stamp at which the domain unit that you want to update was created.
" + } + }, + "lastUpdatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the domain unit was last updated.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The user who created the domain unit that you want to update.
" + } + }, + "lastUpdatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The user who last updated the domain unit.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#UpdateEnvironment": { "type": "operation", "input": { @@ -25596,7 +27698,7 @@ "domainIdentifier": { "target": "com.amazonaws.datazone#DomainId", "traits": { - "smithy.api#documentation": "The identifier of the Amazon DataZone domain in which a project is to be updated.
", + "smithy.api#documentation": "The ID of the Amazon DataZone domain where a project is being updated.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -25700,6 +27802,12 @@ "traits": { "smithy.api#documentation": "The glossary terms of the project that are to be updated.
" } + }, + "domainUnitId": { + "target": "com.amazonaws.datazone#DomainUnitId", + "traits": { + "smithy.api#documentation": "The ID of the domain unit.
" + } } }, "traits": { @@ -26425,7 +28533,27 @@ "com.amazonaws.datazone#UserIdentifier": { "type": "string", "traits": { - "smithy.api#pattern": "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\\d{12}:.+$)" + "smithy.api#pattern": "(^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\\d{12}:.+$)" + } + }, + "com.amazonaws.datazone#UserPolicyGrantPrincipal": { + "type": "union", + "members": { + "userIdentifier": { + "target": "com.amazonaws.datazone#UserIdentifier", + "traits": { + "smithy.api#documentation": "The user ID of the user policy grant principal.
" + } + }, + "allUsersGrantFilter": { + "target": "com.amazonaws.datazone#AllUsersGrantFilter", + "traits": { + "smithy.api#documentation": "The all users grant filter of the user policy grant principal.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The user policy grant principal.
" } }, "com.amazonaws.datazone#UserProfileDetails": { @@ -26451,7 +28579,7 @@ "com.amazonaws.datazone#UserProfileId": { "type": "string", "traits": { - "smithy.api#pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + "smithy.api#pattern": "^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$" } }, "com.amazonaws.datazone#UserProfileName": {