From caa775021ad6fd9302a44ffab87345e92d121d1f Mon Sep 17 00:00:00 2001 From: awstools Date: Mon, 22 Jul 2024 18:16:14 +0000 Subject: [PATCH] feat(client-datazone): This release adds 1/ support of register S3 locations of assets in AWS Lake Formation hybrid access mode for DefaultDataLake blueprint. 2/ support of CRUD operations for Asset Filters. --- clients/client-datazone/README.md | 40 + clients/client-datazone/src/DataZone.ts | 112 + clients/client-datazone/src/DataZoneClient.ts | 15 + .../src/auth/httpAuthSchemeProvider.ts | 2 +- .../src/commands/CreateAssetFilterCommand.ts | 384 + .../src/commands/DeleteAssetFilterCommand.ts | 103 + .../src/commands/DeleteListingCommand.ts | 2 +- .../src/commands/GetAssetFilterCommand.ts | 243 + ...nvironmentBlueprintConfigurationCommand.ts | 10 + .../src/commands/GetListingCommand.ts | 2 +- .../src/commands/ListAssetFiltersCommand.ts | 124 + ...vironmentBlueprintConfigurationsCommand.ts | 10 + .../ListEnvironmentBlueprintsCommand.ts | 2 +- .../ListEnvironmentProfilesCommand.ts | 2 +- .../src/commands/ListEnvironmentsCommand.ts | 2 +- .../commands/ListLineageNodeHistoryCommand.ts | 2 +- .../src/commands/ListNotificationsCommand.ts | 7 +- ...nvironmentBlueprintConfigurationCommand.ts | 20 + .../src/commands/UpdateAssetFilterCommand.ts | 381 + clients/client-datazone/src/commands/index.ts | 5 + .../client-datazone/src/models/models_0.ts | 9034 ++++++++--------- .../client-datazone/src/models/models_1.ts | 5281 ++++++---- .../pagination/ListAssetFiltersPaginator.ts | 24 + .../client-datazone/src/pagination/index.ts | 1 + .../src/protocols/Aws_restJson1.ts | 498 +- codegen/sdk-codegen/aws-models/datazone.json | 1353 ++- 26 files changed, 11124 insertions(+), 6535 deletions(-) create mode 100644 clients/client-datazone/src/commands/CreateAssetFilterCommand.ts create mode 100644 clients/client-datazone/src/commands/DeleteAssetFilterCommand.ts create mode 100644 clients/client-datazone/src/commands/GetAssetFilterCommand.ts create mode 100644 clients/client-datazone/src/commands/ListAssetFiltersCommand.ts create mode 100644 clients/client-datazone/src/commands/UpdateAssetFilterCommand.ts create mode 100644 clients/client-datazone/src/pagination/ListAssetFiltersPaginator.ts diff --git a/clients/client-datazone/README.md b/clients/client-datazone/README.md index ebf0768ab7823..4be93f2283ba9 100644 --- a/clients/client-datazone/README.md +++ b/clients/client-datazone/README.md @@ -254,6 +254,14 @@ CreateAsset [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/datazone/command/CreateAssetCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/CreateAssetCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/CreateAssetCommandOutput/) + +
+ +CreateAssetFilter + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/datazone/command/CreateAssetFilterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/CreateAssetFilterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/CreateAssetFilterCommandOutput/) +
@@ -406,6 +414,14 @@ DeleteAsset [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/datazone/command/DeleteAssetCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/DeleteAssetCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/DeleteAssetCommandOutput/) +
+
+ +DeleteAssetFilter + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/datazone/command/DeleteAssetFilterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/DeleteAssetFilterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/DeleteAssetFilterCommandOutput/) +
@@ -558,6 +574,14 @@ GetAsset [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/datazone/command/GetAssetCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/GetAssetCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/GetAssetCommandOutput/) +
+
+ +GetAssetFilter + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/datazone/command/GetAssetFilterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/GetAssetFilterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/GetAssetFilterCommandOutput/) +
@@ -750,6 +774,14 @@ GetUserProfile [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/datazone/command/GetUserProfileCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/GetUserProfileCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/GetUserProfileCommandOutput/) +
+
+ +ListAssetFilters + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/datazone/command/ListAssetFiltersCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/ListAssetFiltersCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/ListAssetFiltersCommandOutput/) +
@@ -1038,6 +1070,14 @@ UntagResource [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/datazone/command/UntagResourceCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/UntagResourceCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/UntagResourceCommandOutput/) +
+
+ +UpdateAssetFilter + + +[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/datazone/command/UpdateAssetFilterCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/UpdateAssetFilterCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-datazone/Interface/UpdateAssetFilterCommandOutput/) +
diff --git a/clients/client-datazone/src/DataZone.ts b/clients/client-datazone/src/DataZone.ts index 1aa89168d563a..bbf5bfcbe6c87 100644 --- a/clients/client-datazone/src/DataZone.ts +++ b/clients/client-datazone/src/DataZone.ts @@ -28,6 +28,11 @@ import { CancelSubscriptionCommandOutput, } from "./commands/CancelSubscriptionCommand"; import { CreateAssetCommand, CreateAssetCommandInput, CreateAssetCommandOutput } from "./commands/CreateAssetCommand"; +import { + CreateAssetFilterCommand, + CreateAssetFilterCommandInput, + CreateAssetFilterCommandOutput, +} from "./commands/CreateAssetFilterCommand"; import { CreateAssetRevisionCommand, CreateAssetRevisionCommandInput, @@ -119,6 +124,11 @@ import { CreateUserProfileCommandOutput, } from "./commands/CreateUserProfileCommand"; import { DeleteAssetCommand, DeleteAssetCommandInput, DeleteAssetCommandOutput } from "./commands/DeleteAssetCommand"; +import { + DeleteAssetFilterCommand, + DeleteAssetFilterCommandInput, + DeleteAssetFilterCommandOutput, +} from "./commands/DeleteAssetFilterCommand"; import { DeleteAssetTypeCommand, DeleteAssetTypeCommandInput, @@ -210,6 +220,11 @@ import { DisassociateEnvironmentRoleCommandOutput, } from "./commands/DisassociateEnvironmentRoleCommand"; import { GetAssetCommand, GetAssetCommandInput, GetAssetCommandOutput } from "./commands/GetAssetCommand"; +import { + GetAssetFilterCommand, + GetAssetFilterCommandInput, + GetAssetFilterCommandOutput, +} from "./commands/GetAssetFilterCommand"; import { GetAssetTypeCommand, GetAssetTypeCommandInput, @@ -310,6 +325,11 @@ import { GetUserProfileCommandInput, GetUserProfileCommandOutput, } from "./commands/GetUserProfileCommand"; +import { + ListAssetFiltersCommand, + ListAssetFiltersCommandInput, + ListAssetFiltersCommandOutput, +} from "./commands/ListAssetFiltersCommand"; import { ListAssetRevisionsCommand, ListAssetRevisionsCommandInput, @@ -474,6 +494,11 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput, } from "./commands/UntagResourceCommand"; +import { + UpdateAssetFilterCommand, + UpdateAssetFilterCommandInput, + UpdateAssetFilterCommandOutput, +} from "./commands/UpdateAssetFilterCommand"; import { UpdateDataSourceCommand, UpdateDataSourceCommandInput, @@ -548,6 +573,7 @@ const commands = { CancelMetadataGenerationRunCommand, CancelSubscriptionCommand, CreateAssetCommand, + CreateAssetFilterCommand, CreateAssetRevisionCommand, CreateAssetTypeCommand, CreateDataSourceCommand, @@ -567,6 +593,7 @@ const commands = { CreateSubscriptionTargetCommand, CreateUserProfileCommand, DeleteAssetCommand, + DeleteAssetFilterCommand, DeleteAssetTypeCommand, DeleteDataSourceCommand, DeleteDomainCommand, @@ -586,6 +613,7 @@ const commands = { DeleteTimeSeriesDataPointsCommand, DisassociateEnvironmentRoleCommand, GetAssetCommand, + GetAssetFilterCommand, GetAssetTypeCommand, GetDataSourceCommand, GetDataSourceRunCommand, @@ -610,6 +638,7 @@ const commands = { GetSubscriptionTargetCommand, GetTimeSeriesDataPointCommand, GetUserProfileCommand, + ListAssetFiltersCommand, ListAssetRevisionsCommand, ListDataSourceRunActivitiesCommand, ListDataSourceRunsCommand, @@ -646,6 +675,7 @@ const commands = { StartMetadataGenerationRunCommand, TagResourceCommand, UntagResourceCommand, + UpdateAssetFilterCommand, UpdateDataSourceCommand, UpdateDomainCommand, UpdateEnvironmentCommand, @@ -758,6 +788,23 @@ export interface DataZone { cb: (err: any, data?: CreateAssetCommandOutput) => void ): void; + /** + * @see {@link CreateAssetFilterCommand} + */ + createAssetFilter( + args: CreateAssetFilterCommandInput, + options?: __HttpHandlerOptions + ): Promise; + createAssetFilter( + args: CreateAssetFilterCommandInput, + cb: (err: any, data?: CreateAssetFilterCommandOutput) => void + ): void; + createAssetFilter( + args: CreateAssetFilterCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: CreateAssetFilterCommandOutput) => void + ): void; + /** * @see {@link CreateAssetRevisionCommand} */ @@ -1054,6 +1101,23 @@ export interface DataZone { cb: (err: any, data?: DeleteAssetCommandOutput) => void ): void; + /** + * @see {@link DeleteAssetFilterCommand} + */ + deleteAssetFilter( + args: DeleteAssetFilterCommandInput, + options?: __HttpHandlerOptions + ): Promise; + deleteAssetFilter( + args: DeleteAssetFilterCommandInput, + cb: (err: any, data?: DeleteAssetFilterCommandOutput) => void + ): void; + deleteAssetFilter( + args: DeleteAssetFilterCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: DeleteAssetFilterCommandOutput) => void + ): void; + /** * @see {@link DeleteAssetTypeCommand} */ @@ -1344,6 +1408,20 @@ export interface DataZone { cb: (err: any, data?: GetAssetCommandOutput) => void ): void; + /** + * @see {@link GetAssetFilterCommand} + */ + getAssetFilter( + args: GetAssetFilterCommandInput, + options?: __HttpHandlerOptions + ): Promise; + getAssetFilter(args: GetAssetFilterCommandInput, cb: (err: any, data?: GetAssetFilterCommandOutput) => void): void; + getAssetFilter( + args: GetAssetFilterCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: GetAssetFilterCommandOutput) => void + ): void; + /** * @see {@link GetAssetTypeCommand} */ @@ -1692,6 +1770,23 @@ export interface DataZone { cb: (err: any, data?: GetUserProfileCommandOutput) => void ): void; + /** + * @see {@link ListAssetFiltersCommand} + */ + listAssetFilters( + args: ListAssetFiltersCommandInput, + options?: __HttpHandlerOptions + ): Promise; + listAssetFilters( + args: ListAssetFiltersCommandInput, + cb: (err: any, data?: ListAssetFiltersCommandOutput) => void + ): void; + listAssetFilters( + args: ListAssetFiltersCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: ListAssetFiltersCommandOutput) => void + ): void; + /** * @see {@link ListAssetRevisionsCommand} */ @@ -2263,6 +2358,23 @@ export interface DataZone { cb: (err: any, data?: UntagResourceCommandOutput) => void ): void; + /** + * @see {@link UpdateAssetFilterCommand} + */ + updateAssetFilter( + args: UpdateAssetFilterCommandInput, + options?: __HttpHandlerOptions + ): Promise; + updateAssetFilter( + args: UpdateAssetFilterCommandInput, + cb: (err: any, data?: UpdateAssetFilterCommandOutput) => void + ): void; + updateAssetFilter( + args: UpdateAssetFilterCommandInput, + options: __HttpHandlerOptions, + cb: (err: any, data?: UpdateAssetFilterCommandOutput) => void + ): void; + /** * @see {@link UpdateDataSourceCommand} */ diff --git a/clients/client-datazone/src/DataZoneClient.ts b/clients/client-datazone/src/DataZoneClient.ts index 9f75115c666f0..20440a3854014 100644 --- a/clients/client-datazone/src/DataZoneClient.ts +++ b/clients/client-datazone/src/DataZoneClient.ts @@ -68,6 +68,7 @@ import { } from "./commands/CancelMetadataGenerationRunCommand"; import { CancelSubscriptionCommandInput, CancelSubscriptionCommandOutput } from "./commands/CancelSubscriptionCommand"; import { CreateAssetCommandInput, CreateAssetCommandOutput } from "./commands/CreateAssetCommand"; +import { CreateAssetFilterCommandInput, CreateAssetFilterCommandOutput } from "./commands/CreateAssetFilterCommand"; import { CreateAssetRevisionCommandInput, CreateAssetRevisionCommandOutput, @@ -111,6 +112,7 @@ import { } from "./commands/CreateSubscriptionTargetCommand"; import { CreateUserProfileCommandInput, CreateUserProfileCommandOutput } from "./commands/CreateUserProfileCommand"; import { DeleteAssetCommandInput, DeleteAssetCommandOutput } from "./commands/DeleteAssetCommand"; +import { DeleteAssetFilterCommandInput, DeleteAssetFilterCommandOutput } from "./commands/DeleteAssetFilterCommand"; import { DeleteAssetTypeCommandInput, DeleteAssetTypeCommandOutput } from "./commands/DeleteAssetTypeCommand"; import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "./commands/DeleteDataSourceCommand"; import { DeleteDomainCommandInput, DeleteDomainCommandOutput } from "./commands/DeleteDomainCommand"; @@ -157,6 +159,7 @@ import { DisassociateEnvironmentRoleCommandOutput, } from "./commands/DisassociateEnvironmentRoleCommand"; import { GetAssetCommandInput, GetAssetCommandOutput } from "./commands/GetAssetCommand"; +import { GetAssetFilterCommandInput, GetAssetFilterCommandOutput } from "./commands/GetAssetFilterCommand"; import { GetAssetTypeCommandInput, GetAssetTypeCommandOutput } from "./commands/GetAssetTypeCommand"; import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "./commands/GetDataSourceCommand"; import { GetDataSourceRunCommandInput, GetDataSourceRunCommandOutput } from "./commands/GetDataSourceRunCommand"; @@ -211,6 +214,7 @@ import { GetTimeSeriesDataPointCommandOutput, } from "./commands/GetTimeSeriesDataPointCommand"; import { GetUserProfileCommandInput, GetUserProfileCommandOutput } from "./commands/GetUserProfileCommand"; +import { ListAssetFiltersCommandInput, ListAssetFiltersCommandOutput } from "./commands/ListAssetFiltersCommand"; import { ListAssetRevisionsCommandInput, ListAssetRevisionsCommandOutput } from "./commands/ListAssetRevisionsCommand"; import { ListDataSourceRunActivitiesCommandInput, @@ -301,6 +305,7 @@ import { } from "./commands/StartMetadataGenerationRunCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; +import { UpdateAssetFilterCommandInput, UpdateAssetFilterCommandOutput } from "./commands/UpdateAssetFilterCommand"; import { UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput } from "./commands/UpdateDataSourceCommand"; import { UpdateDomainCommandInput, UpdateDomainCommandOutput } from "./commands/UpdateDomainCommand"; import { @@ -350,6 +355,7 @@ export type ServiceInputTypes = | CancelMetadataGenerationRunCommandInput | CancelSubscriptionCommandInput | CreateAssetCommandInput + | CreateAssetFilterCommandInput | CreateAssetRevisionCommandInput | CreateAssetTypeCommandInput | CreateDataSourceCommandInput @@ -369,6 +375,7 @@ export type ServiceInputTypes = | CreateSubscriptionTargetCommandInput | CreateUserProfileCommandInput | DeleteAssetCommandInput + | DeleteAssetFilterCommandInput | DeleteAssetTypeCommandInput | DeleteDataSourceCommandInput | DeleteDomainCommandInput @@ -388,6 +395,7 @@ export type ServiceInputTypes = | DeleteTimeSeriesDataPointsCommandInput | DisassociateEnvironmentRoleCommandInput | GetAssetCommandInput + | GetAssetFilterCommandInput | GetAssetTypeCommandInput | GetDataSourceCommandInput | GetDataSourceRunCommandInput @@ -412,6 +420,7 @@ export type ServiceInputTypes = | GetSubscriptionTargetCommandInput | GetTimeSeriesDataPointCommandInput | GetUserProfileCommandInput + | ListAssetFiltersCommandInput | ListAssetRevisionsCommandInput | ListDataSourceRunActivitiesCommandInput | ListDataSourceRunsCommandInput @@ -448,6 +457,7 @@ export type ServiceInputTypes = | StartMetadataGenerationRunCommandInput | TagResourceCommandInput | UntagResourceCommandInput + | UpdateAssetFilterCommandInput | UpdateDataSourceCommandInput | UpdateDomainCommandInput | UpdateEnvironmentActionCommandInput @@ -472,6 +482,7 @@ export type ServiceOutputTypes = | CancelMetadataGenerationRunCommandOutput | CancelSubscriptionCommandOutput | CreateAssetCommandOutput + | CreateAssetFilterCommandOutput | CreateAssetRevisionCommandOutput | CreateAssetTypeCommandOutput | CreateDataSourceCommandOutput @@ -491,6 +502,7 @@ export type ServiceOutputTypes = | CreateSubscriptionTargetCommandOutput | CreateUserProfileCommandOutput | DeleteAssetCommandOutput + | DeleteAssetFilterCommandOutput | DeleteAssetTypeCommandOutput | DeleteDataSourceCommandOutput | DeleteDomainCommandOutput @@ -510,6 +522,7 @@ export type ServiceOutputTypes = | DeleteTimeSeriesDataPointsCommandOutput | DisassociateEnvironmentRoleCommandOutput | GetAssetCommandOutput + | GetAssetFilterCommandOutput | GetAssetTypeCommandOutput | GetDataSourceCommandOutput | GetDataSourceRunCommandOutput @@ -534,6 +547,7 @@ export type ServiceOutputTypes = | GetSubscriptionTargetCommandOutput | GetTimeSeriesDataPointCommandOutput | GetUserProfileCommandOutput + | ListAssetFiltersCommandOutput | ListAssetRevisionsCommandOutput | ListDataSourceRunActivitiesCommandOutput | ListDataSourceRunsCommandOutput @@ -570,6 +584,7 @@ export type ServiceOutputTypes = | StartMetadataGenerationRunCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput + | UpdateAssetFilterCommandOutput | UpdateDataSourceCommandOutput | UpdateDomainCommandOutput | UpdateEnvironmentActionCommandOutput diff --git a/clients/client-datazone/src/auth/httpAuthSchemeProvider.ts b/clients/client-datazone/src/auth/httpAuthSchemeProvider.ts index 022367c2bcca2..dca77f4b34ac7 100644 --- a/clients/client-datazone/src/auth/httpAuthSchemeProvider.ts +++ b/clients/client-datazone/src/auth/httpAuthSchemeProvider.ts @@ -60,7 +60,7 @@ function createAwsAuthSigv4HttpAuthOption(authParameters: DataZoneHttpAuthScheme name: "datazone", region: authParameters.region, }, - propertiesExtractor: (config: DataZoneClientConfig, context) => ({ + propertiesExtractor: (config: Partial, context) => ({ /** * @internal */ diff --git a/clients/client-datazone/src/commands/CreateAssetFilterCommand.ts b/clients/client-datazone/src/commands/CreateAssetFilterCommand.ts new file mode 100644 index 0000000000000..915dae2abd32d --- /dev/null +++ b/clients/client-datazone/src/commands/CreateAssetFilterCommand.ts @@ -0,0 +1,384 @@ +// 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 { + CreateAssetFilterInput, + CreateAssetFilterInputFilterSensitiveLog, + CreateAssetFilterOutput, + CreateAssetFilterOutputFilterSensitiveLog, +} from "../models/models_1"; +import { de_CreateAssetFilterCommand, se_CreateAssetFilterCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateAssetFilterCommand}. + */ +export interface CreateAssetFilterCommandInput extends CreateAssetFilterInput {} +/** + * @public + * + * The output of {@link CreateAssetFilterCommand}. + */ +export interface CreateAssetFilterCommandOutput extends CreateAssetFilterOutput, __MetadataBearer {} + +/** + *

Creates a data asset filter.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, CreateAssetFilterCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, CreateAssetFilterCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // CreateAssetFilterInput + * domainIdentifier: "STRING_VALUE", // required + * assetIdentifier: "STRING_VALUE", // required + * name: "STRING_VALUE", // required + * description: "STRING_VALUE", + * configuration: { // AssetFilterConfiguration Union: only one key present + * columnConfiguration: { // ColumnFilterConfiguration + * includedColumnNames: [ // ColumnNameList + * "STRING_VALUE", + * ], + * }, + * rowConfiguration: { // RowFilterConfiguration + * rowFilter: { // RowFilter Union: only one key present + * expression: { // RowFilterExpression Union: only one key present + * equalTo: { // EqualToExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * notEqualTo: { // NotEqualToExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * greaterThan: { // GreaterThanExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * lessThan: { // LessThanExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * greaterThanOrEqualTo: { // GreaterThanOrEqualToExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * lessThanOrEqualTo: { // LessThanOrEqualToExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * isNull: { // IsNullExpression + * columnName: "STRING_VALUE", // required + * }, + * isNotNull: { // IsNotNullExpression + * columnName: "STRING_VALUE", // required + * }, + * in: { // InExpression + * columnName: "STRING_VALUE", // required + * values: [ // StringList // required + * "STRING_VALUE", + * ], + * }, + * notIn: { // NotInExpression + * columnName: "STRING_VALUE", // required + * values: [ // required + * "STRING_VALUE", + * ], + * }, + * like: { // LikeExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * notLike: { // NotLikeExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * }, + * and: [ // RowFilterList + * {// Union: only one key present + * expression: {// Union: only one key present + * equalTo: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * notEqualTo: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * greaterThan: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * lessThan: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * greaterThanOrEqualTo: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * lessThanOrEqualTo: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * isNull: { + * columnName: "STRING_VALUE", // required + * }, + * isNotNull: { + * columnName: "STRING_VALUE", // required + * }, + * in: { + * columnName: "STRING_VALUE", // required + * values: [ // required + * "STRING_VALUE", + * ], + * }, + * notIn: { + * columnName: "STRING_VALUE", // required + * values: [ // required + * "STRING_VALUE", + * ], + * }, + * like: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * notLike: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * }, + * and: [ + * "", + * ], + * or: [ + * "", + * ], + * }, + * ], + * or: [ + * "", + * ], + * }, + * sensitive: true || false, + * }, + * }, + * clientToken: "STRING_VALUE", + * }; + * const command = new CreateAssetFilterCommand(input); + * const response = await client.send(command); + * // { // CreateAssetFilterOutput + * // id: "STRING_VALUE", // required + * // domainId: "STRING_VALUE", // required + * // assetId: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // status: "VALID" || "INVALID", + * // configuration: { // AssetFilterConfiguration Union: only one key present + * // columnConfiguration: { // ColumnFilterConfiguration + * // includedColumnNames: [ // ColumnNameList + * // "STRING_VALUE", + * // ], + * // }, + * // rowConfiguration: { // RowFilterConfiguration + * // rowFilter: { // RowFilter Union: only one key present + * // expression: { // RowFilterExpression Union: only one key present + * // equalTo: { // EqualToExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // notEqualTo: { // NotEqualToExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // greaterThan: { // GreaterThanExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // lessThan: { // LessThanExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // greaterThanOrEqualTo: { // GreaterThanOrEqualToExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // lessThanOrEqualTo: { // LessThanOrEqualToExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // isNull: { // IsNullExpression + * // columnName: "STRING_VALUE", // required + * // }, + * // isNotNull: { // IsNotNullExpression + * // columnName: "STRING_VALUE", // required + * // }, + * // in: { // InExpression + * // columnName: "STRING_VALUE", // required + * // values: [ // StringList // required + * // "STRING_VALUE", + * // ], + * // }, + * // notIn: { // NotInExpression + * // columnName: "STRING_VALUE", // required + * // values: [ // required + * // "STRING_VALUE", + * // ], + * // }, + * // like: { // LikeExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // notLike: { // NotLikeExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // }, + * // and: [ // RowFilterList + * // {// Union: only one key present + * // expression: {// Union: only one key present + * // equalTo: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // notEqualTo: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // greaterThan: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // lessThan: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // greaterThanOrEqualTo: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // lessThanOrEqualTo: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // isNull: { + * // columnName: "STRING_VALUE", // required + * // }, + * // isNotNull: { + * // columnName: "STRING_VALUE", // required + * // }, + * // in: { + * // columnName: "STRING_VALUE", // required + * // values: [ // required + * // "STRING_VALUE", + * // ], + * // }, + * // notIn: { + * // columnName: "STRING_VALUE", // required + * // values: [ // required + * // "STRING_VALUE", + * // ], + * // }, + * // like: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // notLike: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // }, + * // and: [ + * // "", + * // ], + * // or: [ + * // "", + * // ], + * // }, + * // ], + * // or: [ + * // "", + * // ], + * // }, + * // sensitive: true || false, + * // }, + * // }, + * // createdAt: new Date("TIMESTAMP"), + * // errorMessage: "STRING_VALUE", + * // effectiveColumnNames: [ + * // "STRING_VALUE", + * // ], + * // effectiveRowFilter: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreateAssetFilterCommandInput - {@link CreateAssetFilterCommandInput} + * @returns {@link CreateAssetFilterCommandOutput} + * @see {@link CreateAssetFilterCommandInput} for command's `input` shape. + * @see {@link CreateAssetFilterCommandOutput} 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 CreateAssetFilterCommand extends $Command + .classBuilder< + CreateAssetFilterCommandInput, + CreateAssetFilterCommandOutput, + 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", "CreateAssetFilter", {}) + .n("DataZoneClient", "CreateAssetFilterCommand") + .f(CreateAssetFilterInputFilterSensitiveLog, CreateAssetFilterOutputFilterSensitiveLog) + .ser(se_CreateAssetFilterCommand) + .de(de_CreateAssetFilterCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/DeleteAssetFilterCommand.ts b/clients/client-datazone/src/commands/DeleteAssetFilterCommand.ts new file mode 100644 index 0000000000000..02cc3855d280f --- /dev/null +++ b/clients/client-datazone/src/commands/DeleteAssetFilterCommand.ts @@ -0,0 +1,103 @@ +// 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 { DeleteAssetFilterInput } from "../models/models_0"; +import { de_DeleteAssetFilterCommand, se_DeleteAssetFilterCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteAssetFilterCommand}. + */ +export interface DeleteAssetFilterCommandInput extends DeleteAssetFilterInput {} +/** + * @public + * + * The output of {@link DeleteAssetFilterCommand}. + */ +export interface DeleteAssetFilterCommandOutput extends __MetadataBearer {} + +/** + *

Deletes an asset filter.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, DeleteAssetFilterCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, DeleteAssetFilterCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // DeleteAssetFilterInput + * domainIdentifier: "STRING_VALUE", // required + * assetIdentifier: "STRING_VALUE", // required + * identifier: "STRING_VALUE", // required + * }; + * const command = new DeleteAssetFilterCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteAssetFilterCommandInput - {@link DeleteAssetFilterCommandInput} + * @returns {@link DeleteAssetFilterCommandOutput} + * @see {@link DeleteAssetFilterCommandInput} for command's `input` shape. + * @see {@link DeleteAssetFilterCommandOutput} 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 DeleteAssetFilterCommand extends $Command + .classBuilder< + DeleteAssetFilterCommandInput, + DeleteAssetFilterCommandOutput, + 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", "DeleteAssetFilter", {}) + .n("DataZoneClient", "DeleteAssetFilterCommand") + .f(void 0, void 0) + .ser(se_DeleteAssetFilterCommand) + .de(de_DeleteAssetFilterCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/DeleteListingCommand.ts b/clients/client-datazone/src/commands/DeleteListingCommand.ts index 13c9019fa7293..957a5c131b06d 100644 --- a/clients/client-datazone/src/commands/DeleteListingCommand.ts +++ b/clients/client-datazone/src/commands/DeleteListingCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { DeleteListingInput, DeleteListingOutput } from "../models/models_0"; +import { DeleteListingInput, DeleteListingOutput } from "../models/models_1"; import { de_DeleteListingCommand, se_DeleteListingCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/GetAssetFilterCommand.ts b/clients/client-datazone/src/commands/GetAssetFilterCommand.ts new file mode 100644 index 0000000000000..d9342373243bf --- /dev/null +++ b/clients/client-datazone/src/commands/GetAssetFilterCommand.ts @@ -0,0 +1,243 @@ +// 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 { GetAssetFilterInput } from "../models/models_0"; +import { GetAssetFilterOutput, GetAssetFilterOutputFilterSensitiveLog } from "../models/models_1"; +import { de_GetAssetFilterCommand, se_GetAssetFilterCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetAssetFilterCommand}. + */ +export interface GetAssetFilterCommandInput extends GetAssetFilterInput {} +/** + * @public + * + * The output of {@link GetAssetFilterCommand}. + */ +export interface GetAssetFilterCommandOutput extends GetAssetFilterOutput, __MetadataBearer {} + +/** + *

Gets an asset filter.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, GetAssetFilterCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, GetAssetFilterCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // GetAssetFilterInput + * domainIdentifier: "STRING_VALUE", // required + * assetIdentifier: "STRING_VALUE", // required + * identifier: "STRING_VALUE", // required + * }; + * const command = new GetAssetFilterCommand(input); + * const response = await client.send(command); + * // { // GetAssetFilterOutput + * // id: "STRING_VALUE", // required + * // domainId: "STRING_VALUE", // required + * // assetId: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // status: "VALID" || "INVALID", + * // configuration: { // AssetFilterConfiguration Union: only one key present + * // columnConfiguration: { // ColumnFilterConfiguration + * // includedColumnNames: [ // ColumnNameList + * // "STRING_VALUE", + * // ], + * // }, + * // rowConfiguration: { // RowFilterConfiguration + * // rowFilter: { // RowFilter Union: only one key present + * // expression: { // RowFilterExpression Union: only one key present + * // equalTo: { // EqualToExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // notEqualTo: { // NotEqualToExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // greaterThan: { // GreaterThanExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // lessThan: { // LessThanExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // greaterThanOrEqualTo: { // GreaterThanOrEqualToExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // lessThanOrEqualTo: { // LessThanOrEqualToExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // isNull: { // IsNullExpression + * // columnName: "STRING_VALUE", // required + * // }, + * // isNotNull: { // IsNotNullExpression + * // columnName: "STRING_VALUE", // required + * // }, + * // in: { // InExpression + * // columnName: "STRING_VALUE", // required + * // values: [ // StringList // required + * // "STRING_VALUE", + * // ], + * // }, + * // notIn: { // NotInExpression + * // columnName: "STRING_VALUE", // required + * // values: [ // required + * // "STRING_VALUE", + * // ], + * // }, + * // like: { // LikeExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // notLike: { // NotLikeExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // }, + * // and: [ // RowFilterList + * // {// Union: only one key present + * // expression: {// Union: only one key present + * // equalTo: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // notEqualTo: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // greaterThan: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // lessThan: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // greaterThanOrEqualTo: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // lessThanOrEqualTo: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // isNull: { + * // columnName: "STRING_VALUE", // required + * // }, + * // isNotNull: { + * // columnName: "STRING_VALUE", // required + * // }, + * // in: { + * // columnName: "STRING_VALUE", // required + * // values: [ // required + * // "STRING_VALUE", + * // ], + * // }, + * // notIn: { + * // columnName: "STRING_VALUE", // required + * // values: [ // required + * // "STRING_VALUE", + * // ], + * // }, + * // like: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // notLike: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // }, + * // and: [ + * // "", + * // ], + * // or: [ + * // "", + * // ], + * // }, + * // ], + * // or: [ + * // "", + * // ], + * // }, + * // sensitive: true || false, + * // }, + * // }, + * // createdAt: new Date("TIMESTAMP"), + * // errorMessage: "STRING_VALUE", + * // effectiveColumnNames: [ + * // "STRING_VALUE", + * // ], + * // effectiveRowFilter: "STRING_VALUE", + * // }; + * + * ``` + * + * @param GetAssetFilterCommandInput - {@link GetAssetFilterCommandInput} + * @returns {@link GetAssetFilterCommandOutput} + * @see {@link GetAssetFilterCommandInput} for command's `input` shape. + * @see {@link GetAssetFilterCommandOutput} 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 GetAssetFilterCommand extends $Command + .classBuilder< + GetAssetFilterCommandInput, + GetAssetFilterCommandOutput, + 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", "GetAssetFilter", {}) + .n("DataZoneClient", "GetAssetFilterCommand") + .f(void 0, GetAssetFilterOutputFilterSensitiveLog) + .ser(se_GetAssetFilterCommand) + .de(de_GetAssetFilterCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/GetEnvironmentBlueprintConfigurationCommand.ts b/clients/client-datazone/src/commands/GetEnvironmentBlueprintConfigurationCommand.ts index 55d7c90f275b1..39ef59bdeae48 100644 --- a/clients/client-datazone/src/commands/GetEnvironmentBlueprintConfigurationCommand.ts +++ b/clients/client-datazone/src/commands/GetEnvironmentBlueprintConfigurationCommand.ts @@ -64,6 +64,16 @@ export interface GetEnvironmentBlueprintConfigurationCommandOutput * // }, * // createdAt: new Date("TIMESTAMP"), * // updatedAt: new Date("TIMESTAMP"), + * // provisioningConfigurations: [ // ProvisioningConfigurationList + * // { // ProvisioningConfiguration Union: only one key present + * // lakeFormationConfiguration: { // LakeFormationConfiguration + * // locationRegistrationRole: "STRING_VALUE", + * // locationRegistrationExcludeS3Locations: [ // S3LocationList + * // "STRING_VALUE", + * // ], + * // }, + * // }, + * // ], * // }; * * ``` diff --git a/clients/client-datazone/src/commands/GetListingCommand.ts b/clients/client-datazone/src/commands/GetListingCommand.ts index 09c1aff7bb6d2..9af16f81d03e4 100644 --- a/clients/client-datazone/src/commands/GetListingCommand.ts +++ b/clients/client-datazone/src/commands/GetListingCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { GetListingInput, GetListingOutput, GetListingOutputFilterSensitiveLog } from "../models/models_0"; +import { GetListingInput, GetListingOutput, GetListingOutputFilterSensitiveLog } from "../models/models_1"; import { de_GetListingCommand, se_GetListingCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/ListAssetFiltersCommand.ts b/clients/client-datazone/src/commands/ListAssetFiltersCommand.ts new file mode 100644 index 0000000000000..d29e09911ff3a --- /dev/null +++ b/clients/client-datazone/src/commands/ListAssetFiltersCommand.ts @@ -0,0 +1,124 @@ +// 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 { + ListAssetFiltersInput, + ListAssetFiltersOutput, + ListAssetFiltersOutputFilterSensitiveLog, +} from "../models/models_0"; +import { de_ListAssetFiltersCommand, se_ListAssetFiltersCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListAssetFiltersCommand}. + */ +export interface ListAssetFiltersCommandInput extends ListAssetFiltersInput {} +/** + * @public + * + * The output of {@link ListAssetFiltersCommand}. + */ +export interface ListAssetFiltersCommandOutput extends ListAssetFiltersOutput, __MetadataBearer {} + +/** + *

Lists asset filters.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, ListAssetFiltersCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, ListAssetFiltersCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // ListAssetFiltersInput + * domainIdentifier: "STRING_VALUE", // required + * assetIdentifier: "STRING_VALUE", // required + * status: "VALID" || "INVALID", + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * }; + * const command = new ListAssetFiltersCommand(input); + * const response = await client.send(command); + * // { // ListAssetFiltersOutput + * // items: [ // AssetFilters // required + * // { // AssetFilterSummary + * // id: "STRING_VALUE", // required + * // domainId: "STRING_VALUE", // required + * // assetId: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // status: "VALID" || "INVALID", + * // effectiveColumnNames: [ // ColumnNameList + * // "STRING_VALUE", + * // ], + * // effectiveRowFilter: "STRING_VALUE", + * // createdAt: new Date("TIMESTAMP"), + * // errorMessage: "STRING_VALUE", + * // }, + * // ], + * // nextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListAssetFiltersCommandInput - {@link ListAssetFiltersCommandInput} + * @returns {@link ListAssetFiltersCommandOutput} + * @see {@link ListAssetFiltersCommandInput} for command's `input` shape. + * @see {@link ListAssetFiltersCommandOutput} 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 ListAssetFiltersCommand extends $Command + .classBuilder< + ListAssetFiltersCommandInput, + ListAssetFiltersCommandOutput, + 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", "ListAssetFilters", {}) + .n("DataZoneClient", "ListAssetFiltersCommand") + .f(void 0, ListAssetFiltersOutputFilterSensitiveLog) + .ser(se_ListAssetFiltersCommand) + .de(de_ListAssetFiltersCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/ListEnvironmentBlueprintConfigurationsCommand.ts b/clients/client-datazone/src/commands/ListEnvironmentBlueprintConfigurationsCommand.ts index 3cbe01408a9c0..c4d55641da089 100644 --- a/clients/client-datazone/src/commands/ListEnvironmentBlueprintConfigurationsCommand.ts +++ b/clients/client-datazone/src/commands/ListEnvironmentBlueprintConfigurationsCommand.ts @@ -68,6 +68,16 @@ export interface ListEnvironmentBlueprintConfigurationsCommandOutput * // }, * // createdAt: new Date("TIMESTAMP"), * // updatedAt: new Date("TIMESTAMP"), + * // provisioningConfigurations: [ // ProvisioningConfigurationList + * // { // ProvisioningConfiguration Union: only one key present + * // lakeFormationConfiguration: { // LakeFormationConfiguration + * // locationRegistrationRole: "STRING_VALUE", + * // locationRegistrationExcludeS3Locations: [ // S3LocationList + * // "STRING_VALUE", + * // ], + * // }, + * // }, + * // ], * // }, * // ], * // nextToken: "STRING_VALUE", diff --git a/clients/client-datazone/src/commands/ListEnvironmentBlueprintsCommand.ts b/clients/client-datazone/src/commands/ListEnvironmentBlueprintsCommand.ts index 757fdc7cfdf6e..9b1005cd08c1c 100644 --- a/clients/client-datazone/src/commands/ListEnvironmentBlueprintsCommand.ts +++ b/clients/client-datazone/src/commands/ListEnvironmentBlueprintsCommand.ts @@ -10,7 +10,7 @@ import { ListEnvironmentBlueprintsInput, ListEnvironmentBlueprintsOutput, ListEnvironmentBlueprintsOutputFilterSensitiveLog, -} from "../models/models_0"; +} from "../models/models_1"; import { de_ListEnvironmentBlueprintsCommand, se_ListEnvironmentBlueprintsCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/ListEnvironmentProfilesCommand.ts b/clients/client-datazone/src/commands/ListEnvironmentProfilesCommand.ts index f52b84e1efee9..641aa4a6b81c9 100644 --- a/clients/client-datazone/src/commands/ListEnvironmentProfilesCommand.ts +++ b/clients/client-datazone/src/commands/ListEnvironmentProfilesCommand.ts @@ -11,7 +11,7 @@ import { ListEnvironmentProfilesInputFilterSensitiveLog, ListEnvironmentProfilesOutput, ListEnvironmentProfilesOutputFilterSensitiveLog, -} from "../models/models_0"; +} from "../models/models_1"; import { de_ListEnvironmentProfilesCommand, se_ListEnvironmentProfilesCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/ListEnvironmentsCommand.ts b/clients/client-datazone/src/commands/ListEnvironmentsCommand.ts index 93c7aa1ab80a1..a5ad799be0e50 100644 --- a/clients/client-datazone/src/commands/ListEnvironmentsCommand.ts +++ b/clients/client-datazone/src/commands/ListEnvironmentsCommand.ts @@ -10,7 +10,7 @@ import { ListEnvironmentsInput, ListEnvironmentsOutput, ListEnvironmentsOutputFilterSensitiveLog, -} from "../models/models_0"; +} from "../models/models_1"; import { de_ListEnvironmentsCommand, se_ListEnvironmentsCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/ListLineageNodeHistoryCommand.ts b/clients/client-datazone/src/commands/ListLineageNodeHistoryCommand.ts index 4e6e161372ad6..4a0d61824c0f8 100644 --- a/clients/client-datazone/src/commands/ListLineageNodeHistoryCommand.ts +++ b/clients/client-datazone/src/commands/ListLineageNodeHistoryCommand.ts @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ListLineageNodeHistoryInput, ListLineageNodeHistoryOutput } from "../models/models_0"; +import { ListLineageNodeHistoryInput, ListLineageNodeHistoryOutput } from "../models/models_1"; import { de_ListLineageNodeHistoryCommand, se_ListLineageNodeHistoryCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/ListNotificationsCommand.ts b/clients/client-datazone/src/commands/ListNotificationsCommand.ts index 469cbd7cfd95c..103bba9f32fc4 100644 --- a/clients/client-datazone/src/commands/ListNotificationsCommand.ts +++ b/clients/client-datazone/src/commands/ListNotificationsCommand.ts @@ -6,8 +6,11 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DataZoneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataZoneClient"; import { commonParams } from "../endpoint/EndpointParameters"; -import { ListNotificationsInput } from "../models/models_0"; -import { ListNotificationsOutput, ListNotificationsOutputFilterSensitiveLog } from "../models/models_1"; +import { + ListNotificationsInput, + ListNotificationsOutput, + ListNotificationsOutputFilterSensitiveLog, +} from "../models/models_1"; import { de_ListNotificationsCommand, se_ListNotificationsCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-datazone/src/commands/PutEnvironmentBlueprintConfigurationCommand.ts b/clients/client-datazone/src/commands/PutEnvironmentBlueprintConfigurationCommand.ts index 4449c27926820..06de04c2b7c07 100644 --- a/clients/client-datazone/src/commands/PutEnvironmentBlueprintConfigurationCommand.ts +++ b/clients/client-datazone/src/commands/PutEnvironmentBlueprintConfigurationCommand.ts @@ -56,6 +56,16 @@ export interface PutEnvironmentBlueprintConfigurationCommandOutput * "": "STRING_VALUE", * }, * }, + * provisioningConfigurations: [ // ProvisioningConfigurationList + * { // ProvisioningConfiguration Union: only one key present + * lakeFormationConfiguration: { // LakeFormationConfiguration + * locationRegistrationRole: "STRING_VALUE", + * locationRegistrationExcludeS3Locations: [ // S3LocationList + * "STRING_VALUE", + * ], + * }, + * }, + * ], * }; * const command = new PutEnvironmentBlueprintConfigurationCommand(input); * const response = await client.send(command); @@ -74,6 +84,16 @@ export interface PutEnvironmentBlueprintConfigurationCommandOutput * // }, * // createdAt: new Date("TIMESTAMP"), * // updatedAt: new Date("TIMESTAMP"), + * // provisioningConfigurations: [ // ProvisioningConfigurationList + * // { // ProvisioningConfiguration Union: only one key present + * // lakeFormationConfiguration: { // LakeFormationConfiguration + * // locationRegistrationRole: "STRING_VALUE", + * // locationRegistrationExcludeS3Locations: [ // S3LocationList + * // "STRING_VALUE", + * // ], + * // }, + * // }, + * // ], * // }; * * ``` diff --git a/clients/client-datazone/src/commands/UpdateAssetFilterCommand.ts b/clients/client-datazone/src/commands/UpdateAssetFilterCommand.ts new file mode 100644 index 0000000000000..f21f9383d4def --- /dev/null +++ b/clients/client-datazone/src/commands/UpdateAssetFilterCommand.ts @@ -0,0 +1,381 @@ +// 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 { + UpdateAssetFilterInput, + UpdateAssetFilterInputFilterSensitiveLog, + UpdateAssetFilterOutput, + UpdateAssetFilterOutputFilterSensitiveLog, +} from "../models/models_1"; +import { de_UpdateAssetFilterCommand, se_UpdateAssetFilterCommand } from "../protocols/Aws_restJson1"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateAssetFilterCommand}. + */ +export interface UpdateAssetFilterCommandInput extends UpdateAssetFilterInput {} +/** + * @public + * + * The output of {@link UpdateAssetFilterCommand}. + */ +export interface UpdateAssetFilterCommandOutput extends UpdateAssetFilterOutput, __MetadataBearer {} + +/** + *

Updates an asset filter.

+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { DataZoneClient, UpdateAssetFilterCommand } from "@aws-sdk/client-datazone"; // ES Modules import + * // const { DataZoneClient, UpdateAssetFilterCommand } = require("@aws-sdk/client-datazone"); // CommonJS import + * const client = new DataZoneClient(config); + * const input = { // UpdateAssetFilterInput + * domainIdentifier: "STRING_VALUE", // required + * assetIdentifier: "STRING_VALUE", // required + * identifier: "STRING_VALUE", // required + * name: "STRING_VALUE", + * description: "STRING_VALUE", + * configuration: { // AssetFilterConfiguration Union: only one key present + * columnConfiguration: { // ColumnFilterConfiguration + * includedColumnNames: [ // ColumnNameList + * "STRING_VALUE", + * ], + * }, + * rowConfiguration: { // RowFilterConfiguration + * rowFilter: { // RowFilter Union: only one key present + * expression: { // RowFilterExpression Union: only one key present + * equalTo: { // EqualToExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * notEqualTo: { // NotEqualToExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * greaterThan: { // GreaterThanExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * lessThan: { // LessThanExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * greaterThanOrEqualTo: { // GreaterThanOrEqualToExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * lessThanOrEqualTo: { // LessThanOrEqualToExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * isNull: { // IsNullExpression + * columnName: "STRING_VALUE", // required + * }, + * isNotNull: { // IsNotNullExpression + * columnName: "STRING_VALUE", // required + * }, + * in: { // InExpression + * columnName: "STRING_VALUE", // required + * values: [ // StringList // required + * "STRING_VALUE", + * ], + * }, + * notIn: { // NotInExpression + * columnName: "STRING_VALUE", // required + * values: [ // required + * "STRING_VALUE", + * ], + * }, + * like: { // LikeExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * notLike: { // NotLikeExpression + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * }, + * and: [ // RowFilterList + * {// Union: only one key present + * expression: {// Union: only one key present + * equalTo: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * notEqualTo: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * greaterThan: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * lessThan: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * greaterThanOrEqualTo: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * lessThanOrEqualTo: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * isNull: { + * columnName: "STRING_VALUE", // required + * }, + * isNotNull: { + * columnName: "STRING_VALUE", // required + * }, + * in: { + * columnName: "STRING_VALUE", // required + * values: [ // required + * "STRING_VALUE", + * ], + * }, + * notIn: { + * columnName: "STRING_VALUE", // required + * values: [ // required + * "STRING_VALUE", + * ], + * }, + * like: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * notLike: { + * columnName: "STRING_VALUE", // required + * value: "STRING_VALUE", // required + * }, + * }, + * and: [ + * "", + * ], + * or: [ + * "", + * ], + * }, + * ], + * or: [ + * "", + * ], + * }, + * sensitive: true || false, + * }, + * }, + * }; + * const command = new UpdateAssetFilterCommand(input); + * const response = await client.send(command); + * // { // UpdateAssetFilterOutput + * // id: "STRING_VALUE", // required + * // domainId: "STRING_VALUE", // required + * // assetId: "STRING_VALUE", // required + * // name: "STRING_VALUE", // required + * // description: "STRING_VALUE", + * // status: "VALID" || "INVALID", + * // configuration: { // AssetFilterConfiguration Union: only one key present + * // columnConfiguration: { // ColumnFilterConfiguration + * // includedColumnNames: [ // ColumnNameList + * // "STRING_VALUE", + * // ], + * // }, + * // rowConfiguration: { // RowFilterConfiguration + * // rowFilter: { // RowFilter Union: only one key present + * // expression: { // RowFilterExpression Union: only one key present + * // equalTo: { // EqualToExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // notEqualTo: { // NotEqualToExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // greaterThan: { // GreaterThanExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // lessThan: { // LessThanExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // greaterThanOrEqualTo: { // GreaterThanOrEqualToExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // lessThanOrEqualTo: { // LessThanOrEqualToExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // isNull: { // IsNullExpression + * // columnName: "STRING_VALUE", // required + * // }, + * // isNotNull: { // IsNotNullExpression + * // columnName: "STRING_VALUE", // required + * // }, + * // in: { // InExpression + * // columnName: "STRING_VALUE", // required + * // values: [ // StringList // required + * // "STRING_VALUE", + * // ], + * // }, + * // notIn: { // NotInExpression + * // columnName: "STRING_VALUE", // required + * // values: [ // required + * // "STRING_VALUE", + * // ], + * // }, + * // like: { // LikeExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // notLike: { // NotLikeExpression + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // }, + * // and: [ // RowFilterList + * // {// Union: only one key present + * // expression: {// Union: only one key present + * // equalTo: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // notEqualTo: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // greaterThan: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // lessThan: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // greaterThanOrEqualTo: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // lessThanOrEqualTo: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // isNull: { + * // columnName: "STRING_VALUE", // required + * // }, + * // isNotNull: { + * // columnName: "STRING_VALUE", // required + * // }, + * // in: { + * // columnName: "STRING_VALUE", // required + * // values: [ // required + * // "STRING_VALUE", + * // ], + * // }, + * // notIn: { + * // columnName: "STRING_VALUE", // required + * // values: [ // required + * // "STRING_VALUE", + * // ], + * // }, + * // like: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // notLike: { + * // columnName: "STRING_VALUE", // required + * // value: "STRING_VALUE", // required + * // }, + * // }, + * // and: [ + * // "", + * // ], + * // or: [ + * // "", + * // ], + * // }, + * // ], + * // or: [ + * // "", + * // ], + * // }, + * // sensitive: true || false, + * // }, + * // }, + * // createdAt: new Date("TIMESTAMP"), + * // errorMessage: "STRING_VALUE", + * // effectiveColumnNames: [ + * // "STRING_VALUE", + * // ], + * // effectiveRowFilter: "STRING_VALUE", + * // }; + * + * ``` + * + * @param UpdateAssetFilterCommandInput - {@link UpdateAssetFilterCommandInput} + * @returns {@link UpdateAssetFilterCommandOutput} + * @see {@link UpdateAssetFilterCommandInput} for command's `input` shape. + * @see {@link UpdateAssetFilterCommandOutput} 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 UpdateAssetFilterCommand extends $Command + .classBuilder< + UpdateAssetFilterCommandInput, + UpdateAssetFilterCommandOutput, + 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", "UpdateAssetFilter", {}) + .n("DataZoneClient", "UpdateAssetFilterCommand") + .f(UpdateAssetFilterInputFilterSensitiveLog, UpdateAssetFilterOutputFilterSensitiveLog) + .ser(se_UpdateAssetFilterCommand) + .de(de_UpdateAssetFilterCommand) + .build() {} diff --git a/clients/client-datazone/src/commands/index.ts b/clients/client-datazone/src/commands/index.ts index cb043b6c077a3..3e84fb535a25e 100644 --- a/clients/client-datazone/src/commands/index.ts +++ b/clients/client-datazone/src/commands/index.ts @@ -5,6 +5,7 @@ export * from "./AssociateEnvironmentRoleCommand"; export * from "./CancelMetadataGenerationRunCommand"; export * from "./CancelSubscriptionCommand"; export * from "./CreateAssetCommand"; +export * from "./CreateAssetFilterCommand"; export * from "./CreateAssetRevisionCommand"; export * from "./CreateAssetTypeCommand"; export * from "./CreateDataSourceCommand"; @@ -24,6 +25,7 @@ export * from "./CreateSubscriptionRequestCommand"; export * from "./CreateSubscriptionTargetCommand"; export * from "./CreateUserProfileCommand"; export * from "./DeleteAssetCommand"; +export * from "./DeleteAssetFilterCommand"; export * from "./DeleteAssetTypeCommand"; export * from "./DeleteDataSourceCommand"; export * from "./DeleteDomainCommand"; @@ -43,6 +45,7 @@ export * from "./DeleteSubscriptionTargetCommand"; export * from "./DeleteTimeSeriesDataPointsCommand"; export * from "./DisassociateEnvironmentRoleCommand"; export * from "./GetAssetCommand"; +export * from "./GetAssetFilterCommand"; export * from "./GetAssetTypeCommand"; export * from "./GetDataSourceCommand"; export * from "./GetDataSourceRunCommand"; @@ -67,6 +70,7 @@ export * from "./GetSubscriptionRequestDetailsCommand"; export * from "./GetSubscriptionTargetCommand"; export * from "./GetTimeSeriesDataPointCommand"; export * from "./GetUserProfileCommand"; +export * from "./ListAssetFiltersCommand"; export * from "./ListAssetRevisionsCommand"; export * from "./ListDataSourceRunActivitiesCommand"; export * from "./ListDataSourceRunsCommand"; @@ -103,6 +107,7 @@ export * from "./StartDataSourceRunCommand"; export * from "./StartMetadataGenerationRunCommand"; export * from "./TagResourceCommand"; export * from "./UntagResourceCommand"; +export * from "./UpdateAssetFilterCommand"; export * from "./UpdateDataSourceCommand"; export * from "./UpdateDomainCommand"; export * from "./UpdateEnvironmentActionCommand"; diff --git a/clients/client-datazone/src/models/models_0.ts b/clients/client-datazone/src/models/models_0.ts index 0853ec9888a69..4006ec49c8335 100644 --- a/clients/client-datazone/src/models/models_0.ts +++ b/clients/client-datazone/src/models/models_0.ts @@ -1355,2196 +1355,1806 @@ export interface GetAssetOutput { } /** - *

The additional attributes of an inventory asset.

+ *

The column configuration of the asset filter.

* @public */ -export interface AssetItemAdditionalAttributes { - /** - *

The forms included in the additional attributes of an inventory asset.

- * @public - */ - formsOutput?: FormOutput[]; - +export interface ColumnFilterConfiguration { /** - *

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.

+ *

Specifies whether to include column names.

* @public */ - latestTimeSeriesDataPointFormsOutput?: TimeSeriesDataPointSummaryFormOutput[]; + includedColumnNames?: string[]; } /** - *

A Amazon DataZone inventory asset.

+ *

Specifies whether the value is equal to an expression.

* @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; - +export interface EqualToExpression { /** - *

The name of the Amazon DataZone inventory asset.

+ *

The name of the column.

* @public */ - name: string | undefined; + columnName: string | undefined; /** - *

The identifier of the asset type of the specified Amazon DataZone inventory asset.

+ *

The value that might be equal to an expression.

* @public */ - typeIdentifier: string | undefined; + value: string | undefined; +} +/** + *

Specifies whether the value is greater than an expression.

+ * @public + */ +export interface GreaterThanExpression { /** - *

The revision of the inventory asset type.

+ *

The name of the column.

* @public */ - typeRevision: string | undefined; + columnName: string | undefined; /** - *

The external identifier of the Amazon DataZone inventory asset.

+ *

The value that might be greater than an expression.

* @public */ - externalIdentifier?: string; + value: string | undefined; +} +/** + *

Specifies whether the value is greater than or equal to an expression.

+ * @public + */ +export interface GreaterThanOrEqualToExpression { /** - *

The description of an Amazon DataZone inventory asset.

+ *

The name of the column.

* @public */ - description?: string; + columnName: string | undefined; /** - *

The timestamp of when the Amazon DataZone inventory asset was created.

+ *

The value that might be greater than or equal to an expression.

* @public */ - createdAt?: Date; + value: string | undefined; +} +/** + *

Specifies whether values are in the expression.

+ * @public + */ +export interface InExpression { /** - *

The Amazon DataZone user who created the inventory asset.

+ *

The name of the column.

* @public */ - createdBy?: string; + columnName: string | undefined; /** - *

The timestamp of when the first revision of the inventory asset was created.

+ *

The values that might be in the expression.

* @public */ - firstRevisionCreatedAt?: Date; + values: string[] | undefined; +} +/** + *

Specifies that the expression is not null.

+ * @public + */ +export interface IsNotNullExpression { /** - *

The Amazon DataZone user who created the first revision of the inventory asset.

+ *

The name of the column.

* @public */ - firstRevisionCreatedBy?: string; + columnName: string | undefined; +} +/** + *

Specifies that the expression is null.

+ * @public + */ +export interface IsNullExpression { /** - *

The glossary terms attached to the Amazon DataZone inventory asset.

+ *

The name of the column.

* @public */ - glossaryTerms?: string[]; + columnName: string | undefined; +} +/** + *

Specifies that a value is less than an expression.

+ * @public + */ +export interface LessThanExpression { /** - *

The identifier of the Amazon DataZone project that owns the inventory asset.

+ *

The name of the column.

* @public */ - owningProjectId: string | undefined; + columnName: string | undefined; /** - *

The additional attributes of a Amazon DataZone inventory asset.

+ *

The value that might be less than the expression.

* @public */ - additionalAttributes?: AssetItemAdditionalAttributes; + value: string | undefined; } /** - *

An asset published in an Amazon DataZone catalog.

+ *

Specifies that a value is less than or equal to an expression.

* @public */ -export interface AssetListing { +export interface LessThanOrEqualToExpression { /** - *

The identifier of an asset published in an Amazon DataZone catalog.

+ *

The name of the column.

* @public */ - assetId?: string; + columnName: string | undefined; /** - *

The revision of an asset published in an Amazon DataZone catalog.

+ *

The value that might be less than or equal to an expression.

* @public */ - assetRevision?: string; + value: string | undefined; +} +/** + *

Specifies that a value is like the expression.

+ * @public + */ +export interface LikeExpression { /** - *

The type of an asset published in an Amazon DataZone catalog.

+ *

The name of the column.

* @public */ - assetType?: string; + columnName: string | undefined; /** - *

The timestamp of when an asset published in an Amazon DataZone catalog was created.

+ *

The value that might be like the expression.

* @public */ - createdAt?: Date; + value: string | undefined; +} +/** + *

Specifies that a value is not equal to the expression.

+ * @public + */ +export interface NotEqualToExpression { /** - *

The metadata forms attached to an asset published in an Amazon DataZone catalog.

+ *

The name of the column.

* @public */ - forms?: string; + columnName: string | undefined; /** - *

The latest time series data points forms included in the additional attributes of an - * asset.

+ *

The value that might not be equal to the expression.

* @public */ - latestTimeSeriesDataPointForms?: TimeSeriesDataPointSummaryFormOutput[]; + value: string | undefined; +} +/** + *

Specifies that a value is not in the expression.

+ * @public + */ +export interface NotInExpression { /** - *

The glossary terms attached to an asset published in an Amazon DataZone catalog.

+ *

The name of the column.

* @public */ - glossaryTerms?: DetailedGlossaryTerm[]; + columnName: string | undefined; /** - *

The identifier of the project where an asset published in an Amazon DataZone catalog exists. - *

+ *

The value that might not be in the expression.

* @public */ - owningProjectId?: string; + values: string[] | undefined; } /** - *

Additional attributes of an inventory asset.

+ *

Specifies that a value might be not like the expression.

* @public */ -export interface AssetListingItemAdditionalAttributes { +export interface NotLikeExpression { /** - *

The metadata forms that form additional attributes of the metadata asset.

+ *

The name of the column.

* @public */ - forms?: string; + columnName: string | undefined; /** - *

The latest time series data points forms included in the additional attributes of an - * asset.

+ *

The value that might not be like the expression.

* @public */ - latestTimeSeriesDataPointForms?: TimeSeriesDataPointSummaryFormOutput[]; + value: string | undefined; } /** - *

The details of an asset published in an Amazon DataZone catalog.

+ *

The row filter expression.

* @public */ -export interface AssetListingItem { +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 namespace RowFilterExpression { /** - *

The identifier of the listing (asset published in Amazon DataZone catalog).

+ *

The 'equal to' clause of the row filter expression.

* @public */ - listingId?: string; + 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 revision of the listing (asset published in Amazon DataZone catalog).

+ *

The 'no equal to' clause of the row filter expression.

* @public */ - listingRevision?: string; + 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 name of the inventory asset.

+ *

The 'greater than' clause of the row filter expression.

* @public */ - name?: 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; + } /** - *

The identifier of the inventory asset.

+ *

The 'less than' clause of the row filter expression.

* @public */ - entityId?: string; + 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 revision of the inventory asset.

+ *

The 'greater than or equal to' clause of the filter expression.

* @public */ - entityRevision?: string; + 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 type of the inventory asset.

+ *

The 'less than or equal to' clause of the row filter expression.

* @public */ - entityType?: string; + 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 an asset published in an Amazon DataZone catalog.

+ *

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 timestamp of when an asset published in an Amazon DataZone catalog was created.

+ *

The 'is not null' clause of the row filter expression.

* @public */ - createdAt?: Date; + 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 Amazon DataZone user who created the listing.

+ *

The 'in' clause of the row filter expression.

* @public */ - listingCreatedBy?: string; + 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 Amazon DataZone user who updated the listing.

+ *

The 'not in' clause of the row filter expression.

* @public */ - listingUpdatedBy?: string; + 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; + } /** - *

Glossary terms attached to the inventory asset.

+ *

The 'like' clause of the row filter expression.

* @public */ - glossaryTerms?: DetailedGlossaryTerm[]; + 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 identifier of the project that owns the inventory asset.

+ *

The 'not like' clause of the row filter expression.

* @public */ - owningProjectId?: string; + 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; + } /** - *

The additional attributes of an asset published in an Amazon DataZone catalog.

* @public */ - additionalAttributes?: AssetListingItemAdditionalAttributes; + 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 Visitor { + equalTo: (value: EqualToExpression) => T; + notEqualTo: (value: NotEqualToExpression) => T; + greaterThan: (value: GreaterThanExpression) => T; + lessThan: (value: LessThanExpression) => T; + greaterThanOrEqualTo: (value: GreaterThanOrEqualToExpression) => T; + lessThanOrEqualTo: (value: LessThanOrEqualToExpression) => T; + isNull: (value: IsNullExpression) => T; + isNotNull: (value: IsNotNullExpression) => T; + in: (value: InExpression) => T; + notIn: (value: NotInExpression) => T; + like: (value: LikeExpression) => T; + notLike: (value: NotLikeExpression) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: RowFilterExpression, visitor: Visitor): T => { + if (value.equalTo !== undefined) return visitor.equalTo(value.equalTo); + if (value.notEqualTo !== undefined) return visitor.notEqualTo(value.notEqualTo); + if (value.greaterThan !== undefined) return visitor.greaterThan(value.greaterThan); + if (value.lessThan !== undefined) return visitor.lessThan(value.lessThan); + if (value.greaterThanOrEqualTo !== undefined) return visitor.greaterThanOrEqualTo(value.greaterThanOrEqualTo); + if (value.lessThanOrEqualTo !== undefined) return visitor.lessThanOrEqualTo(value.lessThanOrEqualTo); + if (value.isNull !== undefined) return visitor.isNull(value.isNull); + if (value.isNotNull !== undefined) return visitor.isNotNull(value.isNotNull); + if (value.in !== undefined) return visitor.in(value.in); + if (value.notIn !== undefined) return visitor.notIn(value.notIn); + if (value.like !== undefined) return visitor.like(value.like); + if (value.notLike !== undefined) return visitor.notLike(value.notLike); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** - *

The revision of an inventory asset.

* @public + * @enum */ -export interface AssetRevision { +export const FilterStatus = { + INVALID: "INVALID", + VALID: "VALID", +} as const; + +/** + * @public + */ +export type FilterStatus = (typeof FilterStatus)[keyof typeof FilterStatus]; + +/** + *

The summary of the asset filter.

+ * @public + */ +export interface AssetFilterSummary { /** - *

The Amazon DataZone user who created the inventory asset.

+ *

The ID of the asset filter.

* @public */ - domainId?: string; + id: string | undefined; /** - *

The identifier of the inventory asset revision.

+ *

The ID of the domain where the asset filter lives.

* @public */ - id?: string; + domainId: string | undefined; /** - *

The revision details of the inventory asset.

+ *

The ID of the data asset.

* @public */ - revision?: string; + assetId: string | undefined; /** - *

The Amazon DataZone user who created the asset revision.

+ *

The name of the asset filter.

* @public */ - createdBy?: string; + name: string | undefined; /** - *

The timestamp of when an inventory asset revison was created.

+ *

The description of the asset filter.

* @public */ - createdAt?: Date; -} + description?: string; -/** - *

The name map for assets.

- * @public - */ -export interface AssetTargetNameMap { /** - *

The identifier of the inventory asset.

+ *

The status of the asset filter.

* @public */ - assetId: string | undefined; + status?: FilterStatus; /** - *

The target name in the asset target name map.

+ *

The effective column names of the asset filter.

* @public */ - targetName: string | undefined; -} + effectiveColumnNames?: string[]; -/** - *

The details of the form entry.

- * @public - */ -export interface FormEntryInput { /** - *

The type ID of the form entry.

+ *

The effective row filter of the asset filter.

* @public */ - typeIdentifier: string | undefined; + effectiveRowFilter?: string; /** - *

The type revision of the form entry.

+ *

The timestamp at which the asset filter was created.

* @public */ - typeRevision: string | undefined; + createdAt?: Date; /** - *

Specifies whether a form entry is required.

+ *

The error message that is displayed if the action does not succeed.

* @public */ - required?: boolean; + errorMessage?: string; } /** + *

The additional attributes of an inventory asset.

* @public */ -export interface CreateAssetTypeInput { +export interface AssetItemAdditionalAttributes { /** - *

The unique identifier of the Amazon DataZone domain where the custom asset type is being - * created.

+ *

The forms included in the additional attributes of an inventory asset.

* @public */ - domainIdentifier: string | undefined; + formsOutput?: FormOutput[]; /** - *

The name of the custom asset type.

+ *

The read-only forms included in the additional attributes of an inventory asset.

* @public */ - name: string | undefined; + readOnlyFormsOutput?: FormOutput[]; /** - *

The descripton of the custom asset type.

- * @public - */ - description?: string; - - /** - *

The metadata forms that are to be attached to the custom asset type.

- * @public - */ - formsInput: Record | undefined; - - /** - *

The identifier of the Amazon DataZone project that is to own the custom asset type.

+ *

The latest time series data points forms included in the additional attributes of an + * asset.

* @public */ - owningProjectIdentifier: string | undefined; + latestTimeSeriesDataPointFormsOutput?: TimeSeriesDataPointSummaryFormOutput[]; } /** - *

The details of the form entry.

+ *

A Amazon DataZone inventory asset.

* @public */ -export interface FormEntryOutput { +export interface AssetItem { /** - *

The name of the type of the form entry.

+ *

The identifier of the Amazon DataZone domain in which the inventory asset exists.

* @public */ - typeName: string | undefined; + domainId: string | undefined; /** - *

The type revision of the form entry.

+ *

the identifier of the Amazon DataZone inventory asset.

* @public */ - typeRevision: string | undefined; + identifier: string | undefined; /** - *

Specifies whether a form entry is required.

+ *

The name of the Amazon DataZone inventory asset.

* @public */ - required?: boolean; -} + name: string | undefined; -/** - * @public - */ -export interface CreateAssetTypeOutput { /** - *

The ID of the Amazon DataZone domain in which the asset type was created.

+ *

The identifier of the asset type of the specified Amazon DataZone inventory asset.

* @public */ - domainId: string | undefined; + typeIdentifier: string | undefined; /** - *

The name of the asset type.

+ *

The revision of the inventory asset type.

* @public */ - name: string | undefined; + typeRevision: string | undefined; /** - *

The revision of the custom asset type.

+ *

The external identifier of the Amazon DataZone inventory asset.

* @public */ - revision: string | undefined; + externalIdentifier?: string; /** - *

The description of the custom asset type.

+ *

The description of an Amazon DataZone inventory asset.

* @public */ description?: string; /** - *

The metadata forms that are attached to the asset type.

- * @public - */ - formsOutput: Record | undefined; - - /** - *

The ID of the Amazon DataZone project that currently owns this asset type.

+ *

The timestamp of when the Amazon DataZone inventory asset was created.

* @public */ - owningProjectId?: string; + createdAt?: Date; /** - *

The ID of the Amazon DataZone domain where the asset type was originally created.

+ *

The Amazon DataZone user who created the inventory asset.

* @public */ - originDomainId?: string; + createdBy?: string; /** - *

The ID of the Amazon DataZone project where the asset type was originally created.

+ *

The timestamp of when the first revision of the inventory asset was created.

* @public */ - originProjectId?: string; + firstRevisionCreatedAt?: Date; /** - *

The timestamp of when the asset type is to be created.

+ *

The Amazon DataZone user who created the first revision of the inventory asset.

* @public */ - createdAt?: Date; + firstRevisionCreatedBy?: string; /** - *

The Amazon DataZone user who creates this custom asset type.

+ *

The glossary terms attached to the Amazon DataZone inventory asset.

* @public */ - createdBy?: string; + glossaryTerms?: string[]; /** - *

The timestamp of when the custom type was created.

+ *

The identifier of the Amazon DataZone project that owns the inventory asset.

* @public */ - updatedAt?: Date; + owningProjectId: string | undefined; /** - *

The Amazon DataZone user that created the custom asset type.

+ *

The additional attributes of a Amazon DataZone inventory asset.

* @public */ - updatedBy?: string; + additionalAttributes?: AssetItemAdditionalAttributes; } /** + *

An asset published in an Amazon DataZone catalog.

* @public */ -export interface DeleteAssetTypeInput { +export interface AssetListing { /** - *

The ID of the Amazon DataZone domain in which the asset type is deleted.

+ *

The identifier of an asset published in an Amazon DataZone catalog.

* @public */ - domainIdentifier: string | undefined; + assetId?: string; /** - *

The identifier of the asset type that is deleted.

+ *

The revision of an asset published in an Amazon DataZone catalog.

* @public */ - identifier: string | undefined; -} - -/** - * @public - */ -export interface DeleteAssetTypeOutput {} + assetRevision?: string; -/** - * @public - */ -export interface GetAssetTypeInput { /** - *

The ID of the Amazon DataZone domain in which the asset type exists.

+ *

The type of an asset published in an Amazon DataZone catalog.

* @public */ - domainIdentifier: string | undefined; + assetType?: string; /** - *

The ID of the asset type.

+ *

The timestamp of when an asset published in an Amazon DataZone catalog was created.

* @public */ - identifier: string | undefined; + createdAt?: Date; /** - *

The revision of the asset type.

+ *

The metadata forms attached to an asset published in an Amazon DataZone catalog.

* @public */ - revision?: string; -} + forms?: string; -/** - * @public - */ -export interface GetAssetTypeOutput { /** - *

The ID of the Amazon DataZone domain in which the asset type exists.

+ *

The latest time series data points forms included in the additional attributes of an + * asset.

* @public */ - domainId: string | undefined; + latestTimeSeriesDataPointForms?: TimeSeriesDataPointSummaryFormOutput[]; /** - *

The name of the asset type.

+ *

The glossary terms attached to an asset published in an Amazon DataZone catalog.

* @public */ - name: string | undefined; + glossaryTerms?: DetailedGlossaryTerm[]; /** - *

The revision of the asset type.

+ *

The identifier of the project where an asset published in an Amazon DataZone catalog exists. + *

* @public */ - revision: string | undefined; + owningProjectId?: string; +} +/** + *

Additional attributes of an inventory asset.

+ * @public + */ +export interface AssetListingItemAdditionalAttributes { /** - *

The description of the asset type.

+ *

The metadata forms that form additional attributes of the metadata asset.

* @public */ - description?: string; + forms?: string; /** - *

The metadata forms attached to the asset type.

+ *

The latest time series data points forms included in the additional attributes of an + * asset.

* @public */ - formsOutput: Record | undefined; + latestTimeSeriesDataPointForms?: TimeSeriesDataPointSummaryFormOutput[]; +} +/** + *

The details of an asset published in an Amazon DataZone catalog.

+ * @public + */ +export interface AssetListingItem { /** - *

The ID of the Amazon DataZone project that owns the asset type.

+ *

The identifier of the listing (asset published in Amazon DataZone catalog).

* @public */ - owningProjectId: string | undefined; + listingId?: string; /** - *

The ID of the Amazon DataZone domain in which the asset type was originally created.

+ *

The revision of the listing (asset published in Amazon DataZone catalog).

* @public */ - originDomainId?: string; + listingRevision?: string; /** - *

The ID of the Amazon DataZone project in which the asset type was originally created.

+ *

The name of the inventory asset.

* @public */ - originProjectId?: string; + name?: string; /** - *

The timestamp of when the asset type was created.

+ *

The identifier of the inventory asset.

* @public */ - createdAt?: Date; + entityId?: string; /** - *

The Amazon DataZone user who created the asset type.

+ *

The revision of the inventory asset.

* @public */ - createdBy?: string; + entityRevision?: string; /** - *

The timestamp of when the asset type was updated.

+ *

The type of the inventory asset.

* @public */ - updatedAt?: Date; + entityType?: string; /** - *

The Amazon DataZone user that updated the asset type.

+ *

The description of an asset published in an Amazon DataZone catalog.

* @public */ - updatedBy?: string; -} + description?: string; -/** - *

The details of the asset type.

- * @public - */ -export interface AssetTypeItem { /** - *

The identifier of the Amazon DataZone domain where the asset type exists.

+ *

The timestamp of when an asset published in an Amazon DataZone catalog was created.

* @public */ - domainId: string | undefined; + createdAt?: Date; /** - *

The name of the asset type.

+ *

The Amazon DataZone user who created the listing.

* @public */ - name: string | undefined; + listingCreatedBy?: string; /** - *

The revision of the asset type.

+ *

The Amazon DataZone user who updated the listing.

* @public */ - revision: string | undefined; + listingUpdatedBy?: string; /** - *

The description of the asset type.

+ *

Glossary terms attached to the inventory asset.

* @public */ - description?: string; + glossaryTerms?: DetailedGlossaryTerm[]; /** - *

The forms included in the details of the asset type.

+ *

The identifier of the project that owns the inventory asset.

* @public */ - formsOutput: Record | undefined; + owningProjectId?: string; /** - *

The identifier of the Amazon DataZone project that owns the asset type.

+ *

The additional attributes of an asset published in an Amazon DataZone catalog.

* @public */ - owningProjectId: string | undefined; + additionalAttributes?: AssetListingItemAdditionalAttributes; +} +/** + *

The revision of an inventory asset.

+ * @public + */ +export interface AssetRevision { /** - *

The identifier of the Amazon DataZone domain where the asset type was originally - * created.

+ *

The Amazon DataZone user who created the inventory asset.

* @public */ - originDomainId?: string; + domainId?: string; /** - *

The identifier of the Amazon DataZone project where the asset type exists.

+ *

The identifier of the inventory asset revision.

* @public */ - originProjectId?: string; + id?: string; /** - *

The timestamp of when the asset type was created.

+ *

The revision details of the inventory asset.

* @public */ - createdAt?: Date; + revision?: string; /** - *

The Amazon DataZone user who created the asset type.

+ *

The Amazon DataZone user who created the asset revision.

* @public */ createdBy?: string; /** - *

The timestamp of when the asset type was updated.

- * @public - */ - updatedAt?: Date; - - /** - *

The Amazon DataZone user who updated the asset type.

+ *

The timestamp of when an inventory asset revison was created.

* @public */ - updatedBy?: string; + createdAt?: Date; } /** + *

The name map for assets.

* @public */ -export interface AssociateEnvironmentRoleInput { +export interface AssetTargetNameMap { /** - *

The ID of the Amazon DataZone domain in which the environment role is associated.

+ *

The identifier of the inventory asset.

* @public */ - domainIdentifier: string | undefined; + assetId: string | undefined; /** - *

The ID of the Amazon DataZone environment.

+ *

The target name in the asset target name map.

* @public */ - environmentIdentifier: string | undefined; - - /** - *

The ARN of the environment role.

- * @public - */ - environmentRoleArn: string | undefined; + targetName: string | undefined; } /** + *

The details of the form entry.

* @public */ -export interface AssociateEnvironmentRoleOutput {} +export interface FormEntryInput { + /** + *

The type ID of the form entry.

+ * @public + */ + typeIdentifier: string | undefined; -/** - * @public - * @enum - */ -export const AuthType = { - DISABLED: "DISABLED", - IAM_IDC: "IAM_IDC", -} as const; + /** + *

The type revision of the form entry.

+ * @public + */ + typeRevision: string | undefined; -/** - * @public - */ -export type AuthType = (typeof AuthType)[keyof typeof AuthType]; + /** + *

Specifies whether a form entry is required.

+ * @public + */ + required?: boolean; +} /** * @public */ -export interface CancelMetadataGenerationRunInput { +export interface CreateAssetTypeInput { /** - *

The ID of the Amazon DataZone domain in which the metadata generation run is to be - * cancelled.

+ *

The unique identifier of the Amazon DataZone domain where the custom asset type is being + * created.

* @public */ domainIdentifier: string | undefined; /** - *

The ID of the metadata generation run.

+ *

The name of the custom asset type.

* @public */ - identifier: string | undefined; -} + name: string | undefined; -/** - * @public - */ -export interface CancelMetadataGenerationRunOutput {} + /** + *

The descripton of the custom asset type.

+ * @public + */ + description?: string; -/** - * @public - */ -export interface CancelSubscriptionInput { /** - *

The unique identifier of the Amazon DataZone domain where the subscription request is being - * cancelled.

+ *

The metadata forms that are to be attached to the custom asset type.

* @public */ - domainIdentifier: string | undefined; + formsInput: Record | undefined; /** - *

The unique identifier of the subscription that is being cancelled.

+ *

The identifier of the Amazon DataZone project that is to own the custom asset type.

* @public */ - identifier: string | undefined; + owningProjectIdentifier: string | undefined; } /** + *

The details of the form entry.

* @public - * @enum */ -export const SubscriptionStatus = { - APPROVED: "APPROVED", - CANCELLED: "CANCELLED", - REVOKED: "REVOKED", -} as const; +export interface FormEntryOutput { + /** + *

The name of the type of the form entry.

+ * @public + */ + typeName: string | undefined; -/** - * @public - */ -export type SubscriptionStatus = (typeof SubscriptionStatus)[keyof typeof SubscriptionStatus]; + /** + *

The type revision of the form entry.

+ * @public + */ + typeRevision: string | undefined; + + /** + *

Specifies whether a form entry is required.

+ * @public + */ + required?: boolean; +} /** * @public */ -export interface CancelSubscriptionOutput { +export interface CreateAssetTypeOutput { /** - *

The identifier of the subscription.

+ *

The ID of the Amazon DataZone domain in which the asset type was created.

* @public */ - id: string | undefined; + domainId: string | undefined; /** - *

Specifies the Amazon DataZone user who is cancelling the subscription.

+ *

The name of the asset type.

* @public */ - createdBy: string | undefined; + name: string | undefined; /** - *

The Amazon DataZone user that cancelled the subscription.

+ *

The revision of the custom asset type.

* @public */ - updatedBy?: string; + revision: string | undefined; /** - *

The unique identifier of the Amazon DataZone domain where the subscription is being - * cancelled.

+ *

The description of the custom asset type.

* @public */ - domainId: string | undefined; + description?: string; /** - *

The status of the request to cancel the subscription.

+ *

The metadata forms that are attached to the asset type.

* @public */ - status: SubscriptionStatus | undefined; + formsOutput: Record | undefined; /** - *

The timestamp that specifies when the request to cancel the subscription was - * created.

+ *

The ID of the Amazon DataZone project that currently owns this asset type.

* @public */ - createdAt: Date | undefined; + owningProjectId?: string; /** - *

The timestamp that specifies when the subscription was cancelled.

+ *

The ID of the Amazon DataZone domain where the asset type was originally created.

* @public */ - updatedAt: Date | undefined; + originDomainId?: string; /** - *

The Amazon DataZone user who is made a subscriber to the specified asset by the subscription - * that is being cancelled.

+ *

The ID of the Amazon DataZone project where the asset type was originally created.

* @public */ - subscribedPrincipal: SubscribedPrincipal | undefined; + originProjectId?: string; /** - *

The asset to which a subscription is being cancelled.

+ *

The timestamp of when the asset type is to be created.

* @public */ - subscribedListing: SubscribedListing | undefined; + createdAt?: Date; /** - *

The unique ID of the subscripton request for the subscription that is being - * cancelled.

+ *

The Amazon DataZone user who creates this custom asset type.

* @public */ - subscriptionRequestId?: string; + createdBy?: string; /** - *

Specifies whether the permissions to the asset are retained after the subscription is - * cancelled.

+ *

The timestamp of when the custom type was created.

* @public */ - retainPermissions?: boolean; -} - -/** - * @public - * @enum - */ -export const ChangeAction = { - PUBLISH: "PUBLISH", - UNPUBLISH: "UNPUBLISH", -} as const; - -/** - * @public - */ -export type ChangeAction = (typeof ChangeAction)[keyof typeof ChangeAction]; + updatedAt?: Date; -/** - *

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.

+ *

The Amazon DataZone user that created the custom asset type.

* @public */ - templateUrl: string | undefined; + updatedBy?: string; } /** - *

The details of the parameters for the configurable environment action.

* @public */ -export interface ConfigurableActionParameter { +export interface DeleteAssetTypeInput { /** - *

The key of the configurable action parameter.

+ *

The ID of the Amazon DataZone domain in which the asset type is deleted.

* @public */ - key?: string; + domainIdentifier: string | undefined; /** - *

The value of the configurable action parameter.

+ *

The identifier of the asset type that is deleted.

* @public */ - value?: string; + identifier: string | undefined; } -/** - * @public - * @enum - */ -export const ConfigurableActionTypeAuthorization = { - HTTPS: "HTTPS", - IAM: "IAM", -} as const; - /** * @public */ -export type ConfigurableActionTypeAuthorization = - (typeof ConfigurableActionTypeAuthorization)[keyof typeof ConfigurableActionTypeAuthorization]; +export interface DeleteAssetTypeOutput {} /** - *

The configurable action of a Amazon DataZone environment.

* @public */ -export interface ConfigurableEnvironmentAction { +export interface GetAssetTypeInput { /** - *

The type of a configurable action in a Amazon DataZone environment.

+ *

The ID of the Amazon DataZone domain in which the asset type exists.

* @public */ - type: string | undefined; + domainIdentifier: string | undefined; /** - *

The authentication type of a configurable action of a Amazon DataZone environment.

+ *

The ID of the asset type.

* @public */ - auth?: ConfigurableActionTypeAuthorization; + identifier: string | undefined; /** - *

The parameters of a configurable action in a Amazon DataZone environment.

+ *

The revision of the asset type.

* @public */ - parameters: ConfigurableActionParameter[] | undefined; + revision?: 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 { +export interface GetAssetTypeOutput { /** - *

The search filter explresison type.

+ *

The ID of the Amazon DataZone domain in which the asset type exists.

* @public */ - type: FilterExpressionType | undefined; + domainId: string | undefined; /** - *

The search filter expression.

+ *

The name of the asset type.

* @public */ - expression: string | undefined; -} + name: 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.

+ *

The revision of the asset type.

* @public */ - databaseName: string | undefined; + revision: string | undefined; /** - *

The schema name specified in the relational filter configuration for the data - * source.

+ *

The description of the asset type.

* @public */ - schemaName?: string; + description?: string; /** - *

The filter expressions specified in the relational filter configuration for the data - * source.

+ *

The metadata forms attached to the asset type.

* @public */ - filterExpressions?: FilterExpression[]; -} + formsOutput: Record | undefined; -/** - *

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.

+ *

The ID of the Amazon DataZone project that owns the asset type.

* @public */ - dataAccessRole?: string; + owningProjectId: string | undefined; /** - *

The relational filter configurations included in the configuration details of the Amazon Web Services - * Glue data source.

+ *

The ID of the Amazon DataZone domain in which the asset type was originally created.

* @public */ - relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; + originDomainId?: string; /** - *

Specifies whether to automatically import data quality metrics as part of the data - * source run.

+ *

The ID of the Amazon DataZone project in which the asset type was originally created.

* @public */ - autoImportDataQualityResult?: boolean; -} + originProjectId?: string; -/** - *

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.

+ *

The timestamp of when the asset type was created.

* @public */ - secretManagerArn: string | undefined; -} + createdAt?: Date; -/** - *

The details of the Amazon Redshift cluster storage.

- * @public - */ -export interface RedshiftClusterStorage { /** - *

The name of an Amazon Redshift cluster.

+ *

The Amazon DataZone user who created the asset type.

* @public */ - clusterName: string | undefined; -} + createdBy?: string; -/** - *

The details of the Amazon Redshift Serverless workgroup storage.

- * @public - */ -export interface RedshiftServerlessStorage { /** - *

The name of the Amazon Redshift Serverless workgroup.

+ *

The timestamp of when the asset type was updated.

* @public */ - workgroupName: string | undefined; + updatedAt?: Date; + + /** + *

The Amazon DataZone user that updated the asset type.

+ * @public + */ + updatedBy?: string; } /** - *

The details of the Amazon Redshift storage as part of the configuration of an Amazon - * Redshift data source run.

+ *

The details of the asset type.

* @public */ -export type RedshiftStorage = - | RedshiftStorage.RedshiftClusterSourceMember - | RedshiftStorage.RedshiftServerlessSourceMember - | RedshiftStorage.$UnknownMember; +export interface AssetTypeItem { + /** + *

The identifier of the Amazon DataZone domain where the asset type exists.

+ * @public + */ + domainId: string | undefined; -/** - * @public - */ -export namespace RedshiftStorage { /** - *

The details of the Amazon Redshift cluster source.

+ *

The name of the asset type.

* @public */ - export interface RedshiftClusterSourceMember { - redshiftClusterSource: RedshiftClusterStorage; - redshiftServerlessSource?: never; - $unknown?: never; - } + name: string | undefined; /** - *

The details of the Amazon Redshift Serverless workgroup source.

+ *

The revision of the asset type.

* @public */ - export interface RedshiftServerlessSourceMember { - redshiftClusterSource?: never; - redshiftServerlessSource: RedshiftServerlessStorage; - $unknown?: never; - } + revision: string | undefined; /** + *

The description of the asset type.

* @public */ - export interface $UnknownMember { - redshiftClusterSource?: never; - redshiftServerlessSource?: never; - $unknown: [string, any]; - } + description?: string; - export interface Visitor { - redshiftClusterSource: (value: RedshiftClusterStorage) => T; - redshiftServerlessSource: (value: RedshiftServerlessStorage) => T; - _: (name: string, value: any) => T; - } + /** + *

The forms included in the details of the asset type.

+ * @public + */ + formsOutput: Record | undefined; - export const visit = (value: RedshiftStorage, visitor: Visitor): T => { - if (value.redshiftClusterSource !== undefined) return visitor.redshiftClusterSource(value.redshiftClusterSource); - if (value.redshiftServerlessSource !== undefined) - return visitor.redshiftServerlessSource(value.redshiftServerlessSource); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} + /** + *

The identifier of the Amazon DataZone project that owns the asset type.

+ * @public + */ + owningProjectId: string | undefined; -/** - *

The 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.

+ *

The identifier of the Amazon DataZone domain where the asset type was originally + * created.

* @public */ - dataAccessRole?: string; + originDomainId?: string; /** - *

The relational filger configurations included in the configuration details of the Amazon - * Redshift data source.

+ *

The identifier of the Amazon DataZone project where the asset type exists.

* @public */ - relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; + originProjectId?: string; /** - *

The details of the credentials required to access an Amazon Redshift cluster.

+ *

The timestamp of when the asset type 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 Amazon DataZone user who created the asset type.

* @public */ - redshiftStorage: RedshiftStorage | undefined; -} + createdBy?: string; -/** - *

The configuration of the data source.

- * @public - */ -export type DataSourceConfigurationInput = - | DataSourceConfigurationInput.GlueRunConfigurationMember - | DataSourceConfigurationInput.RedshiftRunConfigurationMember - | DataSourceConfigurationInput.$UnknownMember; + /** + *

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 namespace DataSourceConfigurationInput { +export interface AssociateEnvironmentRoleInput { /** - *

The configuration of the Amazon Web Services Glue data source.

+ *

The ID of the Amazon DataZone domain in which the environment role is associated.

* @public */ - export interface GlueRunConfigurationMember { - glueRunConfiguration: GlueRunConfigurationInput; - redshiftRunConfiguration?: never; - $unknown?: never; - } + domainIdentifier: string | undefined; /** - *

The configuration of the Amazon Redshift data source.

+ *

The ID of the Amazon DataZone environment.

* @public */ - export interface RedshiftRunConfigurationMember { - glueRunConfiguration?: never; - redshiftRunConfiguration: RedshiftRunConfigurationInput; - $unknown?: never; - } + environmentIdentifier: string | undefined; /** + *

The ARN of the environment role.

* @public */ - export interface $UnknownMember { - glueRunConfiguration?: never; - redshiftRunConfiguration?: never; - $unknown: [string, any]; - } - - export interface Visitor { - glueRunConfiguration: (value: GlueRunConfigurationInput) => T; - redshiftRunConfiguration: (value: RedshiftRunConfigurationInput) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: DataSourceConfigurationInput, visitor: Visitor): T => { - if (value.glueRunConfiguration !== undefined) return visitor.glueRunConfiguration(value.glueRunConfiguration); - if (value.redshiftRunConfiguration !== undefined) - return visitor.redshiftRunConfiguration(value.redshiftRunConfiguration); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + environmentRoleArn: string | undefined; } +/** + * @public + */ +export interface AssociateEnvironmentRoleOutput {} + /** * @public * @enum */ -export const EnableSetting = { +export const AuthType = { DISABLED: "DISABLED", - ENABLED: "ENABLED", + IAM_IDC: "IAM_IDC", } as const; /** * @public */ -export type EnableSetting = (typeof EnableSetting)[keyof typeof EnableSetting]; +export type AuthType = (typeof AuthType)[keyof typeof AuthType]; /** - *

The recommendation to be updated as part of the UpdateDataSource - * action.

* @public */ -export interface RecommendationConfiguration { +export interface CancelMetadataGenerationRunInput { /** - *

Specifies whether automatic business name generation is to be enabled or not as part of - * the recommendation configuration.

+ *

The ID of the Amazon DataZone domain in which the metadata generation run is to be + * cancelled.

* @public */ - enableBusinessNameGeneration?: boolean; + domainIdentifier: string | undefined; + + /** + *

The ID of the metadata generation run.

+ * @public + */ + identifier: string | undefined; } /** * @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]; +export interface CancelMetadataGenerationRunOutput {} /** - *

The details of the schedule of the data source runs.

* @public */ -export interface ScheduleConfiguration { +export interface CancelSubscriptionInput { /** - *

The timezone of the data source run.

+ *

The unique identifier of the Amazon DataZone domain where the subscription request is being + * cancelled.

* @public */ - timezone?: Timezone; + domainIdentifier: string | undefined; /** - *

The schedule of the data source runs.

+ *

The unique identifier of the subscription that is being cancelled.

* @public */ - schedule?: string; + identifier: string | undefined; } +/** + * @public + * @enum + */ +export const SubscriptionStatus = { + APPROVED: "APPROVED", + CANCELLED: "CANCELLED", + REVOKED: "REVOKED", +} as const; + /** * @public */ -export interface CreateDataSourceInput { - /** - *

The name of the data source.

- * @public - */ - name: string | undefined; +export type SubscriptionStatus = (typeof SubscriptionStatus)[keyof typeof SubscriptionStatus]; +/** + * @public + */ +export interface CancelSubscriptionOutput { /** - *

The description of the data source.

+ *

The identifier of the subscription.

* @public */ - description?: string; + id: string | undefined; /** - *

The ID of the Amazon DataZone domain where the data source is created.

+ *

Specifies the Amazon DataZone user who is cancelling the subscription.

* @public */ - domainIdentifier: string | undefined; + createdBy: string | undefined; /** - *

The identifier of the Amazon DataZone project in which you want to add this data - * source.

+ *

The Amazon DataZone user that cancelled the subscription.

* @public */ - projectIdentifier: string | undefined; + updatedBy?: string; /** - *

The unique identifier of the Amazon DataZone environment to which the data source publishes - * assets.

+ *

The unique identifier of the Amazon DataZone domain where the subscription is being + * cancelled.

* @public */ - environmentIdentifier: string | undefined; + domainId: string | undefined; /** - *

The type of the data source.

+ *

The status of the request to cancel the subscription.

* @public */ - type: string | undefined; + status: SubscriptionStatus | undefined; /** - *

Specifies the configuration of the data source. It can be set to either - * glueRunConfiguration or redshiftRunConfiguration.

+ *

The timestamp that specifies when the request to cancel the subscription was + * created.

* @public */ - configuration?: DataSourceConfigurationInput; + createdAt: Date | undefined; /** - *

Specifies whether the business name generation is to be enabled for this data - * source.

+ *

The timestamp that specifies when the subscription was cancelled.

* @public */ - recommendation?: RecommendationConfiguration; + updatedAt: Date | undefined; /** - *

Specifies whether the data source is enabled.

+ *

The Amazon DataZone user who is made a subscriber to the specified asset by the subscription + * that is being cancelled.

* @public */ - enableSetting?: EnableSetting; + subscribedPrincipal: SubscribedPrincipal | undefined; /** - *

The schedule of the data source runs.

+ *

The asset to which a subscription is being cancelled.

* @public */ - schedule?: ScheduleConfiguration; + subscribedListing: SubscribedListing | undefined; /** - *

Specifies whether the assets that this data source creates in the inventory are to be - * also automatically published to the catalog.

+ *

The unique ID of the subscripton request for the subscription that is being + * cancelled.

* @public */ - publishOnImport?: boolean; + subscriptionRequestId?: string; /** - *

The metadata forms that are to be attached to the assets that this data source works - * with.

+ *

Specifies whether the permissions to the asset are retained after the subscription is + * cancelled.

* @public */ - assetFormsInput?: FormInput[]; + 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 { /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

The template URL of the cloud formation provisioning properties of the environment + * blueprint.

* @public */ - clientToken?: string; + templateUrl: string | undefined; } /** - *

The configuration details of the Amazon Web Services Glue data source.

+ *

The details of the parameters for the configurable environment action.

* @public */ -export interface GlueRunConfigurationOutput { +export interface ConfigurableActionParameter { /** - *

The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data - * source.

+ *

The key of the configurable action parameter.

* @public */ - accountId?: string; + key?: string; /** - *

The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source. - *

+ *

The value of the configurable action parameter.

* @public */ - region?: string; + 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 data access role included in the configuration details of the Amazon Web Services Glue data - * source.

+ *

The type of a configurable action in a Amazon DataZone environment.

* @public */ - dataAccessRole?: string; + type: string | undefined; /** - *

The relational filter configurations included in the configuration details of the Amazon Web Services - * Glue data source.

+ *

The authentication type of a configurable action of a Amazon DataZone environment.

* @public */ - relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; + auth?: ConfigurableActionTypeAuthorization; /** - *

Specifies whether to automatically import data quality metrics as part of the data - * source run.

+ *

The parameters of a configurable action in a Amazon DataZone environment.

* @public */ - autoImportDataQualityResult?: boolean; + parameters: ConfigurableActionParameter[] | undefined; } /** - *

The configuration details of the Amazon Redshift data source.

* @public + * @enum */ -export interface RedshiftRunConfigurationOutput { +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 ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift - * data source.

+ *

The search filter explresison type.

* @public */ - accountId?: string; + type: FilterExpressionType | undefined; /** - *

The Amazon Web Services region included in the configuration details of the Amazon Redshift data - * source.

+ *

The search filter expression.

* @public */ - region?: string; + expression: string | undefined; +} +/** + *

The relational filter configuration for the data source.

+ * @public + */ +export interface RelationalFilterConfiguration { /** - *

The data access role included in the configuration details of the Amazon Redshift data + *

The database name specified in the relational filter configuration for the data * source.

* @public */ - dataAccessRole?: string; + databaseName: string | undefined; /** - *

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 DataSourceConfigurationOutput = - | DataSourceConfigurationOutput.GlueRunConfigurationMember - | DataSourceConfigurationOutput.RedshiftRunConfigurationMember - | DataSourceConfigurationOutput.$UnknownMember; - -/** - * @public - */ -export namespace DataSourceConfigurationOutput { - /** - *

The configuration of the Amazon Web Services Glue data source.

- * @public - */ - export interface GlueRunConfigurationMember { - glueRunConfiguration: GlueRunConfigurationOutput; - redshiftRunConfiguration?: never; - $unknown?: never; - } - - /** - *

The configuration of the Amazon Redshift data source.

- * @public - */ - export interface RedshiftRunConfigurationMember { - glueRunConfiguration?: never; - redshiftRunConfiguration: RedshiftRunConfigurationOutput; - $unknown?: never; - } - - /** - * @public - */ - export interface $UnknownMember { - glueRunConfiguration?: never; - redshiftRunConfiguration?: never; - $unknown: [string, any]; - } - - export interface Visitor { - glueRunConfiguration: (value: GlueRunConfigurationOutput) => T; - redshiftRunConfiguration: (value: RedshiftRunConfigurationOutput) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: DataSourceConfigurationOutput, visitor: Visitor): T => { - if (value.glueRunConfiguration !== undefined) return visitor.glueRunConfiguration(value.glueRunConfiguration); - if (value.redshiftRunConfiguration !== undefined) - return visitor.redshiftRunConfiguration(value.redshiftRunConfiguration); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} - -/** - * @public - * @enum - */ -export const DataSourceErrorType = { - ACCESS_DENIED_EXCEPTION: "ACCESS_DENIED_EXCEPTION", - CONFLICT_EXCEPTION: "CONFLICT_EXCEPTION", - INTERNAL_SERVER_EXCEPTION: "INTERNAL_SERVER_EXCEPTION", - RESOURCE_NOT_FOUND_EXCEPTION: "RESOURCE_NOT_FOUND_EXCEPTION", - SERVICE_QUOTA_EXCEEDED_EXCEPTION: "SERVICE_QUOTA_EXCEEDED_EXCEPTION", - THROTTLING_EXCEPTION: "THROTTLING_EXCEPTION", - VALIDATION_EXCEPTION: "VALIDATION_EXCEPTION", -} as const; - -/** - * @public - */ -export type DataSourceErrorType = (typeof DataSourceErrorType)[keyof typeof DataSourceErrorType]; - -/** - *

The details of the error message that is returned if the operation cannot be - * successfully completed.

- * @public - */ -export interface DataSourceErrorMessage { - /** - *

The type of the error message that is returned if the operation cannot be successfully - * completed.

- * @public - */ - errorType: DataSourceErrorType | undefined; - - /** - *

The details of the error message that is returned if the operation cannot be - * successfully completed.

- * @public - */ - errorDetail?: string; -} - -/** - * @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]; - -/** - * @public - */ -export interface CreateDataSourceOutput { - /** - *

The unique identifier of the data source.

- * @public - */ - id: string | undefined; - - /** - *

The status of the data source.

- * @public - */ - status?: DataSourceStatus; - - /** - *

The type of the data source.

- * @public - */ - type?: string; - - /** - *

The name of the data source.

- * @public - */ - name: string | undefined; - - /** - *

The description of the data source.

- * @public - */ - description?: string; - - /** - *

The ID of the Amazon DataZone domain in which the data source is created.

- * @public - */ - domainId: string | undefined; - - /** - *

The ID of the Amazon DataZone project to which the data source is added.

- * @public - */ - projectId: string | undefined; - - /** - *

The unique identifier of the Amazon DataZone environment to which the data source publishes - * assets.

- * @public - */ - environmentId: string | undefined; - - /** - *

Specifies the configuration of the data source. It can be set to either - * glueRunConfiguration or redshiftRunConfiguration.

- * @public - */ - configuration?: DataSourceConfigurationOutput; - - /** - *

Specifies whether the business name generation is to be enabled for this data - * source.

- * @public - */ - recommendation?: RecommendationConfiguration; - - /** - *

Specifies whether the data source is enabled.

- * @public - */ - enableSetting?: EnableSetting; - - /** - *

Specifies whether the assets that this data source creates in the inventory are to be - * also automatically published to the catalog.

- * @public - */ - publishOnImport?: boolean; - - /** - *

The metadata forms attached to the assets that this data source creates.

- * @public - */ - assetFormsOutput?: FormOutput[]; - - /** - *

The schedule of the data source runs.

- * @public - */ - schedule?: ScheduleConfiguration; - - /** - *

The status of the last run of this data source.

- * @public - */ - lastRunStatus?: DataSourceRunStatus; - - /** - *

The timestamp that specifies when the data source was last run.

- * @public - */ - lastRunAt?: Date; - - /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

- * @public - */ - lastRunErrorMessage?: DataSourceErrorMessage; - - /** - *

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 - */ - createdAt?: Date; - - /** - *

The timestamp of when the data source was updated.

- * @public - */ - updatedAt?: Date; -} - -/** - * @public - * @enum - */ -export const UserAssignment = { - AUTOMATIC: "AUTOMATIC", - MANUAL: "MANUAL", -} as const; - -/** - * @public - */ -export type UserAssignment = (typeof UserAssignment)[keyof typeof UserAssignment]; - -/** - *

The single sign-on details in Amazon DataZone.

- * @public - */ -export interface SingleSignOn { - /** - *

The type of single sign-on in Amazon DataZone.

- * @public - */ - type?: AuthType; - - /** - *

The single sign-on user assignment in Amazon DataZone.

- * @public - */ - userAssignment?: UserAssignment; -} - -/** - * @public - */ -export interface CreateDomainInput { - /** - *

The name of the Amazon DataZone domain.

- * @public - */ - name: string | undefined; - - /** - *

The description of the Amazon DataZone domain.

- * @public - */ - description?: string; - - /** - *

The single-sign on configuration of the Amazon DataZone domain.

- * @public - */ - singleSignOn?: SingleSignOn; - - /** - *

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 - */ - domainExecutionRole: string | undefined; - - /** - *

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used - * to encrypt the Amazon DataZone domain, metadata, and reporting data.

- * @public - */ - kmsKeyIdentifier?: string; - - /** - *

The tags specified for the Amazon DataZone domain.

- * @public - */ - tags?: Record; - - /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

- * @public - */ - clientToken?: string; -} - -/** - * @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]; - -/** - * @public - */ -export interface CreateDomainOutput { - /** - *

The identifier of the Amazon DataZone domain.

- * @public - */ - id: string | undefined; - - /** - *

The name of the Amazon DataZone domain.

- * @public - */ - name?: string; - - /** - *

The description of the Amazon DataZone domain.

- * @public - */ - description?: string; - - /** - *

The single-sign on configuration of the Amazon DataZone domain.

- * @public - */ - singleSignOn?: SingleSignOn; - - /** - *

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 - */ - domainExecutionRole?: string; - - /** - *

The ARN of the Amazon DataZone domain.

- * @public - */ - arn?: 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.

- * @public - */ - kmsKeyIdentifier?: string; - - /** - *

The status of the Amazon DataZone domain.

- * @public - */ - status?: DomainStatus; - - /** - *

The URL of the data portal for this Amazon DataZone domain.

- * @public - */ - portalUrl?: string; - - /** - *

The tags specified for the Amazon DataZone domain.

- * @public - */ - tags?: Record; -} - -/** - *

The parameter details of an evironment profile.

- * @public - */ -export interface EnvironmentParameter { - /** - *

The name of an environment profile parameter.

- * @public - */ - name?: string; - - /** - *

The value of an environment profile parameter.

- * @public - */ - value?: string; -} - -/** - * @public - */ -export interface CreateEnvironmentInput { - /** - *

The identifier of the Amazon DataZone project in which this environment is created.

- * @public - */ - projectIdentifier: string | undefined; - - /** - *

The identifier of the Amazon DataZone domain in which the environment is created.

- * @public - */ - domainIdentifier: string | undefined; - - /** - *

The description of the Amazon DataZone environment.

- * @public - */ - description?: string; - - /** - *

The name of the Amazon DataZone environment.

- * @public - */ - name: string | undefined; - - /** - *

The identifier of the environment profile that is used to create this Amazon DataZone - * environment.

- * @public - */ - environmentProfileIdentifier: string | undefined; - - /** - *

The user parameters of this Amazon DataZone environment.

- * @public - */ - userParameters?: EnvironmentParameter[]; - - /** - *

The glossary terms that can be used in this Amazon DataZone environment.

- * @public - */ - glossaryTerms?: string[]; - - /** - *

The ID of the account in which the environment is being created.

- * @public - */ - environmentAccountIdentifier?: string; - - /** - *

The region of the account in which the environment is being created.

+ *

The schema name specified in the relational filter configuration for the data + * source.

* @public */ - environmentAccountRegion?: string; + schemaName?: string; /** - *

The ID of the blueprint with which the environment is being created.

+ *

The filter expressions specified in the relational filter configuration for the data + * source.

* @public */ - environmentBlueprintIdentifier?: string; + filterExpressions?: FilterExpression[]; } /** - *

The deployment properties of the Amazon DataZone blueprint.

+ *

The configuration details of the Amazon Web Services Glue data source.

* @public */ -export interface DeploymentProperties { +export interface GlueRunConfigurationInput { /** - *

The start timeout of the environment blueprint deployment.

+ *

The data access role included in the configuration details of the Amazon Web Services Glue data + * source.

* @public */ - startTimeoutMinutes?: number; + dataAccessRole?: string; /** - *

The end timeout of the environment blueprint deployment.

+ *

The relational filter configurations included in the configuration details of the Amazon Web Services + * Glue data source.

* @public */ - endTimeoutMinutes?: number; -} - -/** - * @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]; + relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; -/** - * @public - * @enum - */ -export const DeploymentType = { - CREATE: "CREATE", - DELETE: "DELETE", - UPDATE: "UPDATE", -} as const; + /** + *

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 type DeploymentType = (typeof DeploymentType)[keyof typeof DeploymentType]; +export interface RedshiftCredentialConfiguration { + /** + *

The ARN of a secret manager for an Amazon Redshift cluster.

+ * @public + */ + secretManagerArn: string | undefined; +} /** - *

The failure reasons for the environment deployment.

+ *

The details of the Amazon Redshift cluster storage.

* @public */ -export interface EnvironmentError { +export interface RedshiftClusterStorage { /** - *

The error code for the failure reason for the environment deployment.

+ *

The name of an Amazon Redshift cluster.

* @public */ - code?: string; + clusterName: string | undefined; +} +/** + *

The details of the Amazon Redshift Serverless workgroup storage.

+ * @public + */ +export interface RedshiftServerlessStorage { /** - *

The error message for the failure reason for the environment deployment.

+ *

The name of the Amazon Redshift Serverless workgroup.

* @public */ - message: string | undefined; + workgroupName: string | undefined; } /** - *

The details of the last deployment of the environment.

+ *

The details of the Amazon Redshift storage as part of the configuration of an Amazon + * Redshift data source run.

* @public */ -export interface Deployment { - /** - *

The identifier of the last deployment of the environment.

- * @public - */ - deploymentId?: string; +export type RedshiftStorage = + | RedshiftStorage.RedshiftClusterSourceMember + | RedshiftStorage.RedshiftServerlessSourceMember + | RedshiftStorage.$UnknownMember; +/** + * @public + */ +export namespace RedshiftStorage { /** - *

The type of the last deployment of the environment.

+ *

The details of the Amazon Redshift cluster source.

* @public */ - deploymentType?: DeploymentType; + export interface RedshiftClusterSourceMember { + redshiftClusterSource: RedshiftClusterStorage; + redshiftServerlessSource?: never; + $unknown?: never; + } /** - *

The status of the last deployment of the environment.

+ *

The details of the Amazon Redshift Serverless workgroup source.

* @public */ - deploymentStatus?: DeploymentStatus; + export interface RedshiftServerlessSourceMember { + redshiftClusterSource?: never; + redshiftServerlessSource: RedshiftServerlessStorage; + $unknown?: never; + } /** - *

The failure reason of the last deployment of the environment.

* @public */ - failureReason?: EnvironmentError; + export interface $UnknownMember { + redshiftClusterSource?: never; + redshiftServerlessSource?: never; + $unknown: [string, any]; + } - /** - *

The messages of the last deployment of the environment.

- * @public - */ - messages?: string[]; + export interface Visitor { + redshiftClusterSource: (value: RedshiftClusterStorage) => T; + redshiftServerlessSource: (value: RedshiftServerlessStorage) => T; + _: (name: string, value: any) => T; + } - /** - *

Specifies whether the last deployment of the environment is complete.

- * @public - */ - isDeploymentComplete?: boolean; + export const visit = (value: RedshiftStorage, visitor: Visitor): T => { + if (value.redshiftClusterSource !== undefined) return visitor.redshiftClusterSource(value.redshiftClusterSource); + if (value.redshiftServerlessSource !== undefined) + return visitor.redshiftServerlessSource(value.redshiftServerlessSource); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** - *

The details of a provisioned resource of this Amazon DataZone environment.

+ *

The configuration details of the Amazon Redshift data source.

* @public */ -export interface Resource { +export interface RedshiftRunConfigurationInput { /** - *

The provider of a provisioned resource of this Amazon DataZone environment.

+ *

The data access role included in the configuration details of the Amazon Redshift data + * source.

* @public */ - provider?: string; + dataAccessRole?: string; /** - *

The name of a provisioned resource of this Amazon DataZone environment.

+ *

The relational filger configurations included in the configuration details of the Amazon + * Redshift data source.

* @public */ - name?: string; + relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; /** - *

The value of a provisioned resource of this Amazon DataZone environment.

+ *

The details of the credentials required to access an Amazon Redshift cluster.

* @public */ - value: string | undefined; + redshiftCredentialConfiguration: RedshiftCredentialConfiguration | undefined; /** - *

The type of a provisioned resource of this Amazon DataZone environment.

+ *

The details of the Amazon Redshift storage as part of the configuration of an Amazon + * Redshift data source run.

* @public */ - type: string | undefined; + redshiftStorage: RedshiftStorage | undefined; } /** - *

The provisioning properties of an environment blueprint.

+ *

The configuration of the data source.

* @public */ -export type ProvisioningProperties = - | ProvisioningProperties.CloudFormationMember - | ProvisioningProperties.$UnknownMember; +export type DataSourceConfigurationInput = + | DataSourceConfigurationInput.GlueRunConfigurationMember + | DataSourceConfigurationInput.RedshiftRunConfigurationMember + | DataSourceConfigurationInput.$UnknownMember; /** * @public */ -export namespace ProvisioningProperties { +export namespace DataSourceConfigurationInput { /** - *

The cloud formation properties included as part of the provisioning properties of an - * environment blueprint.

+ *

The configuration of the Amazon Web Services Glue data source.

* @public */ - export interface CloudFormationMember { - cloudFormation: CloudFormationProperties; + export interface GlueRunConfigurationMember { + glueRunConfiguration: GlueRunConfigurationInput; + redshiftRunConfiguration?: never; + $unknown?: never; + } + + /** + *

The configuration of the Amazon Redshift data source.

+ * @public + */ + export interface RedshiftRunConfigurationMember { + glueRunConfiguration?: never; + redshiftRunConfiguration: RedshiftRunConfigurationInput; $unknown?: never; } @@ -3552,17 +3162,21 @@ export namespace ProvisioningProperties { * @public */ export interface $UnknownMember { - cloudFormation?: never; + glueRunConfiguration?: never; + redshiftRunConfiguration?: never; $unknown: [string, any]; } export interface Visitor { - cloudFormation: (value: CloudFormationProperties) => T; + glueRunConfiguration: (value: GlueRunConfigurationInput) => T; + redshiftRunConfiguration: (value: RedshiftRunConfigurationInput) => T; _: (name: string, value: any) => T; } - export const visit = (value: ProvisioningProperties, visitor: Visitor): T => { - if (value.cloudFormation !== undefined) return visitor.cloudFormation(value.cloudFormation); + export const visit = (value: DataSourceConfigurationInput, visitor: Visitor): T => { + if (value.glueRunConfiguration !== undefined) return visitor.glueRunConfiguration(value.glueRunConfiguration); + if (value.redshiftRunConfiguration !== undefined) + return visitor.redshiftRunConfiguration(value.redshiftRunConfiguration); return visitor._(value.$unknown[0], value.$unknown[1]); }; } @@ -3571,1379 +3185,1423 @@ export namespace ProvisioningProperties { * @public * @enum */ -export const EnvironmentStatus = { - ACTIVE: "ACTIVE", - CREATE_FAILED: "CREATE_FAILED", - CREATING: "CREATING", - DELETED: "DELETED", - DELETE_FAILED: "DELETE_FAILED", - DELETING: "DELETING", +export const EnableSetting = { DISABLED: "DISABLED", - EXPIRED: "EXPIRED", - INACCESSIBLE: "INACCESSIBLE", - SUSPENDED: "SUSPENDED", - UPDATE_FAILED: "UPDATE_FAILED", - UPDATING: "UPDATING", - VALIDATION_FAILED: "VALIDATION_FAILED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type EnableSetting = (typeof EnableSetting)[keyof typeof EnableSetting]; + +/** + *

The recommendation to be updated as part of the UpdateDataSource + * action.

+ * @public + */ +export interface RecommendationConfiguration { + /** + *

Specifies whether automatic business name generation is to be enabled or not as part of + * the recommendation configuration.

+ * @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 EnvironmentStatus = (typeof EnvironmentStatus)[keyof typeof EnvironmentStatus]; +export type Timezone = (typeof Timezone)[keyof typeof Timezone]; /** - *

The details of user parameters of an environment blueprint.

+ *

The details of the schedule of the data source runs.

* @public */ -export interface CustomParameter { - /** - *

The key name of the parameter.

- * @public - */ - keyName: string | undefined; - - /** - *

The description of the parameter.

- * @public - */ - description?: string; - - /** - *

The filed type of the parameter.

- * @public - */ - fieldType: string | undefined; - - /** - *

The default value of the parameter.

- * @public - */ - defaultValue?: string; - +export interface ScheduleConfiguration { /** - *

Specifies whether the parameter is editable.

+ *

The timezone of the data source run.

* @public */ - isEditable?: boolean; + timezone?: Timezone; /** - *

Specifies whether the custom parameter is optional.

+ *

The schedule of the data source runs.

* @public */ - isOptional?: boolean; + schedule?: string; } /** * @public */ -export interface CreateEnvironmentOutput { - /** - *

The ID of the Amazon DataZone project in which this environment is created.

- * @public - */ - projectId: string | undefined; - - /** - *

The ID of this Amazon DataZone environment.

- * @public - */ - id?: string; - - /** - *

The identifier of the Amazon DataZone domain in which the environment is created.

- * @public - */ - domainId: string | undefined; - - /** - *

The Amazon DataZone user who created this 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; - +export interface CreateDataSourceInput { /** - *

The name of this environment.

+ *

The name of the data source.

* @public */ name: string | undefined; /** - *

The description of this Amazon DataZone environment.

+ *

The description of the data source.

* @public */ description?: string; /** - *

The ID of the environment profile with which this Amazon DataZone environment was - * created.

- * @public - */ - environmentProfileId?: string; - - /** - *

The Amazon Web Services account in which the Amazon DataZone environment is created.

- * @public - */ - awsAccountId?: string; - - /** - *

The Amazon Web Services region in which the Amazon DataZone environment is created.

+ *

The ID of the Amazon DataZone domain where the data source is created.

* @public */ - awsAccountRegion?: string; + domainIdentifier: string | undefined; /** - *

The provider of this Amazon DataZone environment.

+ *

The identifier of the Amazon DataZone project in which you want to add this data + * source.

* @public */ - provider: string | undefined; + projectIdentifier: string | undefined; /** - *

The provisioned resources of this Amazon DataZone environment.

+ *

The unique identifier of the Amazon DataZone environment to which the data source publishes + * assets.

* @public */ - provisionedResources?: Resource[]; + environmentIdentifier: string | undefined; /** - *

The status of this Amazon DataZone environment.

+ *

The type of the data source.

* @public */ - status?: EnvironmentStatus; + type: string | undefined; /** - *

The configurable actions of this Amazon DataZone environment.

+ *

Specifies the configuration of the data source. It can be set to either + * glueRunConfiguration or redshiftRunConfiguration.

* @public */ - environmentActions?: ConfigurableEnvironmentAction[]; + configuration?: DataSourceConfigurationInput; /** - *

The glossary terms that can be used in this Amazon DataZone environment.

+ *

Specifies whether the business name generation is to be enabled for this data + * source.

* @public */ - glossaryTerms?: string[]; + recommendation?: RecommendationConfiguration; /** - *

The user parameters of this Amazon DataZone environment.

+ *

Specifies whether the data source is enabled.

* @public */ - userParameters?: CustomParameter[]; + enableSetting?: EnableSetting; /** - *

The details of the last deployment of this Amazon DataZone environment.

+ *

The schedule of the data source runs.

* @public */ - lastDeployment?: Deployment; + schedule?: ScheduleConfiguration; /** - *

The provisioning properties of this Amazon DataZone environment.

+ *

Specifies whether the assets that this data source creates in the inventory are to be + * also automatically published to the catalog.

* @public */ - provisioningProperties?: ProvisioningProperties; + publishOnImport?: boolean; /** - *

The deployment properties of this Amazon DataZone environment.

+ *

The metadata forms that are to be attached to the assets that this data source works + * with.

* @public */ - deploymentProperties?: DeploymentProperties; + assetFormsInput?: FormInput[]; /** - *

The ID of the blueprint with which this Amazon DataZone environment was created.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - environmentBlueprintId?: string; + clientToken?: string; } /** + *

The configuration details of the Amazon Web Services Glue data source.

* @public */ -export interface CreateEnvironmentActionInput { +export interface GlueRunConfigurationOutput { /** - *

The ID of the Amazon DataZone domain in which the environment action is created.

+ *

The Amazon Web Services account ID included in the configuration details of the Amazon Web Services Glue data + * source.

* @public */ - domainIdentifier: string | undefined; + accountId?: string; /** - *

The ID of the environment in which the environment action is created.

+ *

The Amazon Web Services region included in the configuration details of the Amazon Web Services Glue data source. + *

* @public */ - environmentIdentifier: string | undefined; + region?: string; /** - *

The name of the environment action.

+ *

The data access role included in the configuration details of the Amazon Web Services Glue data + * source.

* @public */ - name: string | undefined; + dataAccessRole?: string; /** - *

The parameters of the environment action.

+ *

The relational filter configurations included in the configuration details of the Amazon Web Services + * Glue data source.

* @public */ - parameters: ActionParameters | undefined; + relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; /** - *

The description of the environment action that is being created in the - * environment.

+ *

Specifies whether to automatically import data quality metrics as part of the data + * source run.

* @public */ - description?: string; + autoImportDataQualityResult?: boolean; } /** + *

The configuration details of the Amazon Redshift data source.

* @public */ -export interface CreateEnvironmentActionOutput { +export interface RedshiftRunConfigurationOutput { /** - *

The ID of the domain in which the environment action is created.

+ *

The ID of the Amazon Web Services account included in the configuration details of the Amazon Redshift + * data source.

* @public */ - domainId: string | undefined; + accountId?: string; /** - *

The ID of the environment in which the environment is created.

+ *

The Amazon Web Services region included in the configuration details of the Amazon Redshift data + * source.

* @public */ - environmentId: string | undefined; + region?: string; /** - *

The ID of the environment action.

+ *

The data access role included in the configuration details of the Amazon Redshift data + * source.

* @public */ - id: string | undefined; + dataAccessRole?: string; /** - *

The name of the environment action.

+ *

The relational filger configurations included in the configuration details of the Amazon + * Redshift data source.

* @public */ - name: string | undefined; + relationalFilterConfigurations: RelationalFilterConfiguration[] | undefined; /** - *

The parameters of the environment action.

+ *

The details of the credentials required to access an Amazon Redshift cluster.

* @public */ - parameters: ActionParameters | undefined; + redshiftCredentialConfiguration: RedshiftCredentialConfiguration | undefined; /** - *

The description of the environment action.

+ *

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 configuration of the data source.

* @public */ -export interface CreateEnvironmentProfileInput { - /** - *

The ID of the Amazon DataZone domain in which this environment profile is created.

- * @public - */ - domainIdentifier: string | undefined; +export type DataSourceConfigurationOutput = + | DataSourceConfigurationOutput.GlueRunConfigurationMember + | DataSourceConfigurationOutput.RedshiftRunConfigurationMember + | DataSourceConfigurationOutput.$UnknownMember; +/** + * @public + */ +export namespace DataSourceConfigurationOutput { /** - *

The name of this Amazon DataZone environment profile.

+ *

The configuration of the Amazon Web Services Glue data source.

* @public */ - name: string | undefined; + export interface GlueRunConfigurationMember { + glueRunConfiguration: GlueRunConfigurationOutput; + redshiftRunConfiguration?: never; + $unknown?: never; + } /** - *

The description of this Amazon DataZone environment profile.

+ *

The configuration of the Amazon Redshift data source.

* @public */ - description?: string; + export interface RedshiftRunConfigurationMember { + glueRunConfiguration?: never; + redshiftRunConfiguration: RedshiftRunConfigurationOutput; + $unknown?: never; + } /** - *

The ID of the blueprint with which this environment profile is created.

* @public */ - environmentBlueprintIdentifier: string | undefined; + export interface $UnknownMember { + glueRunConfiguration?: never; + redshiftRunConfiguration?: never; + $unknown: [string, any]; + } - /** - *

The identifier of the project in which to create the environment profile.

- * @public - */ - projectIdentifier: string | undefined; + export interface Visitor { + glueRunConfiguration: (value: GlueRunConfigurationOutput) => T; + redshiftRunConfiguration: (value: RedshiftRunConfigurationOutput) => T; + _: (name: string, value: any) => T; + } - /** - *

The user parameters of this Amazon DataZone environment profile.

- * @public - */ - userParameters?: EnvironmentParameter[]; + export const visit = (value: DataSourceConfigurationOutput, visitor: Visitor): T => { + if (value.glueRunConfiguration !== undefined) return visitor.glueRunConfiguration(value.glueRunConfiguration); + if (value.redshiftRunConfiguration !== undefined) + return visitor.redshiftRunConfiguration(value.redshiftRunConfiguration); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + * @public + * @enum + */ +export const DataSourceErrorType = { + ACCESS_DENIED_EXCEPTION: "ACCESS_DENIED_EXCEPTION", + CONFLICT_EXCEPTION: "CONFLICT_EXCEPTION", + INTERNAL_SERVER_EXCEPTION: "INTERNAL_SERVER_EXCEPTION", + RESOURCE_NOT_FOUND_EXCEPTION: "RESOURCE_NOT_FOUND_EXCEPTION", + SERVICE_QUOTA_EXCEEDED_EXCEPTION: "SERVICE_QUOTA_EXCEEDED_EXCEPTION", + THROTTLING_EXCEPTION: "THROTTLING_EXCEPTION", + VALIDATION_EXCEPTION: "VALIDATION_EXCEPTION", +} as const; + +/** + * @public + */ +export type DataSourceErrorType = (typeof DataSourceErrorType)[keyof typeof DataSourceErrorType]; +/** + *

The details of the error message that is returned if the operation cannot be + * successfully completed.

+ * @public + */ +export interface DataSourceErrorMessage { /** - *

The Amazon Web Services account in which the Amazon DataZone environment is created.

+ *

The type of the error message that is returned if the operation cannot be successfully + * completed.

* @public */ - awsAccountId?: string; + errorType: DataSourceErrorType | undefined; /** - *

The Amazon Web Services region in which this environment profile is created.

+ *

The details of the error message that is returned if the operation cannot be + * successfully completed.

* @public */ - awsAccountRegion?: string; + errorDetail?: string; } /** * @public + * @enum */ -export interface CreateEnvironmentProfileOutput { +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]; + +/** + * @public + */ +export interface CreateDataSourceOutput { /** - *

The ID of this Amazon DataZone environment profile.

+ *

The unique identifier of the data source.

* @public */ id: string | undefined; /** - *

The ID of the Amazon DataZone domain in which this environment profile is created.

+ *

The status of the data source.

* @public */ - domainId: string | undefined; + status?: DataSourceStatus; /** - *

The Amazon Web Services account ID in which this Amazon DataZone environment profile is - * created.

+ *

The type of the data source.

* @public */ - awsAccountId?: string; + type?: string; /** - *

The Amazon Web Services region in which this Amazon DataZone environment profile is - * created.

+ *

The name of the data source.

* @public */ - awsAccountRegion?: string; + name: string | undefined; /** - *

The Amazon DataZone user who created this environment profile.

+ *

The description of the data source.

* @public */ - createdBy: string | undefined; + description?: string; /** - *

The timestamp of when this environment profile was created.

+ *

The ID of the Amazon DataZone domain in which the data source is created.

* @public */ - createdAt?: Date; + domainId: string | undefined; /** - *

The timestamp of when this environment profile was updated.

+ *

The ID of the Amazon DataZone project to which the data source is added.

* @public */ - updatedAt?: Date; + projectId: string | undefined; /** - *

The name of this Amazon DataZone environment profile.

+ *

The unique identifier of the Amazon DataZone environment to which the data source publishes + * assets.

* @public */ - name: string | undefined; + environmentId: string | undefined; /** - *

The description of this Amazon DataZone environment profile.

+ *

Specifies the configuration of the data source. It can be set to either + * glueRunConfiguration or redshiftRunConfiguration.

* @public */ - description?: string; + configuration?: DataSourceConfigurationOutput; /** - *

The ID of the blueprint with which this environment profile is created.

+ *

Specifies whether the business name generation is to be enabled for this data + * source.

* @public */ - environmentBlueprintId: string | undefined; + recommendation?: RecommendationConfiguration; /** - *

The ID of the Amazon DataZone project in which this environment profile is created.

+ *

Specifies whether the data source is enabled.

* @public */ - projectId?: string; + enableSetting?: EnableSetting; /** - *

The user parameters of this Amazon DataZone environment profile.

+ *

Specifies whether the assets that this data source creates in the inventory are to be + * also automatically published to the catalog.

* @public */ - userParameters?: CustomParameter[]; -} - -/** - *

The model of the API.

- * @public - */ -export type Model = Model.SmithyMember | Model.$UnknownMember; + publishOnImport?: boolean; -/** - * @public - */ -export namespace Model { /** - *

Indicates the smithy model of the API.

+ *

The metadata forms attached to the assets that this data source creates.

* @public */ - export interface SmithyMember { - smithy: string; - $unknown?: never; - } + assetFormsOutput?: FormOutput[]; /** + *

The schedule of the data source runs.

* @public */ - export interface $UnknownMember { - smithy?: never; - $unknown: [string, any]; - } - - export interface Visitor { - smithy: (value: string) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: Model, visitor: Visitor): T => { - if (value.smithy !== undefined) return visitor.smithy(value.smithy); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} + schedule?: ScheduleConfiguration; -/** - * @public - * @enum - */ -export const FormTypeStatus = { - DISABLED: "DISABLED", - ENABLED: "ENABLED", -} as const; + /** + *

The status of the last run of this data source.

+ * @public + */ + lastRunStatus?: DataSourceRunStatus; -/** - * @public - */ -export type FormTypeStatus = (typeof FormTypeStatus)[keyof typeof FormTypeStatus]; + /** + *

The timestamp that specifies when the data source was last run.

+ * @public + */ + lastRunAt?: Date; -/** - * @public - */ -export interface CreateFormTypeInput { /** - *

The ID of the Amazon DataZone domain in which this metadata form type is created.

+ *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

* @public */ - domainIdentifier: string | undefined; + lastRunErrorMessage?: DataSourceErrorMessage; /** - *

The name of this Amazon DataZone metadata form type.

+ *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

* @public */ - name: string | undefined; + errorMessage?: DataSourceErrorMessage; /** - *

The model of this Amazon DataZone metadata form type.

+ *

The timestamp of when the data source was created.

* @public */ - model: Model | undefined; + createdAt?: Date; /** - *

The ID of the Amazon DataZone project that owns this metadata form type.

+ *

The timestamp of when the data source was updated.

* @public */ - owningProjectIdentifier: string | undefined; + updatedAt?: Date; +} + +/** + * @public + * @enum + */ +export const UserAssignment = { + AUTOMATIC: "AUTOMATIC", + MANUAL: "MANUAL", +} as const; + +/** + * @public + */ +export type UserAssignment = (typeof UserAssignment)[keyof typeof UserAssignment]; +/** + *

The single sign-on details in Amazon DataZone.

+ * @public + */ +export interface SingleSignOn { /** - *

The status of this Amazon DataZone metadata form type.

+ *

The type of single sign-on in Amazon DataZone.

* @public */ - status?: FormTypeStatus; + type?: AuthType; /** - *

The description of this Amazon DataZone metadata form type.

+ *

The single sign-on user assignment in Amazon DataZone.

* @public */ - description?: string; + userAssignment?: UserAssignment; } /** * @public */ -export interface CreateFormTypeOutput { +export interface CreateDomainInput { /** - *

The ID of the Amazon DataZone domain in which this metadata form type is created.

+ *

The name of the Amazon DataZone domain.

* @public */ - domainId: string | undefined; + name: string | undefined; /** - *

The name of this Amazon DataZone metadata form type.

+ *

The description of the Amazon DataZone domain.

* @public */ - name: string | undefined; + description?: string; /** - *

The revision of this Amazon DataZone metadata form type.

+ *

The single-sign on configuration of the Amazon DataZone domain.

* @public */ - revision: string | undefined; + singleSignOn?: SingleSignOn; /** - *

The description of this Amazon DataZone metadata form type.

+ *

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 */ - description?: string; + domainExecutionRole: string | undefined; /** - *

The ID of the project that owns this Amazon DataZone metadata form type.

+ *

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 */ - owningProjectId?: string; + kmsKeyIdentifier?: string; /** - *

The ID of the Amazon DataZone domain in which this metadata form type was originally - * created.

+ *

The tags specified for the Amazon DataZone domain.

* @public */ - originDomainId?: string; + tags?: Record; /** - *

The ID of the project in which this Amazon DataZone metadata form type was originally - * created.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - originProjectId?: string; + clientToken?: string; } /** * @public * @enum */ -export const GlossaryStatus = { - DISABLED: "DISABLED", - ENABLED: "ENABLED", +export const DomainStatus = { + AVAILABLE: "AVAILABLE", + CREATING: "CREATING", + CREATION_FAILED: "CREATION_FAILED", + DELETED: "DELETED", + DELETING: "DELETING", + DELETION_FAILED: "DELETION_FAILED", } as const; /** * @public */ -export type GlossaryStatus = (typeof GlossaryStatus)[keyof typeof GlossaryStatus]; +export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus]; /** * @public */ -export interface CreateGlossaryInput { +export interface CreateDomainOutput { /** - *

The ID of the Amazon DataZone domain in which this business glossary is created.

+ *

The identifier of the Amazon DataZone domain.

* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *

The name of this business glossary.

+ *

The name of the Amazon DataZone domain.

* @public */ - name: string | undefined; + name?: string; /** - *

The ID of the project that currently owns business glossary.

+ *

The description of the Amazon DataZone domain.

* @public */ - owningProjectIdentifier: string | undefined; + description?: string; /** - *

The description of this business glossary.

+ *

The single-sign on configuration of the Amazon DataZone domain.

* @public */ - description?: string; + singleSignOn?: SingleSignOn; /** - *

The status of this business glossary.

+ *

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 */ - status?: GlossaryStatus; + domainExecutionRole?: string; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

The ARN of the Amazon DataZone domain.

* @public */ - clientToken?: string; -} + arn?: string; -/** - * @public - */ -export interface CreateGlossaryOutput { /** - *

The ID of the Amazon DataZone domain in which this business glossary 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 */ - domainId: string | undefined; + kmsKeyIdentifier?: string; /** - *

The ID of this business glossary.

+ *

The status of the Amazon DataZone domain.

* @public */ - id: string | undefined; + status?: DomainStatus; /** - *

The name of this business glossary.

+ *

The URL of the data portal for this Amazon DataZone domain.

* @public */ - name: string | undefined; + portalUrl?: string; /** - *

The ID of the project that currently owns this business glossary.

+ *

The tags specified for the Amazon DataZone domain.

* @public */ - owningProjectId: string | undefined; + tags?: Record; +} +/** + *

The parameter details of an evironment profile.

+ * @public + */ +export interface EnvironmentParameter { /** - *

The description of this business glossary.

+ *

The name of an environment profile parameter.

* @public */ - description?: string; + name?: string; /** - *

The status of this business glossary.

+ *

The value of an environment profile parameter.

* @public */ - status?: GlossaryStatus; + value?: string; } /** * @public - * @enum */ -export const GlossaryTermStatus = { - DISABLED: "DISABLED", - ENABLED: "ENABLED", -} as const; +export interface CreateEnvironmentInput { + /** + *

The identifier of the Amazon DataZone project in which this environment is created.

+ * @public + */ + projectIdentifier: string | undefined; -/** - * @public - */ -export type GlossaryTermStatus = (typeof GlossaryTermStatus)[keyof typeof GlossaryTermStatus]; + /** + *

The identifier of the Amazon DataZone domain in which the environment is created.

+ * @public + */ + domainIdentifier: string | undefined; -/** - *

The details of the term relations.

- * @public - */ -export interface TermRelations { /** - *

The isA property of the term relations.

+ *

The description of the Amazon DataZone environment.

* @public */ - isA?: string[]; + description?: string; /** - *

The classifies of the term relations.

+ *

The name of the Amazon DataZone environment.

* @public */ - classifies?: string[]; -} + name: string | undefined; -/** - * @public - */ -export interface CreateGlossaryTermInput { /** - *

The ID of the Amazon DataZone domain in which this business glossary term is created.

+ *

The identifier of the environment profile that is used to create this Amazon DataZone + * environment.

* @public */ - domainIdentifier: string | undefined; + environmentProfileIdentifier: string | undefined; /** - *

The ID of the business glossary in which this term is created.

+ *

The user parameters of this Amazon DataZone environment.

* @public */ - glossaryIdentifier: string | undefined; + userParameters?: EnvironmentParameter[]; /** - *

The name of this business glossary term.

+ *

The glossary terms that can be used in this Amazon DataZone environment.

* @public */ - name: string | undefined; + glossaryTerms?: string[]; /** - *

The status of this business glossary term.

+ *

The ID of the account in which the environment is being created.

* @public */ - status?: GlossaryTermStatus; + environmentAccountIdentifier?: string; /** - *

The short description of this business glossary term.

+ *

The region of the account in which the environment is being created.

* @public */ - shortDescription?: string; + environmentAccountRegion?: string; /** - *

The long description of this business glossary term.

+ *

The ID of the blueprint with which the environment is being created.

* @public */ - longDescription?: string; + environmentBlueprintIdentifier?: string; +} + +/** + *

The deployment properties of the Amazon DataZone blueprint.

+ * @public + */ +export interface DeploymentProperties { + /** + *

The start timeout of the environment blueprint deployment.

+ * @public + */ + startTimeoutMinutes?: number; + + /** + *

The end timeout of the environment blueprint deployment.

+ * @public + */ + endTimeoutMinutes?: number; +} + +/** + * @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]; - /** - *

The term relations of this business glossary term.

- * @public - */ - termRelations?: TermRelations; +/** + * @public + * @enum + */ +export const DeploymentType = { + CREATE: "CREATE", + DELETE: "DELETE", + UPDATE: "UPDATE", +} as const; - /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

- * @public - */ - clientToken?: string; -} +/** + * @public + */ +export type DeploymentType = (typeof DeploymentType)[keyof typeof DeploymentType]; /** + *

The failure reasons for the environment deployment.

* @public */ -export interface CreateGlossaryTermOutput { +export interface EnvironmentError { /** - *

The ID of this business glossary term.

+ *

The error code for the failure reason for the environment deployment.

* @public */ - id: string | undefined; + code?: string; /** - *

The ID of the Amazon DataZone domain in which this business glossary term is created.

+ *

The error message for the failure reason for the environment deployment.

* @public */ - domainId: string | undefined; + message: string | undefined; +} +/** + *

The details of the last deployment of the environment.

+ * @public + */ +export interface Deployment { /** - *

The ID of the business glossary in which this term is created.

+ *

The identifier of the last deployment of the environment.

* @public */ - glossaryId: string | undefined; + deploymentId?: string; /** - *

The name of this business glossary term.

+ *

The type of the last deployment of the environment.

* @public */ - name: string | undefined; + deploymentType?: DeploymentType; /** - *

The status of this business glossary term.

+ *

The status of the last deployment of the environment.

* @public */ - status: GlossaryTermStatus | undefined; + deploymentStatus?: DeploymentStatus; /** - *

The short description of this business glossary term.

+ *

The failure reason of the last deployment of the environment.

* @public */ - shortDescription?: string; + failureReason?: EnvironmentError; /** - *

The long description of this business glossary term.

+ *

The messages of the last deployment of the environment.

* @public */ - longDescription?: string; + messages?: string[]; /** - *

The term relations of this business glossary term.

+ *

Specifies whether the last deployment of the environment is complete.

* @public */ - termRelations?: TermRelations; + isDeploymentComplete?: boolean; } /** + *

The details of a provisioned resource of this Amazon DataZone environment.

* @public */ -export interface CreateGroupProfileInput { +export interface Resource { /** - *

The identifier of the Amazon DataZone domain in which the group profile is created.

+ *

The provider of a provisioned resource of this Amazon DataZone environment.

* @public */ - domainIdentifier: string | undefined; + provider?: string; /** - *

The identifier of the group for which the group profile is created.

+ *

The name of a provisioned resource of this Amazon DataZone environment.

* @public */ - groupIdentifier: string | undefined; + name?: string; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

The value of a provisioned resource of this Amazon DataZone environment.

* @public */ - clientToken?: string; -} + value: string | undefined; -/** - * @public - * @enum - */ -export const GroupProfileStatus = { - ASSIGNED: "ASSIGNED", - NOT_ASSIGNED: "NOT_ASSIGNED", -} as const; + /** + *

The type of a provisioned resource of this Amazon DataZone environment.

+ * @public + */ + type: string | undefined; +} /** + *

The provisioning properties of an environment blueprint.

* @public */ -export type GroupProfileStatus = (typeof GroupProfileStatus)[keyof typeof GroupProfileStatus]; +export type ProvisioningProperties = + | ProvisioningProperties.CloudFormationMember + | ProvisioningProperties.$UnknownMember; /** * @public */ -export interface CreateGroupProfileOutput { +export namespace ProvisioningProperties { /** - *

The identifier of the Amazon DataZone domain in which the group profile is created.

+ *

The cloud formation properties included as part of the provisioning properties of an + * environment blueprint.

* @public */ - domainId?: string; + export interface CloudFormationMember { + cloudFormation: CloudFormationProperties; + $unknown?: never; + } /** - *

The identifier of the group profile.

* @public */ - id?: string; + export interface $UnknownMember { + cloudFormation?: never; + $unknown: [string, any]; + } - /** - *

The status of the group profile.

- * @public - */ - status?: GroupProfileStatus; + export interface Visitor { + cloudFormation: (value: CloudFormationProperties) => T; + _: (name: string, value: any) => T; + } - /** - *

The name of the group for which group profile is created.

- * @public - */ - groupName?: string; + export const visit = (value: ProvisioningProperties, visitor: Visitor): T => { + if (value.cloudFormation !== undefined) return visitor.cloudFormation(value.cloudFormation); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** * @public * @enum */ -export const EntityType = { - ASSET: "ASSET", +export const EnvironmentStatus = { + ACTIVE: "ACTIVE", + CREATE_FAILED: "CREATE_FAILED", + CREATING: "CREATING", + DELETED: "DELETED", + DELETE_FAILED: "DELETE_FAILED", + DELETING: "DELETING", + DISABLED: "DISABLED", + EXPIRED: "EXPIRED", + INACCESSIBLE: "INACCESSIBLE", + SUSPENDED: "SUSPENDED", + UPDATE_FAILED: "UPDATE_FAILED", + UPDATING: "UPDATING", + VALIDATION_FAILED: "VALIDATION_FAILED", } as const; /** * @public */ -export type EntityType = (typeof EntityType)[keyof typeof EntityType]; +export type EnvironmentStatus = (typeof EnvironmentStatus)[keyof typeof EnvironmentStatus]; /** + *

The details of user parameters of an environment blueprint.

* @public */ -export interface CreateListingChangeSetInput { +export interface CustomParameter { /** - *

The ID of the Amazon DataZone domain.

+ *

The key name of the parameter.

* @public */ - domainIdentifier: string | undefined; + keyName: string | undefined; /** - *

The ID of the asset.

+ *

The description of the parameter.

* @public */ - entityIdentifier: string | undefined; + description?: string; /** - *

The type of an entity.

+ *

The filed type of the parameter.

* @public */ - entityType: EntityType | undefined; + fieldType: string | undefined; /** - *

The revision of an asset.

+ *

The default value of the parameter.

* @public */ - entityRevision?: string; + defaultValue?: string; /** - *

Specifies whether to publish or unpublish a listing.

+ *

Specifies whether the parameter is editable.

* @public */ - action: ChangeAction | undefined; + isEditable?: boolean; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

Specifies whether the custom parameter is optional.

* @public */ - clientToken?: string; + isOptional?: boolean; } /** * @public */ -export interface CreateListingChangeSetOutput { +export interface CreateEnvironmentOutput { /** - *

The ID of the listing (a record of an asset at a given time).

+ *

The ID of the Amazon DataZone project in which this environment is created.

* @public */ - listingId: string | undefined; + projectId: string | undefined; /** - *

The revision of a listing.

+ *

The ID of this Amazon DataZone environment.

* @public */ - listingRevision: string | undefined; + id?: string; /** - *

Specifies the status of the listing.

+ *

The identifier of the Amazon DataZone domain in which the environment is created.

* @public */ - status: ListingStatus | undefined; -} + domainId: string | undefined; -/** - * @public - */ -export interface CreateProjectInput { /** - *

The ID of the Amazon DataZone domain in which this project is created.

+ *

The Amazon DataZone user who created this environment.

* @public */ - domainIdentifier: string | undefined; + createdBy: string | undefined; /** - *

The name of the Amazon DataZone project.

+ *

The timestamp of when the environment was created.

* @public */ - name: string | undefined; + createdAt?: Date; /** - *

The description of the Amazon DataZone project.

+ *

The timestamp of when this environment was updated.

* @public */ - description?: string; + updatedAt?: Date; /** - *

The glossary terms that can be used in this Amazon DataZone project.

+ *

The name of this environment.

* @public */ - glossaryTerms?: string[]; -} + name: string | undefined; -/** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

- * @public - */ -export interface ProjectDeletionError { /** - *

The code of the project deletion error.

+ *

The description of this Amazon DataZone environment.

* @public */ - code?: string; + description?: string; /** - *

The message of the project deletion error.

+ *

The ID of the environment profile with which this Amazon DataZone environment was + * created.

* @public */ - message?: string; -} + environmentProfileId?: string; -/** - * @public - * @enum - */ -export const ProjectStatus = { - ACTIVE: "ACTIVE", - DELETE_FAILED: "DELETE_FAILED", - DELETING: "DELETING", -} as const; + /** + *

The Amazon Web Services account in which the Amazon DataZone environment is created.

+ * @public + */ + awsAccountId?: string; -/** - * @public - */ -export type ProjectStatus = (typeof ProjectStatus)[keyof typeof ProjectStatus]; + /** + *

The Amazon Web Services region in which the Amazon DataZone environment is created.

+ * @public + */ + awsAccountRegion?: string; -/** - * @public - */ -export interface CreateProjectOutput { /** - *

The identifier of the Amazon DataZone domain in which the project was created.

+ *

The provider of this Amazon DataZone environment.

* @public */ - domainId: string | undefined; + provider: string | undefined; /** - *

The ID of the Amazon DataZone project.

+ *

The provisioned resources of this Amazon DataZone environment.

* @public */ - id: string | undefined; + provisionedResources?: Resource[]; /** - *

The name of the project.

+ *

The status of this Amazon DataZone environment.

* @public */ - name: string | undefined; + status?: EnvironmentStatus; /** - *

The description of the project.

+ *

The configurable actions of this Amazon DataZone environment.

* @public */ - description?: string; + environmentActions?: ConfigurableEnvironmentAction[]; /** - *

The status of the Amazon DataZone project that was created.

+ *

The glossary terms that can be used in this Amazon DataZone environment.

* @public */ - projectStatus?: ProjectStatus; + glossaryTerms?: string[]; /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

+ *

The user parameters of this Amazon DataZone environment.

* @public */ - failureReasons?: ProjectDeletionError[]; + userParameters?: CustomParameter[]; /** - *

The Amazon DataZone user who created the project.

+ *

The details of the last deployment of this Amazon DataZone environment.

* @public */ - createdBy: string | undefined; + lastDeployment?: Deployment; /** - *

The timestamp of when the project was created.

+ *

The provisioning properties of this Amazon DataZone environment.

* @public */ - createdAt?: Date; + provisioningProperties?: ProvisioningProperties; /** - *

The timestamp of when the project was last updated.

+ *

The deployment properties of this Amazon DataZone environment.

* @public */ - lastUpdatedAt?: Date; + deploymentProperties?: DeploymentProperties; /** - *

The glossary terms that can be used in the project.

+ *

The ID of the blueprint with which this Amazon DataZone environment was created.

* @public */ - glossaryTerms?: string[]; + environmentBlueprintId?: 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 { +export interface CreateEnvironmentActionInput { /** - *

The user ID of a project member.

+ *

The ID of the Amazon DataZone domain in which the environment action is created.

* @public */ - export interface UserIdentifierMember { - userIdentifier: string; - groupIdentifier?: never; - $unknown?: never; - } + domainIdentifier: string | undefined; /** - *

The ID of the group of a project member.

+ *

The ID of the environment in which the environment action is created.

* @public */ - export interface GroupIdentifierMember { - userIdentifier?: never; - groupIdentifier: string; - $unknown?: never; - } + environmentIdentifier: string | undefined; /** + *

The name of the environment action.

* @public */ - export interface $UnknownMember { - userIdentifier?: never; - groupIdentifier?: never; - $unknown: [string, any]; - } + name: string | undefined; - export interface Visitor { - userIdentifier: (value: string) => T; - groupIdentifier: (value: string) => T; - _: (name: string, value: any) => T; - } + /** + *

The parameters of the environment action.

+ * @public + */ + parameters: ActionParameters | undefined; - export const visit = (value: Member, visitor: Visitor): T => { - if (value.userIdentifier !== undefined) return visitor.userIdentifier(value.userIdentifier); - if (value.groupIdentifier !== undefined) return visitor.groupIdentifier(value.groupIdentifier); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + /** + *

The description of the environment action that is being created in the + * environment.

+ * @public + */ + description?: string; } /** * @public */ -export interface CreateProjectMembershipInput { +export interface CreateEnvironmentActionOutput { /** - *

The ID of the Amazon DataZone domain in which project membership is created.

+ *

The ID of the domain in which the environment action is created.

* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *

The ID of the project for which this project membership was created.

+ *

The ID of the environment in which the environment is created.

* @public */ - projectIdentifier: string | undefined; + environmentId: string | undefined; /** - *

The project member whose project membership was created.

+ *

The ID of the environment action.

* @public */ - member: Member | undefined; + id: string | undefined; /** - *

The designation of the project membership.

+ *

The name of the environment action.

* @public */ - designation: UserDesignation | undefined; -} - -/** - * @public - */ -export interface CreateProjectMembershipOutput {} + name: 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 parameters of the environment action.

* @public */ - identifier: string | undefined; + parameters: ActionParameters | undefined; /** - *

The details of a revision to be made to an asset published in a Amazon DataZone - * catalog.

+ *

The description of the environment action.

* @public */ - revision: string | undefined; + description?: string; } -/** - *

The details of a listing for which a subscription is to be granted.

- * @public - */ -export type GrantedEntityInput = GrantedEntityInput.ListingMember | GrantedEntityInput.$UnknownMember; - /** * @public */ -export namespace GrantedEntityInput { +export interface CreateEnvironmentProfileInput { /** - *

The listing for which a subscription is to be granted.

+ *

The ID of the Amazon DataZone domain in which this environment profile is created.

* @public */ - export interface ListingMember { - listing: ListingRevisionInput; - $unknown?: never; - } + domainIdentifier: string | undefined; /** + *

The name of this Amazon DataZone environment profile.

* @public */ - export interface $UnknownMember { - listing?: never; - $unknown: [string, any]; - } - - export interface Visitor { - listing: (value: ListingRevisionInput) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: GrantedEntityInput, visitor: Visitor): T => { - if (value.listing !== undefined) return visitor.listing(value.listing); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} + name: string | undefined; -/** - * @public - */ -export interface CreateSubscriptionGrantInput { /** - *

The ID of the Amazon DataZone domain in which the subscription grant is created.

+ *

The description of this Amazon DataZone environment profile.

* @public */ - domainIdentifier: string | undefined; + description?: string; /** - *

The ID of the environment in which the subscription grant is created.

+ *

The ID of the blueprint with which this environment profile is created.

* @public */ - environmentIdentifier: string | undefined; + environmentBlueprintIdentifier: string | undefined; /** - *

The ID of the subscription target for which the subscription grant is created.

+ *

The identifier of the project in which to create the environment profile.

* @public */ - subscriptionTargetIdentifier: string | undefined; + projectIdentifier: string | undefined; /** - *

The entity to which the subscription is to be granted.

+ *

The user parameters of this Amazon DataZone environment profile.

* @public */ - grantedEntity: GrantedEntityInput | undefined; + userParameters?: EnvironmentParameter[]; /** - *

The names of the assets for which the subscription grant is created.

+ *

The Amazon Web Services account in which the Amazon DataZone environment is created.

* @public */ - assetTargetNames?: AssetTargetNameMap[]; + awsAccountId?: string; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

The Amazon Web Services region in which this environment profile is created.

* @public */ - clientToken?: string; + awsAccountRegion?: string; } /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

* @public */ -export interface FailureCause { +export interface CreateEnvironmentProfileOutput { /** - *

The description of the error message.

+ *

The ID of this Amazon DataZone environment profile.

* @public */ - message?: string; -} + id: string | undefined; -/** - * @public - * @enum - */ -export const SubscriptionGrantStatus = { - GRANTED: "GRANTED", - GRANT_FAILED: "GRANT_FAILED", - GRANT_IN_PROGRESS: "GRANT_IN_PROGRESS", - GRANT_PENDING: "GRANT_PENDING", - REVOKED: "REVOKED", - REVOKE_FAILED: "REVOKE_FAILED", - REVOKE_IN_PROGRESS: "REVOKE_IN_PROGRESS", - REVOKE_PENDING: "REVOKE_PENDING", -} as const; + /** + *

The ID of the Amazon DataZone domain in which this environment profile is created.

+ * @public + */ + domainId: string | undefined; -/** - * @public - */ -export type SubscriptionGrantStatus = (typeof SubscriptionGrantStatus)[keyof typeof SubscriptionGrantStatus]; + /** + *

The Amazon Web Services account ID in which this Amazon DataZone environment profile is + * created.

+ * @public + */ + awsAccountId?: string; -/** - *

The details of the asset for which the subscription grant is created.

- * @public - */ -export interface SubscribedAsset { /** - *

The identifier of the asset for which the subscription grant is created.

+ *

The Amazon Web Services region in which this Amazon DataZone environment profile is + * created.

* @public */ - assetId: string | undefined; + awsAccountRegion?: string; /** - *

The revision of the asset for which the subscription grant is created.

+ *

The Amazon DataZone user who created this environment profile.

* @public */ - assetRevision: string | undefined; + createdBy: string | undefined; /** - *

The status of the asset for which the subscription grant is created.

+ *

The timestamp of when this environment profile was created.

* @public */ - status: SubscriptionGrantStatus | undefined; + createdAt?: Date; /** - *

The target name of the asset for which the subscription grant is created.

+ *

The timestamp of when this environment profile was updated.

* @public */ - targetName?: string; + updatedAt?: Date; /** - *

The failure cause included in the details of the asset for which the subscription grant - * is created.

+ *

The name of this Amazon DataZone environment profile.

* @public */ - failureCause?: FailureCause; + name: string | undefined; /** - *

The timestamp of when the subscription grant to the asset is created.

+ *

The description of this Amazon DataZone environment profile.

* @public */ - grantedTimestamp?: Date; + description?: string; /** - *

The failure timestamp included in the details of the asset for which the subscription - * grant is created.

+ *

The ID of the blueprint with which this environment profile is created.

* @public */ - failureTimestamp?: Date; -} + environmentBlueprintId: string | undefined; -/** - *

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 ID of the Amazon DataZone project in which this environment profile is created.

* @public */ - id: string | undefined; + projectId?: string; /** - *

The details of a revision of an asset published in a Amazon DataZone catalog.

+ *

The user parameters of this Amazon DataZone environment profile.

* @public */ - revision: string | undefined; + userParameters?: CustomParameter[]; } /** - *

The details of a listing for which a subscription is granted.

+ *

The model of the API.

* @public */ -export type GrantedEntity = GrantedEntity.ListingMember | GrantedEntity.$UnknownMember; +export type Model = Model.SmithyMember | Model.$UnknownMember; /** * @public */ -export namespace GrantedEntity { +export namespace Model { /** - *

The listing for which a subscription is granted.

+ *

Indicates the smithy model of the API.

* @public */ - export interface ListingMember { - listing: ListingRevision; + export interface SmithyMember { + smithy: string; $unknown?: never; } @@ -4951,17 +4609,17 @@ export namespace GrantedEntity { * @public */ export interface $UnknownMember { - listing?: never; + smithy?: never; $unknown: [string, any]; } export interface Visitor { - listing: (value: ListingRevision) => T; + smithy: (value: string) => T; _: (name: string, value: any) => T; } - export const visit = (value: GrantedEntity, visitor: Visitor): T => { - if (value.listing !== undefined) return visitor.listing(value.listing); + export const visit = (value: Model, visitor: Visitor): T => { + if (value.smithy !== undefined) return visitor.smithy(value.smithy); return visitor._(value.$unknown[0], value.$unknown[1]); }; } @@ -4970,559 +4628,657 @@ export namespace GrantedEntity { * @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", +export const FormTypeStatus = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", } as const; /** * @public */ -export type SubscriptionGrantOverallStatus = - (typeof SubscriptionGrantOverallStatus)[keyof typeof SubscriptionGrantOverallStatus]; +export type FormTypeStatus = (typeof FormTypeStatus)[keyof typeof FormTypeStatus]; /** * @public */ -export interface CreateSubscriptionGrantOutput { +export interface CreateFormTypeInput { /** - *

The ID of the subscription grant.

+ *

The ID of the Amazon DataZone domain in which this metadata form type is created.

* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *

The Amazon DataZone user who created the subscription grant.

+ *

The name of this Amazon DataZone metadata form type.

* @public */ - createdBy: string | undefined; + name: string | undefined; /** - *

The Amazon DataZone user who updated the subscription grant.

+ *

The model of this Amazon DataZone metadata form type.

* @public */ - updatedBy?: string; + model: Model | undefined; /** - *

The ID of the Amazon DataZone domain in which the subscription grant is created.

+ *

The ID of the Amazon DataZone project that owns this metadata form type.

* @public */ - domainId: string | undefined; + owningProjectIdentifier: string | undefined; /** - *

A timestamp of when the subscription grant is created.

+ *

The status of this Amazon DataZone metadata form type.

* @public */ - createdAt: Date | undefined; + status?: FormTypeStatus; /** - *

A timestamp of when the subscription grant was updated.

+ *

The description of this Amazon DataZone metadata form type.

* @public */ - updatedAt: Date | undefined; + description?: string; +} +/** + * @public + */ +export interface CreateFormTypeOutput { /** - *

The ID of the subscription target for which the subscription grant is created.

+ *

The ID of the Amazon DataZone domain in which this metadata form type is created.

* @public */ - subscriptionTargetId: string | undefined; + domainId: string | undefined; /** - *

The entity to which the subscription is granted.

+ *

The name of this Amazon DataZone metadata form type.

* @public */ - grantedEntity: GrantedEntity | undefined; + name: string | undefined; /** - *

The status of the subscription grant.

+ *

The revision of this Amazon DataZone metadata form type.

* @public */ - status: SubscriptionGrantOverallStatus | undefined; + revision: string | undefined; /** - *

The assets for which the subscription grant is created.

+ *

The description of this Amazon DataZone metadata form type.

* @public */ - assets?: SubscribedAsset[]; + description?: string; /** - *

The identifier of the subscription grant.

+ *

The ID of the project that owns this Amazon DataZone metadata form type.

* @public */ - subscriptionId?: string; -} + owningProjectId?: string; -/** - *

The published asset for which the subscription grant is to be created.

- * @public - */ -export interface SubscribedListingInput { /** - *

The identifier of the published asset for which the subscription grant is to be + *

The ID of the Amazon DataZone domain in which this metadata form type was originally * created.

* @public */ - identifier: string | undefined; -} + originDomainId?: string; -/** - *

The project that is to be given a subscription grant.

- * @public - */ -export interface SubscribedProjectInput { /** - *

The identifier of the project that is to be given a subscription grant.

+ *

The ID of the project in which this Amazon DataZone metadata form type was originally + * created.

* @public */ - identifier?: string; + originProjectId?: string; } /** - *

The principal that is to be given a subscriptiong grant.

* @public + * @enum */ -export type SubscribedPrincipalInput = SubscribedPrincipalInput.ProjectMember | SubscribedPrincipalInput.$UnknownMember; +export const GlossaryStatus = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; /** * @public */ -export namespace SubscribedPrincipalInput { +export type GlossaryStatus = (typeof GlossaryStatus)[keyof typeof GlossaryStatus]; + +/** + * @public + */ +export interface CreateGlossaryInput { /** - *

The project that is to be given a subscription grant.

+ *

The ID of the Amazon DataZone domain in which this business glossary is created.

* @public */ - export interface ProjectMember { - project: SubscribedProjectInput; - $unknown?: never; - } + domainIdentifier: string | undefined; /** + *

The name of this business glossary.

* @public */ - export interface $UnknownMember { - project?: never; - $unknown: [string, any]; - } + name: string | undefined; - export interface Visitor { - project: (value: SubscribedProjectInput) => T; - _: (name: string, value: any) => T; - } + /** + *

The ID of the project that currently owns business glossary.

+ * @public + */ + owningProjectIdentifier: string | undefined; - export const visit = (value: SubscribedPrincipalInput, visitor: Visitor): T => { - if (value.project !== undefined) return visitor.project(value.project); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + /** + *

The description of this business glossary.

+ * @public + */ + description?: string; + + /** + *

The status of this business glossary.

+ * @public + */ + status?: GlossaryStatus; + + /** + *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

+ * @public + */ + clientToken?: string; } /** * @public */ -export interface CreateSubscriptionRequestInput { +export interface CreateGlossaryOutput { /** - *

The ID of the Amazon DataZone domain in which the subscription request is created.

+ *

The ID of the Amazon DataZone domain in which this business glossary is created.

* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *

The Amazon DataZone principals for whom the subscription request is created.

+ *

The ID of this business glossary.

* @public */ - subscribedPrincipals: SubscribedPrincipalInput[] | undefined; + id: string | undefined; /** - *

The published asset for which the subscription grant is to be created.

+ *

The name of this business glossary.

* @public */ - subscribedListings: SubscribedListingInput[] | undefined; + name: string | undefined; + + /** + *

The ID of the project that currently owns this business glossary.

+ * @public + */ + owningProjectId: string | undefined; + + /** + *

The description of this business glossary.

+ * @public + */ + description?: string; + + /** + *

The status of this business glossary.

+ * @public + */ + status?: GlossaryStatus; +} + +/** + * @public + * @enum + */ +export const GlossaryTermStatus = { + DISABLED: "DISABLED", + ENABLED: "ENABLED", +} as const; + +/** + * @public + */ +export type GlossaryTermStatus = (typeof GlossaryTermStatus)[keyof typeof GlossaryTermStatus]; +/** + *

The details of the term relations.

+ * @public + */ +export interface TermRelations { /** - *

The reason for the subscription request.

+ *

The isA property of the term relations.

* @public */ - requestReason: string | undefined; + isA?: string[]; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

The classifies of the term relations.

* @public */ - clientToken?: string; + classifies?: string[]; } /** * @public */ -export interface CreateSubscriptionRequestOutput { +export interface CreateGlossaryTermInput { /** - *

The ID of the subscription request.

+ *

The ID of the Amazon DataZone domain in which this business glossary term is created.

* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *

The Amazon DataZone user who created the subscription request.

+ *

The ID of the business glossary in which this term is created.

* @public */ - createdBy: string | undefined; + glossaryIdentifier: string | undefined; /** - *

The Amazon DataZone user who updated the subscription request.

+ *

The name of this business glossary term.

* @public */ - updatedBy?: string; + name: string | undefined; /** - *

The ID of the Amazon DataZone domain in whcih the subscription request is created.

+ *

The status of this business glossary term.

* @public */ - domainId: string | undefined; + status?: GlossaryTermStatus; /** - *

The status of the subscription request.

+ *

The short description of this business glossary term.

* @public */ - status: SubscriptionRequestStatus | undefined; + shortDescription?: string; /** - *

A timestamp of when the subscription request is created.

+ *

The long description of this business glossary term.

* @public */ - createdAt: Date | undefined; + longDescription?: string; /** - *

The timestamp of when the subscription request was updated.

+ *

The term relations of this business glossary term.

* @public */ - updatedAt: Date | undefined; + termRelations?: TermRelations; /** - *

The reason for the subscription request.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - requestReason: string | undefined; + clientToken?: string; +} +/** + * @public + */ +export interface CreateGlossaryTermOutput { /** - *

The subscribed principals of the subscription request.

+ *

The ID of this business glossary term.

* @public */ - subscribedPrincipals: SubscribedPrincipal[] | undefined; + id: string | undefined; /** - *

The published asset for which the subscription grant is to be created.

+ *

The ID of the Amazon DataZone domain in which this business glossary term is created.

* @public */ - subscribedListings: SubscribedListing[] | undefined; + domainId: string | undefined; /** - *

The ID of the reviewer of the subscription request.

+ *

The ID of the business glossary in which this term is created.

* @public */ - reviewerId?: string; + glossaryId: string | undefined; /** - *

The decision comment of the subscription request.

+ *

The name of this business glossary term.

* @public */ - decisionComment?: string; -} + name: string | undefined; -/** - *

The details of the subscription target configuration.

- * @public - */ -export interface SubscriptionTargetForm { /** - *

The form name included in the subscription target configuration.

+ *

The status of this business glossary term.

* @public */ - formName: string | undefined; + status: GlossaryTermStatus | undefined; /** - *

The content of the subscription target configuration.

+ *

The short description of this business glossary term.

* @public */ - content: string | undefined; -} + shortDescription?: string; -/** - * @public - */ -export interface CreateSubscriptionTargetInput { /** - *

The ID of the Amazon DataZone domain in which subscription target is created.

+ *

The long description of this business glossary term.

* @public */ - domainIdentifier: string | undefined; + longDescription?: string; /** - *

The ID of the environment in which subscription target is created.

+ *

The term relations of this business glossary term.

* @public */ - environmentIdentifier: string | undefined; + termRelations?: TermRelations; +} +/** + * @public + */ +export interface CreateGroupProfileInput { /** - *

The name of the subscription target.

+ *

The identifier of the Amazon DataZone domain in which the group profile is created.

* @public */ - name: string | undefined; + domainIdentifier: string | undefined; /** - *

The type of the subscription target.

+ *

The identifier of the group for which the group profile is created.

* @public */ - type: string | undefined; + groupIdentifier: string | undefined; /** - *

The configuration of the subscription target.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + clientToken?: string; +} - /** - *

The authorized principals of the subscription target.

- * @public - */ - authorizedPrincipals: string[] | undefined; +/** + * @public + * @enum + */ +export const GroupProfileStatus = { + ASSIGNED: "ASSIGNED", + NOT_ASSIGNED: "NOT_ASSIGNED", +} as const; +/** + * @public + */ +export type GroupProfileStatus = (typeof GroupProfileStatus)[keyof typeof GroupProfileStatus]; + +/** + * @public + */ +export interface CreateGroupProfileOutput { /** - *

The manage access role that is used to create the subscription target.

+ *

The identifier of the Amazon DataZone domain in which the group profile is created.

* @public */ - manageAccessRole: string | undefined; + domainId?: string; /** - *

The asset types that can be included in the subscription target.

+ *

The identifier of the group profile.

* @public */ - applicableAssetTypes: string[] | undefined; + id?: string; /** - *

The provider of the subscription target.

+ *

The status of the group profile.

* @public */ - provider?: string; + status?: GroupProfileStatus; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

The name of the group for which group profile is created.

* @public */ - clientToken?: string; + groupName?: string; } /** * @public + * @enum */ -export interface CreateSubscriptionTargetOutput { +export const EntityType = { + ASSET: "ASSET", +} as const; + +/** + * @public + */ +export type EntityType = (typeof EntityType)[keyof typeof EntityType]; + +/** + * @public + */ +export interface CreateListingChangeSetInput { /** - *

The ID of the subscription target.

+ *

The ID of the Amazon DataZone domain.

* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *

The authorised principals of the subscription target.

+ *

The ID of the asset.

* @public */ - authorizedPrincipals: string[] | undefined; + entityIdentifier: string | undefined; /** - *

The ID of the Amazon DataZone domain in which the subscription target was created.

+ *

The type of an entity.

* @public */ - domainId: string | undefined; + entityType: EntityType | undefined; /** - *

???

+ *

The revision of an asset.

* @public */ - projectId: string | undefined; + entityRevision?: string; /** - *

The ID of the environment in which the subscription target was created.

+ *

Specifies whether to publish or unpublish a listing.

* @public */ - environmentId: string | undefined; + action: ChangeAction | undefined; /** - *

The name of the subscription target.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - name: string | undefined; + clientToken?: string; +} +/** + * @public + */ +export interface CreateListingChangeSetOutput { /** - *

The type of the subscription target.

+ *

The ID of the listing (a record of an asset at a given time).

* @public */ - type: string | undefined; + listingId: string | undefined; /** - *

The Amazon DataZone user who created the subscription target.

+ *

The revision of a listing.

* @public */ - createdBy: string | undefined; + listingRevision: string | undefined; /** - *

The Amazon DataZone user who updated the subscription target.

+ *

Specifies the status of the listing.

* @public */ - updatedBy?: string; + status: ListingStatus | undefined; +} +/** + * @public + */ +export interface CreateProjectInput { /** - *

The timestamp of when the subscription target was created.

+ *

The ID of the Amazon DataZone domain in which this project is created.

* @public */ - createdAt: Date | undefined; + domainIdentifier: string | undefined; /** - *

The timestamp of when the subscription target was updated.

+ *

The name of the Amazon DataZone project.

* @public */ - updatedAt?: Date; + name: string | undefined; /** - *

The manage access role with which the subscription target was created.

+ *

The description of the Amazon DataZone project.

* @public */ - manageAccessRole: string | undefined; + description?: string; /** - *

The asset types that can be included in the subscription target.

+ *

The glossary terms that can be used in this Amazon DataZone project.

* @public */ - applicableAssetTypes: string[] | undefined; + glossaryTerms?: string[]; +} +/** + *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

+ * @public + */ +export interface ProjectDeletionError { /** - *

The configuration of the subscription target.

+ *

The code of the project deletion error.

* @public */ - subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + code?: string; /** - *

The provider of the subscription target.

+ *

The message of the project deletion error.

* @public */ - provider: string | undefined; + message?: string; } /** * @public * @enum */ -export const UserType = { - IAM_ROLE: "IAM_ROLE", - IAM_USER: "IAM_USER", - SSO_USER: "SSO_USER", +export const ProjectStatus = { + ACTIVE: "ACTIVE", + DELETE_FAILED: "DELETE_FAILED", + DELETING: "DELETING", } as const; /** * @public */ -export type UserType = (typeof UserType)[keyof typeof UserType]; +export type ProjectStatus = (typeof ProjectStatus)[keyof typeof ProjectStatus]; /** * @public */ -export interface CreateUserProfileInput { +export interface CreateProjectOutput { /** - *

The identifier of the Amazon DataZone domain in which a user profile is created.

+ *

The identifier of the Amazon DataZone domain in which the project was created.

* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *

The identifier of the user for which the user profile is created.

+ *

The ID of the Amazon DataZone project.

* @public */ - userIdentifier: string | undefined; + id: string | undefined; /** - *

The user type of the user for which the user profile is created.

+ *

The name of the project.

* @public */ - userType?: UserType; + name: string | undefined; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

The description of the project.

* @public */ - clientToken?: string; -} + description?: 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 status of the Amazon DataZone project that was created.

* @public */ - arn?: string; -} + projectStatus?: ProjectStatus; -/** - *

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.

+ *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

* @public */ - username?: string; + failureReasons?: ProjectDeletionError[]; /** - *

The first name included in the single sign-on details of the user profile.

+ *

The Amazon DataZone user who created the project.

* @public */ - firstName?: string; + createdBy: string | undefined; /** - *

The last name included in the single sign-on details of the user profile.

+ *

The timestamp of when the project was created.

* @public */ - lastName?: string; + createdAt?: Date; + + /** + *

The timestamp of when the project was last updated.

+ * @public + */ + lastUpdatedAt?: Date; + + /** + *

The glossary terms that can be used in the project.

+ * @public + */ + glossaryTerms?: string[]; } /** - *

The details of the user profile in Amazon DataZone.

* @public + * @enum */ -export type UserProfileDetails = - | UserProfileDetails.IamMember - | UserProfileDetails.SsoMember - | UserProfileDetails.$UnknownMember; +export const UserDesignation = { + PROJECT_CONTRIBUTOR: "PROJECT_CONTRIBUTOR", + PROJECT_OWNER: "PROJECT_OWNER", +} as const; /** * @public */ -export namespace UserProfileDetails { +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 IAM details included in the user profile details.

+ *

The user ID of a project member.

* @public */ - export interface IamMember { - iam: IamUserProfileDetails; - sso?: never; + export interface UserIdentifierMember { + userIdentifier: string; + groupIdentifier?: never; $unknown?: never; } /** - *

The single sign-on details included in the user profile details.

+ *

The ID of the group of a project member.

* @public */ - export interface SsoMember { - iam?: never; - sso: SsoUserProfileDetails; + export interface GroupIdentifierMember { + userIdentifier?: never; + groupIdentifier: string; $unknown?: never; } @@ -5530,220 +5286,149 @@ export namespace UserProfileDetails { * @public */ export interface $UnknownMember { - iam?: never; - sso?: never; + userIdentifier?: never; + groupIdentifier?: never; $unknown: [string, any]; } export interface Visitor { - iam: (value: IamUserProfileDetails) => T; - sso: (value: SsoUserProfileDetails) => T; + userIdentifier: (value: string) => T; + groupIdentifier: (value: string) => T; _: (name: string, value: any) => T; } - export const visit = (value: UserProfileDetails, visitor: Visitor): T => { - if (value.iam !== undefined) return visitor.iam(value.iam); - if (value.sso !== undefined) return visitor.sso(value.sso); + export const visit = (value: Member, visitor: Visitor): T => { + if (value.userIdentifier !== undefined) return visitor.userIdentifier(value.userIdentifier); + if (value.groupIdentifier !== undefined) return visitor.groupIdentifier(value.groupIdentifier); return visitor._(value.$unknown[0], value.$unknown[1]); }; } -/** - * @public - * @enum - */ -export const UserProfileStatus = { - ACTIVATED: "ACTIVATED", - ASSIGNED: "ASSIGNED", - DEACTIVATED: "DEACTIVATED", - NOT_ASSIGNED: "NOT_ASSIGNED", -} as const; - -/** - * @public - */ -export type UserProfileStatus = (typeof UserProfileStatus)[keyof typeof UserProfileStatus]; - -/** - * @public - * @enum - */ -export const UserProfileType = { - IAM: "IAM", - SSO: "SSO", -} as const; - -/** - * @public - */ -export type UserProfileType = (typeof UserProfileType)[keyof typeof UserProfileType]; - /** * @public */ -export interface CreateUserProfileOutput { - /** - *

The identifier of the Amazon DataZone domain in which a user profile is created.

- * @public - */ - domainId?: string; - +export interface CreateProjectMembershipInput { /** - *

The identifier of the user profile.

+ *

The ID of the Amazon DataZone domain in which project membership is created.

* @public */ - id?: string; + domainIdentifier: string | undefined; /** - *

The type of the user profile.

+ *

The ID of the project for which this project membership was created.

* @public */ - type?: UserProfileType; + projectIdentifier: string | undefined; /** - *

The status of the user profile.

+ *

The project member whose project membership was created.

* @public */ - status?: UserProfileStatus; + member: Member | undefined; /** - *

The details of the user profile in Amazon DataZone.

+ *

The designation of the project membership.

* @public */ - details?: UserProfileDetails; + designation: UserDesignation | undefined; } -/** - * @public - * @enum - */ -export const DataAssetActivityStatus = { - FAILED: "FAILED", - PUBLISHING_FAILED: "PUBLISHING_FAILED", - SKIPPED_ALREADY_IMPORTED: "SKIPPED_ALREADY_IMPORTED", - SKIPPED_ARCHIVED: "SKIPPED_ARCHIVED", - SKIPPED_NO_ACCESS: "SKIPPED_NO_ACCESS", - SUCCEEDED_CREATED: "SUCCEEDED_CREATED", - SUCCEEDED_UPDATED: "SUCCEEDED_UPDATED", - UNCHANGED: "UNCHANGED", -} as const; - /** * @public */ -export type DataAssetActivityStatus = (typeof DataAssetActivityStatus)[keyof typeof DataAssetActivityStatus]; +export interface CreateProjectMembershipOutput {} /** - *

- * - * @deprecated This structure is deprecated. + *

A revision to be made to an asset published in a Amazon DataZone catalog.

* @public */ -export interface DataProductItem { +export interface ListingRevisionInput { /** - *

+ *

An identifier of revision to be made to an asset published in a Amazon DataZone + * catalog.

* @public */ - itemId?: string; + identifier: string | undefined; /** - *

+ *

The details of a revision to be made to an asset published in a Amazon DataZone + * catalog.

* @public */ - domainId?: string; + revision: string | undefined; } /** - *

- * - * @deprecated This structure is deprecated. + *

The details of a listing for which a subscription is to be granted.

* @public */ -export interface DataProductSummary { - /** - *

- * @public - */ - domainId: string | undefined; - - /** - *

- * @public - */ - id: string | undefined; - - /** - *

- * @public - */ - name: string | undefined; - - /** - *

- * @public - */ - owningProjectId: string | undefined; +export type GrantedEntityInput = GrantedEntityInput.ListingMember | GrantedEntityInput.$UnknownMember; +/** + * @public + */ +export namespace GrantedEntityInput { /** - *

+ *

The listing for which a subscription is to be granted.

* @public */ - description?: string; + export interface ListingMember { + listing: ListingRevisionInput; + $unknown?: never; + } /** - *

* @public */ - glossaryTerms?: string[]; + export interface $UnknownMember { + listing?: never; + $unknown: [string, any]; + } - /** - * @deprecated - * - *

- * @public - */ - dataProductItems?: DataProductItem[]; + export interface Visitor { + listing: (value: ListingRevisionInput) => T; + _: (name: string, value: any) => T; + } - /** - *

- * @public - */ - createdAt?: Date; + export const visit = (value: GrantedEntityInput, visitor: Visitor): T => { + if (value.listing !== undefined) return visitor.listing(value.listing); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} +/** + * @public + */ +export interface CreateSubscriptionGrantInput { /** - *

+ *

The ID of the Amazon DataZone domain in which the subscription grant is created.

* @public */ - createdBy?: string; + domainIdentifier: string | undefined; /** - *

+ *

The ID of the environment in which the subscription grant is created.

* @public */ - updatedAt?: Date; + environmentIdentifier: string | undefined; /** - *

+ *

The ID of the subscription target for which the subscription grant is created.

* @public */ - updatedBy?: string; -} + subscriptionTargetIdentifier: string | undefined; -/** - * @public - */ -export interface DeleteDataSourceInput { /** - *

The ID of the Amazon DataZone domain in which the data source is deleted.

+ *

The entity to which the subscription is to be granted.

* @public */ - domainIdentifier: string | undefined; + grantedEntity: GrantedEntityInput | undefined; /** - *

The identifier of the data source that is deleted.

+ *

The names of the assets for which the subscription grant is created.

* @public */ - identifier: string | undefined; + assetTargetNames?: AssetTargetNameMap[]; /** *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the @@ -5751,24 +5436,31 @@ export interface DeleteDataSourceInput { * @public */ clientToken?: string; +} +/** + *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

+ * @public + */ +export interface FailureCause { /** - *

Specifies that the granted permissions are retained in case of a self-subscribe - * functionality failure for a data source.

+ *

The description of the error message.

* @public */ - retainPermissionsOnRevokeFailure?: boolean; + message?: string; } /** * @public * @enum */ -export const SelfGrantStatus = { +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", @@ -5777,92 +5469,92 @@ export const SelfGrantStatus = { /** * @public */ -export type SelfGrantStatus = (typeof SelfGrantStatus)[keyof typeof SelfGrantStatus]; +export type SubscriptionGrantStatus = (typeof SubscriptionGrantStatus)[keyof typeof SubscriptionGrantStatus]; /** - *

The details for the self granting status.

+ *

The details of the asset for which the subscription grant is created.

* @public */ -export interface SelfGrantStatusDetail { +export interface SubscribedAsset { /** - *

The name of the database used for the data source.

+ *

The identifier of the asset for which the subscription grant is created.

* @public */ - databaseName: string | undefined; + assetId: string | undefined; /** - *

The name of the schema used in the data source.

+ *

The revision of the asset for which the subscription grant is created.

* @public */ - schemaName?: string; + assetRevision: string | undefined; /** - *

The self granting status of the data source.

+ *

The status of the asset for which the subscription grant is created.

* @public */ - status: SelfGrantStatus | undefined; + status: SubscriptionGrantStatus | undefined; /** - *

The reason for why the operation failed.

+ *

The target name of the asset for which the subscription grant is created.

* @public */ - failureCause?: string; -} + targetName?: 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 failure cause included in the details of the asset for which the subscription grant + * is created.

* @public */ - selfGrantStatusDetails: SelfGrantStatusDetail[] | undefined; + failureCause?: FailureCause; + + /** + *

The timestamp of when the subscription grant to the asset is created.

+ * @public + */ + grantedTimestamp?: Date; + + /** + *

The failure timestamp included in the details of the asset for which the subscription + * grant is created.

+ * @public + */ + failureTimestamp?: Date; } /** - *

The details for the self granting status for an Amazon Redshift data source.

+ *

A revision of an asset published in a Amazon DataZone catalog.

* @public */ -export interface RedshiftSelfGrantStatusOutput { +export interface ListingRevision { /** - *

The details for the self granting status for an Amazon Redshift data source.

+ *

An identifier of a revision of an asset published in a Amazon DataZone catalog.

* @public */ - selfGrantStatusDetails: SelfGrantStatusDetail[] | undefined; + id: string | undefined; + + /** + *

The details of a revision of an asset published in a Amazon DataZone catalog.

+ * @public + */ + revision: string | undefined; } /** - *

The details for the self granting status for a data source.

+ *

The details of a listing for which a subscription is granted.

* @public */ -export type SelfGrantStatusOutput = - | SelfGrantStatusOutput.GlueSelfGrantStatusMember - | SelfGrantStatusOutput.RedshiftSelfGrantStatusMember - | SelfGrantStatusOutput.$UnknownMember; +export type GrantedEntity = GrantedEntity.ListingMember | GrantedEntity.$UnknownMember; /** * @public */ -export namespace SelfGrantStatusOutput { - /** - *

The details for the self granting status for a Glue data source.

- * @public - */ - export interface GlueSelfGrantStatusMember { - glueSelfGrantStatus: GlueSelfGrantStatusOutput; - redshiftSelfGrantStatus?: never; - $unknown?: never; - } - +export namespace GrantedEntity { /** - *

The details for the self granting status for an Amazon Redshift data source.

+ *

The listing for which a subscription is granted.

* @public */ - export interface RedshiftSelfGrantStatusMember { - glueSelfGrantStatus?: never; - redshiftSelfGrantStatus: RedshiftSelfGrantStatusOutput; + export interface ListingMember { + listing: ListingRevision; $unknown?: never; } @@ -5870,835 +5562,1047 @@ export namespace SelfGrantStatusOutput { * @public */ export interface $UnknownMember { - glueSelfGrantStatus?: never; - redshiftSelfGrantStatus?: never; + listing?: never; $unknown: [string, any]; } export interface Visitor { - glueSelfGrantStatus: (value: GlueSelfGrantStatusOutput) => T; - redshiftSelfGrantStatus: (value: RedshiftSelfGrantStatusOutput) => T; + listing: (value: ListingRevision) => T; _: (name: string, value: any) => T; } - export const visit = (value: SelfGrantStatusOutput, visitor: Visitor): T => { - if (value.glueSelfGrantStatus !== undefined) return visitor.glueSelfGrantStatus(value.glueSelfGrantStatus); - if (value.redshiftSelfGrantStatus !== undefined) - return visitor.redshiftSelfGrantStatus(value.redshiftSelfGrantStatus); + export const visit = (value: GrantedEntity, visitor: Visitor): T => { + if (value.listing !== undefined) return visitor.listing(value.listing); return visitor._(value.$unknown[0], value.$unknown[1]); }; } /** * @public + * @enum */ -export interface DeleteDataSourceOutput { +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; + +/** + * @public + */ +export type SubscriptionGrantOverallStatus = + (typeof SubscriptionGrantOverallStatus)[keyof typeof SubscriptionGrantOverallStatus]; + +/** + * @public + */ +export interface CreateSubscriptionGrantOutput { /** - *

The ID of the data source that is deleted.

+ *

The ID of the subscription grant.

* @public */ id: string | undefined; /** - *

The status of this data source.

+ *

The Amazon DataZone user who created the subscription grant.

* @public */ - status?: DataSourceStatus; + createdBy: string | undefined; /** - *

The type of this data source.

+ *

The Amazon DataZone user who updated the subscription grant.

* @public */ - type?: string; + updatedBy?: string; /** - *

The name of the data source that is deleted.

+ *

The ID of the Amazon DataZone domain in which the subscription grant is created.

* @public */ - name: string | undefined; + domainId: string | undefined; /** - *

The description of the data source that is deleted.

+ *

A timestamp of when the subscription grant is created.

* @public */ - description?: string; + createdAt: Date | undefined; /** - *

The ID of the Amazon DataZone domain in which the data source is deleted.

+ *

A timestamp of when the subscription grant was updated.

* @public */ - domainId: string | undefined; + updatedAt: Date | undefined; /** - *

The ID of the project in which this data source exists and from which it's - * deleted.

+ *

The ID of the subscription target for which the subscription grant is created.

* @public */ - projectId: string | undefined; + subscriptionTargetId: string | undefined; /** - *

The ID of the environemnt associated with this data source.

+ *

The entity to which the subscription is granted.

* @public */ - environmentId: string | undefined; + grantedEntity: GrantedEntity | undefined; /** - *

The configuration of the data source that is deleted.

+ *

The status of the subscription grant.

* @public */ - configuration?: DataSourceConfigurationOutput; + status: SubscriptionGrantOverallStatus | undefined; /** - *

The enable setting of the data source that specifies whether the data source is enabled - * or disabled.

+ *

The assets for which the subscription grant is created.

* @public */ - enableSetting?: EnableSetting; + assets?: SubscribedAsset[]; /** - *

Specifies whether the assets that this data source creates in the inventory are to be - * also automatically published to the catalog.

+ *

The identifier of the subscription grant.

* @public */ - publishOnImport?: boolean; + subscriptionId?: string; +} +/** + *

The published asset for which the subscription grant is to be created.

+ * @public + */ +export interface SubscribedListingInput { /** - *

The asset data forms associated with this data source.

+ *

The identifier of the published asset for which the subscription grant is to be + * created.

* @public */ - assetFormsOutput?: FormOutput[]; + identifier: string | undefined; +} +/** + *

The project that is to be given a subscription grant.

+ * @public + */ +export interface SubscribedProjectInput { /** - *

The schedule of runs for this data source.

+ *

The identifier of the project that is to be given a subscription grant.

* @public */ - schedule?: ScheduleConfiguration; + identifier?: string; +} - /** - *

The status of the last run of this data source.

- * @public - */ - lastRunStatus?: DataSourceRunStatus; +/** + *

The principal that is to be given a subscriptiong grant.

+ * @public + */ +export type SubscribedPrincipalInput = SubscribedPrincipalInput.ProjectMember | SubscribedPrincipalInput.$UnknownMember; +/** + * @public + */ +export namespace SubscribedPrincipalInput { /** - *

The timestamp of when the data source was last run.

+ *

The project that is to be given a subscription grant.

* @public */ - lastRunAt?: Date; + export interface ProjectMember { + project: SubscribedProjectInput; + $unknown?: never; + } /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

* @public */ - lastRunErrorMessage?: DataSourceErrorMessage; + export interface $UnknownMember { + project?: never; + $unknown: [string, any]; + } + + export interface Visitor { + project: (value: SubscribedProjectInput) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: SubscribedPrincipalInput, visitor: Visitor): T => { + if (value.project !== undefined) return visitor.project(value.project); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} +/** + * @public + */ +export interface CreateSubscriptionRequestInput { /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

+ *

The ID of the Amazon DataZone domain in which the subscription request is created.

* @public */ - errorMessage?: DataSourceErrorMessage; + domainIdentifier: string | undefined; /** - *

The timestamp of when this data source was created.

+ *

The Amazon DataZone principals for whom the subscription request is created.

* @public */ - createdAt?: Date; + subscribedPrincipals: SubscribedPrincipalInput[] | undefined; /** - *

The timestamp of when this data source was updated.

+ *

The published asset for which the subscription grant is to be created.

* @public */ - updatedAt?: Date; + subscribedListings: SubscribedListingInput[] | undefined; /** - *

Specifies the status of the self-granting functionality.

+ *

The reason for the subscription request.

* @public */ - selfGrantStatus?: SelfGrantStatusOutput; + requestReason: string | undefined; /** - *

Specifies that the granted permissions are retained in case of a self-subscribe - * functionality failure for a data source.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - retainPermissionsOnRevokeFailure?: boolean; + clientToken?: string; } /** * @public */ -export interface GetDataSourceInput { +export interface CreateSubscriptionRequestOutput { /** - *

The ID of the Amazon DataZone domain in which the data source exists.

+ *

The ID of the subscription request.

* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *

The ID of the Amazon DataZone data source.

+ *

The Amazon DataZone user who created the subscription request.

* @public */ - identifier: string | undefined; -} + createdBy: string | undefined; -/** - * @public - */ -export interface GetDataSourceOutput { /** - *

The ID of the data source.

+ *

The Amazon DataZone user who updated the subscription request.

* @public */ - id: string | undefined; + updatedBy?: string; /** - *

The status of the data source.

+ *

The ID of the Amazon DataZone domain in whcih the subscription request is created.

* @public */ - status?: DataSourceStatus; + domainId: string | undefined; /** - *

The type of the data source.

+ *

The status of the subscription request.

* @public */ - type?: string; + status: SubscriptionRequestStatus | undefined; /** - *

The name of the data source.

+ *

A timestamp of when the subscription request is created.

* @public */ - name: string | undefined; + createdAt: Date | undefined; /** - *

The description of the data source.

+ *

The timestamp of when the subscription request was updated.

* @public */ - description?: string; + updatedAt: Date | undefined; /** - *

The ID of the Amazon DataZone domain in which the data source exists.

+ *

The reason for the subscription request.

* @public */ - domainId: string | undefined; + requestReason: string | undefined; /** - *

The ID of the project where the data source creates and publishes assets.

+ *

The subscribed principals of the subscription request.

* @public */ - projectId: string | undefined; + subscribedPrincipals: SubscribedPrincipal[] | undefined; /** - *

The ID of the environment where this data source creates and publishes assets,

+ *

The published asset for which the subscription grant is to be created.

* @public */ - environmentId: string | undefined; + subscribedListings: SubscribedListing[] | undefined; /** - *

The configuration of the data source.

+ *

The ID of the reviewer of the subscription request.

* @public */ - configuration?: DataSourceConfigurationOutput; + reviewerId?: string; /** - *

The recommendation configuration of the data source.

+ *

The decision comment of the subscription request.

* @public */ - recommendation?: RecommendationConfiguration; + decisionComment?: string; +} +/** + *

The details of the subscription target configuration.

+ * @public + */ +export interface SubscriptionTargetForm { /** - *

Specifies whether this data source is enabled or not.

+ *

The form name included in the subscription target configuration.

* @public */ - enableSetting?: EnableSetting; + formName: string | undefined; /** - *

Specifies whether the assets that this data source creates in the inventory are to be - * also automatically published to the catalog.

+ *

The content of the subscription target configuration.

* @public */ - publishOnImport?: boolean; + content: string | undefined; +} +/** + * @public + */ +export interface CreateSubscriptionTargetInput { /** - *

The metadata forms attached to the assets created by this data source.

+ *

The ID of the Amazon DataZone domain in which subscription target is created.

* @public */ - assetFormsOutput?: FormOutput[]; + domainIdentifier: string | undefined; /** - *

The schedule of the data source runs.

+ *

The ID of the environment in which subscription target is created.

* @public */ - schedule?: ScheduleConfiguration; + environmentIdentifier: string | undefined; /** - *

The status of the last run of the data source.

+ *

The name of the subscription target.

* @public */ - lastRunStatus?: DataSourceRunStatus; + name: string | undefined; /** - *

The timestamp of the last run of the data source.

+ *

The type of the subscription target.

* @public */ - lastRunAt?: Date; + type: string | undefined; /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

+ *

The configuration of the subscription target.

* @public */ - lastRunErrorMessage?: DataSourceErrorMessage; + subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; /** - *

The number of assets created by the data source during its last run.

+ *

The authorized principals of the subscription target.

* @public */ - lastRunAssetCount?: number; + authorizedPrincipals: string[] | undefined; /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

+ *

The manage access role that is used to create the subscription target.

* @public */ - errorMessage?: DataSourceErrorMessage; + manageAccessRole: string | undefined; /** - *

The timestamp of when the data source was created.

+ *

The asset types that can be included in the subscription target.

* @public */ - createdAt?: Date; + applicableAssetTypes: string[] | undefined; /** - *

The timestamp of when the data source was updated.

+ *

The provider of the subscription target.

* @public */ - updatedAt?: Date; + provider?: string; /** - *

Specifies the status of the self-granting functionality.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - selfGrantStatus?: SelfGrantStatusOutput; + clientToken?: string; } /** * @public */ -export interface ListDataSourcesInput { - /** - *

The identifier of the Amazon DataZone domain in which to list the data sources.

- * @public - */ - domainIdentifier: string | undefined; - - /** - *

The identifier of the project in which to list data sources.

- * @public - */ - projectIdentifier: string | undefined; - - /** - *

The identifier of the environment in which to list the data sources.

- * @public - */ - environmentIdentifier?: string; - +export interface CreateSubscriptionTargetOutput { /** - *

The type of the data source.

+ *

The ID of the subscription target.

* @public */ - type?: string; + id: string | undefined; /** - *

The status of the data source.

+ *

The authorised principals of the subscription target.

* @public */ - status?: DataSourceStatus; + authorizedPrincipals: string[] | undefined; /** - *

The name of the data source.

+ *

The ID of the Amazon DataZone domain in which the subscription target was created.

* @public */ - name?: string; + domainId: string | undefined; /** - *

When the number of data sources is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of data sources, the response - * includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListDataSources to - * list the next set of data sources.

+ *

???

* @public */ - nextToken?: string; + projectId: string | undefined; /** - *

The maximum number of data sources to return in a single call to - * ListDataSources. When the number of data sources to be listed is greater - * than the value of MaxResults, the response contains a NextToken - * value that you can use in a subsequent call to ListDataSources to list the - * next set of data sources.

+ *

The ID of the environment in which the subscription target was created.

* @public */ - maxResults?: number; -} + environmentId: string | undefined; -/** - *

The details of the data source.

- * @public - */ -export interface DataSourceSummary { /** - *

The ID of the Amazon DataZone domain in which the data source exists.

+ *

The name of the subscription target.

* @public */ - domainId: string | undefined; + name: string | undefined; /** - *

The ID of the environment in which the data source exists.

+ *

The type of the subscription target.

* @public */ - environmentId: string | undefined; + type: string | undefined; /** - *

The ID of the data source.

+ *

The Amazon DataZone user who created the subscription target.

* @public */ - dataSourceId: string | undefined; + createdBy: string | undefined; /** - *

The name of the data source.

+ *

The Amazon DataZone user who updated the subscription target.

* @public */ - name: string | undefined; + updatedBy?: string; /** - *

The type of the data source.

+ *

The timestamp of when the subscription target was created.

* @public */ - type: string | undefined; + createdAt: Date | undefined; /** - *

The status of the data source.

+ *

The timestamp of when the subscription target was updated.

* @public */ - status: DataSourceStatus | undefined; + updatedAt?: Date; /** - *

Specifies whether the data source is enabled.

+ *

The manage access role with which the subscription target was created.

* @public */ - enableSetting?: EnableSetting; + manageAccessRole: string | undefined; /** - *

The details of the schedule of the data source runs.

+ *

The asset types that can be included in the subscription target.

* @public */ - schedule?: ScheduleConfiguration; + applicableAssetTypes: string[] | undefined; /** - *

The status of the last data source run.

+ *

The configuration of the subscription target.

* @public */ - lastRunStatus?: DataSourceRunStatus; + subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; /** - *

The timestamp of when the data source run was last performed.

+ *

The provider of the subscription target.

* @public */ - lastRunAt?: Date; + 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]; +/** + * @public + */ +export interface CreateUserProfileInput { /** - *

The 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 */ - lastRunErrorMessage?: DataSourceErrorMessage; + domainIdentifier: string | undefined; /** - *

The count of the assets created during the last data source run.

+ *

The identifier of the user for which the user profile is created.

* @public */ - lastRunAssetCount?: number; + userIdentifier: string | undefined; /** - *

The timestamp of when the data source was created.

+ *

The user type of the user for which the user profile is created.

* @public */ - createdAt?: Date; + userType?: UserType; /** - *

The timestamp of when the data source was updated.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - updatedAt?: Date; + clientToken?: string; } /** + *

The details of an IAM user profile in Amazon DataZone.

* @public */ -export interface ListDataSourcesOutput { - /** - *

The results of the ListDataSources action.

- * @public - */ - items: DataSourceSummary[] | undefined; - +export interface IamUserProfileDetails { /** - *

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 ARN of an IAM user profile in Amazon DataZone.

* @public */ - nextToken?: string; + arn?: string; } /** + *

The single sign-on details of the user profile.

* @public */ -export interface UpdateDataSourceInput { +export interface SsoUserProfileDetails { /** - *

The identifier of the domain in which to update a data source.

+ *

The username included in the single sign-on details of the user profile.

* @public */ - domainIdentifier: string | undefined; + username?: string; /** - *

The identifier of the data source to be updated.

+ *

The first name included in the single sign-on details of the user profile.

* @public */ - identifier: string | undefined; + firstName?: string; /** - *

The name to be updated as part of the UpdateDataSource action.

+ *

The last name included in the single sign-on details of the user profile.

* @public */ - name?: string; + 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 description to be updated as part of the UpdateDataSource - * action.

+ *

The IAM details included in the user profile details.

* @public */ - description?: string; + export interface IamMember { + iam: IamUserProfileDetails; + sso?: never; + $unknown?: never; + } /** - *

The enable setting to be updated as part of the UpdateDataSource - * action.

+ *

The single sign-on details included in the user profile details.

* @public */ - enableSetting?: EnableSetting; + export interface SsoMember { + iam?: never; + sso: SsoUserProfileDetails; + $unknown?: never; + } /** - *

The publish on import setting to be updated as part of the UpdateDataSource - * action.

* @public */ - publishOnImport?: boolean; + export interface $UnknownMember { + iam?: never; + sso?: never; + $unknown: [string, any]; + } + + export interface Visitor { + iam: (value: IamUserProfileDetails) => T; + sso: (value: SsoUserProfileDetails) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: UserProfileDetails, visitor: Visitor): T => { + if (value.iam !== undefined) return visitor.iam(value.iam); + if (value.sso !== undefined) return visitor.sso(value.sso); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + * @public + * @enum + */ +export const UserProfileStatus = { + ACTIVATED: "ACTIVATED", + ASSIGNED: "ASSIGNED", + DEACTIVATED: "DEACTIVATED", + NOT_ASSIGNED: "NOT_ASSIGNED", +} as const; + +/** + * @public + */ +export type UserProfileStatus = (typeof UserProfileStatus)[keyof typeof UserProfileStatus]; + +/** + * @public + * @enum + */ +export const UserProfileType = { + IAM: "IAM", + SSO: "SSO", +} as const; + +/** + * @public + */ +export type UserProfileType = (typeof UserProfileType)[keyof typeof UserProfileType]; +/** + * @public + */ +export interface CreateUserProfileOutput { /** - *

The asset forms to be updated as part of the UpdateDataSource - * action.

+ *

The identifier of the Amazon DataZone domain in which a user profile is created.

* @public */ - assetFormsInput?: FormInput[]; + domainId?: string; /** - *

The schedule to be updated as part of the UpdateDataSource action.

+ *

The identifier of the user profile.

* @public */ - schedule?: ScheduleConfiguration; + id?: string; /** - *

The configuration to be updated as part of the UpdateDataSource - * action.

+ *

The type of the user profile.

* @public */ - configuration?: DataSourceConfigurationInput; + type?: UserProfileType; /** - *

The recommendation to be updated as part of the UpdateDataSource - * action.

+ *

The status of the user profile.

* @public */ - recommendation?: RecommendationConfiguration; + status?: UserProfileStatus; /** - *

Specifies that the granted permissions are retained in case of a self-subscribe - * functionality failure for a data source.

+ *

The details of the user profile in Amazon DataZone.

* @public */ - retainPermissionsOnRevokeFailure?: boolean; + details?: UserProfileDetails; } /** * @public + * @enum */ -export interface UpdateDataSourceOutput { +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]; + +/** + *

+ * + * @deprecated This structure is deprecated. + * @public + */ +export interface DataProductItem { /** - *

The identifier of the data source to be updated.

+ *

* @public */ - id: string | undefined; + itemId?: string; /** - *

The status to be updated as part of the UpdateDataSource action.

+ *

* @public */ - status?: DataSourceStatus; + domainId?: string; +} +/** + *

+ * + * @deprecated This structure is deprecated. + * @public + */ +export interface DataProductSummary { /** - *

The type to be updated as part of the UpdateDataSource action.

+ *

* @public */ - type?: string; + domainId: string | undefined; /** - *

The name to be updated as part of the UpdateDataSource action.

+ *

* @public */ - name: string | undefined; + id: string | undefined; /** - *

The description to be updated as part of the UpdateDataSource - * action.

+ *

* @public */ - description?: string; + name: string | undefined; /** - *

The identifier of the Amazon DataZone domain in which a data source is to be updated.

+ *

* @public */ - domainId: string | undefined; + owningProjectId: string | undefined; /** - *

The identifier of the project where data source is to be updated.

+ *

* @public */ - projectId: string | undefined; + description?: string; /** - *

The identifier of the environment in which a data source is to be updated.

+ *

* @public */ - environmentId: string | undefined; + glossaryTerms?: string[]; /** - *

The configuration to be updated as part of the UpdateDataSource - * action.

+ * @deprecated + * + *

* @public */ - configuration?: DataSourceConfigurationOutput; + dataProductItems?: DataProductItem[]; /** - *

The recommendation to be updated as part of the UpdateDataSource - * action.

+ *

* @public */ - recommendation?: RecommendationConfiguration; + createdAt?: Date; /** - *

The enable setting to be updated as part of the UpdateDataSource - * action.

+ *

* @public */ - enableSetting?: EnableSetting; + createdBy?: string; /** - *

The publish on import setting to be updated as part of the UpdateDataSource - * action.

+ *

* @public */ - publishOnImport?: boolean; + updatedAt?: Date; /** - *

The asset forms to be updated as part of the UpdateDataSource - * action.

+ *

* @public */ - assetFormsOutput?: FormOutput[]; + updatedBy?: string; +} +/** + * @public + */ +export interface DeleteDataSourceInput { /** - *

The schedule to be updated as part of the UpdateDataSource action.

+ *

The ID of the Amazon DataZone domain in which the data source is deleted.

* @public */ - schedule?: ScheduleConfiguration; + domainIdentifier: string | undefined; /** - *

The last run status of the data source.

+ *

The identifier of the data source that is deleted.

* @public */ - lastRunStatus?: DataSourceRunStatus; + identifier: string | undefined; /** - *

The timestamp of when the data source was last run.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - lastRunAt?: Date; + clientToken?: string; /** - *

The last run error message of the data source.

+ *

Specifies that the granted permissions are retained in case of a self-subscribe + * functionality failure for a data source.

* @public */ - lastRunErrorMessage?: DataSourceErrorMessage; + 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; + +/** + * @public + */ +export type SelfGrantStatus = (typeof SelfGrantStatus)[keyof typeof SelfGrantStatus]; +/** + *

The details for the self granting status.

+ * @public + */ +export interface SelfGrantStatusDetail { /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

+ *

The name of the database used for the data source.

* @public */ - errorMessage?: DataSourceErrorMessage; + databaseName: string | undefined; /** - *

The timestamp of when the data source was updated.

+ *

The name of the schema used in the data source.

* @public */ - createdAt?: Date; + schemaName?: string; /** - *

The timestamp of when the data source was updated.

+ *

The self granting status of the data source.

* @public */ - updatedAt?: Date; + status: SelfGrantStatus | undefined; /** - *

Specifies the status of the self-granting functionality.

+ *

The reason for why the operation failed.

* @public */ - selfGrantStatus?: SelfGrantStatusOutput; + failureCause?: string; +} +/** + *

The details of the self granting status.

+ * @public + */ +export interface GlueSelfGrantStatusOutput { /** - *

Specifies that the granted permissions are retained in case of a self-subscribe - * functionality failure for a data source.

+ *

The details for the self granting status for a Glue data source.

* @public */ - retainPermissionsOnRevokeFailure?: boolean; + selfGrantStatusDetails: SelfGrantStatusDetail[] | undefined; } /** + *

The details for the self granting status for an Amazon Redshift data source.

* @public - * @enum */ -export const DataSourceRunType = { - PRIORITIZED: "PRIORITIZED", - SCHEDULED: "SCHEDULED", -} as const; +export interface RedshiftSelfGrantStatusOutput { + /** + *

The details for the self granting status for an Amazon Redshift data source.

+ * @public + */ + selfGrantStatusDetails: SelfGrantStatusDetail[] | undefined; +} /** + *

The details for the self granting status for a data source.

* @public */ -export type DataSourceRunType = (typeof DataSourceRunType)[keyof typeof DataSourceRunType]; +export type SelfGrantStatusOutput = + | SelfGrantStatusOutput.GlueSelfGrantStatusMember + | SelfGrantStatusOutput.RedshiftSelfGrantStatusMember + | SelfGrantStatusOutput.$UnknownMember; /** * @public */ -export interface GetDataSourceRunInput { +export namespace SelfGrantStatusOutput { /** - *

The ID of the domain in which this data source run was performed.

+ *

The details for the self granting status for a Glue data source.

* @public */ - domainIdentifier: string | undefined; + export interface GlueSelfGrantStatusMember { + glueSelfGrantStatus: GlueSelfGrantStatusOutput; + redshiftSelfGrantStatus?: never; + $unknown?: never; + } /** - *

The ID of the data source run.

+ *

The details for the self granting status for an Amazon Redshift data source.

* @public */ - identifier: string | undefined; + export interface RedshiftSelfGrantStatusMember { + glueSelfGrantStatus?: never; + redshiftSelfGrantStatus: RedshiftSelfGrantStatusOutput; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + glueSelfGrantStatus?: never; + redshiftSelfGrantStatus?: never; + $unknown: [string, any]; + } + + export interface Visitor { + glueSelfGrantStatus: (value: GlueSelfGrantStatusOutput) => T; + redshiftSelfGrantStatus: (value: RedshiftSelfGrantStatusOutput) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: SelfGrantStatusOutput, visitor: Visitor): T => { + if (value.glueSelfGrantStatus !== undefined) return visitor.glueSelfGrantStatus(value.glueSelfGrantStatus); + if (value.redshiftSelfGrantStatus !== undefined) + return visitor.redshiftSelfGrantStatus(value.redshiftSelfGrantStatus); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** - *

The asset statistics from the data source run.

* @public */ -export interface RunStatisticsForAssets { +export interface DeleteDataSourceOutput { /** - *

The added statistic for the data source run.

+ *

The ID of the data source that is deleted.

* @public */ - added?: number; + id: string | undefined; /** - *

The updated statistic for the data source run.

+ *

The status of this data source.

* @public */ - updated?: number; + status?: DataSourceStatus; /** - *

The unchanged statistic for the data source run.

+ *

The type of this data source.

* @public */ - unchanged?: number; + type?: string; /** - *

The skipped statistic for the data source run.

+ *

The name of the data source that is deleted.

* @public */ - skipped?: number; + name: string | undefined; /** - *

The failed statistic for the data source run.

+ *

The description of the data source that is deleted.

* @public */ - failed?: number; -} + description?: string; -/** - * @public - */ -export interface GetDataSourceRunOutput { /** - *

The ID of the domain in which this data source run was performed.

+ *

The ID of the Amazon DataZone domain in which the data source is deleted.

* @public */ domainId: string | undefined; /** - *

The ID of the data source for this data source run.

+ *

The ID of the project in which this data source exists and from which it's + * deleted.

* @public */ - dataSourceId: string | undefined; + projectId: string | undefined; /** - *

The ID of the data source run.

+ *

The ID of the environemnt associated with this data source.

* @public */ - id: string | undefined; + environmentId: string | undefined; /** - *

The ID of the project in which this data source run occured.

+ *

The configuration of the data source that is deleted.

* @public */ - projectId: string | undefined; + configuration?: DataSourceConfigurationOutput; /** - *

The status of this data source run.

+ *

The enable setting of the data source that specifies whether the data source is enabled + * or disabled.

* @public */ - status: DataSourceRunStatus | undefined; + enableSetting?: EnableSetting; /** - *

The type of this data source run.

+ *

Specifies whether the assets that this data source creates in the inventory are to be + * also automatically published to the catalog.

* @public */ - type: DataSourceRunType | undefined; + publishOnImport?: boolean; /** - *

The configuration snapshot of the data source run.

+ *

The asset data forms associated with this data source.

* @public */ - dataSourceConfigurationSnapshot?: string; + assetFormsOutput?: FormOutput[]; /** - *

The asset statistics from this data source run.

+ *

The schedule of runs for this data source.

* @public */ - runStatisticsForAssets?: RunStatisticsForAssets; + schedule?: ScheduleConfiguration; + + /** + *

The status of the last run of this data source.

+ * @public + */ + lastRunStatus?: DataSourceRunStatus; + + /** + *

The timestamp of when the data source was last run.

+ * @public + */ + lastRunAt?: Date; + + /** + *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

+ * @public + */ + lastRunErrorMessage?: DataSourceErrorMessage; /** *

Specifies the error message that is returned if the operation cannot be successfully @@ -6708,904 +6612,872 @@ export interface GetDataSourceRunOutput { errorMessage?: DataSourceErrorMessage; /** - *

The timestamp of when the data source run was created.

+ *

The timestamp of when this data source was created.

+ * @public + */ + createdAt?: Date; + + /** + *

The timestamp of when this data source was updated.

+ * @public + */ + updatedAt?: Date; + + /** + *

Specifies the status of the self-granting functionality.

* @public */ - createdAt: Date | undefined; + selfGrantStatus?: SelfGrantStatusOutput; /** - *

The timestamp of when this data source run was updated.

+ *

Specifies that the granted permissions are retained in case of a self-subscribe + * functionality failure for a data source.

* @public */ - updatedAt: Date | undefined; + retainPermissionsOnRevokeFailure?: boolean; +} +/** + * @public + */ +export interface GetDataSourceInput { /** - *

The timestamp of when this data source run started.

+ *

The ID of the Amazon DataZone domain in which the data source exists.

* @public */ - startedAt?: Date; + domainIdentifier: string | undefined; /** - *

The timestamp of when this data source run stopped.

+ *

The ID of the Amazon DataZone data source.

* @public */ - stoppedAt?: Date; + identifier: string | undefined; } /** * @public */ -export interface ListDataSourceRunsInput { +export interface GetDataSourceOutput { /** - *

The identifier of the Amazon DataZone domain in which to invoke the - * ListDataSourceRuns action.

+ *

The ID of the data source.

* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *

The identifier of the data source.

+ *

The status of the data source.

* @public */ - dataSourceIdentifier: string | undefined; + status?: DataSourceStatus; /** - *

The status of the data source.

+ *

The type of the data source.

* @public */ - status?: DataSourceRunStatus; + type?: string; /** - *

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 data source.

* @public */ - nextToken?: string; + name: string | undefined; /** - *

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 description of the data source.

* @public */ - maxResults?: number; -} + description?: string; -/** - *

The details of a data source run.

- * @public - */ -export interface DataSourceRunSummary { /** - *

The identifier of the data source run.

+ *

The ID of the Amazon DataZone domain in which the data source exists.

* @public */ - id: string | undefined; + domainId: string | undefined; /** - *

The identifier of the data source of the data source run.

+ *

The ID of the project where the data source creates and publishes assets.

* @public */ - dataSourceId: string | undefined; + projectId: string | undefined; /** - *

The type of the data source run.

+ *

The ID of the environment where this data source creates and publishes assets,

* @public */ - type: DataSourceRunType | undefined; + environmentId: string | undefined; /** - *

The status of the data source run.

+ *

The configuration of the data source.

* @public */ - status: DataSourceRunStatus | undefined; + configuration?: DataSourceConfigurationOutput; /** - *

The project ID of the data source run.

+ *

The recommendation configuration of the data source.

* @public */ - projectId: string | undefined; + recommendation?: RecommendationConfiguration; /** - *

The asset statistics from the data source run.

+ *

Specifies whether this data source is enabled or not.

* @public */ - runStatisticsForAssets?: RunStatisticsForAssets; + enableSetting?: EnableSetting; /** - *

The details of the error message that is returned if the operation cannot be - * successfully completed.

+ *

Specifies whether the assets that this data source creates in the inventory are to be + * also automatically published to the catalog.

* @public */ - errorMessage?: DataSourceErrorMessage; + publishOnImport?: boolean; /** - *

The timestamp of when a data source run was created.

+ *

The metadata forms attached to the assets created by this data source.

* @public */ - createdAt: Date | undefined; + assetFormsOutput?: FormOutput[]; /** - *

The timestamp of when a data source run was updated.

+ *

The schedule of the data source runs.

* @public */ - updatedAt: Date | undefined; + schedule?: ScheduleConfiguration; /** - *

The timestamp of when a data source run was started.

+ *

The status of the last run of the data source.

* @public */ - startedAt?: Date; + lastRunStatus?: DataSourceRunStatus; /** - *

The timestamp of when a data source run was stopped.

+ *

The timestamp of the last run of the data source.

* @public */ - stoppedAt?: Date; -} + lastRunAt?: Date; -/** - * @public - */ -export interface ListDataSourceRunsOutput { /** - *

The results of the ListDataSourceRuns action.

+ *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

* @public */ - items: DataSourceRunSummary[] | undefined; + lastRunErrorMessage?: DataSourceErrorMessage; /** - *

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 number of assets created by the data source during its last run.

* @public */ - nextToken?: string; -} + lastRunAssetCount?: number; -/** - * @public - */ -export interface StartDataSourceRunInput { /** - *

The identifier of the Amazon DataZone domain in which to start a data source run.

+ *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

* @public */ - domainIdentifier: string | undefined; + errorMessage?: DataSourceErrorMessage; /** - *

The identifier of the data source.

+ *

The timestamp of when the data source was created.

* @public */ - dataSourceIdentifier: string | undefined; + createdAt?: Date; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

The timestamp of when the data source was updated.

* @public */ - clientToken?: string; -} + updatedAt?: Date; -/** - * @public - */ -export interface StartDataSourceRunOutput { /** - *

The identifier of the Amazon DataZone domain in which to start a data source run.

+ *

Specifies the status of the self-granting functionality.

* @public */ - domainId: string | undefined; + selfGrantStatus?: SelfGrantStatusOutput; +} +/** + * @public + */ +export interface ListDataSourcesInput { /** - *

The identifier of the data source.

+ *

The identifier of the Amazon DataZone domain in which to list the data sources.

* @public */ - dataSourceId: string | undefined; + domainIdentifier: string | undefined; /** - *

The identifier of the data source run.

+ *

The identifier of the project in which to list data sources.

* @public */ - id: string | undefined; + projectIdentifier: string | undefined; /** - *

The identifier of the project.

+ *

The identifier of the environment in which to list the data sources.

* @public */ - projectId: string | undefined; + environmentIdentifier?: string; /** - *

The status of the data source run.

+ *

The type of the data source.

* @public */ - status: DataSourceRunStatus | undefined; + type?: string; /** - *

The type of the data source run.

+ *

The status of the data source.

* @public */ - type: DataSourceRunType | undefined; + status?: DataSourceStatus; /** - *

The configuration snapshot of the data source that is being run.

+ *

The name of the data source.

* @public */ - dataSourceConfigurationSnapshot?: string; + name?: string; /** - *

Specifies run statistics for assets.

+ *

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.

* @public */ - runStatisticsForAssets?: RunStatisticsForAssets; + nextToken?: string; /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

+ *

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.

* @public */ - errorMessage?: DataSourceErrorMessage; + maxResults?: number; +} +/** + *

The details of the data source.

+ * @public + */ +export interface DataSourceSummary { /** - *

The timestamp of when data source run was created.

+ *

The ID of the Amazon DataZone domain in which the data source exists.

* @public */ - createdAt: Date | undefined; + domainId: string | undefined; /** - *

The timestamp of when the data source run was updated.

+ *

The ID of the environment in which the data source exists.

* @public */ - updatedAt: Date | undefined; + environmentId: string | undefined; /** - *

The timestamp of when the data source run was started.

+ *

The ID of the data source.

* @public */ - startedAt?: Date; + dataSourceId: string | undefined; /** - *

The timestamp of when the data source run was stopped.

+ *

The name of the data source.

* @public */ - stoppedAt?: Date; -} + name: string | undefined; -/** - *

The activity details of the data source run.

- * @public - */ -export interface DataSourceRunActivity { /** - *

The database included in the data source run activity.

+ *

The type of the data source.

* @public */ - database: string | undefined; + type: string | undefined; /** - *

The identifier of the data source for the data source run activity.

+ *

The status of the data source.

* @public */ - dataSourceRunId: string | undefined; + status: DataSourceStatus | undefined; /** - *

The technical name included in the data source run activity.

+ *

Specifies whether the data source is enabled.

* @public */ - technicalName: string | undefined; + enableSetting?: EnableSetting; /** - *

The status of the asset included in the data source run activity.

+ *

The details of the schedule of the data source runs.

* @public */ - dataAssetStatus: DataAssetActivityStatus | undefined; + schedule?: ScheduleConfiguration; /** - *

The project ID included in the data source run activity.

+ *

The status of the last data source run.

* @public */ - projectId: string | undefined; + lastRunStatus?: DataSourceRunStatus; /** - *

The identifier of the asset included in the data source run activity.

+ *

The timestamp of when the data source run was last performed.

* @public */ - dataAssetId?: string; + lastRunAt?: Date; /** - *

The technical description included in the data source run activity.

+ *

The details of the error message that is returned if the operation cannot be + * successfully completed.

* @public */ - technicalDescription?: string; + lastRunErrorMessage?: DataSourceErrorMessage; /** - *

The details of the error message that is returned if the operation cannot be - * successfully completed.

+ *

The count of the assets created during the last data source run.

* @public */ - errorMessage?: DataSourceErrorMessage; + lastRunAssetCount?: number; /** - *

The timestamp of when data source run activity was created.

+ *

The timestamp of when the data source was created.

* @public */ - createdAt: Date | undefined; + createdAt?: Date; /** - *

The timestamp of when data source run activity was updated.

+ *

The timestamp of when the data source was updated.

* @public */ - updatedAt: Date | undefined; + updatedAt?: Date; } /** * @public */ -export interface DeleteEnvironmentInput { +export interface ListDataSourcesOutput { /** - *

The ID of the Amazon DataZone domain in which the environment is deleted.

+ *

The results of the ListDataSources action.

* @public */ - domainIdentifier: string | undefined; + items: DataSourceSummary[] | undefined; /** - *

The identifier of the environment that is to be deleted.

+ *

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.

* @public */ - identifier: string | undefined; + nextToken?: string; } /** * @public */ -export interface DeleteEnvironmentActionInput { +export interface UpdateDataSourceInput { /** - *

The ID of the Amazon DataZone domain in which an environment action is deleted.

+ *

The identifier of the domain in which to update a data source.

* @public */ domainIdentifier: string | undefined; /** - *

The ID of the environment where an environment action is deleted.

+ *

The identifier of the data source to be updated.

* @public */ - environmentIdentifier: string | undefined; + identifier: string | undefined; /** - *

The ID of the environment action that is deleted.

+ *

The name to be updated as part of the UpdateDataSource action.

* @public */ - identifier: string | undefined; -} + name?: string; -/** - * @public - */ -export interface DeleteEnvironmentProfileInput { /** - *

The ID of the Amazon DataZone domain in which the environment profile is deleted.

+ *

The description to be updated as part of the UpdateDataSource + * action.

* @public */ - domainIdentifier: string | undefined; + description?: string; /** - *

The ID of the environment profile that is deleted.

+ *

The enable setting to be updated as part of the UpdateDataSource + * action.

* @public */ - identifier: string | undefined; -} + enableSetting?: EnableSetting; -/** - * @public - */ -export interface DeleteProjectInput { /** - *

The ID of the Amazon DataZone domain in which the project is deleted.

+ *

The publish on import setting to be updated as part of the UpdateDataSource + * action.

* @public */ - domainIdentifier: string | undefined; + publishOnImport?: boolean; /** - *

The identifier of the project that is to be deleted.

+ *

The asset forms to be updated as part of the UpdateDataSource + * action.

* @public */ - identifier: string | undefined; + assetFormsInput?: FormInput[]; /** - *

Specifies the optional flag to delete all child entities within the project.

+ *

The schedule to be updated as part of the UpdateDataSource action.

* @public */ - skipDeletionCheck?: boolean; -} - -/** - * @public - */ -export interface DeleteProjectOutput {} + schedule?: ScheduleConfiguration; -/** - * @public - */ -export interface DeleteProjectMembershipInput { /** - *

The ID of the Amazon DataZone domain where project membership is deleted.

+ *

The configuration to be updated as part of the UpdateDataSource + * action.

* @public */ - domainIdentifier: string | undefined; + configuration?: DataSourceConfigurationInput; /** - *

The ID of the Amazon DataZone project the membership to which is deleted.

+ *

The recommendation to be updated as part of the UpdateDataSource + * action.

* @public */ - projectIdentifier: string | undefined; + recommendation?: RecommendationConfiguration; /** - *

The project member whose project membership is deleted.

+ *

Specifies that the granted permissions are retained in case of a self-subscribe + * functionality failure for a data source.

* @public */ - member: Member | undefined; + retainPermissionsOnRevokeFailure?: boolean; } /** * @public */ -export interface DeleteProjectMembershipOutput {} - -/** - * @public - */ -export interface DeleteSubscriptionGrantInput { +export interface UpdateDataSourceOutput { /** - *

The ID of the Amazon DataZone domain where the subscription grant is deleted.

+ *

The identifier of the data source to be updated.

* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *

The ID of the subscription grant that is deleted.

+ *

The status to be updated as part of the UpdateDataSource action.

* @public */ - identifier: string | undefined; -} + status?: DataSourceStatus; -/** - * @public - */ -export interface DeleteSubscriptionGrantOutput { /** - *

The ID of the subscription grant that is deleted.

+ *

The type to be updated as part of the UpdateDataSource action.

* @public */ - id: string | undefined; + type?: string; /** - *

The Amazon DataZone user who created the subscription grant that is deleted.

+ *

The name to be updated as part of the UpdateDataSource action.

* @public */ - createdBy: string | undefined; + name: string | undefined; /** - *

The Amazon DataZone user who updated the subscription grant that is deleted.

+ *

The description to be updated as part of the UpdateDataSource + * action.

* @public */ - updatedBy?: string; + description?: string; /** - *

The ID of the Amazon DataZone domain in which the subscription grant is deleted.

+ *

The identifier of the Amazon DataZone domain in which a data source is to be updated.

* @public */ domainId: string | undefined; /** - *

The timestamp of when the subscription grant that is deleted was created.

- * @public - */ - createdAt: Date | undefined; - - /** - *

The timestamp of when the subscription grant that is deleted was updated.

+ *

The identifier of the project where data source is to be updated.

* @public */ - updatedAt: Date | undefined; + projectId: string | undefined; /** - *

The ID of the subscription target associated with the subscription grant that is - * deleted.

+ *

The identifier of the environment in which a data source is to be updated.

* @public */ - subscriptionTargetId: string | undefined; + environmentId: string | undefined; /** - *

The entity to which the subscription is deleted.

+ *

The configuration to be updated as part of the UpdateDataSource + * action.

* @public */ - grantedEntity: GrantedEntity | undefined; + configuration?: DataSourceConfigurationOutput; /** - *

The status of the subscription grant that is deleted.

+ *

The recommendation to be updated as part of the UpdateDataSource + * action.

* @public */ - status: SubscriptionGrantOverallStatus | undefined; + recommendation?: RecommendationConfiguration; /** - *

The assets for which the subsctiption grant that is deleted gave access.

+ *

The enable setting to be updated as part of the UpdateDataSource + * action.

* @public */ - assets?: SubscribedAsset[]; + enableSetting?: EnableSetting; /** - *

The identifier of the subsctiption whose subscription grant is to be deleted.

+ *

The publish on import setting to be updated as part of the UpdateDataSource + * action.

* @public */ - subscriptionId?: string; -} + publishOnImport?: boolean; -/** - * @public - */ -export interface DeleteSubscriptionRequestInput { /** - *

The ID of the Amazon DataZone domain in which the subscription request is deleted.

+ *

The asset forms to be updated as part of the UpdateDataSource + * action.

* @public */ - domainIdentifier: string | undefined; + assetFormsOutput?: FormOutput[]; /** - *

The ID of the subscription request that is deleted.

+ *

The schedule to be updated as part of the UpdateDataSource action.

* @public */ - identifier: string | undefined; -} + schedule?: ScheduleConfiguration; -/** - * @public - */ -export interface DeleteSubscriptionTargetInput { /** - *

The ID of the Amazon DataZone domain in which the subscription target is deleted.

+ *

The last run status of the data source.

* @public */ - domainIdentifier: string | undefined; + lastRunStatus?: DataSourceRunStatus; /** - *

The ID of the Amazon DataZone environment in which the subscription target is deleted.

+ *

The timestamp of when the data source was last run.

* @public */ - environmentIdentifier: string | undefined; + lastRunAt?: Date; /** - *

The ID of the subscription target that is deleted.

+ *

The last run error message of the data source.

* @public */ - identifier: string | undefined; -} - -/** - * @public - * @enum - */ -export const TimeSeriesEntityType = { - ASSET: "ASSET", - LISTING: "LISTING", -} as const; - -/** - * @public - */ -export type TimeSeriesEntityType = (typeof TimeSeriesEntityType)[keyof typeof TimeSeriesEntityType]; + lastRunErrorMessage?: DataSourceErrorMessage; -/** - * @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.

+ *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

* @public */ - domainIdentifier: string | undefined; + errorMessage?: DataSourceErrorMessage; /** - *

The ID of the asset for which you want to delete a time series form.

+ *

The timestamp of when the data source was updated.

* @public */ - entityIdentifier: string | undefined; + createdAt?: Date; /** - *

The type of the asset for which you want to delete a time series form.

+ *

The timestamp of when the data source was updated.

* @public */ - entityType: TimeSeriesEntityType | undefined; + updatedAt?: Date; /** - *

The name of the time series form that you want to delete.

+ *

Specifies the status of the self-granting functionality.

* @public */ - formName: string | undefined; + selfGrantStatus?: SelfGrantStatusOutput; /** - *

A unique, case-sensitive identifier to ensure idempotency of the request. This field is - * automatically populated if not provided.

+ *

Specifies that the granted permissions are retained in case of a self-subscribe + * functionality failure for a data source.

* @public */ - clientToken?: string; + retainPermissionsOnRevokeFailure?: boolean; } /** * @public + * @enum */ -export interface DeleteTimeSeriesDataPointsOutput {} +export const DataSourceRunType = { + PRIORITIZED: "PRIORITIZED", + SCHEDULED: "SCHEDULED", +} as const; /** * @public */ -export interface DisassociateEnvironmentRoleInput { - /** - *

The ID of the Amazon DataZone domain in which an environment role is disassociated.

- * @public - */ - domainIdentifier: string | undefined; +export type DataSourceRunType = (typeof DataSourceRunType)[keyof typeof DataSourceRunType]; +/** + * @public + */ +export interface GetDataSourceRunInput { /** - *

The ID of the environment.

+ *

The ID of the domain in which this data source run was performed.

* @public */ - environmentIdentifier: string | undefined; + domainIdentifier: string | undefined; /** - *

The ARN of the environment role.

+ *

The ID of the data source run.

* @public */ - environmentRoleArn: string | undefined; + identifier: string | undefined; } /** + *

The asset statistics from the data source run.

* @public */ -export interface DisassociateEnvironmentRoleOutput {} +export interface RunStatisticsForAssets { + /** + *

The added statistic for the data source run.

+ * @public + */ + added?: number; -/** - * @public - */ -export interface DeleteDomainInput { /** - *

The identifier of the Amazon Web Services domain that is to be deleted.

+ *

The updated statistic for the data source run.

* @public */ - identifier: string | undefined; + updated?: number; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

The unchanged statistic for the data source run.

* @public */ - clientToken?: string; + unchanged?: number; /** - *

Specifies the optional flag to delete all child entities within the domain.

+ *

The skipped statistic for the data source run.

* @public */ - skipDeletionCheck?: boolean; -} + skipped?: number; -/** - * @public - */ -export interface DeleteDomainOutput { /** - *

The status of the domain.

+ *

The failed statistic for the data source run.

* @public */ - status: DomainStatus | undefined; + failed?: number; } /** * @public */ -export interface GetDomainInput { +export interface GetDataSourceRunOutput { /** - *

The identifier of the specified Amazon DataZone domain.

+ *

The ID of the domain in which this data source run was performed.

* @public */ - identifier: string | undefined; -} + domainId: string | undefined; -/** - * @public - */ -export interface GetDomainOutput { /** - *

The identifier of the specified Amazon DataZone domain.

+ *

The ID of the data source for this data source run.

* @public */ - id: string | undefined; + dataSourceId: string | undefined; /** - *

The name of the Amazon DataZone domain.

+ *

The ID of the data source run.

* @public */ - name?: string; + id: string | undefined; /** - *

The description of the Amazon DataZone domain.

+ *

The ID of the project in which this data source run occured.

* @public */ - description?: string; + projectId: string | undefined; /** - *

The single sing-on option of the specified Amazon DataZone domain.

+ *

The status of this data source run.

* @public */ - singleSignOn?: SingleSignOn; + status: DataSourceRunStatus | undefined; /** - *

The domain execution role with which the Amazon DataZone domain is created.

+ *

The type of this data source run.

* @public */ - domainExecutionRole: string | undefined; + type: DataSourceRunType | undefined; /** - *

The ARN of the specified Amazon DataZone domain.

+ *

The configuration snapshot of the data source run.

* @public */ - arn?: string; + dataSourceConfigurationSnapshot?: 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 asset statistics from this data source run.

* @public */ - kmsKeyIdentifier?: string; + runStatisticsForAssets?: RunStatisticsForAssets; /** - *

The status of the specified Amazon DataZone domain.

+ *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

* @public */ - status: DomainStatus | undefined; + errorMessage?: DataSourceErrorMessage; /** - *

The URL of the data portal for this Amazon DataZone domain.

+ *

The timestamp of when the data source run was created.

* @public */ - portalUrl?: string; + createdAt: Date | undefined; /** - *

The timestamp of when the Amazon DataZone domain was created.

+ *

The timestamp of when this data source run was updated.

* @public */ - createdAt?: Date; + updatedAt: Date | undefined; /** - *

The timestamp of when the Amazon DataZone domain was last updated.

+ *

The timestamp of when this data source run started.

* @public */ - lastUpdatedAt?: Date; + startedAt?: Date; /** - *

The tags specified for the Amazon DataZone domain.

+ *

The timestamp of when this data source run stopped.

* @public */ - tags?: Record; + stoppedAt?: Date; } /** * @public */ -export interface ListDomainsInput { +export interface ListDataSourceRunsInput { /** - *

The status of the data source.

+ *

The identifier of the Amazon DataZone domain in which to invoke the + * ListDataSourceRuns action.

* @public */ - status?: DomainStatus; + domainIdentifier: string | undefined; /** - *

The maximum number of domains to return in a single call to ListDomains. - * When the number of domains to be listed is greater than the value of - * MaxResults, the response contains a NextToken value that you - * can use in a subsequent call to ListDomains to list the next set of - * domains.

+ *

The identifier of the data source.

* @public */ - maxResults?: number; + dataSourceIdentifier: string | undefined; /** - *

When the number of domains is greater than the default value for the + *

The status of the data source.

+ * @public + */ + status?: DataSourceRunStatus; + + /** + *

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 domains, the response includes a + * 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 ListDomains to list the next set of - * domains.

+ * value in a subsequent call to ListDataSourceRuns to list the next set of + * runs.

* @public */ nextToken?: string; + + /** + *

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.

+ * @public + */ + maxResults?: number; } /** - *

A summary of a Amazon DataZone domain.

+ *

The details of a data source run.

* @public */ -export interface DomainSummary { +export interface DataSourceRunSummary { /** - *

The ID of the Amazon DataZone domain.

+ *

The identifier of the data source run.

* @public */ id: string | undefined; /** - *

A name of an Amazon DataZone domain.

+ *

The identifier of the data source of the data source run.

* @public */ - name: string | undefined; + dataSourceId: string | undefined; /** - *

A description of an Amazon DataZone domain.

+ *

The type of the data source run.

* @public */ - description?: string; + type: DataSourceRunType | undefined; /** - *

The ARN of the Amazon DataZone domain.

+ *

The status of the data source run.

* @public */ - arn: string | undefined; + status: DataSourceRunStatus | undefined; /** - *

The identifier of the Amazon Web Services account that manages the domain.

+ *

The project ID of the data source run.

* @public */ - managedAccountId: string | undefined; + projectId: string | undefined; /** - *

The status of the Amazon DataZone domain.

+ *

The asset statistics from the data source run.

* @public */ - status: DomainStatus | undefined; + runStatisticsForAssets?: RunStatisticsForAssets; /** - *

The data portal URL for the Amazon DataZone domain.

+ *

The details of the error message that is returned if the operation cannot be + * successfully completed.

* @public */ - portalUrl?: string; + errorMessage?: DataSourceErrorMessage; /** - *

A timestamp of when a Amazon DataZone domain was created.

+ *

The timestamp of when a data source run was created.

* @public */ createdAt: Date | undefined; /** - *

A timestamp of when a Amazon DataZone domain was last updated.

+ *

The timestamp of when a data source run was updated.

* @public */ - lastUpdatedAt?: Date; + updatedAt: Date | undefined; + + /** + *

The timestamp of when a data source run was started.

+ * @public + */ + startedAt?: Date; + + /** + *

The timestamp of when a data source run was stopped.

+ * @public + */ + stoppedAt?: Date; } /** * @public */ -export interface ListDomainsOutput { +export interface ListDataSourceRunsOutput { /** - *

The results of the ListDomains action.

+ *

The results of the ListDataSourceRuns action.

* @public */ - items: DomainSummary[] | undefined; + items: DataSourceRunSummary[] | undefined; /** - *

When the number of domains is greater than the default value for the + *

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 domains, the response includes a + * 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 ListDomains to list the next set of - * domains.

+ * value in a subsequent call to ListDataSourceRuns to list the next set of + * runs.

* @public */ nextToken?: string; @@ -7614,541 +7486,568 @@ export interface ListDomainsOutput { /** * @public */ -export interface UpdateDomainInput { +export interface StartDataSourceRunInput { /** - *

The ID of the Amazon Web Services domain that is to be updated.

+ *

The identifier of the Amazon DataZone domain in which to start a data source run.

* @public */ - identifier: string | undefined; + domainIdentifier: string | undefined; /** - *

The description to be updated as part of the UpdateDomain action.

+ *

The identifier of the data source.

* @public */ - description?: string; + dataSourceIdentifier: string | undefined; /** - *

The single sign-on option to be updated as part of the UpdateDomain - * action.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - singleSignOn?: SingleSignOn; + clientToken?: string; +} +/** + * @public + */ +export interface StartDataSourceRunOutput { /** - *

The domain execution role to be updated as part of the UpdateDomain - * action.

+ *

The identifier of the Amazon DataZone domain in which to start a data source run.

* @public */ - domainExecutionRole?: string; + domainId: string | undefined; /** - *

The name to be updated as part of the UpdateDomain action.

+ *

The identifier of the data source.

* @public */ - name?: string; + dataSourceId: string | undefined; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

The identifier of the data source run.

* @public */ - clientToken?: string; -} + id: string | undefined; + + /** + *

The identifier of the project.

+ * @public + */ + projectId: string | undefined; + + /** + *

The status of the data source run.

+ * @public + */ + status: DataSourceRunStatus | undefined; -/** - * @public - */ -export interface UpdateDomainOutput { /** - *

The identifier of the Amazon DataZone domain.

+ *

The type of the data source run.

* @public */ - id: string | undefined; + type: DataSourceRunType | undefined; /** - *

The description to be updated as part of the UpdateDomain action.

+ *

The configuration snapshot of the data source that is being run.

* @public */ - description?: string; + dataSourceConfigurationSnapshot?: string; /** - *

The single sign-on option of the Amazon DataZone domain.

+ *

Specifies run statistics for assets.

* @public */ - singleSignOn?: SingleSignOn; + runStatisticsForAssets?: RunStatisticsForAssets; /** - *

The domain execution role to be updated as part of the UpdateDomain - * action.

+ *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

* @public */ - domainExecutionRole?: string; + errorMessage?: DataSourceErrorMessage; /** - *

The name to be updated as part of the UpdateDomain action.

+ *

The timestamp of when data source run was created.

* @public */ - name?: string; + createdAt: Date | undefined; /** - *

Specifies the timestamp of when the domain was last updated.

+ *

The timestamp of when the data source run was updated.

* @public */ - lastUpdatedAt?: Date; -} + updatedAt: Date | undefined; -/** - * @public - */ -export interface DeleteEnvironmentBlueprintConfigurationInput { /** - *

The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.

+ *

The timestamp of when the data source run was started.

* @public */ - domainIdentifier: string | undefined; + startedAt?: Date; /** - *

The ID of the blueprint the configuration of which is deleted.

+ *

The timestamp of when the data source run was stopped.

* @public */ - environmentBlueprintIdentifier: string | undefined; + stoppedAt?: Date; } /** + *

The activity details of the data source run.

* @public */ -export interface DeleteEnvironmentBlueprintConfigurationOutput {} - -/** - * @public - */ -export interface GetEnvironmentBlueprintConfigurationInput { +export interface DataSourceRunActivity { /** - *

The ID of the Amazon DataZone domain where this blueprint exists.

+ *

The database included in the data source run activity.

* @public */ - domainIdentifier: string | undefined; + database: string | undefined; /** - *

He ID of the blueprint.

+ *

The identifier of the data source for the data source run activity.

* @public */ - environmentBlueprintIdentifier: string | undefined; -} + dataSourceRunId: string | undefined; -/** - * @public - */ -export interface GetEnvironmentBlueprintConfigurationOutput { /** - *

The ID of the Amazon DataZone domain where this blueprint exists.

+ *

The technical name included in the data source run activity.

* @public */ - domainId: string | undefined; + technicalName: string | undefined; /** - *

The ID of the blueprint.

+ *

The status of the asset included in the data source run activity.

* @public */ - environmentBlueprintId: string | undefined; + dataAssetStatus: DataAssetActivityStatus | undefined; /** - *

The ARN of the provisioning role with which this blueprint is created.

+ *

The project ID included in the data source run activity.

* @public */ - provisioningRoleArn?: string; + projectId: string | undefined; /** - *

The ARN of the manage access role with which this blueprint is created.

+ *

The identifier of the asset included in the data source run activity.

* @public */ - manageAccessRoleArn?: string; + dataAssetId?: string; /** - *

The Amazon Web Services regions in which this blueprint is enabled.

+ *

The technical description included in the data source run activity.

* @public */ - enabledRegions?: string[]; + technicalDescription?: string; /** - *

The regional parameters of the blueprint.

+ *

The details of the error message that is returned if the operation cannot be + * successfully completed.

* @public */ - regionalParameters?: Record>; + errorMessage?: DataSourceErrorMessage; /** - *

The timestamp of when this blueprint was created.

+ *

The timestamp of when data source run activity was created.

* @public */ - createdAt?: Date; + createdAt: Date | undefined; /** - *

The timestamp of when this blueprint was upated.

+ *

The timestamp of when data source run activity was updated.

* @public */ - updatedAt?: Date; + updatedAt: Date | undefined; } /** * @public */ -export interface ListEnvironmentBlueprintConfigurationsInput { +export interface DeleteAssetFilterInput { /** - *

The identifier of the Amazon DataZone domain.

+ *

The ID of the domain where you want to delete an asset filter.

* @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.

+ *

The ID of the data asset.

* @public */ - maxResults?: number; + assetIdentifier: 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 asset filter that you want to delete.

* @public */ - nextToken?: string; + identifier: 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.

- * @public - */ - domainId: string | undefined; - +export interface DeleteEnvironmentInput { /** - *

The identifier of the environment blueprint.

+ *

The ID of the Amazon DataZone domain in which the environment is deleted.

* @public */ - environmentBlueprintId: string | undefined; + domainIdentifier: string | undefined; /** - *

The ARN of the provisioning role specified in the environment blueprint - * configuration.

+ *

The identifier of the environment that is to be deleted.

* @public */ - provisioningRoleArn?: string; + identifier: string | undefined; +} +/** + * @public + */ +export interface DeleteEnvironmentActionInput { /** - *

The ARN of the manage access role specified in the environment blueprint - * configuration.

+ *

The ID of the Amazon DataZone domain in which an environment action is deleted.

* @public */ - manageAccessRoleArn?: string; + domainIdentifier: string | undefined; /** - *

The enabled Amazon Web Services Regions specified in a blueprint configuration.

+ *

The ID of the environment where an environment action is deleted.

* @public */ - enabledRegions?: string[]; + environmentIdentifier: string | undefined; /** - *

The regional parameters of the environment blueprint.

+ *

The ID of the environment action that is deleted.

* @public */ - regionalParameters?: Record>; + identifier: string | undefined; +} +/** + * @public + */ +export interface DeleteEnvironmentProfileInput { /** - *

The timestamp of when an environment blueprint was created.

+ *

The ID of the Amazon DataZone domain in which the environment profile is deleted.

* @public */ - createdAt?: Date; + domainIdentifier: string | undefined; /** - *

The timestamp of when the environment blueprint was updated.

+ *

The ID of the environment profile that is deleted.

* @public */ - updatedAt?: Date; + identifier: string | undefined; } /** * @public */ -export interface ListEnvironmentBlueprintConfigurationsOutput { +export interface DeleteProjectInput { /** - *

The results of the ListEnvironmentBlueprintConfigurations action.

+ *

The ID of the Amazon DataZone domain in which the project is deleted.

* @public */ - items?: EnvironmentBlueprintConfigurationItem[]; + domainIdentifier: string | undefined; /** - *

When the number of blueprint configurations is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of configurations, the response - * includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to - * ListEnvironmentBlueprintConfigurations to list the next set of - * configurations.

+ *

The identifier of the project that is to be deleted.

* @public */ - nextToken?: string; + identifier: string | undefined; + + /** + *

Specifies the optional flag to delete all child entities within the project.

+ * @public + */ + skipDeletionCheck?: boolean; } /** * @public */ -export interface PutEnvironmentBlueprintConfigurationInput { +export interface DeleteProjectOutput {} + +/** + * @public + */ +export interface DeleteProjectMembershipInput { /** - *

The identifier of the Amazon DataZone domain.

+ *

The ID of the Amazon DataZone domain where project membership is deleted.

* @public */ domainIdentifier: string | undefined; /** - *

The identifier of the environment blueprint.

+ *

The ID of the Amazon DataZone project the membership to which is deleted.

* @public */ - environmentBlueprintIdentifier: string | undefined; + projectIdentifier: string | undefined; /** - *

The ARN of the provisioning role.

+ *

The project member whose project membership is deleted.

* @public */ - provisioningRoleArn?: string; + member: Member | undefined; +} - /** - *

The ARN of the manage access role.

- * @public - */ - manageAccessRoleArn?: string; +/** + * @public + */ +export interface DeleteProjectMembershipOutput {} +/** + * @public + */ +export interface DeleteSubscriptionGrantInput { /** - *

Specifies the enabled Amazon Web Services Regions.

+ *

The ID of the Amazon DataZone domain where the subscription grant is deleted.

* @public */ - enabledRegions: string[] | undefined; + domainIdentifier: string | undefined; /** - *

The regional parameters in the environment blueprint.

+ *

The ID of the subscription grant that is deleted.

* @public */ - regionalParameters?: Record>; + identifier: string | undefined; } /** * @public */ -export interface PutEnvironmentBlueprintConfigurationOutput { +export interface DeleteSubscriptionGrantOutput { /** - *

The identifier of the Amazon DataZone domain.

+ *

The ID of the subscription grant that is deleted.

+ * @public + */ + id: string | undefined; + + /** + *

The Amazon DataZone user who created the subscription grant that is deleted.

+ * @public + */ + createdBy: string | undefined; + + /** + *

The Amazon DataZone user who updated the subscription grant that is deleted.

+ * @public + */ + updatedBy?: string; + + /** + *

The ID of the Amazon DataZone domain in which the subscription grant is deleted.

* @public */ domainId: string | undefined; /** - *

The identifier of the environment blueprint.

+ *

The timestamp of when the subscription grant that is deleted was created.

* @public */ - environmentBlueprintId: string | undefined; + createdAt: Date | undefined; /** - *

The ARN of the provisioning role.

+ *

The timestamp of when the subscription grant that is deleted was updated.

* @public */ - provisioningRoleArn?: string; + updatedAt: Date | undefined; /** - *

The ARN of the manage access role.

+ *

The ID of the subscription target associated with the subscription grant that is + * deleted.

* @public */ - manageAccessRoleArn?: string; + subscriptionTargetId: string | undefined; /** - *

Specifies the enabled Amazon Web Services Regions.

+ *

The entity to which the subscription is deleted.

* @public */ - enabledRegions?: string[]; + grantedEntity: GrantedEntity | undefined; /** - *

The regional parameters in the environment blueprint.

+ *

The status of the subscription grant that is deleted.

* @public */ - regionalParameters?: Record>; + status: SubscriptionGrantOverallStatus | undefined; /** - *

The timestamp of when the environment blueprint was created.

+ *

The assets for which the subsctiption grant that is deleted gave access.

* @public */ - createdAt?: Date; + assets?: SubscribedAsset[]; /** - *

The timestamp of when the environment blueprint was updated.

+ *

The identifier of the subsctiption whose subscription grant is to be deleted.

* @public */ - updatedAt?: Date; + subscriptionId?: string; } /** * @public */ -export interface DeleteFormTypeInput { +export interface DeleteSubscriptionRequestInput { /** - *

The ID of the Amazon DataZone domain in which the metadata form type is deleted.

+ *

The ID of the Amazon DataZone domain in which the subscription request is deleted.

* @public */ domainIdentifier: string | undefined; /** - *

The ID of the metadata form type that is deleted.

+ *

The ID of the subscription request that is deleted.

* @public */ - formTypeIdentifier: string | undefined; + identifier: string | undefined; } /** * @public */ -export interface DeleteFormTypeOutput {} - -/** - * @public - */ -export interface GetFormTypeInput { +export interface DeleteSubscriptionTargetInput { /** - *

The ID of the Amazon DataZone domain in which this metadata form type exists.

+ *

The ID of the Amazon DataZone domain in which the subscription target is deleted.

* @public */ domainIdentifier: string | undefined; /** - *

The ID of the metadata form type.

+ *

The ID of the Amazon DataZone environment in which the subscription target is deleted.

* @public */ - formTypeIdentifier: string | undefined; + environmentIdentifier: string | undefined; /** - *

The revision of this metadata form type.

+ *

The ID of the subscription target that is deleted.

* @public */ - revision?: string; + identifier: string | undefined; } /** - *

The details of the import of the metadata form type.

* @public + * @enum */ -export interface Import { - /** - *

The name of the import.

- * @public - */ - name: string | undefined; +export const TimeSeriesEntityType = { + ASSET: "ASSET", + LISTING: "LISTING", +} as const; - /** - *

The revision of the import.

- * @public - */ - revision: string | undefined; -} +/** + * @public + */ +export type TimeSeriesEntityType = (typeof TimeSeriesEntityType)[keyof typeof TimeSeriesEntityType]; /** * @public */ -export interface GetFormTypeOutput { +export interface DeleteTimeSeriesDataPointsInput { /** - *

The ID of the Amazon DataZone domain in which this metadata form type exists.

+ *

The ID of the Amazon DataZone domain that houses the asset for which you want to delete + * a time series form.

* @public */ - domainId: string | undefined; + domainIdentifier: string | undefined; /** - *

The name of the metadata form type.

+ *

The ID of the asset for which you want to delete a time series form.

* @public */ - name: string | undefined; + entityIdentifier: string | undefined; /** - *

The revision of the metadata form type.

+ *

The type of the asset for which you want to delete a time series form.

* @public */ - revision: string | undefined; + entityType: TimeSeriesEntityType | undefined; /** - *

The model of the metadata form type.

+ *

The name of the time series form that you want to delete.

* @public */ - model: Model | undefined; + formName: string | undefined; /** - *

The ID of the project that owns this metadata form type.

+ *

A unique, case-sensitive identifier to ensure idempotency of the request. This field is + * automatically populated if not provided.

* @public */ - owningProjectId?: string; + clientToken?: string; +} - /** - *

The ID of the Amazon DataZone domain in which the metadata form type was originally - * created.

- * @public - */ - originDomainId?: string; +/** + * @public + */ +export interface DeleteTimeSeriesDataPointsOutput {} +/** + * @public + */ +export interface DisassociateEnvironmentRoleInput { /** - *

The ID of the project in which this metadata form type was originally created.

+ *

The ID of the Amazon DataZone domain in which an environment role is disassociated.

* @public */ - originProjectId?: string; + domainIdentifier: string | undefined; /** - *

The status of the metadata form type.

+ *

The ID of the environment.

* @public */ - status?: FormTypeStatus; + environmentIdentifier: string | undefined; /** - *

The timestamp of when this metadata form type was created.

+ *

The ARN of the environment role.

* @public */ - createdAt?: Date; + environmentRoleArn: string | undefined; +} + +/** + * @public + */ +export interface DisassociateEnvironmentRoleOutput {} +/** + * @public + */ +export interface DeleteDomainInput { /** - *

The Amazon DataZone user who created this metadata form type.

+ *

The identifier of the Amazon Web Services domain that is to be deleted.

* @public */ - createdBy?: string; + identifier: string | undefined; /** - *

The description of the metadata form type.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - description?: string; + clientToken?: string; /** - *

The imports of the metadata form type.

+ *

Specifies the optional flag to delete all child entities within the domain.

* @public */ - imports?: Import[]; + skipDeletionCheck?: boolean; } /** * @public */ -export interface GetEnvironmentInput { +export interface DeleteDomainOutput { /** - *

The ID of the Amazon DataZone domain where the environment exists.

+ *

The status of the domain.

* @public */ - domainIdentifier: string | undefined; + status: DomainStatus | undefined; +} +/** + * @public + */ +export interface GetDomainInput { /** - *

The ID of the Amazon DataZone environment.

+ *

The identifier of the specified Amazon DataZone domain.

* @public */ identifier: string | undefined; @@ -8157,961 +8056,1054 @@ export interface GetEnvironmentInput { /** * @public */ -export interface GetEnvironmentOutput { +export interface GetDomainOutput { /** - *

The ID of the Amazon DataZone project in which this environment is created.

+ *

The identifier of the specified Amazon DataZone domain.

* @public */ - projectId: string | undefined; + id: string | undefined; /** - *

The ID of the environment.

+ *

The name of the Amazon DataZone domain.

* @public */ - id?: string; + name?: string; /** - *

The ID of the Amazon DataZone domain where the environment exists.

+ *

The description of the Amazon DataZone domain.

* @public */ - domainId: string | undefined; + description?: string; /** - *

The Amazon DataZone user who created the environment.

+ *

The single sing-on option of the specified Amazon DataZone domain.

* @public */ - createdBy: string | undefined; + singleSignOn?: SingleSignOn; /** - *

The timestamp of when the environment was created.

+ *

The domain execution role with which the Amazon DataZone domain is created.

* @public */ - createdAt?: Date; + domainExecutionRole: string | undefined; /** - *

The timestamp of when this environment was updated.

+ *

The ARN of the specified Amazon DataZone domain.

* @public */ - updatedAt?: Date; + arn?: string; /** - *

The name of the environment.

+ *

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 */ - name: string | undefined; + kmsKeyIdentifier?: string; /** - *

The description of the environment.

+ *

The status of the specified Amazon DataZone domain.

* @public */ - description?: string; + status: DomainStatus | undefined; /** - *

The ID of the environment profile with which the environment is created.

+ *

The URL of the data portal for this Amazon DataZone domain.

* @public */ - environmentProfileId?: string; + portalUrl?: string; /** - *

The ID of the Amazon Web Services account where the environment exists.

+ *

The timestamp of when the Amazon DataZone domain was created.

* @public */ - awsAccountId?: string; + createdAt?: Date; /** - *

The Amazon Web Services region where the environment exists.

+ *

The timestamp of when the Amazon DataZone domain was last updated.

* @public */ - awsAccountRegion?: string; + lastUpdatedAt?: Date; /** - *

The provider of this Amazon DataZone environment.

+ *

The tags specified for the Amazon DataZone domain.

* @public */ - provider: string | undefined; + tags?: Record; +} +/** + * @public + */ +export interface ListDomainsInput { /** - *

The provisioned resources of this Amazon DataZone environment.

+ *

The status of the data source.

* @public */ - provisionedResources?: Resource[]; + status?: DomainStatus; /** - *

The status of this Amazon DataZone environment.

+ *

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.

* @public */ - status?: EnvironmentStatus; + maxResults?: number; /** - *

The actions of the environment.

+ *

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.

* @public */ - environmentActions?: ConfigurableEnvironmentAction[]; + nextToken?: string; +} + +/** + *

A summary of a Amazon DataZone domain.

+ * @public + */ +export interface DomainSummary { + /** + *

The ID of the Amazon DataZone domain.

+ * @public + */ + id: string | undefined; + + /** + *

A name of an Amazon DataZone domain.

+ * @public + */ + name: string | undefined; + + /** + *

A description of an Amazon DataZone domain.

+ * @public + */ + description?: string; /** - *

The business glossary terms that can be used in this environment.

+ *

The ARN of the Amazon DataZone domain.

* @public */ - glossaryTerms?: string[]; + arn: string | undefined; /** - *

The user parameters of this Amazon DataZone environment.

+ *

The identifier of the Amazon Web Services account that manages the domain.

* @public */ - userParameters?: CustomParameter[]; + managedAccountId: string | undefined; /** - *

The details of the last deployment of the environment.

+ *

The status of the Amazon DataZone domain.

* @public */ - lastDeployment?: Deployment; + status: DomainStatus | undefined; /** - *

The provisioning properties of this Amazon DataZone environment.

+ *

The data portal URL for the Amazon DataZone domain.

* @public */ - provisioningProperties?: ProvisioningProperties; + portalUrl?: string; /** - *

The deployment properties of the environment.

+ *

A timestamp of when a Amazon DataZone domain was created.

* @public */ - deploymentProperties?: DeploymentProperties; + createdAt: Date | undefined; /** - *

The blueprint with which the environment is created.

+ *

A timestamp of when a Amazon DataZone domain was last updated.

* @public */ - environmentBlueprintId?: string; + lastUpdatedAt?: Date; } /** * @public */ -export interface GetEnvironmentActionInput { - /** - *

The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is - * invoked.

- * @public - */ - domainIdentifier: string | undefined; - +export interface ListDomainsOutput { /** - *

The environment ID of the environment action.

+ *

The results of the ListDomains action.

* @public */ - environmentIdentifier: string | undefined; + items: DomainSummary[] | undefined; /** - *

The ID of the environment action

+ *

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.

* @public */ - identifier: string | undefined; + nextToken?: string; } /** * @public */ -export interface GetEnvironmentActionOutput { +export interface UpdateDomainInput { /** - *

The ID of the Amazon DataZone domain in which the environment action lives.

+ *

The ID of the Amazon Web Services domain that is to be updated.

* @public */ - domainId: string | undefined; + identifier: string | undefined; /** - *

The environment ID of the environment action.

+ *

The description to be updated as part of the UpdateDomain action.

* @public */ - environmentId: string | undefined; + description?: string; /** - *

The ID of the environment action.

+ *

The single sign-on option to be updated as part of the UpdateDomain + * action.

* @public */ - id: string | undefined; + singleSignOn?: SingleSignOn; /** - *

The name of the environment action.

+ *

The domain execution role to be updated as part of the UpdateDomain + * action.

* @public */ - name: string | undefined; + domainExecutionRole?: string; /** - *

The parameters of the environment action.

+ *

The name to be updated as part of the UpdateDomain action.

* @public */ - parameters: ActionParameters | undefined; + name?: string; /** - *

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 UpdateDomainOutput { /** - *

The identifier of the domain in which this blueprint exists.

+ *

The identifier of the Amazon DataZone domain.

* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *

The ID of this Amazon DataZone blueprint.

+ *

The description to be updated as part of the UpdateDomain action.

* @public */ - identifier: string | undefined; -} + description?: string; -/** - * @public - */ -export interface GetEnvironmentBlueprintOutput { /** - *

The ID of this Amazon DataZone blueprint.

+ *

The single sign-on option of the Amazon DataZone domain.

* @public */ - id: string | undefined; + singleSignOn?: SingleSignOn; /** - *

The name of this Amazon DataZone blueprint.

+ *

The domain execution role to be updated as part of the UpdateDomain + * action.

* @public */ - name: string | undefined; + domainExecutionRole?: string; /** - *

The description of this Amazon DataZone blueprint.

+ *

The name to be updated as part of the UpdateDomain action.

* @public */ - description?: string; + name?: string; /** - *

The provider of this Amazon DataZone blueprint.

+ *

Specifies the timestamp of when the domain was last updated.

* @public */ - provider: string | undefined; + lastUpdatedAt?: Date; +} +/** + * @public + */ +export interface DeleteEnvironmentBlueprintConfigurationInput { /** - *

The provisioning properties of this Amazon DataZone blueprint.

+ *

The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.

* @public */ - provisioningProperties: ProvisioningProperties | undefined; + domainIdentifier: string | undefined; /** - *

The deployment properties of this Amazon DataZone blueprint.

+ *

The ID of the blueprint the configuration of which is deleted.

* @public */ - deploymentProperties?: DeploymentProperties; + environmentBlueprintIdentifier: string | undefined; +} + +/** + * @public + */ +export interface DeleteEnvironmentBlueprintConfigurationOutput {} +/** + * @public + */ +export interface GetEnvironmentBlueprintConfigurationInput { /** - *

The user parameters of this blueprint.

+ *

The ID of the Amazon DataZone domain where this blueprint exists.

* @public */ - userParameters?: CustomParameter[]; + domainIdentifier: string | undefined; /** - *

The glossary terms attached to this Amazon DataZone blueprint.

+ *

He ID of the blueprint.

* @public */ - glossaryTerms?: string[]; + environmentBlueprintIdentifier: string | undefined; +} +/** + *

The Lake Formation configuration of the Data Lake blueprint.

+ * @public + */ +export interface LakeFormationConfiguration { /** - *

A timestamp of when this blueprint was created.

+ *

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 */ - createdAt?: Date; + locationRegistrationRole?: string; /** - *

The timestamp of when this blueprint was updated.

+ *

Specifies certain Amazon S3 locations if you do not want Amazon DataZone to + * automatically register them in hybrid mode.

* @public */ - updatedAt?: Date; + locationRegistrationExcludeS3Locations?: string[]; } /** + *

The provisioning configuration of the blueprint.

* @public */ -export interface GetEnvironmentProfileInput { +export type ProvisioningConfiguration = + | ProvisioningConfiguration.LakeFormationConfigurationMember + | ProvisioningConfiguration.$UnknownMember; + +/** + * @public + */ +export namespace ProvisioningConfiguration { /** - *

The ID of the Amazon DataZone domain in which this environment profile exists.

+ *

The Lake Formation configuration of the Data Lake blueprint.

* @public */ - domainIdentifier: string | undefined; + export interface LakeFormationConfigurationMember { + lakeFormationConfiguration: LakeFormationConfiguration; + $unknown?: never; + } /** - *

The ID of the environment profile.

* @public */ - identifier: string | undefined; + export interface $UnknownMember { + lakeFormationConfiguration?: never; + $unknown: [string, any]; + } + + export interface Visitor { + lakeFormationConfiguration: (value: LakeFormationConfiguration) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: ProvisioningConfiguration, visitor: Visitor): T => { + if (value.lakeFormationConfiguration !== undefined) + return visitor.lakeFormationConfiguration(value.lakeFormationConfiguration); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** * @public */ -export interface GetEnvironmentProfileOutput { +export interface GetEnvironmentBlueprintConfigurationOutput { /** - *

The ID of the environment profile.

+ *

The ID of the Amazon DataZone domain where this blueprint exists.

* @public */ - id: string | undefined; + domainId: string | undefined; /** - *

The ID of the Amazon DataZone domain in which this environment profile exists.

+ *

The ID of the blueprint.

* @public */ - domainId: string | undefined; + environmentBlueprintId: string | undefined; /** - *

The ID of the Amazon Web Services account where this environment profile exists.

+ *

The ARN of the provisioning role with which this blueprint is created.

* @public */ - awsAccountId?: string; + provisioningRoleArn?: string; /** - *

The Amazon Web Services region where this environment profile exists.

+ *

The ARN of the manage access role with which this blueprint is created.

* @public */ - awsAccountRegion?: string; + manageAccessRoleArn?: string; /** - *

The Amazon DataZone user who created this environment profile.

+ *

The Amazon Web Services regions in which this blueprint is enabled.

* @public */ - createdBy: string | undefined; + enabledRegions?: string[]; /** - *

The timestamp of when this environment profile was created.

+ *

The regional parameters of the blueprint.

* @public */ - createdAt?: Date; + regionalParameters?: Record>; /** - *

The timestamp of when this environment profile was upated.

+ *

The timestamp of when this blueprint was created.

* @public */ - updatedAt?: Date; + createdAt?: Date; /** - *

The name of the environment profile.

+ *

The timestamp of when this blueprint was upated.

* @public */ - name: string | undefined; + updatedAt?: Date; /** - *

The description of the environment profile.

+ *

The provisioning configuration of a blueprint.

* @public */ - description?: string; + provisioningConfigurations?: ProvisioningConfiguration[]; +} +/** + * @public + */ +export interface ListEnvironmentBlueprintConfigurationsInput { /** - *

The ID of the blueprint with which this environment profile is created.

+ *

The identifier of the Amazon DataZone domain.

* @public */ - environmentBlueprintId: string | undefined; + domainIdentifier: string | undefined; /** - *

The ID of the Amazon DataZone project in which this environment profile is created.

+ *

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.

* @public */ - projectId?: string; + maxResults?: number; /** - *

The user parameters of the environment profile.

+ *

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.

* @public */ - userParameters?: CustomParameter[]; + nextToken?: string; } /** + *

The configuration details of an environment blueprint.

* @public */ -export interface GetGroupProfileInput { +export interface EnvironmentBlueprintConfigurationItem { /** - *

The identifier of the Amazon DataZone domain in which the group profile exists.

+ *

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 */ - domainIdentifier: string | undefined; + manageAccessRoleArn?: string; /** - *

The identifier of the group profile.

+ *

The enabled Amazon Web Services Regions specified in a blueprint configuration.

* @public */ - groupIdentifier: string | undefined; -} + enabledRegions?: string[]; -/** - * @public - */ -export interface GetGroupProfileOutput { /** - *

The identifier of the Amazon DataZone domain in which the group profile exists.

+ *

The regional parameters of the environment blueprint.

* @public */ - domainId?: string; + regionalParameters?: Record>; /** - *

The identifier of the group profile.

+ *

The timestamp of when an environment blueprint was created.

* @public */ - id?: string; + createdAt?: Date; /** - *

The identifier of the group profile.

+ *

The timestamp of when the environment blueprint was updated.

* @public */ - status?: GroupProfileStatus; + updatedAt?: Date; /** - *

The name of the group for which the specified group profile exists.

+ *

The provisioning configuration of a blueprint.

* @public */ - groupName?: string; + provisioningConfigurations?: ProvisioningConfiguration[]; } /** * @public */ -export interface GetIamPortalLoginUrlInput { +export interface ListEnvironmentBlueprintConfigurationsOutput { /** - *

the ID of the Amazon DataZone domain the data portal of which you want to get.

+ *

The results of the ListEnvironmentBlueprintConfigurations action.

* @public */ - domainIdentifier: string | undefined; + items?: EnvironmentBlueprintConfigurationItem[]; + + /** + *

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.

+ * @public + */ + nextToken?: string; } /** * @public */ -export interface GetIamPortalLoginUrlOutput { +export interface PutEnvironmentBlueprintConfigurationInput { /** - *

The data portal URL of the specified Amazon DataZone domain.

+ *

The identifier of the Amazon DataZone domain.

* @public */ - authCodeUrl?: string; + domainIdentifier: string | undefined; /** - *

The ID of the user profile.

+ *

The identifier of the environment blueprint.

* @public */ - userProfileId: string | undefined; -} + environmentBlueprintIdentifier: string | undefined; -/** - * @public - */ -export interface GetLineageNodeInput { /** - *

The ID of the domain in which you want to get the data lineage node.

+ *

The ARN of the provisioning role.

* @public */ - domainIdentifier: string | undefined; + provisioningRoleArn?: string; /** - *

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 ARN of the manage access role.

* @public */ - identifier: string | undefined; + manageAccessRoleArn?: string; /** - *

The event time stamp for which you want to get the data lineage node.

+ *

Specifies the enabled Amazon Web Services Regions.

* @public */ - eventTimestamp?: Date; -} + enabledRegions: string[] | undefined; -/** - *

The reference details for the data lineage node.

- * @public - */ -export interface LineageNodeReference { /** - *

The ID of the data lineage node.

+ *

The regional parameters in the environment blueprint.

* @public */ - id?: string; + regionalParameters?: Record>; /** - *

The event timestamp of the data lineage node.

+ *

The provisioning configuration of a blueprint.

* @public */ - eventTimestamp?: Date; + provisioningConfigurations?: ProvisioningConfiguration[]; } /** * @public */ -export interface GetLineageNodeOutput { +export interface PutEnvironmentBlueprintConfigurationOutput { /** - *

The ID of the domain where you're getting the data lineage node.

+ *

The identifier of the Amazon DataZone domain.

* @public */ domainId: string | undefined; /** - *

The name of the data lineage node.

+ *

The identifier of the environment blueprint.

* @public */ - name?: string; + environmentBlueprintId: string | undefined; /** - *

The description of the data lineage node.

+ *

The ARN of the provisioning role.

* @public */ - description?: string; + provisioningRoleArn?: string; /** - *

The timestamp at which the data lineage node was created.

+ *

The ARN of the manage access role.

* @public */ - createdAt?: Date; + manageAccessRoleArn?: string; /** - *

The user who created the data lineage node.

+ *

Specifies the enabled Amazon Web Services Regions.

* @public */ - createdBy?: string; + enabledRegions?: string[]; /** - *

The timestamp at which the data lineage node was updated.

+ *

The regional parameters in the environment blueprint.

* @public */ - updatedAt?: Date; + regionalParameters?: Record>; /** - *

The user who updated the data lineage node.

+ *

The timestamp of when the environment blueprint was created.

* @public */ - updatedBy?: string; + createdAt?: Date; /** - *

The ID of the data lineage node.

+ *

The timestamp of when the environment blueprint was updated.

* @public */ - id: string | undefined; + updatedAt?: Date; /** - *

The name of the type of the specified data lineage node.

+ *

The provisioning configuration of a blueprint.

* @public */ - typeName: string | undefined; + provisioningConfigurations?: ProvisioningConfiguration[]; +} +/** + * @public + */ +export interface DeleteFormTypeInput { /** - *

The revision type of the specified data lineage node.

+ *

The ID of the Amazon DataZone domain in which the metadata form type is deleted.

* @public */ - typeRevision?: string; + domainIdentifier: string | undefined; /** - *

The source identifier of the data lineage node.

+ *

The ID of the metadata form type that is deleted.

* @public */ - sourceIdentifier?: string; + formTypeIdentifier: string | undefined; +} - /** - *

The timestamp of the event described in the data lineage node.

- * @public - */ - eventTimestamp?: Date; +/** + * @public + */ +export interface DeleteFormTypeOutput {} +/** + * @public + */ +export interface GetFormTypeInput { /** - *

The metadata of the specified data lineage node.

+ *

The ID of the Amazon DataZone domain in which this metadata form type exists.

* @public */ - formsOutput?: FormOutput[]; + domainIdentifier: string | undefined; /** - *

The upstream nodes of the specified data lineage node.

+ *

The ID of the metadata form type.

* @public */ - upstreamNodes?: LineageNodeReference[]; + formTypeIdentifier: string | undefined; /** - *

The downsteam nodes of the specified data lineage node.

+ *

The revision of this metadata form type.

* @public */ - downstreamNodes?: LineageNodeReference[]; + revision?: string; } /** + *

The details of the import of the metadata form type.

* @public */ -export interface GetProjectInput { +export interface Import { /** - *

The ID of the Amazon DataZone domain in which the project exists.

+ *

The name of the import.

* @public */ - domainIdentifier: string | undefined; + name: string | undefined; /** - *

The ID of the project.

+ *

The revision of the import.

* @public */ - identifier: string | undefined; + revision: string | undefined; } /** * @public */ -export interface GetProjectOutput { +export interface GetFormTypeOutput { /** - *

The ID of the Amazon DataZone domain in which the project exists.

+ *

The ID of the Amazon DataZone domain in which this metadata form type exists.

* @public */ domainId: string | undefined; /** - *

>The ID of the project.

+ *

The name of the metadata form type.

* @public */ - id: string | undefined; + name: string | undefined; /** - *

The name of the project.

+ *

The revision of the metadata form type.

* @public */ - name: string | undefined; + revision: string | undefined; /** - *

The description of the project.

+ *

The model of the metadata form type.

* @public */ - description?: string; + model: Model | undefined; /** - *

The status of the project.

+ *

The ID of the project that owns this metadata form type.

* @public */ - projectStatus?: ProjectStatus; + owningProjectId?: string; /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

+ *

The ID of the Amazon DataZone domain in which the metadata form type was originally + * created.

* @public */ - failureReasons?: ProjectDeletionError[]; + originDomainId?: string; /** - *

The Amazon DataZone user who created the project.

+ *

The ID of the project in which this metadata form type was originally created.

* @public */ - createdBy: string | undefined; + originProjectId?: string; /** - *

The timestamp of when the project was created.

+ *

The status of the metadata form type.

* @public */ - createdAt?: Date; + status?: FormTypeStatus; /** - *

The timestamp of when the project was last updated.

+ *

The timestamp of when this metadata form type was created.

* @public */ - lastUpdatedAt?: Date; + createdAt?: Date; /** - *

The business glossary terms that can be used in the project.

+ *

The Amazon DataZone user who created this metadata form type.

* @public */ - glossaryTerms?: string[]; -} + createdBy?: string; -/** - * @public - */ -export interface GetSubscriptionInput { /** - *

The ID of the Amazon DataZone domain in which the subscription exists.

+ *

The description of the metadata form type.

* @public */ - domainIdentifier: string | undefined; + description?: string; /** - *

The ID of the subscription.

+ *

The imports of the metadata form type.

* @public */ - identifier: string | undefined; + imports?: Import[]; } /** * @public */ -export interface GetSubscriptionOutput { +export interface GetAssetFilterInput { /** - *

The ID of the subscription.

+ *

The ID of the domain where you want to get an asset filter.

* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *

The Amazon DataZone user who created the subscription.

+ *

The ID of the data asset.

* @public */ - createdBy: string | undefined; + assetIdentifier: string | undefined; /** - *

The Amazon DataZone user who updated the subscription.

+ *

The ID of the asset filter.

* @public */ - updatedBy?: string; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetEnvironmentInput { /** - *

The ID of the Amazon DataZone domain in which the subscription exists.

+ *

The ID of the Amazon DataZone domain where the environment exists.

* @public */ - domainId: string | undefined; + domainIdentifier: string | undefined; /** - *

The status of the subscription.

+ *

The ID of the Amazon DataZone environment.

* @public */ - status: SubscriptionStatus | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetEnvironmentOutput { /** - *

The timestamp of when the subscription was created.

+ *

The ID of the Amazon DataZone project in which this environment is created.

* @public */ - createdAt: Date | undefined; + projectId: string | undefined; /** - *

The timestamp of when the subscription was updated.

+ *

The ID of the environment.

* @public */ - updatedAt: Date | undefined; + id?: string; /** - *

The principal that owns the subscription.

+ *

The ID of the Amazon DataZone domain where the environment exists.

* @public */ - subscribedPrincipal: SubscribedPrincipal | undefined; + domainId: string | undefined; /** - *

The details of the published asset for which the subscription grant is created.

+ *

The Amazon DataZone user who created the environment.

* @public */ - subscribedListing: SubscribedListing | undefined; + createdBy: string | undefined; /** - *

The ID of the subscription request.

+ *

The timestamp of when the environment was created.

* @public */ - subscriptionRequestId?: string; + createdAt?: Date; /** - *

The retain permissions of the subscription.

+ *

The timestamp of when this environment was updated.

* @public */ - retainPermissions?: boolean; -} + updatedAt?: Date; -/** - * @public - */ -export interface GetSubscriptionGrantInput { /** - *

The ID of the Amazon DataZone domain in which the subscription grant exists.

+ *

The name of the environment.

* @public */ - domainIdentifier: string | undefined; + name: string | undefined; /** - *

The ID of the subscription grant.

+ *

The description of the environment.

* @public */ - identifier: string | undefined; -} + description?: string; -/** - * @public - */ -export interface GetSubscriptionGrantOutput { /** - *

The ID of the subscription grant.

+ *

The ID of the environment profile with which the environment is created.

* @public */ - id: string | undefined; + environmentProfileId?: string; /** - *

The Amazon DataZone user who created the subscription grant.

+ *

The ID of the Amazon Web Services account where the environment exists.

* @public */ - createdBy: string | undefined; + awsAccountId?: string; /** - *

The Amazon DataZone user who updated the subscription grant.

+ *

The Amazon Web Services region where the environment exists.

* @public */ - updatedBy?: string; + awsAccountRegion?: string; /** - *

The ID of the Amazon DataZone domain in which the subscription grant exists.

+ *

The provider of this Amazon DataZone environment.

* @public */ - domainId: string | undefined; + provider: string | undefined; /** - *

The timestamp of when the subscription grant is created.

+ *

The provisioned resources of this Amazon DataZone environment.

* @public */ - createdAt: Date | undefined; + provisionedResources?: Resource[]; /** - *

The timestamp of when the subscription grant was upated.

+ *

The status of this Amazon DataZone environment.

* @public */ - updatedAt: Date | undefined; + status?: EnvironmentStatus; /** - *

The subscription target ID associated with the subscription grant.

+ *

The actions of the environment.

* @public */ - subscriptionTargetId: string | undefined; + environmentActions?: ConfigurableEnvironmentAction[]; /** - *

The entity to which the subscription is granted.

+ *

The business glossary terms that can be used in this environment.

* @public */ - grantedEntity: GrantedEntity | undefined; + glossaryTerms?: string[]; /** - *

The status of the subscription grant.

+ *

The user parameters of this Amazon DataZone environment.

* @public */ - status: SubscriptionGrantOverallStatus | undefined; + userParameters?: CustomParameter[]; /** - *

The assets for which the subscription grant is created.

+ *

The details of the last deployment of the environment.

* @public */ - assets?: SubscribedAsset[]; + lastDeployment?: Deployment; /** - *

The identifier of the subscription.

+ *

The provisioning properties of this Amazon DataZone environment.

* @public */ - subscriptionId?: string; -} + provisioningProperties?: ProvisioningProperties; -/** - * @public - */ -export interface GetSubscriptionRequestDetailsInput { /** - *

The identifier of the Amazon DataZone domain in which to get the subscription request - * details.

+ *

The deployment properties of the environment.

* @public */ - domainIdentifier: string | undefined; + deploymentProperties?: DeploymentProperties; /** - *

The identifier of the subscription request the details of which to get.

+ *

The blueprint with which the environment is created.

* @public */ - identifier: string | undefined; + environmentBlueprintId?: string; } /** * @public */ -export interface GetSubscriptionRequestDetailsOutput { +export interface GetEnvironmentActionInput { /** - *

The identifier of the subscription request.

+ *

The ID of the Amazon DataZone domain in which the GetEnvironmentAction API is + * invoked.

* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *

The Amazon DataZone user who created the subscription request.

+ *

The environment ID of the environment action.

* @public */ - createdBy: string | undefined; + environmentIdentifier: string | undefined; /** - *

The Amazon DataZone user who updated the subscription request.

+ *

The ID of the environment action

* @public */ - updatedBy?: string; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetEnvironmentActionOutput { /** - *

The Amazon DataZone domain of the subscription request.

+ *

The ID of the Amazon DataZone domain in which the environment action lives.

* @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.

+ *

The environment ID of the environment action.

* @public */ - requestReason: string | undefined; + environmentId: string | undefined; /** - *

The subscribed principals in the subscription request.

+ *

The ID of the environment action.

* @public */ - subscribedPrincipals: SubscribedPrincipal[] | undefined; + id: string | undefined; /** - *

The subscribed listings in the subscription request.

+ *

The name of the environment action.

* @public */ - subscribedListings: SubscribedListing[] | undefined; + name: string | undefined; /** - *

The identifier of the Amazon DataZone user who reviewed the subscription request.

+ *

The parameters of the environment action.

* @public */ - reviewerId?: string; + parameters: ActionParameters | undefined; /** - *

The decision comment of the subscription request.

+ *

The description of the environment action.

* @public */ - decisionComment?: string; + description?: string; } /** * @public */ -export interface GetSubscriptionTargetInput { +export interface GetEnvironmentBlueprintInput { /** - *

The ID of the Amazon DataZone domain in which the subscription target exists.

+ *

The identifier of the domain in which this blueprint 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.

+ *

The ID of this Amazon DataZone blueprint.

* @public */ identifier: string | undefined; @@ -9120,472 +9112,471 @@ export interface GetSubscriptionTargetInput { /** * @public */ -export interface GetSubscriptionTargetOutput { +export interface GetEnvironmentBlueprintOutput { /** - *

The ID of the subscription target.

+ *

The ID of this Amazon DataZone blueprint.

* @public */ id: string | undefined; /** - *

The authorized principals of the subscription target.

+ *

The name of this Amazon DataZone blueprint.

* @public */ - authorizedPrincipals: string[] | undefined; + name: string | undefined; /** - *

The ID of the Amazon DataZone domain in which the subscription target exists.

+ *

The description of this Amazon DataZone blueprint.

* @public */ - domainId: string | undefined; + description?: string; /** - *

The ID of the project associated with the subscription target.

+ *

The provider of this Amazon DataZone blueprint.

* @public */ - projectId: string | undefined; + provider: string | undefined; /** - *

The ID of the environment associated with the subscription target.

+ *

The provisioning properties of this Amazon DataZone blueprint.

* @public */ - environmentId: string | undefined; + provisioningProperties: ProvisioningProperties | undefined; /** - *

The name of the subscription target.

+ *

The deployment properties of this Amazon DataZone blueprint.

* @public */ - name: string | undefined; + deploymentProperties?: DeploymentProperties; /** - *

The type of the subscription target.

+ *

The user parameters of this blueprint.

* @public */ - type: string | undefined; + userParameters?: CustomParameter[]; /** - *

The Amazon DataZone user who created the subscription target.

+ *

The glossary terms attached to this Amazon DataZone blueprint.

* @public */ - createdBy: string | undefined; + glossaryTerms?: string[]; /** - *

The Amazon DataZone user who updated the subscription target.

+ *

A timestamp of when this blueprint was created.

* @public */ - updatedBy?: string; + createdAt?: Date; /** - *

The timestamp of when the subscription target was created.

+ *

The timestamp of when this blueprint was updated.

* @public */ - createdAt: Date | undefined; + updatedAt?: Date; +} +/** + * @public + */ +export interface GetEnvironmentProfileInput { /** - *

The timestamp of when the subscription target was updated.

+ *

The ID of the Amazon DataZone domain in which this environment profile exists.

* @public */ - updatedAt?: Date; + domainIdentifier: string | undefined; /** - *

The manage access role with which the subscription target was created.

+ *

The ID of the environment profile.

* @public */ - manageAccessRole: string | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetEnvironmentProfileOutput { /** - *

The asset types associated with the subscription target.

+ *

The ID of the environment profile.

* @public */ - applicableAssetTypes: string[] | undefined; + id: string | undefined; /** - *

The configuration of teh subscription target.

+ *

The ID of the Amazon DataZone domain in which this environment profile exists.

* @public */ - subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + domainId: string | undefined; /** - *

The provider of the subscription target.

+ *

The ID of the Amazon Web Services account where this environment profile exists.

* @public */ - provider: string | undefined; -} + awsAccountId?: string; -/** - * @public - */ -export interface GetTimeSeriesDataPointInput { /** - *

The ID of the Amazon DataZone domain that houses the asset for which you want to get the - * data point.

+ *

The Amazon Web Services region where this environment profile exists.

* @public */ - domainIdentifier: string | undefined; + awsAccountRegion?: string; /** - *

The ID of the asset for which you want to get the data point.

+ *

The Amazon DataZone user who created this environment profile.

* @public */ - entityIdentifier: string | undefined; + createdBy: string | undefined; /** - *

The type of the asset for which you want to get the data point.

+ *

The timestamp of when this environment profile was created.

* @public */ - entityType: TimeSeriesEntityType | undefined; + createdAt?: Date; /** - *

The ID of the data point that you want to get.

+ *

The timestamp of when this environment profile was upated.

* @public */ - identifier: string | undefined; + updatedAt?: Date; /** - *

The name of the time series form that houses the data point that you want to get.

+ *

The name of the environment profile.

* @public */ - formName: string | undefined; -} + name: string | undefined; -/** - *

The time series data points form.

- * @public - */ -export interface TimeSeriesDataPointFormOutput { /** - *

The name of the time series data points form.

+ *

The description of the environment profile.

* @public */ - formName: string | undefined; + description?: string; /** - *

The ID of the type of the time series data points form.

+ *

The ID of the blueprint with which this environment profile is created.

* @public */ - typeIdentifier: string | undefined; + environmentBlueprintId: string | undefined; /** - *

The revision type of the time series data points form.

+ *

The ID of the Amazon DataZone project in which this environment profile is created.

* @public */ - typeRevision?: string; + projectId?: string; /** - *

The timestamp of the time series data points form.

+ *

The user parameters of the environment profile.

* @public */ - timestamp: Date | undefined; + userParameters?: CustomParameter[]; +} +/** + * @public + */ +export interface GetGroupProfileInput { /** - *

The content of the time series data points form.

+ *

The identifier of the Amazon DataZone domain in which the group profile exists.

* @public */ - content?: string; + domainIdentifier: string | undefined; /** - *

The ID of the time series data points form.

+ *

The identifier of the group profile.

* @public */ - id?: string; + groupIdentifier: string | undefined; } /** * @public */ -export interface GetTimeSeriesDataPointOutput { +export interface GetGroupProfileOutput { /** - *

The ID of the Amazon DataZone domain that houses the asset data point that you want to - * get.

+ *

The identifier of the Amazon DataZone domain in which the group profile exists.

* @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.

+ *

The identifier of the group profile.

* @public */ - entityType?: TimeSeriesEntityType; + id?: string; /** - *

The name of the time series form that houses the data point that you want to get.

+ *

The identifier of the group profile.

* @public */ - formName?: string; + status?: GroupProfileStatus; /** - *

The time series form that houses the data point that you want to get.

+ *

The name of the group for which the specified group profile exists.

* @public */ - form?: TimeSeriesDataPointFormOutput; + groupName?: string; } /** * @public */ -export interface GetUserProfileInput { +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 identifier of the user for which you want to get the user profile.

+ *

The data portal URL of the specified Amazon DataZone domain.

* @public */ - userIdentifier: string | undefined; + authCodeUrl?: string; /** - *

The type of the user profile.

+ *

The ID of the user profile.

* @public */ - type?: UserProfileType; + userProfileId: string | undefined; } /** * @public */ -export interface GetUserProfileOutput { +export interface GetLineageNodeInput { /** - *

the identifier of the Amazon DataZone domain of which you want to get the user - * profile.

+ *

The ID of the domain in which you want to get the data lineage node.

* @public */ - domainId?: string; + domainIdentifier: string | undefined; /** - *

The identifier of the user profile.

+ *

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.

* @public */ - id?: string; + identifier: string | undefined; /** - *

The type of the user profile.

+ *

The event time stamp for which you want to get the data lineage node.

* @public */ - type?: UserProfileType; + eventTimestamp?: Date; +} +/** + *

The reference details for the data lineage node.

+ * @public + */ +export interface LineageNodeReference { /** - *

The status of the user profile.

+ *

The ID of the data lineage node.

* @public */ - status?: UserProfileStatus; + id?: string; /** - *

The details of the user profile in Amazon DataZone.

+ *

The event timestamp of the data lineage node.

* @public */ - details?: UserProfileDetails; + eventTimestamp?: Date; } /** * @public */ -export interface DeleteGlossaryInput { +export interface GetLineageNodeOutput { /** - *

The ID of the Amazon DataZone domain in which the business glossary is deleted.

+ *

The ID of the domain where you're getting the data lineage node.

* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *

The ID of the business glossary that is deleted.

+ *

The name of the data lineage node.

* @public */ - identifier: string | undefined; -} + name?: string; -/** - * @public - */ -export interface DeleteGlossaryOutput {} + /** + *

The description of the data lineage node.

+ * @public + */ + description?: string; -/** - * @public - */ -export interface GetGlossaryInput { /** - *

The ID of the Amazon DataZone domain in which this business glossary exists.

+ *

The timestamp at which the data lineage node was created.

* @public */ - domainIdentifier: string | undefined; + createdAt?: Date; /** - *

The ID of the business glossary.

+ *

The user who created the data lineage node.

* @public */ - identifier: string | undefined; -} + createdBy?: string; -/** - * @public - */ -export interface GetGlossaryOutput { /** - *

The ID of the Amazon DataZone domain in which this business glossary exists.

+ *

The timestamp at which the data lineage node was updated.

* @public */ - domainId: string | undefined; + updatedAt?: Date; /** - *

The ID of the business glossary.

+ *

The user who updated the data lineage node.

* @public */ - id: string | undefined; + updatedBy?: string; /** - *

The ID of the project that owns this business glossary.

+ *

The ID of the data lineage node.

* @public */ - owningProjectId: string | undefined; + id: string | undefined; /** - *

The name of the business glossary.

+ *

The name of the type of the specified data lineage node.

* @public */ - name: string | undefined; + typeName: string | undefined; /** - *

The description of the business glossary.

+ *

The revision type of the specified data lineage node.

* @public */ - description?: string; + typeRevision?: string; /** - *

The status of the business glossary.

+ *

The source identifier of the data lineage node.

* @public */ - status: GlossaryStatus | undefined; + sourceIdentifier?: string; /** - *

The timestamp of when this business glossary was created.

+ *

The timestamp of the event described in the data lineage node.

* @public */ - createdAt?: Date; + eventTimestamp?: Date; /** - *

The Amazon DataZone user who created this business glossary.

+ *

The metadata of the specified data lineage node.

* @public */ - createdBy?: string; + formsOutput?: FormOutput[]; /** - *

The timestamp of when the business glossary was updated.

+ *

The upstream nodes of the specified data lineage node.

* @public */ - updatedAt?: Date; + upstreamNodes?: LineageNodeReference[]; /** - *

The Amazon DataZone user who updated the business glossary.

+ *

The downsteam nodes of the specified data lineage node.

* @public */ - updatedBy?: string; + downstreamNodes?: LineageNodeReference[]; } /** * @public */ -export interface UpdateGlossaryInput { +export interface GetProjectInput { /** - *

The identifier of the Amazon DataZone domain in which a business glossary is to be - * updated.

+ *

The ID of the Amazon DataZone domain in which the project exists.

* @public */ domainIdentifier: string | undefined; /** - *

The identifier of the business glossary to be updated.

+ *

The ID of the project.

* @public */ identifier: string | undefined; +} +/** + * @public + */ +export interface GetProjectOutput { /** - *

The name to be updated as part of the UpdateGlossary action.

+ *

The ID of the Amazon DataZone domain in which the project exists.

* @public */ - name?: string; + domainId: string | undefined; /** - *

The description to be updated as part of the UpdateGlossary action.

+ *

>The ID of the project.

* @public */ - description?: string; + id: string | undefined; /** - *

The status to be updated as part of the UpdateGlossary action.

+ *

The name of the project.

* @public */ - status?: GlossaryStatus; + name: string | undefined; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

The description of the project.

* @public */ - clientToken?: string; -} + description?: string; -/** - * @public - */ -export interface UpdateGlossaryOutput { /** - *

The identifier of the Amazon DataZone domain in which a business glossary is to be - * updated.

+ *

The status of the project.

* @public */ - domainId: string | undefined; + projectStatus?: ProjectStatus; /** - *

The identifier of the business glossary that is to be updated.

+ *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

* @public */ - id: string | undefined; + failureReasons?: ProjectDeletionError[]; /** - *

The name to be updated as part of the UpdateGlossary action.

+ *

The Amazon DataZone user who created the project.

* @public */ - name: string | undefined; + createdBy: string | undefined; /** - *

The identifier of the project in which to update a business glossary.

+ *

The timestamp of when the project was created.

* @public */ - owningProjectId: string | undefined; + createdAt?: Date; /** - *

The description to be updated as part of the UpdateGlossary action.

+ *

The timestamp of when the project was last updated.

* @public */ - description?: string; + lastUpdatedAt?: Date; /** - *

The status to be updated as part of the UpdateGlossary action.

+ *

The business glossary terms that can be used in the project.

* @public */ - status?: GlossaryStatus; + glossaryTerms?: string[]; } /** * @public */ -export interface DeleteGlossaryTermInput { +export interface GetSubscriptionInput { /** - *

The ID of the Amazon DataZone domain in which the business glossary term is deleted.

+ *

The ID of the Amazon DataZone domain in which the subscription exists.

* @public */ domainIdentifier: string | undefined; /** - *

The ID of the business glossary term that is deleted.

+ *

The ID of the subscription.

* @public */ identifier: string | undefined; @@ -9594,1251 +9585,1155 @@ export interface DeleteGlossaryTermInput { /** * @public */ -export interface DeleteGlossaryTermOutput {} +export interface GetSubscriptionOutput { + /** + *

The ID of the subscription.

+ * @public + */ + id: string | undefined; -/** - * @public - */ -export interface GetGlossaryTermInput { /** - *

The ID of the Amazon DataZone domain in which this business glossary term exists.

+ *

The Amazon DataZone user who created the subscription.

* @public */ - domainIdentifier: string | undefined; + createdBy: string | undefined; /** - *

The ID of the business glossary term.

+ *

The Amazon DataZone user who updated the subscription.

* @public */ - identifier: string | undefined; -} + updatedBy?: string; -/** - * @public - */ -export interface GetGlossaryTermOutput { /** - *

The ID of the Amazon DataZone domain in which this business glossary term exists.

+ *

The ID of the Amazon DataZone domain in which the subscription exists.

* @public */ domainId: string | undefined; /** - *

The ID of the business glossary to which this term belongs.

+ *

The status of the subscription.

* @public */ - glossaryId: string | undefined; + status: SubscriptionStatus | undefined; /** - *

The ID of the business glossary term.

+ *

The timestamp of when the subscription was created.

* @public */ - id: string | undefined; + createdAt: Date | undefined; /** - *

The name of the business glossary term.

+ *

The timestamp of when the subscription was updated.

* @public */ - name: string | undefined; + updatedAt: Date | undefined; /** - *

The short decription of the business glossary term.

+ *

The principal that owns the subscription.

* @public */ - shortDescription?: string; + subscribedPrincipal: SubscribedPrincipal | undefined; /** - *

The long description of the business glossary term.

+ *

The details of the published asset for which the subscription grant is created.

* @public */ - longDescription?: string; + subscribedListing: SubscribedListing | undefined; /** - *

The relations of the business glossary term.

+ *

The ID of the subscription request.

* @public */ - termRelations?: TermRelations; + subscriptionRequestId?: string; /** - *

The status of the business glossary term.

+ *

The retain permissions of the subscription.

* @public */ - status: GlossaryTermStatus | undefined; + retainPermissions?: boolean; +} +/** + * @public + */ +export interface GetSubscriptionGrantInput { /** - *

The timestamp of when the business glossary term was created.

+ *

The ID of the Amazon DataZone domain in which the subscription grant exists.

* @public */ - createdAt?: Date; + domainIdentifier: string | undefined; /** - *

The Amazon DataZone user who created the business glossary.

+ *

The ID of the subscription grant.

* @public */ - createdBy?: string; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetSubscriptionGrantOutput { /** - *

The timestamp of when the business glossary term was updated.

+ *

The ID of the subscription grant.

* @public */ - updatedAt?: Date; + id: string | undefined; /** - *

The Amazon DataZone user who updated the business glossary term.

+ *

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; -} -/** - * @public - */ -export interface UpdateGlossaryTermInput { /** - *

The identifier of the Amazon DataZone domain in which a business glossary term is to be - * updated.

+ *

The ID of the Amazon DataZone domain in which the subscription grant exists.

* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *

The identifier of the business glossary in which a term is to be updated.

+ *

The timestamp of when the subscription grant is created.

* @public */ - glossaryIdentifier?: string; + createdAt: Date | undefined; /** - *

The identifier of the business glossary term that is to be updated.

+ *

The timestamp of when the subscription grant was upated.

* @public */ - identifier: string | undefined; + updatedAt: Date | undefined; /** - *

The name to be updated as part of the UpdateGlossaryTerm action.

+ *

The subscription target ID associated with the subscription grant.

* @public */ - name?: string; + subscriptionTargetId: string | undefined; /** - *

The short description to be updated as part of the UpdateGlossaryTerm - * action.

+ *

The entity to which the subscription is granted.

* @public */ - shortDescription?: string; + grantedEntity: GrantedEntity | undefined; /** - *

The long description to be updated as part of the UpdateGlossaryTerm - * action.

+ *

The status of the subscription grant.

* @public */ - longDescription?: string; + status: SubscriptionGrantOverallStatus | undefined; /** - *

The term relations to be updated as part of the UpdateGlossaryTerm - * action.

+ *

The assets for which the subscription grant is created.

* @public */ - termRelations?: TermRelations; + assets?: SubscribedAsset[]; /** - *

The status to be updated as part of the UpdateGlossaryTerm action.

+ *

The identifier of the subscription.

* @public */ - status?: GlossaryTermStatus; + subscriptionId?: string; } /** * @public */ -export interface UpdateGlossaryTermOutput { +export interface GetSubscriptionRequestDetailsInput { /** - *

The identifier of the business glossary term that is to be updated.

+ *

The identifier of the Amazon DataZone domain in which to get the subscription request + * details.

* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *

The identifier of the Amazon DataZone domain in which a business glossary term is to be - * updated.

+ *

The identifier of the subscription request the details of which to get.

* @public */ - domainId: string | undefined; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetSubscriptionRequestDetailsOutput { /** - *

The identifier of the business glossary in which a term is to be updated.

+ *

The identifier of the subscription request.

* @public */ - glossaryId: string | undefined; + id: string | undefined; /** - *

The name to be updated as part of the UpdateGlossaryTerm action.

+ *

The Amazon DataZone user who created the subscription request.

* @public */ - name: string | undefined; + createdBy: string | undefined; /** - *

The status to be updated as part of the UpdateGlossaryTerm action.

+ *

The Amazon DataZone user who updated the subscription request.

* @public */ - status: GlossaryTermStatus | undefined; + updatedBy?: string; /** - *

The short description to be updated as part of the UpdateGlossaryTerm - * action.

+ *

The Amazon DataZone domain of the subscription request.

* @public */ - shortDescription?: string; + domainId: string | undefined; /** - *

The long description to be updated as part of the UpdateGlossaryTerm - * action.

+ *

The status of the subscription request.

* @public */ - longDescription?: string; + status: SubscriptionRequestStatus | undefined; /** - *

The term relations to be updated as part of the UpdateGlossaryTerm - * action.

+ *

The timestamp of when the specified subscription request was created.

* @public */ - termRelations?: TermRelations; -} + createdAt: Date | undefined; -/** - * @public - */ -export interface ListAssetRevisionsInput { /** - *

The identifier of the domain.

+ *

The timestamp of when the subscription request was updated.

* @public */ - domainIdentifier: string | undefined; + updatedAt: Date | undefined; /** - *

The identifier of the asset.

+ *

The reason for the subscription request.

* @public */ - identifier: string | undefined; + requestReason: string | undefined; /** - *

When the number of revisions is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of revisions, the response includes - * a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListAssetRevisions to - * list the next set of revisions.

+ *

The subscribed principals in the subscription request.

* @public */ - nextToken?: string; + subscribedPrincipals: SubscribedPrincipal[] | undefined; /** - *

The maximum number of revisions to return in a single call to - * ListAssetRevisions. When the number of revisions to be listed is greater - * than the value of MaxResults, the response contains a NextToken - * value that you can use in a subsequent call to ListAssetRevisions to list the - * next set of revisions.

+ *

The subscribed listings in the subscription request.

* @public */ - maxResults?: number; -} + subscribedListings: SubscribedListing[] | undefined; -/** - * @public - */ -export interface ListAssetRevisionsOutput { /** - *

The results of the ListAssetRevisions action.

+ *

The identifier of the Amazon DataZone user who reviewed the subscription request.

* @public */ - items?: AssetRevision[]; + reviewerId?: string; /** - *

When the number of revisions is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of revisions, the response includes - * a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListAssetRevisions to - * list the next set of revisions.

+ *

The decision comment of the subscription request.

* @public */ - nextToken?: string; + decisionComment?: string; } /** * @public */ -export interface ListDataSourceRunActivitiesInput { +export interface GetSubscriptionTargetInput { /** - *

The identifier of the Amazon DataZone domain in which to list data source run - * activities.

+ *

The ID of the Amazon DataZone domain in which the subscription target exists.

* @public */ domainIdentifier: string | undefined; /** - *

The identifier of the data source run.

- * @public - */ - identifier: string | undefined; - - /** - *

The status of the data source run.

+ *

The ID of the environment associated with the subscription target.

* @public */ - status?: DataAssetActivityStatus; + environmentIdentifier: string | undefined; /** - *

When the number of activities is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of activities, the response - * includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to - * ListDataSourceRunActivities to list the next set of activities.

+ *

The ID of the subscription target.

* @public */ - nextToken?: string; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetSubscriptionTargetOutput { /** - *

The maximum number of activities to return in a single call to - * ListDataSourceRunActivities. When the number of activities to be listed is - * greater than the value of MaxResults, the response contains a - * NextToken value that you can use in a subsequent call to - * ListDataSourceRunActivities to list the next set of activities.

+ *

The ID of the subscription target.

* @public */ - maxResults?: number; -} + id: string | undefined; -/** - * @public - */ -export interface ListDataSourceRunActivitiesOutput { /** - *

The results of the ListDataSourceRunActivities action.

+ *

The authorized principals of the subscription target.

* @public */ - items: DataSourceRunActivity[] | undefined; + authorizedPrincipals: string[] | undefined; /** - *

When the number of activities is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of activities, the response - * includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to - * ListDataSourceRunActivities to list the next set of activities.

+ *

The ID of the Amazon DataZone domain in which the subscription target exists.

* @public */ - nextToken?: string; -} + domainId: string | undefined; -/** - * @public - */ -export interface ListEnvironmentActionsInput { /** - *

The ID of the Amazon DataZone domain in which the environment actions are listed.

+ *

The ID of the project associated with the subscription target.

* @public */ - domainIdentifier: string | undefined; + projectId: string | undefined; /** - *

The ID of the envrironment whose environment actions are listed.

+ *

The ID of the environment associated with the subscription target.

* @public */ - environmentIdentifier: string | undefined; + environmentId: string | undefined; /** - *

When the number of environment actions is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of environment actions, the - * response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListEnvironmentActions - * to list the next set of environment actions.

+ *

The name of the subscription target.

* @public */ - nextToken?: string; + name: string | undefined; /** - *

The maximum number of environment actions to return in a single call to - * ListEnvironmentActions. When the number of environment actions to be listed - * is greater than the value of MaxResults, the response contains a - * NextToken value that you can use in a subsequent call to - * ListEnvironmentActions to list the next set of environment actions.

+ *

The type of the subscription target.

* @public */ - maxResults?: number; -} + type: string | undefined; -/** - *

The details about the specified action configured for an environment. For example, the - * details of the specified console links for an analytics tool that is available in this - * environment.

- * @public - */ -export interface EnvironmentActionSummary { /** - *

The Amazon DataZone domain ID of the environment action.

+ *

The Amazon DataZone user who created the subscription target.

* @public */ - domainId: string | undefined; + createdBy: string | undefined; /** - *

The environment ID of the environment action.

+ *

The Amazon DataZone user who updated the subscription target.

* @public */ - environmentId: string | undefined; + updatedBy?: string; /** - *

The ID of the environment action.

+ *

The timestamp of when the subscription target was created.

* @public */ - id: string | undefined; + createdAt: Date | undefined; /** - *

The name of the environment action.

+ *

The timestamp of when the subscription target was updated.

* @public */ - name: string | undefined; + updatedAt?: Date; /** - *

The parameters of the environment action.

+ *

The manage access role with which the subscription target was created.

* @public */ - parameters: ActionParameters | undefined; + manageAccessRole: string | undefined; /** - *

The environment action description.

+ *

The asset types associated with the subscription target.

* @public */ - description?: string; -} + applicableAssetTypes: string[] | undefined; -/** - * @public - */ -export interface ListEnvironmentActionsOutput { /** - *

The results of ListEnvironmentActions.

+ *

The configuration of teh subscription target.

* @public */ - items?: EnvironmentActionSummary[]; + subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; /** - *

When the number of environment actions is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of environment actions, the - * response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListEnvironmentActions - * to list the next set of environment actions.

+ *

The provider of the subscription target.

* @public */ - nextToken?: string; + provider: string | undefined; } /** * @public */ -export interface ListEnvironmentBlueprintsInput { +export interface GetTimeSeriesDataPointInput { /** - *

The identifier of the Amazon DataZone domain.

+ *

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 maximum number of blueprints to return in a single call to - * ListEnvironmentBlueprints. When the number of blueprints to be listed is - * greater than the value of MaxResults, the response contains a - * NextToken value that you can use in a subsequent call to - * ListEnvironmentBlueprints to list the next set of blueprints.

+ *

The ID of the asset for which you want to get the data point.

* @public */ - maxResults?: number; + entityIdentifier: string | undefined; /** - *

When the number of blueprints in the environment is greater than the default value for - * the MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of blueprints in the environment, - * the response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to - * ListEnvironmentBlueprintsto list the next set of blueprints.

+ *

The type of the asset for which you want to get the data point.

* @public */ - nextToken?: string; + entityType: TimeSeriesEntityType | undefined; /** - *

The name of the Amazon DataZone environment.

+ *

The ID of the data point that you want to get.

* @public */ - name?: string; + identifier: string | undefined; /** - *

Specifies whether the environment blueprint is managed by Amazon DataZone.

+ *

The name of the time series form that houses the data point that you want to get.

* @public */ - managed?: boolean; + formName: string | undefined; } /** - *

The details of an environment blueprint summary.

+ *

The time series data points form.

* @public */ -export interface EnvironmentBlueprintSummary { - /** - *

The identifier of the blueprint.

- * @public - */ - id: string | undefined; - +export interface TimeSeriesDataPointFormOutput { /** - *

The name of the blueprint.

+ *

The name of the time series data points form.

* @public */ - name: string | undefined; + formName: string | undefined; /** - *

The description of a blueprint.

+ *

The ID of the type of the time series data points form.

* @public */ - description?: string; + typeIdentifier: string | undefined; /** - *

The provider of the blueprint.

+ *

The revision type of the time series data points form.

* @public */ - provider: string | undefined; + typeRevision?: string; /** - *

The provisioning properties of the blueprint.

+ *

The timestamp of the time series data points form.

* @public */ - provisioningProperties: ProvisioningProperties | undefined; + timestamp: Date | undefined; /** - *

The timestamp of when an environment blueprint was created.

+ *

The content of the time series data points form.

* @public */ - createdAt?: Date; + content?: string; /** - *

The timestamp of when the blueprint was enabled.

+ *

The ID of the time series data points form.

* @public */ - updatedAt?: Date; + id?: string; } /** * @public */ -export interface ListEnvironmentBlueprintsOutput { +export interface GetTimeSeriesDataPointOutput { /** - *

The results of the ListEnvironmentBlueprints action.

+ *

The ID of the Amazon DataZone domain that houses the asset data point that you want to + * get.

* @public */ - items: EnvironmentBlueprintSummary[] | undefined; + domainId?: string; /** - *

When the number of blueprints in the environment is greater than the default value for - * the MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of blueprints in the environment, - * the response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to - * ListEnvironmentBlueprintsto list the next set of blueprints.

+ *

The ID of the asset for which you want to get the data point.

* @public */ - nextToken?: string; + 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 ListEnvironmentProfilesInput { +export interface GetUserProfileInput { /** - *

The identifier of the Amazon DataZone domain.

+ *

the ID of the Amazon DataZone domain the data portal of which you want to get.

* @public */ domainIdentifier: string | undefined; /** - *

The identifier of the Amazon Web Services account where you want to list environment - * profiles.

+ *

The identifier of the user for which you want to get the user profile.

* @public */ - awsAccountId?: string; + userIdentifier: string | undefined; /** - *

The Amazon Web Services region where you want to list environment profiles.

+ *

The type of the user profile.

* @public */ - awsAccountRegion?: string; + type?: UserProfileType; +} +/** + * @public + */ +export interface GetUserProfileOutput { /** - *

The identifier of the blueprint that was used to create the environment profiles that - * you want to list.

+ *

the identifier of the Amazon DataZone domain of which you want to get the user + * profile.

* @public */ - environmentBlueprintIdentifier?: string; + domainId?: string; /** - *

The identifier of the Amazon DataZone project.

+ *

The identifier of the user profile.

* @public */ - projectIdentifier?: string; + id?: string; /** - *

+ *

The type of the user profile.

* @public */ - name?: string; + type?: UserProfileType; /** - *

When the number of environment profiles is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of environment profiles, the - * response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to - * ListEnvironmentProfiles to list the next set of environment - * profiles.

+ *

The status of the user profile.

* @public */ - nextToken?: string; + status?: UserProfileStatus; /** - *

The maximum number of environment profiles to return in a single call to - * ListEnvironmentProfiles. When the number of environment profiles to be - * listed is greater than the value of MaxResults, the response contains a - * NextToken value that you can use in a subsequent call to - * ListEnvironmentProfiles to list the next set of environment - * profiles.

+ *

The details of the user profile in Amazon DataZone.

* @public */ - maxResults?: number; + details?: UserProfileDetails; } /** - *

The details of an environment profile.

* @public */ -export interface EnvironmentProfileSummary { +export interface DeleteGlossaryInput { /** - *

The identifier of the environment profile.

+ *

The ID of the Amazon DataZone domain in which the business glossary is deleted.

* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *

The identifier of the Amazon DataZone domain in which the environment profile exists.

+ *

The ID of the business glossary that is deleted.

* @public */ - domainId: string | undefined; + identifier: string | undefined; +} + +/** + * @public + */ +export interface DeleteGlossaryOutput {} +/** + * @public + */ +export interface GetGlossaryInput { /** - *

The identifier of an Amazon Web Services account in which an environment profile exists.

+ *

The ID of the Amazon DataZone domain in which this business glossary exists.

* @public */ - awsAccountId?: string; + domainIdentifier: string | undefined; /** - *

The Amazon Web Services Region in which an environment profile exists.

+ *

The ID of the business glossary.

* @public */ - awsAccountRegion?: string; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetGlossaryOutput { /** - *

The Amazon DataZone user who created the environment profile.

+ *

The ID of the Amazon DataZone domain in which this business glossary exists.

* @public */ - createdBy: string | undefined; + domainId: string | undefined; /** - *

The timestamp of when an environment profile was created.

+ *

The ID of the business glossary.

* @public */ - createdAt?: Date; + id: string | undefined; /** - *

The timestamp of when the environment profile was updated.

+ *

The ID of the project that owns this business glossary.

* @public */ - updatedAt?: Date; + owningProjectId: string | undefined; /** - *

The name of the environment profile.

+ *

The name of the business glossary.

* @public */ name: string | undefined; /** - *

The description of the environment profile.

+ *

The description of the business glossary.

* @public */ description?: string; /** - *

The identifier of a blueprint with which an environment profile is created.

+ *

The status of the business glossary.

* @public */ - environmentBlueprintId: string | undefined; + status: GlossaryStatus | undefined; + + /** + *

The timestamp of when this business glossary was created.

+ * @public + */ + createdAt?: Date; /** - *

The identifier of a project in which an environment profile exists.

+ *

The Amazon DataZone user who created this business glossary.

* @public */ - projectId?: string; -} + createdBy?: string; -/** - * @public - */ -export interface ListEnvironmentProfilesOutput { /** - *

The results of the ListEnvironmentProfiles action.

+ *

The timestamp of when the business glossary was updated.

* @public */ - items: EnvironmentProfileSummary[] | undefined; + updatedAt?: Date; /** - *

When the number of environment profiles is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of environment profiles, the - * response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to - * ListEnvironmentProfiles to list the next set of environment - * profiles.

+ *

The Amazon DataZone user who updated the business glossary.

* @public */ - nextToken?: string; + updatedBy?: string; } /** * @public */ -export interface ListEnvironmentsInput { +export interface UpdateGlossaryInput { /** - *

The identifier of the Amazon DataZone domain.

+ *

The identifier of the Amazon DataZone domain in which a business glossary is to be + * updated.

* @public */ domainIdentifier: string | undefined; /** - *

The identifier of the Amazon Web Services account where you want to list - * environments.

+ *

The identifier of the business glossary to be updated.

* @public */ - awsAccountId?: string; + identifier: string | undefined; /** - *

The status of the environments that you want to list.

+ *

The name to be updated as part of the UpdateGlossary action.

* @public */ - status?: EnvironmentStatus; + name?: string; /** - *

The Amazon Web Services region where you want to list environments.

+ *

The description to be updated as part of the UpdateGlossary action.

* @public */ - awsAccountRegion?: string; + description?: string; /** - *

The identifier of the Amazon DataZone project.

+ *

The status to be updated as part of the UpdateGlossary action.

* @public */ - projectIdentifier: string | undefined; + status?: GlossaryStatus; + + /** + *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

+ * @public + */ + clientToken?: string; +} +/** + * @public + */ +export interface UpdateGlossaryOutput { /** - *

The identifier of the environment profile.

+ *

The identifier of the Amazon DataZone domain in which a business glossary is to be + * updated.

* @public */ - environmentProfileIdentifier?: string; + domainId: string | undefined; /** - *

The identifier of the Amazon DataZone blueprint.

+ *

The identifier of the business glossary that is to be updated.

* @public */ - environmentBlueprintIdentifier?: string; + id: string | undefined; /** - *

The provider of the environment.

+ *

The name to be updated as part of the UpdateGlossary action.

* @public */ - provider?: string; + name: string | undefined; /** - *

The name of the environment.

+ *

The identifier of the project in which to update a business glossary.

* @public */ - name?: string; + owningProjectId: string | undefined; /** - *

The maximum number of environments to return in a single call to - * ListEnvironments. When the number of environments to be listed is greater - * than the value of MaxResults, the response contains a NextToken - * value that you can use in a subsequent call to ListEnvironments to list the - * next set of environments.

+ *

The description to be updated as part of the UpdateGlossary action.

* @public */ - maxResults?: number; + description?: string; /** - *

When the number of environments is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of environments, the response - * includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListEnvironments to - * list the next set of environments.

+ *

The status to be updated as part of the UpdateGlossary action.

* @public */ - nextToken?: string; + status?: GlossaryStatus; } /** - *

The details of an environment.

* @public */ -export interface EnvironmentSummary { +export interface DeleteGlossaryTermInput { /** - *

The identifier of the project in which the environment exists.

+ *

The ID of the Amazon DataZone domain in which the business glossary term is deleted.

* @public */ - projectId: string | undefined; + domainIdentifier: string | undefined; /** - *

The identifier of the environment.

+ *

The ID of the business glossary term that is deleted.

* @public */ - id?: string; + identifier: string | undefined; +} - /** - *

The identifier of the Amazon DataZone domain in which the environment exists.

- * @public - */ - domainId: string | undefined; +/** + * @public + */ +export interface DeleteGlossaryTermOutput {} +/** + * @public + */ +export interface GetGlossaryTermInput { /** - *

The Amazon DataZone user who created the environment.

+ *

The ID of the Amazon DataZone domain in which this business glossary term exists.

* @public */ - createdBy: string | undefined; + domainIdentifier: string | undefined; /** - *

The timestamp of when the environment was created.

+ *

The ID of the business glossary term.

* @public */ - createdAt?: Date; + identifier: string | undefined; +} +/** + * @public + */ +export interface GetGlossaryTermOutput { /** - *

The timestamp of when the environment was updated.

+ *

The ID of the Amazon DataZone domain in which this business glossary term exists.

* @public */ - updatedAt?: Date; + domainId: string | undefined; /** - *

The name of the environment.

+ *

The ID of the business glossary to which this term belongs.

* @public */ - name: string | undefined; + glossaryId: string | undefined; /** - *

The description of the environment.

+ *

The ID of the business glossary term.

* @public */ - description?: string; + id: string | undefined; /** - *

The identifier of the environment profile with which the environment was created.

+ *

The name of the business glossary term.

* @public */ - environmentProfileId?: string; + name: string | undefined; /** - *

The identifier of the Amazon Web Services account in which an environment exists.

+ *

The short decription of the business glossary term.

* @public */ - awsAccountId?: string; + shortDescription?: string; /** - *

The Amazon Web Services Region in which an environment exists.

+ *

The long description of the business glossary term.

* @public */ - awsAccountRegion?: string; + longDescription?: string; /** - *

The provider of the environment.

+ *

The relations of the business glossary term.

* @public */ - provider: string | undefined; + termRelations?: TermRelations; /** - *

The status of the environment.

+ *

The status of the business glossary term.

* @public */ - status?: EnvironmentStatus; -} + status: GlossaryTermStatus | undefined; -/** - * @public - */ -export interface ListEnvironmentsOutput { /** - *

The results of the ListEnvironments action.

+ *

The timestamp of when the business glossary term was created.

* @public */ - items: EnvironmentSummary[] | undefined; + createdAt?: Date; /** - *

When the number of environments is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of environments, the response - * includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListEnvironments to - * list the next set of environments.

+ *

The Amazon DataZone user who created the business glossary.

* @public */ - nextToken?: string; -} + createdBy?: string; -/** - * @public - */ -export interface DeleteListingInput { /** - *

The ID of the Amazon DataZone domain.

+ *

The timestamp of when the business glossary term was updated.

* @public */ - domainIdentifier: string | undefined; + updatedAt?: Date; /** - *

The ID of the listing to be deleted.

+ *

The Amazon DataZone user who updated the business glossary term.

* @public */ - identifier: string | undefined; + updatedBy?: string; } /** * @public */ -export interface DeleteListingOutput {} - -/** - * @public - */ -export interface GetListingInput { +export interface UpdateGlossaryTermInput { /** - *

The ID of the Amazon DataZone domain.

+ *

The identifier of the Amazon DataZone domain in which a business glossary term is to be + * updated.

* @public */ domainIdentifier: string | undefined; /** - *

The ID of the listing.

+ *

The identifier of the business glossary in which a term is to be updated.

* @public */ - identifier: string | undefined; + glossaryIdentifier?: string; /** - *

The revision of the listing.

+ *

The identifier of the business glossary term that is to be updated.

* @public */ - listingRevision?: string; -} - -/** - *

The details of a listing (aka asset published in a Amazon DataZone catalog).

- * @public - */ -export type ListingItem = ListingItem.AssetListingMember | ListingItem.$UnknownMember; + identifier: string | undefined; -/** - * @public - */ -export namespace ListingItem { /** - *

An asset published in an Amazon DataZone catalog.

+ *

The name to be updated as part of the UpdateGlossaryTerm action.

* @public */ - export interface AssetListingMember { - assetListing: AssetListing; - $unknown?: never; - } + name?: string; /** + *

The short description to be updated as part of the UpdateGlossaryTerm + * action.

* @public */ - export interface $UnknownMember { - assetListing?: never; - $unknown: [string, any]; - } - - export interface Visitor { - assetListing: (value: AssetListing) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: ListingItem, visitor: Visitor): T => { - if (value.assetListing !== undefined) return visitor.assetListing(value.assetListing); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; -} + shortDescription?: string; -/** - * @public - */ -export interface GetListingOutput { /** - *

The ID of the Amazon DataZone domain.

+ *

The long description to be updated as part of the UpdateGlossaryTerm + * action.

* @public */ - domainId: string | undefined; + longDescription?: string; /** - *

The ID of the listing.

+ *

The term relations to be updated as part of the UpdateGlossaryTerm + * action.

* @public */ - id: string | undefined; + termRelations?: TermRelations; /** - *

The revision of a listing.

+ *

The status to be updated as part of the UpdateGlossaryTerm action.

* @public */ - listingRevision: string | undefined; + status?: GlossaryTermStatus; +} +/** + * @public + */ +export interface UpdateGlossaryTermOutput { /** - *

The timestamp of when the listing was created.

+ *

The identifier of the business glossary term that is to be updated.

* @public */ - createdAt?: Date; + id: string | undefined; /** - *

The timestamp of when the listing was updated.

+ *

The identifier of the Amazon DataZone domain in which a business glossary term is to be + * updated.

* @public */ - updatedAt?: Date; + domainId: string | undefined; /** - *

The Amazon DataZone user who created the listing.

+ *

The identifier of the business glossary in which a term is to be updated.

* @public */ - createdBy?: string; + glossaryId: string | undefined; /** - *

The Amazon DataZone user who updated the listing.

+ *

The name to be updated as part of the UpdateGlossaryTerm action.

* @public */ - updatedBy?: string; + name: string | undefined; /** - *

The details of a listing.

+ *

The status to be updated as part of the UpdateGlossaryTerm action.

* @public */ - item?: ListingItem; + status: GlossaryTermStatus | undefined; /** - *

The name of the listing.

+ *

The short description to be updated as part of the UpdateGlossaryTerm + * action.

* @public */ - name?: string; + shortDescription?: string; /** - *

The description of the listing.

+ *

The long description to be updated as part of the UpdateGlossaryTerm + * action.

* @public */ - description?: string; + longDescription?: string; /** - *

The status of the listing.

+ *

The term relations to be updated as part of the UpdateGlossaryTerm + * action.

* @public */ - status?: ListingStatus; -} - -/** - * @public - * @enum - */ -export const EdgeDirection = { - DOWNSTREAM: "DOWNSTREAM", - UPSTREAM: "UPSTREAM", -} as const; - -/** - * @public - */ -export type EdgeDirection = (typeof EdgeDirection)[keyof typeof EdgeDirection]; - -/** - * @public - * @enum - */ -export const SortOrder = { - ASCENDING: "ASCENDING", - DESCENDING: "DESCENDING", -} as const; - -/** - * @public - */ -export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; + termRelations?: TermRelations; +} /** * @public */ -export interface ListLineageNodeHistoryInput { +export interface ListAssetFiltersInput { /** - *

The ID of the domain where you want to list the history of the specified data lineage - * node.

+ *

The ID of the domain where you want to list asset filters.

* @public */ domainIdentifier: string | undefined; /** - *

The maximum number of history items to return in a single call to - * ListLineageNodeHistory. When the number of memberships to be listed is greater than the - * value of MaxResults, the response contains a NextToken value that you can use in a - * subsequent call to ListLineageNodeHistory to list the next set of items.

- * @public - */ - maxResults?: number; - - /** - *

When the number of history items is greater than the default value for the MaxResults - * parameter, or if you explicitly specify a value for MaxResults that is less than the number - * of items, the response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of - * items.

+ *

The ID of the data asset.

* @public */ - nextToken?: string; + assetIdentifier: string | undefined; /** - *

The ID of the data lineage node whose history you want to list.

+ *

The status of the asset filter.

* @public */ - identifier: string | undefined; + status?: FilterStatus; /** - *

The direction of the data lineage node refers to the lineage node having neighbors in - * that direction. For example, if direction is UPSTREAM, the - * ListLineageNodeHistory API responds with historical versions with upstream - * neighbors only.

+ *

When the number of asset filters is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of asset filters, the response + * includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListAssetFilters to + * list the next set of asset filters.

* @public */ - direction?: EdgeDirection; + nextToken?: string; /** - *

Specifies whether the action is to return data lineage node history from the time after - * the event timestamp.

+ *

The maximum number of asset filters to return in a single call to + * ListAssetFilters. When the number of asset filters to be listed is greater + * than the value of MaxResults, the response contains a NextToken + * value that you can use in a subsequent call to ListAssetFilters to list the + * next set of asset filters.

* @public */ - eventTimestampGTE?: Date; + maxResults?: number; +} +/** + * @public + */ +export interface ListAssetFiltersOutput { /** - *

Specifies whether the action is to return data lineage node history from the time prior - * of the event timestamp.

+ *

The results of the ListAssetFilters action.

* @public */ - eventTimestampLTE?: Date; + items: AssetFilterSummary[] | undefined; /** - *

The order by which you want data lineage node history to be sorted.

+ *

When the number of asset filters is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of asset filters, the response + * includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListAssetFilters to + * list the next set of asset filters.

* @public */ - sortOrder?: SortOrder; + nextToken?: string; } /** - *

The summary of the data lineage node.

* @public */ -export interface LineageNodeSummary { - /** - *

The ID of the domain of the data lineage node.

- * @public - */ - domainId: string | undefined; - +export interface ListAssetRevisionsInput { /** - *

The name of the data lineage node.

+ *

The identifier of the domain.

* @public */ - name?: string; + domainIdentifier: string | undefined; /** - *

The description of the data lineage node.

+ *

The identifier of the asset.

* @public */ - description?: string; + identifier: string | undefined; /** - *

The timestamp at which the data lineage node was created.

+ *

When the number of revisions is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of revisions, the response includes + * a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListAssetRevisions to + * list the next set of revisions.

* @public */ - createdAt?: Date; + nextToken?: string; /** - *

The user who created the data lineage node.

+ *

The maximum number of revisions to return in a single call to + * ListAssetRevisions. When the number of revisions to be listed is greater + * than the value of MaxResults, the response contains a NextToken + * value that you can use in a subsequent call to ListAssetRevisions to list the + * next set of revisions.

* @public */ - createdBy?: string; + maxResults?: number; +} +/** + * @public + */ +export interface ListAssetRevisionsOutput { /** - *

The timestamp at which the data lineage node was updated.

+ *

The results of the ListAssetRevisions action.

* @public */ - updatedAt?: Date; + items?: AssetRevision[]; /** - *

The user who updated the data lineage node.

+ *

When the number of revisions is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of revisions, the response includes + * a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListAssetRevisions to + * list the next set of revisions.

* @public */ - updatedBy?: string; + nextToken?: string; +} +/** + * @public + */ +export interface ListDataSourceRunActivitiesInput { /** - *

The ID of the data lineage node.

+ *

The identifier of the Amazon DataZone domain in which to list data source run + * activities.

* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *

The name of the type of the data lineage node.

+ *

The identifier of the data source run.

* @public */ - typeName: string | undefined; + identifier: string | undefined; /** - *

The type of the revision of the data lineage node.

+ *

The status of the data source run.

* @public */ - typeRevision?: string; + status?: DataAssetActivityStatus; /** - *

The alternate ID of the data lineage node.

+ *

When the number of activities is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of activities, the response + * includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to + * ListDataSourceRunActivities to list the next set of activities.

* @public */ - sourceIdentifier?: string; + nextToken?: string; /** - *

The event timestamp of the data lineage node.

+ *

The maximum number of activities to return in a single call to + * ListDataSourceRunActivities. When the number of activities to be listed is + * greater than the value of MaxResults, the response contains a + * NextToken value that you can use in a subsequent call to + * ListDataSourceRunActivities to list the next set of activities.

* @public */ - eventTimestamp?: Date; + maxResults?: number; } /** * @public */ -export interface ListLineageNodeHistoryOutput { +export interface ListDataSourceRunActivitiesOutput { /** - *

The nodes returned by the ListLineageNodeHistory action.

+ *

The results of the ListDataSourceRunActivities action.

* @public */ - nodes?: LineageNodeSummary[]; + items: DataSourceRunActivity[] | undefined; /** - *

When the number of history items is greater than the default value for the MaxResults - * parameter, or if you explicitly specify a value for MaxResults that is less than the number - * of items, the response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of - * items.

+ *

When the number of activities is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of activities, the response + * includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to + * ListDataSourceRunActivities to list the next set of activities.

* @public */ nextToken?: string; @@ -10846,89 +10741,103 @@ export interface ListLineageNodeHistoryOutput { /** * @public - * @enum */ -export const TaskStatus = { - ACTIVE: "ACTIVE", - INACTIVE: "INACTIVE", -} as const; +export interface ListEnvironmentActionsInput { + /** + *

The ID of the Amazon DataZone domain in which the environment actions are listed.

+ * @public + */ + domainIdentifier: string | undefined; -/** - * @public - */ -export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus]; + /** + *

The ID of the envrironment whose environment actions are listed.

+ * @public + */ + environmentIdentifier: string | undefined; -/** - * @public - * @enum - */ -export const NotificationType = { - EVENT: "EVENT", - TASK: "TASK", -} as const; + /** + *

When the number of environment actions is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of environment actions, the + * response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListEnvironmentActions + * to list the next set of environment actions.

+ * @public + */ + nextToken?: string; -/** - * @public - */ -export type NotificationType = (typeof NotificationType)[keyof typeof NotificationType]; + /** + *

The maximum number of environment actions to return in a single call to + * ListEnvironmentActions. When the number of environment actions to be listed + * is greater than the value of MaxResults, the response contains a + * NextToken value that you can use in a subsequent call to + * ListEnvironmentActions to list the next set of environment actions.

+ * @public + */ + maxResults?: number; +} /** + *

The details about the specified action configured for an environment. For example, the + * details of the specified console links for an analytics tool that is available in this + * environment.

* @public */ -export interface ListNotificationsInput { +export interface EnvironmentActionSummary { /** - *

The identifier of the Amazon DataZone domain.

+ *

The Amazon DataZone domain ID of the environment action.

* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *

The type of notifications.

+ *

The environment ID of the environment action.

* @public */ - type: NotificationType | undefined; + environmentId: string | undefined; /** - *

The time after which you want to list notifications.

+ *

The ID of the environment action.

* @public */ - afterTimestamp?: Date; + id: string | undefined; /** - *

The time before which you want to list notifications.

+ *

The name of the environment action.

* @public */ - beforeTimestamp?: Date; + name: string | undefined; /** - *

The subjects of notifications.

+ *

The parameters of the environment action.

* @public */ - subjects?: string[]; + parameters: ActionParameters | undefined; /** - *

The task status of notifications.

+ *

The environment action description.

* @public */ - taskStatus?: TaskStatus; + description?: string; +} +/** + * @public + */ +export interface ListEnvironmentActionsOutput { /** - *

The maximum number of notifications to return in a single call to - * ListNotifications. When the number of notifications to be listed is greater - * than the value of MaxResults, the response contains a NextToken - * value that you can use in a subsequent call to ListNotifications to list the - * next set of notifications.

+ *

The results of ListEnvironmentActions.

* @public */ - maxResults?: number; + items?: EnvironmentActionSummary[]; /** - *

When the number of notifications is greater than the default value for the + *

When the number of environment actions is greater than the default value for the * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of 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 environment actions, the + * response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListEnvironmentActions + * to list the next set of environment actions.

* @public */ nextToken?: string; @@ -11104,6 +11013,15 @@ export const GetAssetOutputFilterSensitiveLog = (obj: GetAssetOutput): any => ({ }), }); +/** + * @internal + */ +export const AssetFilterSummaryFilterSensitiveLog = (obj: AssetFilterSummary): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), +}); + /** * @internal */ @@ -11761,83 +11679,15 @@ export const UpdateGlossaryTermOutputFilterSensitiveLog = (obj: UpdateGlossaryTe /** * @internal */ -export const ListDataSourceRunActivitiesOutputFilterSensitiveLog = (obj: ListDataSourceRunActivitiesOutput): any => ({ - ...obj, - ...(obj.items && { items: obj.items.map((item) => DataSourceRunActivityFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const EnvironmentBlueprintSummaryFilterSensitiveLog = (obj: EnvironmentBlueprintSummary): any => ({ - ...obj, - ...(obj.description && { description: SENSITIVE_STRING }), - ...(obj.provisioningProperties && { provisioningProperties: obj.provisioningProperties }), -}); - -/** - * @internal - */ -export const ListEnvironmentBlueprintsOutputFilterSensitiveLog = (obj: ListEnvironmentBlueprintsOutput): any => ({ - ...obj, - ...(obj.items && { items: obj.items.map((item) => EnvironmentBlueprintSummaryFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const ListEnvironmentProfilesInputFilterSensitiveLog = (obj: ListEnvironmentProfilesInput): any => ({ - ...obj, - ...(obj.name && { name: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const EnvironmentProfileSummaryFilterSensitiveLog = (obj: EnvironmentProfileSummary): any => ({ - ...obj, - ...(obj.name && { name: SENSITIVE_STRING }), - ...(obj.description && { description: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const ListEnvironmentProfilesOutputFilterSensitiveLog = (obj: ListEnvironmentProfilesOutput): any => ({ - ...obj, - ...(obj.items && { items: obj.items.map((item) => EnvironmentProfileSummaryFilterSensitiveLog(item)) }), -}); - -/** - * @internal - */ -export const EnvironmentSummaryFilterSensitiveLog = (obj: EnvironmentSummary): any => ({ - ...obj, - ...(obj.name && { name: SENSITIVE_STRING }), - ...(obj.description && { description: SENSITIVE_STRING }), -}); - -/** - * @internal - */ -export const ListEnvironmentsOutputFilterSensitiveLog = (obj: ListEnvironmentsOutput): any => ({ +export const ListAssetFiltersOutputFilterSensitiveLog = (obj: ListAssetFiltersOutput): any => ({ ...obj, - ...(obj.items && { items: obj.items.map((item) => EnvironmentSummaryFilterSensitiveLog(item)) }), + ...(obj.items && { items: obj.items.map((item) => AssetFilterSummaryFilterSensitiveLog(item)) }), }); /** * @internal */ -export const ListingItemFilterSensitiveLog = (obj: ListingItem): any => { - if (obj.assetListing !== undefined) return { assetListing: AssetListingFilterSensitiveLog(obj.assetListing) }; - if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; -}; - -/** - * @internal - */ -export const GetListingOutputFilterSensitiveLog = (obj: GetListingOutput): any => ({ +export const ListDataSourceRunActivitiesOutputFilterSensitiveLog = (obj: ListDataSourceRunActivitiesOutput): any => ({ ...obj, - ...(obj.item && { item: ListingItemFilterSensitiveLog(obj.item) }), - ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.items && { items: obj.items.map((item) => DataSourceRunActivityFilterSensitiveLog(item)) }), }); diff --git a/clients/client-datazone/src/models/models_1.ts b/clients/client-datazone/src/models/models_1.ts index 05afa2458c0cc..3dbe2731fc389 100644 --- a/clients/client-datazone/src/models/models_1.ts +++ b/clients/client-datazone/src/models/models_1.ts @@ -5,10 +5,13 @@ import { ActionParameters, AssetItem, AssetItemFilterSensitiveLog, + AssetListing, + AssetListingFilterSensitiveLog, AssetListingItem, AssetListingItemFilterSensitiveLog, AssetTypeItem, AssetTypeItemFilterSensitiveLog, + ColumnFilterConfiguration, ConfigurableEnvironmentAction, CustomParameter, CustomParameterFilterSensitiveLog, @@ -19,6 +22,7 @@ import { EnvironmentParameter, EnvironmentStatus, FailureCause, + FilterStatus, FormEntryOutput, FormEntryOutputFilterSensitiveLog, FormTypeStatus, @@ -28,13 +32,13 @@ import { GroupProfileStatus, Import, ImportFilterSensitiveLog, + ListingStatus, Model, - NotificationType, ProjectDeletionError, ProjectStatus, ProvisioningProperties, Resource, - SortOrder, + RowFilterExpression, SubscribedAsset, SubscribedListing, SubscribedListingFilterSensitiveLog, @@ -45,7 +49,6 @@ import { SubscriptionRequestStatus, SubscriptionStatus, SubscriptionTargetForm, - TaskStatus, TermRelations, TimeSeriesDataPointFormOutput, TimeSeriesDataPointSummaryFormOutput, @@ -57,486 +60,463 @@ import { UserProfileType, } from "./models_0"; -/** - * @public - * @enum - */ -export const NotificationResourceType = { - PROJECT: "PROJECT", -} as const; - /** * @public */ -export type NotificationResourceType = (typeof NotificationResourceType)[keyof typeof NotificationResourceType]; +export interface ListEnvironmentBlueprintsInput { + /** + *

The identifier of the Amazon DataZone domain.

+ * @public + */ + domainIdentifier: string | undefined; -/** - *

The details of the resource mentioned in a notification.

- * @public - */ -export interface NotificationResource { /** - *

The type of the resource mentioned in a notification.

+ *

The maximum number of blueprints to return in a single call to + * ListEnvironmentBlueprints. When the number of blueprints to be listed is + * greater than the value of MaxResults, the response contains a + * NextToken value that you can use in a subsequent call to + * ListEnvironmentBlueprints to list the next set of blueprints.

* @public */ - type: NotificationResourceType | undefined; + maxResults?: number; /** - *

The ID of the resource mentioned in a notification.

+ *

When the number of blueprints in the environment is greater than the default value for + * the MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of blueprints in the environment, + * the response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to + * ListEnvironmentBlueprintsto list the next set of blueprints.

* @public */ - id: string | undefined; + nextToken?: string; /** - *

The name of the resource mentioned in a notification.

+ *

The name of the Amazon DataZone environment.

* @public */ name?: string; -} - -/** - * @public - * @enum - */ -export const NotificationRole = { - DOMAIN_OWNER: "DOMAIN_OWNER", - PROJECT_CONTRIBUTOR: "PROJECT_CONTRIBUTOR", - PROJECT_OWNER: "PROJECT_OWNER", - PROJECT_SUBSCRIBER: "PROJECT_SUBSCRIBER", - PROJECT_VIEWER: "PROJECT_VIEWER", -} as const; -/** - * @public - */ -export type NotificationRole = (typeof NotificationRole)[keyof typeof NotificationRole]; + /** + *

Specifies whether the environment blueprint is managed by Amazon DataZone.

+ * @public + */ + managed?: boolean; +} /** - *

The topic of the notification.

+ *

The details of an environment blueprint summary.

* @public */ -export interface Topic { +export interface EnvironmentBlueprintSummary { /** - *

The subject of the resource mentioned in a notification.

+ *

The identifier of the blueprint.

* @public */ - subject: string | undefined; + id: string | undefined; /** - *

The details of the resource mentioned in a notification.

+ *

The name of the blueprint.

* @public */ - resource: NotificationResource | undefined; + name: string | undefined; /** - *

The role of the resource mentioned in a notification.

+ *

The description of a blueprint.

* @public */ - role: NotificationRole | undefined; -} + description?: string; -/** - *

The details of a notification generated in Amazon DataZone.

- * @public - */ -export interface NotificationOutput { /** - *

The identifier of the notification.

+ *

The provider of the blueprint.

* @public */ - identifier: string | undefined; + provider: string | undefined; /** - *

The identifier of a Amazon DataZone domain in which the notification exists.

+ *

The provisioning properties of the blueprint.

* @public */ - domainIdentifier: string | undefined; + provisioningProperties: ProvisioningProperties | undefined; /** - *

The type of the notification.

+ *

The timestamp of when an environment blueprint was created.

* @public */ - type: NotificationType | undefined; + createdAt?: Date; /** - *

The topic of the notification.

+ *

The timestamp of when the blueprint was enabled.

* @public */ - topic: Topic | undefined; + updatedAt?: Date; +} +/** + * @public + */ +export interface ListEnvironmentBlueprintsOutput { /** - *

The title of the notification.

+ *

The results of the ListEnvironmentBlueprints action.

* @public */ - title: string | undefined; + items: EnvironmentBlueprintSummary[] | undefined; /** - *

The message included in the notification.

+ *

When the number of blueprints in the environment is greater than the default value for + * the MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of blueprints in the environment, + * the response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to + * ListEnvironmentBlueprintsto list the next set of blueprints.

* @public */ - message: string | undefined; + nextToken?: string; +} +/** + * @public + */ +export interface ListEnvironmentProfilesInput { /** - *

The status included in the notification.

+ *

The identifier of the Amazon DataZone domain.

* @public */ - status?: TaskStatus; + domainIdentifier: string | undefined; /** - *

The action link included in the notification.

+ *

The identifier of the Amazon Web Services account where you want to list environment + * profiles.

* @public */ - actionLink: string | undefined; + awsAccountId?: string; /** - *

The timestamp of when a notification was created.

+ *

The Amazon Web Services region where you want to list environment profiles.

* @public */ - creationTimestamp: Date | undefined; + awsAccountRegion?: string; /** - *

The timestamp of when the notification was last updated.

+ *

The identifier of the blueprint that was used to create the environment profiles that + * you want to list.

* @public */ - lastUpdatedTimestamp: Date | undefined; + environmentBlueprintIdentifier?: string; /** - *

The metadata included in the notification.

+ *

The identifier of the Amazon DataZone project.

* @public */ - metadata?: Record; -} + projectIdentifier?: string; -/** - * @public - */ -export interface ListNotificationsOutput { /** - *

The results of the ListNotifications action.

+ *

* @public */ - notifications?: NotificationOutput[]; + name?: string; /** - *

When the number of notifications is greater than the default value for the + *

When the number of environment profiles is greater than the default value for the * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of 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 environment profiles, the + * response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to + * ListEnvironmentProfiles to list the next set of environment + * profiles.

* @public */ nextToken?: string; -} - -/** - * @public - * @enum - */ -export const SortFieldProject = { - NAME: "NAME", -} as const; -/** - * @public - */ -export type SortFieldProject = (typeof SortFieldProject)[keyof typeof SortFieldProject]; + /** + *

The maximum number of environment profiles to return in a single call to + * ListEnvironmentProfiles. When the number of environment profiles to be + * listed is greater than the value of MaxResults, the response contains a + * NextToken value that you can use in a subsequent call to + * ListEnvironmentProfiles to list the next set of environment + * profiles.

+ * @public + */ + maxResults?: number; +} /** + *

The details of an environment profile.

* @public */ -export interface ListProjectMembershipsInput { +export interface EnvironmentProfileSummary { /** - *

The identifier of the Amazon DataZone domain in which you want to list project - * memberships.

+ *

The identifier of the environment profile.

* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *

The identifier of the project whose memberships you want to list.

+ *

The identifier of the Amazon DataZone domain in which the environment profile exists.

* @public */ - projectIdentifier: string | undefined; + domainId: string | undefined; /** - *

The method by which you want to sort the project memberships.

+ *

The identifier of an Amazon Web Services account in which an environment profile exists.

* @public */ - sortBy?: SortFieldProject; + awsAccountId?: string; /** - *

The sort order of the project memberships.

+ *

The Amazon Web Services Region in which an environment profile exists.

* @public */ - sortOrder?: SortOrder; + awsAccountRegion?: string; /** - *

When the number of memberships is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of memberships, the response - * includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListProjectMemberships - * to list the next set of memberships.

+ *

The Amazon DataZone user who created the environment profile.

* @public */ - nextToken?: string; + createdBy: string | undefined; /** - *

The maximum number of memberships to return in a single call to - * ListProjectMemberships. When the number of memberships to be listed is - * greater than the value of MaxResults, the response contains a - * NextToken value that you can use in a subsequent call to - * ListProjectMemberships to list the next set of memberships.

+ *

The timestamp of when an environment profile was created.

* @public */ - maxResults?: number; -} + createdAt?: Date; -/** - *

The details of a group in Amazon DataZone.

- * @public - */ -export interface GroupDetails { /** - *

The identifier of the group in Amazon DataZone.

+ *

The timestamp of when the environment profile was updated.

* @public */ - groupId: string | undefined; -} + updatedAt?: Date; -/** - *

The user details of a project member.

- * @public - */ -export interface UserDetails { /** - *

The identifier of the Amazon DataZone user.

+ *

The name of the environment profile.

* @public */ - userId: string | undefined; -} - -/** - *

The details about a project member.

- * @public - */ -export type MemberDetails = MemberDetails.GroupMember | MemberDetails.UserMember | MemberDetails.$UnknownMember; + name: string | undefined; -/** - * @public - */ -export namespace MemberDetails { /** - *

The user details of a project member.

+ *

The description of the environment profile.

* @public */ - export interface UserMember { - user: UserDetails; - group?: never; - $unknown?: never; - } + description?: string; /** - *

The group details of a project member.

+ *

The identifier of a blueprint with which an environment profile is created.

* @public */ - export interface GroupMember { - user?: never; - group: GroupDetails; - $unknown?: never; - } + environmentBlueprintId: string | undefined; /** + *

The identifier of a project in which an environment profile exists.

* @public */ - export interface $UnknownMember { - user?: never; - group?: never; - $unknown: [string, any]; - } - - export interface Visitor { - user: (value: UserDetails) => T; - group: (value: GroupDetails) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: MemberDetails, visitor: Visitor): T => { - if (value.user !== undefined) return visitor.user(value.user); - if (value.group !== undefined) return visitor.group(value.group); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + projectId?: string; } /** - *

The details of a project member.

* @public */ -export interface ProjectMember { +export interface ListEnvironmentProfilesOutput { /** - *

The membership details of a project member.

+ *

The results of the ListEnvironmentProfiles action.

* @public */ - memberDetails: MemberDetails | undefined; + items: EnvironmentProfileSummary[] | undefined; /** - *

The designated role of a project member.

+ *

When the number of environment profiles is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of environment profiles, the + * response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to + * ListEnvironmentProfiles to list the next set of environment + * profiles.

* @public */ - designation: UserDesignation | undefined; + nextToken?: string; } /** * @public */ -export interface ListProjectMembershipsOutput { +export interface ListEnvironmentsInput { /** - *

The members of the project.

+ *

The identifier of the Amazon DataZone domain.

* @public */ - members: ProjectMember[] | undefined; + domainIdentifier: string | undefined; /** - *

When the number of memberships is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of memberships, the response - * includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListProjectMemberships - * to list the next set of memberships.

+ *

The identifier of the Amazon Web Services account where you want to list + * environments.

* @public */ - nextToken?: string; -} + awsAccountId?: string; -/** - * @public - */ -export interface ListProjectsInput { /** - *

The identifier of the Amazon DataZone domain.

+ *

The status of the environments that you want to list.

* @public */ - domainIdentifier: string | undefined; + status?: EnvironmentStatus; /** - *

The identifier of the Amazon DataZone user.

+ *

The Amazon Web Services region where you want to list environments.

* @public */ - userIdentifier?: string; + awsAccountRegion?: string; /** - *

The identifier of a group.

+ *

The identifier of the Amazon DataZone project.

* @public */ - groupIdentifier?: string; + projectIdentifier: string | undefined; /** - *

The name of the project.

+ *

The identifier of the environment profile.

* @public */ - name?: string; + environmentProfileIdentifier?: string; /** - *

When the number of projects is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of projects, the response includes - * a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListProjects to list - * the next set of projects.

+ *

The identifier of the Amazon DataZone blueprint.

* @public */ - nextToken?: string; + environmentBlueprintIdentifier?: string; /** - *

The maximum number of projects to return in a single call to ListProjects. - * When the number of projects to be listed is greater than the value of - * MaxResults, the response contains a NextToken value that you - * can use in a subsequent call to ListProjects to list the next set of - * projects.

+ *

The provider of the environment.

+ * @public + */ + provider?: string; + + /** + *

The name of the environment.

+ * @public + */ + name?: string; + + /** + *

The maximum number of environments to return in a single call to + * ListEnvironments. When the number of environments to be listed is greater + * than the value of MaxResults, the response contains a NextToken + * value that you can use in a subsequent call to ListEnvironments to list the + * next set of environments.

* @public */ maxResults?: number; + + /** + *

When the number of environments is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of environments, the response + * includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListEnvironments to + * list the next set of environments.

+ * @public + */ + nextToken?: string; } /** - *

The details of a Amazon DataZone project.

+ *

The details of an environment.

* @public */ -export interface ProjectSummary { +export interface EnvironmentSummary { /** - *

The identifier of a Amazon DataZone domain where the project exists.

+ *

The identifier of the project in which the environment exists.

+ * @public + */ + projectId: string | undefined; + + /** + *

The identifier of the environment.

+ * @public + */ + id?: string; + + /** + *

The identifier of the Amazon DataZone domain in which the environment exists.

* @public */ domainId: string | undefined; /** - *

The identifier of a project.

+ *

The Amazon DataZone user who created the environment.

* @public */ - id: string | undefined; + createdBy: string | undefined; /** - *

The name of a project.

+ *

The timestamp of when the environment was created.

+ * @public + */ + createdAt?: Date; + + /** + *

The timestamp of when the environment was updated.

+ * @public + */ + updatedAt?: Date; + + /** + *

The name of the environment.

* @public */ name: string | undefined; /** - *

The description of a project.

+ *

The description of the environment.

* @public */ description?: string; /** - *

The status of the project.

+ *

The identifier of the environment profile with which the environment was created.

* @public */ - projectStatus?: ProjectStatus; + environmentProfileId?: string; /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

+ *

The identifier of the Amazon Web Services account in which an environment exists.

* @public */ - failureReasons?: ProjectDeletionError[]; + awsAccountId?: string; /** - *

The Amazon DataZone user who created the project.

+ *

The Amazon Web Services Region in which an environment exists.

* @public */ - createdBy: string | undefined; + awsAccountRegion?: string; /** - *

The timestamp of when a project was created.

+ *

The provider of the environment.

* @public */ - createdAt?: Date; + provider: string | undefined; /** - *

The timestamp of when the project was updated.

+ *

The status of the environment.

* @public */ - updatedAt?: Date; + status?: EnvironmentStatus; } /** * @public */ -export interface ListProjectsOutput { +export interface ListEnvironmentsOutput { /** - *

The results of the ListProjects action.

+ *

The results of the ListEnvironments action.

* @public */ - items?: ProjectSummary[]; + items: EnvironmentSummary[] | undefined; /** - *

When the number of projects is greater than the default value for the + *

When the number of environments is greater than the default value for the * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of projects, the response includes - * a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListProjects to list - * the next set of projects.

+ * MaxResults that is less than the number of environments, the response + * includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListEnvironments to + * list the next set of environments.

* @public */ nextToken?: string; @@ -544,346 +524,346 @@ export interface ListProjectsOutput { /** * @public - * @enum */ -export const SortKey = { - CREATED_AT: "CREATED_AT", - UPDATED_AT: "UPDATED_AT", -} as const; +export interface DeleteListingInput { + /** + *

The ID of the Amazon DataZone domain.

+ * @public + */ + domainIdentifier: string | undefined; + + /** + *

The ID of the listing to be deleted.

+ * @public + */ + identifier: string | undefined; +} /** * @public */ -export type SortKey = (typeof SortKey)[keyof typeof SortKey]; +export interface DeleteListingOutput {} /** * @public */ -export interface ListSubscriptionGrantsInput { +export interface GetListingInput { /** - *

The identifier of the Amazon DataZone domain.

+ *

The ID of the Amazon DataZone domain.

* @public */ domainIdentifier: string | undefined; /** - *

The identifier of the Amazon DataZone environment.

- * @public - */ - environmentId?: string; - - /** - *

The identifier of the subscription target.

+ *

The ID of the listing.

* @public */ - subscriptionTargetId?: string; + identifier: string | undefined; /** - *

The identifier of the subscribed listing.

+ *

The revision of the listing.

* @public */ - subscribedListingId?: string; + listingRevision?: string; +} - /** - *

The identifier of the subscription.

- * @public - */ - subscriptionId?: string; +/** + *

The details of a listing (aka asset published in a Amazon DataZone catalog).

+ * @public + */ +export type ListingItem = ListingItem.AssetListingMember | ListingItem.$UnknownMember; +/** + * @public + */ +export namespace ListingItem { /** - *

Specifies the way of sorting the results of this action.

+ *

An asset published in an Amazon DataZone catalog.

* @public */ - sortBy?: SortKey; + export interface AssetListingMember { + assetListing: AssetListing; + $unknown?: never; + } /** - *

Specifies the sort order of this action.

* @public */ - sortOrder?: SortOrder; + export interface $UnknownMember { + assetListing?: never; + $unknown: [string, any]; + } - /** - *

The maximum number of subscription grants to return in a single call to - * ListSubscriptionGrants. When the number of subscription grants to be listed - * is greater than the value of MaxResults, the response contains a - * NextToken value that you can use in a subsequent call to - * ListSubscriptionGrants to list the next set of subscription grants.

- * @public - */ - maxResults?: number; + export interface Visitor { + assetListing: (value: AssetListing) => T; + _: (name: string, value: any) => T; + } - /** - *

When the number of subscription grants is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of subscription grants, the - * response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListSubscriptionGrants - * to list the next set of subscription grants.

- * @public - */ - nextToken?: string; + export const visit = (value: ListingItem, visitor: Visitor): T => { + if (value.assetListing !== undefined) return visitor.assetListing(value.assetListing); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** - *

The details of the subscription grant.

* @public */ -export interface SubscriptionGrantSummary { +export interface GetListingOutput { /** - *

The identifier of the subscription grant.

+ *

The ID of the Amazon DataZone domain.

* @public */ - id: string | undefined; + domainId: string | undefined; /** - *

The datazone user who created the subscription grant.

+ *

The ID of the listing.

* @public */ - createdBy: string | undefined; + id: string | undefined; /** - *

The Amazon DataZone user who updated the subscription grant.

+ *

The revision of a listing.

* @public */ - updatedBy?: string; + listingRevision: string | undefined; /** - *

The identifier of the Amazon DataZone domain in which a subscription grant exists.

+ *

The timestamp of when the listing was created.

* @public */ - domainId: string | undefined; + createdAt?: Date; /** - *

The timestamp of when a subscription grant was created.

+ *

The timestamp of when the listing was updated.

* @public */ - createdAt: Date | undefined; + updatedAt?: Date; /** - *

The timestampf of when the subscription grant was updated.

+ *

The Amazon DataZone user who created the listing.

* @public */ - updatedAt: Date | undefined; + createdBy?: string; /** - *

The identifier of the target of the subscription grant.

+ *

The Amazon DataZone user who updated the listing.

* @public */ - subscriptionTargetId: string | undefined; + updatedBy?: string; /** - *

The entity to which the subscription is granted.

+ *

The details of a listing.

* @public */ - grantedEntity: GrantedEntity | undefined; + item?: ListingItem; /** - *

The status of the subscription grant.

+ *

The name of the listing.

* @public */ - status: SubscriptionGrantOverallStatus | undefined; + name?: string; /** - *

The assets included in the subscription grant.

+ *

The description of the listing.

* @public */ - assets?: SubscribedAsset[]; + description?: string; /** - *

The ID of the subscription grant.

+ *

The status of the listing.

* @public */ - subscriptionId?: string; + status?: ListingStatus; } /** * @public + * @enum */ -export interface ListSubscriptionGrantsOutput { - /** - *

The results of the ListSubscriptionGrants action.

- * @public - */ - items: SubscriptionGrantSummary[] | undefined; +export const EdgeDirection = { + DOWNSTREAM: "DOWNSTREAM", + UPSTREAM: "UPSTREAM", +} as const; - /** - *

When the number of subscription grants is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of subscription grants, the - * response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListSubscriptionGrants - * to list the next set of subscription grants.

- * @public - */ - nextToken?: string; -} +/** + * @public + */ +export type EdgeDirection = (typeof EdgeDirection)[keyof typeof EdgeDirection]; /** * @public + * @enum */ -export interface ListSubscriptionRequestsInput { +export const SortOrder = { + ASCENDING: "ASCENDING", + DESCENDING: "DESCENDING", +} as const; + +/** + * @public + */ +export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; + +/** + * @public + */ +export interface ListLineageNodeHistoryInput { /** - *

The identifier of the Amazon DataZone domain.

+ *

The ID of the domain where you want to list the history of the specified data lineage + * node.

* @public */ domainIdentifier: string | undefined; /** - *

Specifies the status of the subscription requests.

+ *

The maximum number of history items to return in a single call to + * ListLineageNodeHistory. When the number of memberships to be listed is greater than the + * value of MaxResults, the response contains a NextToken value that you can use in a + * subsequent call to ListLineageNodeHistory to list the next set of items.

* @public */ - status?: SubscriptionRequestStatus; + maxResults?: number; /** - *

The identifier of the subscribed listing.

- * @public - */ - subscribedListingId?: string; - - /** - *

The identifier of the project for the subscription requests.

+ *

When the number of history items is greater than the default value for the MaxResults + * parameter, or if you explicitly specify a value for MaxResults that is less than the number + * of items, the response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of + * items.

* @public */ - owningProjectId?: string; + nextToken?: string; /** - *

The identifier of the subscription request approver's project.

+ *

The ID of the data lineage node whose history you want to list.

* @public */ - approverProjectId?: string; + identifier: string | undefined; /** - *

Specifies the way to sort the results of this action.

+ *

The direction of the data lineage node refers to the lineage node having neighbors in + * that direction. For example, if direction is UPSTREAM, the + * ListLineageNodeHistory API responds with historical versions with upstream + * neighbors only.

* @public */ - sortBy?: SortKey; + direction?: EdgeDirection; /** - *

Specifies the sort order for the results of this action.

+ *

Specifies whether the action is to return data lineage node history from the time after + * the event timestamp.

* @public */ - sortOrder?: SortOrder; + eventTimestampGTE?: Date; /** - *

The maximum number of subscription requests to return in a single call to - * ListSubscriptionRequests. When the number of subscription requests to be - * listed is greater than the value of MaxResults, the response contains a - * NextToken value that you can use in a subsequent call to - * ListSubscriptionRequests to list the next set of subscription - * requests.

+ *

Specifies whether the action is to return data lineage node history from the time prior + * of the event timestamp.

* @public */ - maxResults?: number; + eventTimestampLTE?: Date; /** - *

When the number of subscription requests is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of subscription requests, the - * response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to - * ListSubscriptionRequests to list the next set of subscription - * requests.

+ *

The order by which you want data lineage node history to be sorted.

* @public */ - nextToken?: string; + sortOrder?: SortOrder; } /** - *

The details of the subscription request.

+ *

The summary of the data lineage node.

* @public */ -export interface SubscriptionRequestSummary { +export interface LineageNodeSummary { /** - *

The identifier of the subscription request.

+ *

The ID of the domain of the data lineage node.

* @public */ - id: string | undefined; + domainId: string | undefined; /** - *

The Amazon DataZone user who created the subscription request.

+ *

The name of the data lineage node.

* @public */ - createdBy: string | undefined; + name?: string; /** - *

The identifier of the Amazon DataZone user who updated the subscription request.

+ *

The description of the data lineage node.

* @public */ - updatedBy?: string; + description?: string; /** - *

The identifier of the Amazon DataZone domain in which a subscription request exists.

+ *

The timestamp at which the data lineage node was created.

* @public */ - domainId: string | undefined; + createdAt?: Date; /** - *

The status of the subscription request.

+ *

The user who created the data lineage node.

* @public */ - status: SubscriptionRequestStatus | undefined; + createdBy?: string; /** - *

The timestamp of when a subscription request was created.

+ *

The timestamp at which the data lineage node was updated.

* @public */ - createdAt: Date | undefined; + updatedAt?: Date; /** - *

The timestamp of when the subscription request was updated.

+ *

The user who updated the data lineage node.

* @public */ - updatedAt: Date | undefined; + updatedBy?: string; /** - *

The reason for the subscription request.

+ *

The ID of the data lineage node.

* @public */ - requestReason: string | undefined; + id: string | undefined; /** - *

The principals included in the subscription request.

+ *

The name of the type of the data lineage node.

* @public */ - subscribedPrincipals: SubscribedPrincipal[] | undefined; + typeName: string | undefined; /** - *

The listings included in the subscription request.

+ *

The type of the revision of the data lineage node.

* @public */ - subscribedListings: SubscribedListing[] | undefined; + typeRevision?: string; /** - *

The identifier of the subscription request reviewer.

+ *

The alternate ID of the data lineage node.

* @public */ - reviewerId?: string; + sourceIdentifier?: string; /** - *

The decision comment of the subscription request.

+ *

The event timestamp of the data lineage node.

* @public */ - decisionComment?: string; + eventTimestamp?: Date; } /** * @public */ -export interface ListSubscriptionRequestsOutput { +export interface ListLineageNodeHistoryOutput { /** - *

The results of the ListSubscriptionRequests action.

+ *

The nodes returned by the ListLineageNodeHistory action.

* @public */ - items: SubscriptionRequestSummary[] | undefined; + nodes?: LineageNodeSummary[]; /** - *

When the number of subscription requests is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of subscription requests, the - * response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to - * ListSubscriptionRequests to list the next set of subscription - * requests.

+ *

When the number of history items is greater than the default value for the MaxResults + * parameter, or if you explicitly specify a value for MaxResults that is less than the number + * of items, the response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of + * items.

* @public */ nextToken?: string; @@ -891,341 +871,1630 @@ export interface ListSubscriptionRequestsOutput { /** * @public + * @enum */ -export interface ListSubscriptionsInput { - /** - *

The identifier of the Amazon DataZone domain.

- * @public - */ - domainIdentifier: string | undefined; +export const TaskStatus = { + ACTIVE: "ACTIVE", + INACTIVE: "INACTIVE", +} as const; - /** - *

The identifier of the subscription request for the subscriptions that you want to - * list.

- * @public - */ - subscriptionRequestIdentifier?: string; +/** + * @public + */ +export type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus]; +/** + * @public + * @enum + */ +export const NotificationType = { + EVENT: "EVENT", + TASK: "TASK", +} as const; + +/** + * @public + */ +export type NotificationType = (typeof NotificationType)[keyof typeof NotificationType]; + +/** + * @public + */ +export interface ListNotificationsInput { /** - *

The status of the subscriptions that you want to list.

+ *

The identifier of the Amazon DataZone domain.

* @public */ - status?: SubscriptionStatus; + domainIdentifier: string | undefined; /** - *

The identifier of the subscribed listing for the subscriptions that you want to - * list.

+ *

The type of notifications.

* @public */ - subscribedListingId?: string; + type: NotificationType | undefined; /** - *

The identifier of the owning project.

+ *

The time after which you want to list notifications.

* @public */ - owningProjectId?: string; + afterTimestamp?: Date; /** - *

The identifier of the project for the subscription's approver.

+ *

The time before which you want to list notifications.

* @public */ - approverProjectId?: string; + beforeTimestamp?: Date; /** - *

Specifies the way in which the results of this action are to be sorted.

+ *

The subjects of notifications.

* @public */ - sortBy?: SortKey; + subjects?: string[]; /** - *

Specifies the sort order for the results of this action.

+ *

The task status of notifications.

* @public */ - sortOrder?: SortOrder; + taskStatus?: TaskStatus; /** - *

The maximum number of subscriptions to return in a single call to - * ListSubscriptions. When the number of subscriptions to be listed is greater + *

The maximum number of notifications to return in a single call to + * ListNotifications. When the number of notifications to be listed is greater * than the value of MaxResults, the response contains a NextToken - * value that you can use in a subsequent call to ListSubscriptions to list the - * next set of Subscriptions.

+ * value that you can use in a subsequent call to ListNotifications to list the + * next set of notifications.

* @public */ maxResults?: number; /** - *

When the number of subscriptions is greater than the default value for the + *

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 subscriptions, the response + * 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 ListSubscriptions to - * list the next set of subscriptions.

+ * NextToken value in a subsequent call to ListNotifications to + * list the next set of notifications.

* @public */ nextToken?: string; } /** - *

The details of the subscription.

* @public + * @enum */ -export interface SubscriptionSummary { +export const NotificationResourceType = { + PROJECT: "PROJECT", +} as const; + +/** + * @public + */ +export type NotificationResourceType = (typeof NotificationResourceType)[keyof typeof NotificationResourceType]; + +/** + *

The details of the resource mentioned in a notification.

+ * @public + */ +export interface NotificationResource { /** - *

The identifier of the subscription.

+ *

The type of the resource mentioned in a notification.

* @public */ - id: string | undefined; + type: NotificationResourceType | undefined; /** - *

The Amazon DataZone user who created the subscription.

+ *

The ID of the resource mentioned in a notification.

* @public */ - createdBy: string | undefined; + id: string | undefined; /** - *

The Amazon DataZone user who updated the subscription.

+ *

The name of the resource mentioned in a notification.

* @public */ - updatedBy?: string; + name?: string; +} + +/** + * @public + * @enum + */ +export const NotificationRole = { + DOMAIN_OWNER: "DOMAIN_OWNER", + PROJECT_CONTRIBUTOR: "PROJECT_CONTRIBUTOR", + PROJECT_OWNER: "PROJECT_OWNER", + PROJECT_SUBSCRIBER: "PROJECT_SUBSCRIBER", + PROJECT_VIEWER: "PROJECT_VIEWER", +} as const; + +/** + * @public + */ +export type NotificationRole = (typeof NotificationRole)[keyof typeof NotificationRole]; +/** + *

The topic of the notification.

+ * @public + */ +export interface Topic { /** - *

The identifier of the Amazon DataZone domain in which a subscription exists.

+ *

The subject of the resource mentioned in a notification.

* @public */ - domainId: string | undefined; + subject: string | undefined; /** - *

The status of the subscription.

+ *

The details of the resource mentioned in a notification.

* @public */ - status: SubscriptionStatus | undefined; + resource: NotificationResource | undefined; /** - *

The timestamp of when the subscription was created.

+ *

The role of the resource mentioned in a notification.

* @public */ - createdAt: Date | undefined; + role: NotificationRole | undefined; +} +/** + *

The details of a notification generated in Amazon DataZone.

+ * @public + */ +export interface NotificationOutput { /** - *

The timestamp of when the subscription was updated.

+ *

The identifier of the notification.

* @public */ - updatedAt: Date | undefined; + identifier: string | undefined; /** - *

The principal included in the subscription.

+ *

The identifier of a Amazon DataZone domain in which the notification exists.

* @public */ - subscribedPrincipal: SubscribedPrincipal | undefined; + domainIdentifier: string | undefined; /** - *

The listing included in the subscription.

+ *

The type of the notification.

* @public */ - subscribedListing: SubscribedListing | undefined; + type: NotificationType | undefined; /** - *

The identifier of the subscription request for the subscription.

+ *

The topic of the notification.

* @public */ - subscriptionRequestId?: string; + topic: Topic | undefined; /** - *

The retain permissions included in the subscription.

+ *

The title of the notification.

* @public */ - retainPermissions?: boolean; -} + title: string | undefined; -/** - * @public - */ -export interface ListSubscriptionsOutput { /** - *

The results of the ListSubscriptions action.

+ *

The message included in the notification.

* @public */ - items: SubscriptionSummary[] | undefined; + message: string | undefined; /** - *

When the number of subscriptions is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of subscriptions, the response - * includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to ListSubscriptions to - * list the next set of subscriptions.

+ *

The status included in the notification.

* @public */ - nextToken?: string; -} + status?: TaskStatus; -/** - * @public - */ -export interface ListSubscriptionTargetsInput { /** - *

The identifier of the Amazon DataZone domain where you want to list subscription - * targets.

+ *

The action link included in the notification.

* @public */ - domainIdentifier: string | undefined; + actionLink: string | undefined; /** - *

The identifier of the environment where you want to list subscription targets.

+ *

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?: Record; +} + +/** + * @public + */ +export interface ListNotificationsOutput { + /** + *

The results of the ListNotifications action.

+ * @public + */ + notifications?: NotificationOutput[]; + + /** + *

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.

+ * @public + */ + nextToken?: string; +} + +/** + * @public + * @enum + */ +export const SortFieldProject = { + NAME: "NAME", +} as const; + +/** + * @public + */ +export type SortFieldProject = (typeof SortFieldProject)[keyof typeof SortFieldProject]; + +/** + * @public + */ +export interface ListProjectMembershipsInput { + /** + *

The identifier of the Amazon DataZone domain in which you want to list project + * memberships.

+ * @public + */ + domainIdentifier: string | undefined; + + /** + *

The identifier of the project whose memberships you want to list.

+ * @public + */ + projectIdentifier: string | undefined; + + /** + *

The method by which you want to sort the project memberships.

+ * @public + */ + sortBy?: SortFieldProject; + + /** + *

The sort order of the project memberships.

+ * @public + */ + sortOrder?: SortOrder; + + /** + *

When the number of memberships is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of memberships, the response + * includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListProjectMemberships + * to list the next set of memberships.

+ * @public + */ + nextToken?: string; + + /** + *

The maximum number of memberships to return in a single call to + * ListProjectMemberships. When the number of memberships to be listed is + * greater than the value of MaxResults, the response contains a + * NextToken value that you can use in a subsequent call to + * ListProjectMemberships to list the next set of memberships.

+ * @public + */ + maxResults?: number; +} + +/** + *

The details of a group in Amazon DataZone.

+ * @public + */ +export interface GroupDetails { + /** + *

The identifier of the group in Amazon DataZone.

+ * @public + */ + groupId: string | undefined; +} + +/** + *

The user details of a project member.

+ * @public + */ +export interface UserDetails { + /** + *

The identifier of the Amazon DataZone user.

+ * @public + */ + userId: string | undefined; +} + +/** + *

The details about a project member.

+ * @public + */ +export type MemberDetails = MemberDetails.GroupMember | MemberDetails.UserMember | MemberDetails.$UnknownMember; + +/** + * @public + */ +export namespace MemberDetails { + /** + *

The user details of a project member.

+ * @public + */ + export interface UserMember { + user: UserDetails; + group?: never; + $unknown?: never; + } + + /** + *

The group details of a project member.

+ * @public + */ + export interface GroupMember { + user?: never; + group: GroupDetails; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + user?: never; + group?: never; + $unknown: [string, any]; + } + + export interface Visitor { + user: (value: UserDetails) => T; + group: (value: GroupDetails) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: MemberDetails, visitor: Visitor): T => { + if (value.user !== undefined) return visitor.user(value.user); + if (value.group !== undefined) return visitor.group(value.group); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} + +/** + *

The details of a project member.

+ * @public + */ +export interface ProjectMember { + /** + *

The membership details of a project member.

+ * @public + */ + memberDetails: MemberDetails | undefined; + + /** + *

The designated role of a project member.

+ * @public + */ + designation: UserDesignation | undefined; +} + +/** + * @public + */ +export interface ListProjectMembershipsOutput { + /** + *

The members of the project.

+ * @public + */ + members: ProjectMember[] | undefined; + + /** + *

When the number of memberships is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of memberships, the response + * includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListProjectMemberships + * to list the next set of memberships.

+ * @public + */ + nextToken?: string; +} + +/** + * @public + */ +export interface ListProjectsInput { + /** + *

The identifier of the Amazon DataZone domain.

+ * @public + */ + domainIdentifier: string | undefined; + + /** + *

The identifier of the Amazon DataZone user.

+ * @public + */ + userIdentifier?: string; + + /** + *

The identifier of a group.

+ * @public + */ + groupIdentifier?: string; + + /** + *

The name of the project.

+ * @public + */ + name?: string; + + /** + *

When the number of projects is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of projects, the response includes + * a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListProjects to list + * the next set of projects.

+ * @public + */ + nextToken?: string; + + /** + *

The maximum number of projects to return in a single call to ListProjects. + * When the number of projects to be listed is greater than the value of + * MaxResults, the response contains a NextToken value that you + * can use in a subsequent call to ListProjects to list the next set of + * projects.

+ * @public + */ + maxResults?: number; +} + +/** + *

The details of a Amazon DataZone project.

+ * @public + */ +export interface ProjectSummary { + /** + *

The identifier of a Amazon DataZone domain where the project exists.

+ * @public + */ + domainId: string | undefined; + + /** + *

The identifier of a project.

+ * @public + */ + id: string | undefined; + + /** + *

The name of a project.

+ * @public + */ + name: string | undefined; + + /** + *

The description of a 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 a project was created.

+ * @public + */ + createdAt?: Date; + + /** + *

The timestamp of when the project was updated.

+ * @public + */ + updatedAt?: Date; +} + +/** + * @public + */ +export interface ListProjectsOutput { + /** + *

The results of the ListProjects action.

+ * @public + */ + items?: ProjectSummary[]; + + /** + *

When the number of projects is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of projects, the response includes + * a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListProjects to list + * the next set of projects.

+ * @public + */ + nextToken?: string; +} + +/** + * @public + * @enum + */ +export const SortKey = { + CREATED_AT: "CREATED_AT", + UPDATED_AT: "UPDATED_AT", +} as const; + +/** + * @public + */ +export type SortKey = (typeof SortKey)[keyof typeof SortKey]; + +/** + * @public + */ +export interface ListSubscriptionGrantsInput { + /** + *

The identifier of the Amazon DataZone domain.

+ * @public + */ + domainIdentifier: string | undefined; + + /** + *

The identifier of the Amazon DataZone environment.

+ * @public + */ + environmentId?: string; + + /** + *

The identifier of the subscription target.

+ * @public + */ + subscriptionTargetId?: string; + + /** + *

The identifier of the subscribed listing.

+ * @public + */ + subscribedListingId?: string; + + /** + *

The identifier of the subscription.

+ * @public + */ + subscriptionId?: string; + + /** + *

Specifies the way of sorting the results of this action.

+ * @public + */ + sortBy?: SortKey; + + /** + *

Specifies the sort order of this action.

+ * @public + */ + sortOrder?: SortOrder; + + /** + *

The maximum number of subscription grants to return in a single call to + * ListSubscriptionGrants. When the number of subscription grants to be listed + * is greater than the value of MaxResults, the response contains a + * NextToken value that you can use in a subsequent call to + * ListSubscriptionGrants to list the next set of subscription grants.

+ * @public + */ + maxResults?: number; + + /** + *

When the number of subscription grants is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of subscription grants, the + * response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListSubscriptionGrants + * to list the next set of subscription grants.

+ * @public + */ + nextToken?: string; +} + +/** + *

The details of the subscription grant.

+ * @public + */ +export interface SubscriptionGrantSummary { + /** + *

The identifier of the subscription grant.

+ * @public + */ + id: string | undefined; + + /** + *

The datazone user who created the subscription grant.

+ * @public + */ + createdBy: string | undefined; + + /** + *

The Amazon DataZone user who updated the subscription grant.

+ * @public + */ + updatedBy?: string; + + /** + *

The identifier of the Amazon DataZone domain in which a subscription grant exists.

+ * @public + */ + domainId: string | undefined; + + /** + *

The timestamp of when a subscription grant was created.

+ * @public + */ + createdAt: Date | undefined; + + /** + *

The timestampf of when the subscription grant was updated.

+ * @public + */ + updatedAt: Date | undefined; + + /** + *

The identifier of the target of 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 included in the subscription grant.

+ * @public + */ + assets?: SubscribedAsset[]; + + /** + *

The ID of the subscription grant.

+ * @public + */ + subscriptionId?: string; +} + +/** + * @public + */ +export interface ListSubscriptionGrantsOutput { + /** + *

The results of the ListSubscriptionGrants action.

+ * @public + */ + items: SubscriptionGrantSummary[] | undefined; + + /** + *

When the number of subscription grants is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of subscription grants, the + * response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListSubscriptionGrants + * to list the next set of subscription grants.

+ * @public + */ + nextToken?: string; +} + +/** + * @public + */ +export interface ListSubscriptionRequestsInput { + /** + *

The identifier of the Amazon DataZone domain.

+ * @public + */ + domainIdentifier: string | undefined; + + /** + *

Specifies the status of the subscription requests.

+ * @public + */ + status?: SubscriptionRequestStatus; + + /** + *

The identifier of the subscribed listing.

+ * @public + */ + subscribedListingId?: string; + + /** + *

The identifier of the project for the subscription requests.

+ * @public + */ + owningProjectId?: string; + + /** + *

The identifier of the subscription request approver's project.

+ * @public + */ + approverProjectId?: string; + + /** + *

Specifies the way to sort the results of this action.

+ * @public + */ + sortBy?: SortKey; + + /** + *

Specifies the sort order for the results of this action.

+ * @public + */ + sortOrder?: SortOrder; + + /** + *

The maximum number of subscription requests to return in a single call to + * ListSubscriptionRequests. When the number of subscription requests to be + * listed is greater than the value of MaxResults, the response contains a + * NextToken value that you can use in a subsequent call to + * ListSubscriptionRequests to list the next set of subscription + * requests.

+ * @public + */ + maxResults?: number; + + /** + *

When the number of subscription requests is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of subscription requests, the + * response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to + * ListSubscriptionRequests to list the next set of subscription + * requests.

+ * @public + */ + nextToken?: string; +} + +/** + *

The details of the subscription request.

+ * @public + */ +export interface SubscriptionRequestSummary { + /** + *

The identifier of the subscription request.

+ * @public + */ + id: string | undefined; + + /** + *

The Amazon DataZone user who created the subscription request.

+ * @public + */ + createdBy: string | undefined; + + /** + *

The identifier of the Amazon DataZone user who updated the subscription request.

+ * @public + */ + updatedBy?: string; + + /** + *

The identifier of the Amazon DataZone domain in which a subscription request exists.

+ * @public + */ + domainId: string | undefined; + + /** + *

The status of the subscription request.

+ * @public + */ + status: SubscriptionRequestStatus | undefined; + + /** + *

The timestamp of when a 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 principals included in the subscription request.

+ * @public + */ + subscribedPrincipals: SubscribedPrincipal[] | undefined; + + /** + *

The listings included in the subscription request.

+ * @public + */ + subscribedListings: SubscribedListing[] | undefined; + + /** + *

The identifier of the subscription request reviewer.

+ * @public + */ + reviewerId?: string; + + /** + *

The decision comment of the subscription request.

+ * @public + */ + decisionComment?: string; +} + +/** + * @public + */ +export interface ListSubscriptionRequestsOutput { + /** + *

The results of the ListSubscriptionRequests action.

+ * @public + */ + items: SubscriptionRequestSummary[] | undefined; + + /** + *

When the number of subscription requests is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of subscription requests, the + * response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to + * ListSubscriptionRequests to list the next set of subscription + * requests.

+ * @public + */ + nextToken?: string; +} + +/** + * @public + */ +export interface ListSubscriptionsInput { + /** + *

The identifier of the Amazon DataZone domain.

+ * @public + */ + domainIdentifier: string | undefined; + + /** + *

The identifier of the subscription request for the subscriptions that you want to + * list.

+ * @public + */ + subscriptionRequestIdentifier?: string; + + /** + *

The status of the subscriptions that you want to list.

+ * @public + */ + status?: SubscriptionStatus; + + /** + *

The identifier of the subscribed listing for the subscriptions that you want to + * list.

+ * @public + */ + subscribedListingId?: string; + + /** + *

The identifier of the owning project.

+ * @public + */ + owningProjectId?: string; + + /** + *

The identifier of the project for the subscription's approver.

+ * @public + */ + approverProjectId?: string; + + /** + *

Specifies the way in which the results of this action are to be sorted.

+ * @public + */ + sortBy?: SortKey; + + /** + *

Specifies the sort order for the results of this action.

+ * @public + */ + sortOrder?: SortOrder; + + /** + *

The maximum number of subscriptions to return in a single call to + * ListSubscriptions. When the number of subscriptions to be listed is greater + * than the value of MaxResults, the response contains a NextToken + * value that you can use in a subsequent call to ListSubscriptions to list the + * next set of Subscriptions.

+ * @public + */ + maxResults?: number; + + /** + *

When the number of subscriptions is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of subscriptions, the response + * includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListSubscriptions to + * list the next set of subscriptions.

+ * @public + */ + nextToken?: string; +} + +/** + *

The details of the subscription.

+ * @public + */ +export interface SubscriptionSummary { + /** + *

The identifier 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 identifier of the Amazon DataZone domain in which a 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 included in the subscription.

+ * @public + */ + subscribedPrincipal: SubscribedPrincipal | undefined; + + /** + *

The listing included in the subscription.

+ * @public + */ + subscribedListing: SubscribedListing | undefined; + + /** + *

The identifier of the subscription request for the subscription.

+ * @public + */ + subscriptionRequestId?: string; + + /** + *

The retain permissions included in the subscription.

+ * @public + */ + retainPermissions?: boolean; +} + +/** + * @public + */ +export interface ListSubscriptionsOutput { + /** + *

The results of the ListSubscriptions action.

+ * @public + */ + items: SubscriptionSummary[] | undefined; + + /** + *

When the number of subscriptions is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of subscriptions, the response + * includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to ListSubscriptions to + * list the next set of subscriptions.

+ * @public + */ + nextToken?: string; +} + +/** + * @public + */ +export interface ListSubscriptionTargetsInput { + /** + *

The identifier of the Amazon DataZone domain where you want to list subscription + * targets.

+ * @public + */ + domainIdentifier: string | undefined; + + /** + *

The identifier of the environment where you want to list subscription targets.

+ * @public + */ + environmentIdentifier: string | undefined; + + /** + *

Specifies the way in which the results of this action are to be sorted.

+ * @public + */ + sortBy?: SortKey; + + /** + *

Specifies the sort order for the results of this action.

+ * @public + */ + sortOrder?: SortOrder; + + /** + *

The maximum number of subscription targets to return in a single call to + * ListSubscriptionTargets. When the number of subscription targets to be + * listed is greater than the value of MaxResults, the response contains a + * NextToken value that you can use in a subsequent call to + * ListSubscriptionTargets to list the next set of subscription targets. + *

+ * @public + */ + maxResults?: number; + + /** + *

When the number of subscription targets is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of subscription targets, the + * response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to + * ListSubscriptionTargets to list the next set of subscription + * targets.

+ * @public + */ + nextToken?: string; +} + +/** + *

The details of the subscription target.

+ * @public + */ +export interface SubscriptionTargetSummary { + /** + *

The identifier of the subscription target.

+ * @public + */ + id: string | undefined; + + /** + *

The authorized principals included in the subscription target.

+ * @public + */ + authorizedPrincipals: string[] | undefined; + + /** + *

The identifier of the Amazon DataZone domain in which the subscription target exists.

+ * @public + */ + domainId: string | undefined; + + /** + *

The identifier of the project specified in the subscription target.

+ * @public + */ + projectId: string | undefined; + + /** + *

The identifier of the environment of the subscription target.

+ * @public + */ + environmentId: string | undefined; + + /** + *

The name of the subscription target.

+ * @public + */ + name: string | undefined; + + /** + *

The type of the subscription target.

+ * @public + */ + type: string | undefined; + + /** + *

The Amazon DataZone user who created the subscription target.

+ * @public + */ + createdBy: string | undefined; + + /** + *

The Amazon DataZone user who updated the subscription target.

+ * @public + */ + 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 specified in the subscription target.

+ * @public + */ + manageAccessRole: string | undefined; + + /** + *

The asset types included in the subscription target.

+ * @public + */ + applicableAssetTypes: string[] | undefined; + + /** + *

The configuration of the subscription target.

+ * @public + */ + subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + + /** + *

The provider of the subscription target.

+ * @public + */ + provider: string | undefined; +} + +/** + * @public + */ +export interface ListSubscriptionTargetsOutput { + /** + *

The results of the ListSubscriptionTargets action.

+ * @public + */ + items: SubscriptionTargetSummary[] | undefined; + + /** + *

When the number of subscription targets is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for + * MaxResults that is less than the number of subscription targets, the + * response includes a pagination token named NextToken. You can specify this + * NextToken value in a subsequent call to + * ListSubscriptionTargets to list the next set of subscription + * targets.

+ * @public + */ + nextToken?: string; +} + +/** + * @public + */ +export interface ListTagsForResourceRequest { + /** + *

The ARN of the resource whose tags you want to list.

+ * @public + */ + resourceArn: string | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceResponse { + /** + *

The tags of the specified resource.

+ * @public + */ + tags?: Record; +} + +/** + * @public + */ +export interface ListTimeSeriesDataPointsInput { + /** + *

The ID of the Amazon DataZone domain that houses the assets for which you want to list + * time series data points.

+ * @public + */ + domainIdentifier: string | undefined; + + /** + *

The ID of the asset for which you want to list data points.

+ * @public + */ + entityIdentifier: string | undefined; + + /** + *

The type of the asset for which you want to list data points.

+ * @public + */ + entityType: TimeSeriesEntityType | undefined; + + /** + *

The name of the time series data points form.

* @public */ - environmentIdentifier: string | undefined; + formName: string | undefined; /** - *

Specifies the way in which the results of this action are to be sorted.

+ *

The timestamp at which the data points that you want to list started.

* @public */ - sortBy?: SortKey; + startedAt?: Date; /** - *

Specifies the sort order for the results of this action.

+ *

The timestamp at which the data points that you wanted to list ended.

* @public */ - sortOrder?: SortOrder; + endedAt?: Date; /** - *

The maximum number of subscription targets to return in a single call to - * ListSubscriptionTargets. When the number of subscription targets to be - * listed is greater than the value of MaxResults, the response contains a - * NextToken value that you can use in a subsequent call to - * ListSubscriptionTargets to list the next set of subscription targets. - *

+ *

When the number of data points is greater than the default value for the MaxResults + * parameter, or if you explicitly specify a value for MaxResults that is less than the number + * of data points, the response includes a pagination token named NextToken. You can specify + * this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set + * of data points.

+ * @public + */ + nextToken?: string; + + /** + *

The maximum number of data points to return in a single call to + * ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the + * value of MaxResults, the response contains a NextToken value that you can use in a + * subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

* @public */ maxResults?: number; +} +/** + * @public + */ +export interface ListTimeSeriesDataPointsOutput { /** - *

When the number of subscription targets is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of subscription targets, the - * response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to - * ListSubscriptionTargets to list the next set of subscription - * targets.

+ *

The results of the ListTimeSeriesDataPoints action.

+ * @public + */ + items?: TimeSeriesDataPointSummaryFormOutput[]; + + /** + *

When the number of data points is greater than the default value for the MaxResults + * parameter, or if you explicitly specify a value for MaxResults that is less than the number + * of data points, the response includes a pagination token named NextToken. You can specify + * this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set + * of data points.

* @public */ nextToken?: string; } /** - *

The details of the subscription target.

* @public */ -export interface SubscriptionTargetSummary { +export interface GetMetadataGenerationRunInput { /** - *

The identifier of the subscription target.

+ *

The ID of the Amazon DataZone domain the metadata generation run of which you want to + * get.

* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *

The authorized principals included in the subscription target.

+ *

The identifier of the metadata generation run.

* @public */ - authorizedPrincipals: string[] | undefined; + identifier: string | undefined; +} + +/** + * @public + * @enum + */ +export const MetadataGenerationRunStatus = { + CANCELED: "CANCELED", + FAILED: "FAILED", + IN_PROGRESS: "IN_PROGRESS", + SUBMITTED: "SUBMITTED", + SUCCEEDED: "SUCCEEDED", +} as const; + +/** + * @public + */ +export type MetadataGenerationRunStatus = + (typeof MetadataGenerationRunStatus)[keyof typeof MetadataGenerationRunStatus]; + +/** + * @public + * @enum + */ +export const MetadataGenerationTargetType = { + ASSET: "ASSET", +} as const; + +/** + * @public + */ +export type MetadataGenerationTargetType = + (typeof MetadataGenerationTargetType)[keyof typeof MetadataGenerationTargetType]; + +/** + *

The asset for which metadata was generated.

+ * @public + */ +export interface MetadataGenerationRunTarget { + /** + *

The type of the asset for which metadata was generated.

+ * @public + */ + type: MetadataGenerationTargetType | undefined; /** - *

The identifier of the Amazon DataZone domain in which the subscription target exists.

+ *

The ID of the metadata generation run's target.

+ * @public + */ + identifier: string | undefined; + + /** + *

The revision of the asset for which metadata was generated.

+ * @public + */ + revision?: string; +} + +/** + * @public + * @enum + */ +export const MetadataGenerationRunType = { + BUSINESS_DESCRIPTIONS: "BUSINESS_DESCRIPTIONS", +} as const; + +/** + * @public + */ +export type MetadataGenerationRunType = (typeof MetadataGenerationRunType)[keyof typeof MetadataGenerationRunType]; + +/** + * @public + */ +export interface GetMetadataGenerationRunOutput { + /** + *

The ID of the Amazon DataZone domain the metadata generation run of which you want to + * get.

* @public */ domainId: string | undefined; /** - *

The identifier of the project specified in the subscription target.

+ *

The ID of the metadata generation run.

* @public */ - projectId: string | undefined; + id: string | undefined; /** - *

The identifier of the environment of the subscription target.

+ *

The asset for which you're generating metadata.

* @public */ - environmentId: string | undefined; + target?: MetadataGenerationRunTarget; /** - *

The name of the subscription target.

+ *

The status of the metadata generation run.

* @public */ - name: string | undefined; + status?: MetadataGenerationRunStatus; /** - *

The type of the subscription target.

+ *

The type of metadata generation run.

* @public */ - type: string | undefined; + type?: MetadataGenerationRunType; /** - *

The Amazon DataZone user who created the subscription target.

+ *

The timestamp of when the metadata generation run was start.

* @public */ - createdBy: string | undefined; + createdAt?: Date; /** - *

The Amazon DataZone user who updated the subscription target.

+ *

The Amazon DataZone user who started the metadata generation run.

* @public */ - updatedBy?: string; + createdBy?: string; /** - *

The timestamp of when the subscription target was created.

+ *

The ID of the project that owns the assets for which you're running metadata + * generation.

* @public */ - createdAt: Date | undefined; + owningProjectId: string | undefined; +} +/** + * @public + */ +export interface ListMetadataGenerationRunsInput { /** - *

The timestamp of when the subscription target was updated.

+ *

The ID of the Amazon DataZone domain where you want to list metadata generation + * runs.

* @public */ - updatedAt?: Date; + domainIdentifier: string | undefined; /** - *

The manage access role specified in the subscription target.

+ *

The status of the metadata generation runs.

* @public */ - manageAccessRole: string | undefined; + status?: MetadataGenerationRunStatus; /** - *

The asset types included in the subscription target.

+ *

The type of the metadata generation runs.

* @public */ - applicableAssetTypes: string[] | undefined; + type?: MetadataGenerationRunType; /** - *

The configuration of the subscription target.

+ *

When the number of metadata generation runs is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than + * the number of metadata generation runs, the response includes a pagination token named + * NextToken. You can specify this NextToken value in a subsequent call to + * ListMetadataGenerationRuns to list the next set of revisions.

+ * @public + */ + nextToken?: string; + + /** + *

The maximum number of metadata generation runs to return in a single call to + * ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is + * greater than the value of MaxResults, the response contains a NextToken value that you can + * use in a subsequent call to ListMetadataGenerationRuns to list the next set of + * revisions.

+ * @public + */ + maxResults?: number; +} + +/** + *

The metadata generation run.

+ * @public + */ +export interface MetadataGenerationRunItem { + /** + *

The ID of the Amazon DataZone domain in which the metadata generation run was + * created.

+ * @public + */ + domainId: string | undefined; + + /** + *

The ID of the metadata generation run.

+ * @public + */ + id: string | undefined; + + /** + *

The asset for which metadata was generated.

+ * @public + */ + target?: MetadataGenerationRunTarget; + + /** + *

The status of the metadata generation run.

+ * @public + */ + status?: MetadataGenerationRunStatus; + + /** + *

The type of the metadata generation run.

+ * @public + */ + type?: MetadataGenerationRunType; + + /** + *

The timestamp at which the metadata generation run was created.

+ * @public + */ + createdAt?: Date; + + /** + *

The user who created the metadata generation run.

* @public */ - subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + createdBy?: string; /** - *

The provider of the subscription target.

+ *

The ID of the project that owns the asset for which the metadata generation was + * ran.

* @public */ - provider: string | undefined; + owningProjectId: string | undefined; } /** * @public */ -export interface ListSubscriptionTargetsOutput { +export interface ListMetadataGenerationRunsOutput { /** - *

The results of the ListSubscriptionTargets action.

+ *

The results of the ListMetadataGenerationRuns action.

* @public */ - items: SubscriptionTargetSummary[] | undefined; + items?: MetadataGenerationRunItem[]; /** - *

When the number of subscription targets is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for - * MaxResults that is less than the number of subscription targets, the - * response includes a pagination token named NextToken. You can specify this - * NextToken value in a subsequent call to - * ListSubscriptionTargets to list the next set of subscription - * targets.

+ *

When the number of metadata generation runs is greater than the default value for the + * MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than + * the number of metadata generation runs, the response includes a pagination token named + * NextToken. You can specify this NextToken value in a subsequent call to + * ListMetadataGenerationRuns to list the next set of revisions.

* @public */ nextToken?: string; @@ -1234,1188 +2503,1255 @@ export interface ListSubscriptionTargetsOutput { /** * @public */ -export interface ListTagsForResourceRequest { +export interface StartMetadataGenerationRunInput { /** - *

The ARN of the resource whose tags you want to list.

+ *

The ID of the Amazon DataZone domain where you want to start a metadata generation + * run.

* @public */ - resourceArn: string | undefined; -} + domainIdentifier: string | undefined; -/** - * @public - */ -export interface ListTagsForResourceResponse { /** - *

The tags of the specified resource.

+ *

The type of the metadata generation run.

* @public */ - tags?: Record; -} + type: MetadataGenerationRunType | undefined; -/** - * @public - */ -export interface ListTimeSeriesDataPointsInput { /** - *

The ID of the Amazon DataZone domain that houses the assets for which you want to list - * time series data points.

+ *

The asset for which you want to start a metadata generation run.

* @public */ - domainIdentifier: string | undefined; + target: MetadataGenerationRunTarget | undefined; /** - *

The ID of the asset for which you want to list data points.

+ *

A unique, case-sensitive identifier to ensure idempotency of the request. This field is + * automatically populated if not provided.

* @public */ - entityIdentifier: string | undefined; + clientToken?: string; /** - *

The type of the asset for which you want to list data points.

+ *

The ID of the project that owns the asset for which you want to start a metadata + * generation run.

* @public */ - entityType: TimeSeriesEntityType | undefined; + owningProjectIdentifier: string | undefined; +} +/** + * @public + */ +export interface StartMetadataGenerationRunOutput { /** - *

The name of the time series data points form.

+ *

The ID of the Amazon DataZone domain in which the metadata generation run was + * started.

* @public */ - formName: string | undefined; + domainId: string | undefined; /** - *

The timestamp at which the data points that you want to list started.

+ *

The ID of the metadata generation run.

* @public */ - startedAt?: Date; + id: string | undefined; /** - *

The timestamp at which the data points that you wanted to list ended.

+ *

The status of the metadata generation run.

* @public */ - endedAt?: Date; + status?: MetadataGenerationRunStatus; /** - *

When the number of data points is greater than the default value for the MaxResults - * parameter, or if you explicitly specify a value for MaxResults that is less than the number - * of data points, the response includes a pagination token named NextToken. You can specify - * this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set - * of data points.

+ *

The type of the metadata generation run.

* @public */ - nextToken?: string; + type?: MetadataGenerationRunType; /** - *

The maximum number of data points to return in a single call to - * ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the - * value of MaxResults, the response contains a NextToken value that you can use in a - * subsequent call to ListTimeSeriesDataPoints to list the next set of data points.

+ *

The timestamp at which the metadata generation run was started.

* @public */ - maxResults?: number; -} + createdAt?: Date; -/** - * @public - */ -export interface ListTimeSeriesDataPointsOutput { /** - *

The results of the ListTimeSeriesDataPoints action.

+ *

The ID of the user who started the metadata generation run.

* @public */ - items?: TimeSeriesDataPointSummaryFormOutput[]; + createdBy?: string; /** - *

When the number of data points is greater than the default value for the MaxResults - * parameter, or if you explicitly specify a value for MaxResults that is less than the number - * of data points, the response includes a pagination token named NextToken. You can specify - * this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set - * of data points.

+ *

The ID of the project that owns the asset for which the metadata generation run was + * started.

* @public */ - nextToken?: string; + owningProjectId?: string; } /** * @public */ -export interface GetMetadataGenerationRunInput { +export interface PostLineageEventInput { /** - *

The ID of the Amazon DataZone domain the metadata generation run of which you want to - * get.

+ *

The ID of the domain where you want to post a data lineage event.

* @public */ domainIdentifier: string | undefined; /** - *

The identifier of the metadata generation run.

+ *

The data lineage event that you want to post. Only open-lineage run event are supported + * as events.

* @public */ - identifier: string | undefined; -} + event: Uint8Array | undefined; -/** - * @public - * @enum - */ -export const MetadataGenerationRunStatus = { - CANCELED: "CANCELED", - FAILED: "FAILED", - IN_PROGRESS: "IN_PROGRESS", - SUBMITTED: "SUBMITTED", - SUCCEEDED: "SUCCEEDED", -} as const; + /** + *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

+ * @public + */ + clientToken?: string; +} /** * @public */ -export type MetadataGenerationRunStatus = - (typeof MetadataGenerationRunStatus)[keyof typeof MetadataGenerationRunStatus]; +export interface PostLineageEventOutput {} /** + *

The time series data points form.

* @public - * @enum */ -export const MetadataGenerationTargetType = { - ASSET: "ASSET", -} as const; +export interface TimeSeriesDataPointFormInput { + /** + *

The name of the time series data points form.

+ * @public + */ + formName: string | undefined; -/** - * @public - */ -export type MetadataGenerationTargetType = - (typeof MetadataGenerationTargetType)[keyof typeof MetadataGenerationTargetType]; + /** + *

The ID of the type of the time series data points form.

+ * @public + */ + typeIdentifier: string | undefined; -/** - *

The asset for which metadata was generated.

- * @public - */ -export interface MetadataGenerationRunTarget { /** - *

The type of the asset for which metadata was generated.

+ *

The revision type of the time series data points form.

* @public */ - type: MetadataGenerationTargetType | undefined; + typeRevision?: string; /** - *

The ID of the metadata generation run's target.

+ *

The timestamp of the time series data points form.

* @public */ - identifier: string | undefined; + timestamp: Date | undefined; /** - *

The revision of the asset for which metadata was generated.

+ *

The content of the time series data points form.

* @public */ - revision?: string; + content?: string; } -/** - * @public - * @enum - */ -export const MetadataGenerationRunType = { - BUSINESS_DESCRIPTIONS: "BUSINESS_DESCRIPTIONS", -} as const; - /** * @public */ -export type MetadataGenerationRunType = (typeof MetadataGenerationRunType)[keyof typeof MetadataGenerationRunType]; +export interface PostTimeSeriesDataPointsInput { + /** + *

The ID of the Amazon DataZone domain in which you want to post time series data + * points.

+ * @public + */ + domainIdentifier: string | undefined; -/** - * @public - */ -export interface GetMetadataGenerationRunOutput { /** - *

The ID of the Amazon DataZone domain the metadata generation run of which you want to - * get.

+ *

The ID of the asset for which you want to post time series data points.

* @public */ - domainId: string | undefined; + entityIdentifier: string | undefined; /** - *

The ID of the metadata generation run.

+ *

The type of the asset for which you want to post data points.

* @public */ - id: string | undefined; + entityType: TimeSeriesEntityType | undefined; /** - *

The asset for which you're generating metadata.

+ *

The forms that contain the data points that you want to post.

* @public */ - target?: MetadataGenerationRunTarget; + forms: TimeSeriesDataPointFormInput[] | undefined; /** - *

The status of the metadata generation run.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - status?: MetadataGenerationRunStatus; + clientToken?: string; +} +/** + * @public + */ +export interface PostTimeSeriesDataPointsOutput { /** - *

The type of metadata generation run.

+ *

The ID of the Amazon DataZone domain in which you want to post time series data + * points.

* @public */ - type?: MetadataGenerationRunType; + domainId?: string; /** - *

The timestamp of when the metadata generation run was start.

+ *

The ID of the asset for which you want to post time series data points.

* @public */ - createdAt?: Date; + entityId?: string; /** - *

The Amazon DataZone user who started the metadata generation run.

+ *

The type of the asset for which you want to post data points.

* @public */ - createdBy?: string; + entityType?: TimeSeriesEntityType; /** - *

The ID of the project that owns the assets for which you're running metadata - * generation.

+ *

The forms that contain the data points that you have posted.

* @public */ - owningProjectId: string | undefined; + forms?: TimeSeriesDataPointFormOutput[]; } /** + *

The details of the automatically generated business metadata that is rejected.

* @public */ -export interface ListMetadataGenerationRunsInput { - /** - *

The ID of the Amazon DataZone domain where you want to list metadata generation - * runs.

- * @public - */ - domainIdentifier: string | undefined; - +export interface RejectChoice { /** - *

The status of the metadata generation runs.

+ *

Specifies the target (for example, a column name) where a prediction can be + * rejected.

* @public */ - status?: MetadataGenerationRunStatus; + predictionTarget: string | undefined; /** - *

The type of the metadata generation runs.

+ *

Specifies the the automatically generated business metadata that can be rejected.

* @public */ - type?: MetadataGenerationRunType; + predictionChoices?: number[]; +} + +/** + * @public + * @enum + */ +export const RejectRuleBehavior = { + ALL: "ALL", + NONE: "NONE", +} as const; +/** + * @public + */ +export type RejectRuleBehavior = (typeof RejectRuleBehavior)[keyof typeof RejectRuleBehavior]; + +/** + *

Specifies the rule and the threshold under which a prediction can be rejected.

+ * @public + */ +export interface RejectRule { /** - *

When the number of metadata generation runs is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than - * the number of metadata generation runs, the response includes a pagination token named - * NextToken. You can specify this NextToken value in a subsequent call to - * ListMetadataGenerationRuns to list the next set of revisions.

+ *

Specifies whether you want to reject the top prediction for all targets or none.

* @public */ - nextToken?: string; + rule?: RejectRuleBehavior; /** - *

The maximum number of metadata generation runs to return in a single call to - * ListMetadataGenerationRuns. When the number of metadata generation runs to be listed is - * greater than the value of MaxResults, the response contains a NextToken value that you can - * use in a subsequent call to ListMetadataGenerationRuns to list the next set of - * revisions.

+ *

The confidence score that specifies the condition at which a prediction can be + * rejected.

* @public */ - maxResults?: number; + threshold?: number; } /** - *

The metadata generation run.

* @public */ -export interface MetadataGenerationRunItem { +export interface RejectPredictionsInput { /** - *

The ID of the Amazon DataZone domain in which the metadata generation run was - * created.

+ *

The identifier of the Amazon DataZone domain.

* @public */ - domainId: string | undefined; + domainIdentifier: string | undefined; /** - *

The ID of the metadata generation run.

+ *

The identifier of the prediction.

* @public */ - id: string | undefined; + identifier: string | undefined; /** - *

The asset for which metadata was generated.

+ *

The revision that is to be made to the asset.

* @public */ - target?: MetadataGenerationRunTarget; + revision?: string; /** - *

The status of the metadata generation run.

+ *

Specifies the rule (or the conditions) under which a prediction can be rejected.

* @public */ - status?: MetadataGenerationRunStatus; + rejectRule?: RejectRule; /** - *

The type of the metadata generation run.

+ *

Specifies the prediction (aka, the automatically generated piece of metadata) and the + * target (for example, a column name) that can be rejected.

* @public */ - type?: MetadataGenerationRunType; + rejectChoices?: RejectChoice[]; /** - *

The timestamp at which the metadata generation run was created.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - createdAt?: Date; + clientToken?: string; +} +/** + * @public + */ +export interface RejectPredictionsOutput { /** - *

The user who created the metadata generation run.

+ *

The ID of the Amazon DataZone domain.

* @public */ - createdBy?: string; + domainId: string | undefined; /** - *

The ID of the project that owns the asset for which the metadata generation was - * ran.

+ *

The ID of the asset.

* @public */ - owningProjectId: string | undefined; + assetId: string | undefined; + + /** + *

The revision that is to be made to the asset.

+ * @public + */ + assetRevision: string | undefined; } /** * @public */ -export interface ListMetadataGenerationRunsOutput { +export interface RejectSubscriptionRequestInput { /** - *

The results of the ListMetadataGenerationRuns action.

+ *

The identifier of the Amazon DataZone domain in which the subscription request was + * rejected.

* @public */ - items?: MetadataGenerationRunItem[]; + domainIdentifier: string | undefined; /** - *

When the number of metadata generation runs is greater than the default value for the - * MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than - * the number of metadata generation runs, the response includes a pagination token named - * NextToken. You can specify this NextToken value in a subsequent call to - * ListMetadataGenerationRuns to list the next set of revisions.

+ *

The identifier of the subscription request that was rejected.

* @public */ - nextToken?: string; + identifier: string | undefined; + + /** + *

The decision comment of the rejected subscription request.

+ * @public + */ + decisionComment?: string; } /** * @public */ -export interface StartMetadataGenerationRunInput { +export interface RejectSubscriptionRequestOutput { /** - *

The ID of the Amazon DataZone domain where you want to start a metadata generation - * run.

+ *

The identifier of the subscription request that was rejected.

* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *

The type of the metadata generation run.

+ *

The timestamp of when the subscription request was rejected.

* @public */ - type: MetadataGenerationRunType | undefined; + createdBy: string | undefined; /** - *

The asset for which you want to start a metadata generation run.

+ *

The Amazon DataZone user who updated the subscription request.

* @public */ - target: MetadataGenerationRunTarget | undefined; + updatedBy?: string; /** - *

A unique, case-sensitive identifier to ensure idempotency of the request. This field is - * automatically populated if not provided.

+ *

The identifier of the Amazon DataZone domain in which the subscription request was + * rejected.

* @public */ - clientToken?: string; + domainId: string | undefined; /** - *

The ID of the project that owns the asset for which you want to start a metadata - * generation run.

+ *

The status of the subscription request.

* @public */ - owningProjectIdentifier: string | undefined; -} + status: SubscriptionRequestStatus | undefined; -/** - * @public - */ -export interface StartMetadataGenerationRunOutput { /** - *

The ID of the Amazon DataZone domain in which the metadata generation run was - * started.

+ *

The timestamp of when the subscription request was rejected.

* @public */ - domainId: string | undefined; + createdAt: Date | undefined; /** - *

The ID of the metadata generation run.

+ *

The timestamp of when the subscription request was updated.

* @public */ - id: string | undefined; + updatedAt: Date | undefined; /** - *

The status of the metadata generation run.

+ *

The reason for the subscription request.

* @public */ - status?: MetadataGenerationRunStatus; + requestReason: string | undefined; /** - *

The type of the metadata generation run.

+ *

The subscribed principals of the subscription request.

* @public */ - type?: MetadataGenerationRunType; + subscribedPrincipals: SubscribedPrincipal[] | undefined; /** - *

The timestamp at which the metadata generation run was started.

+ *

The subscribed listings of the subscription request.

* @public */ - createdAt?: Date; + subscribedListings: SubscribedListing[] | undefined; /** - *

The ID of the user who started the metadata generation run.

+ *

The identifier of the subscription request reviewer.

* @public */ - createdBy?: string; + reviewerId?: string; /** - *

The ID of the project that owns the asset for which the metadata generation run was - * started.

+ *

The decision comment of the rejected subscription request.

* @public */ - owningProjectId?: string; + decisionComment?: string; } /** * @public */ -export interface PostLineageEventInput { +export interface RevokeSubscriptionInput { /** - *

The ID of the domain where you want to post a data lineage event.

+ *

The identifier of the Amazon DataZone domain where you want to revoke a subscription.

* @public */ domainIdentifier: string | undefined; /** - *

The data lineage event that you want to post. Only open-lineage run event are supported - * as events.

+ *

The identifier of the revoked subscription.

* @public */ - event: Uint8Array | undefined; + identifier: string | undefined; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

Specifies whether permissions are retained when the subscription is revoked.

* @public */ - clientToken?: string; + retainPermissions?: boolean; } /** * @public */ -export interface PostLineageEventOutput {} +export interface RevokeSubscriptionOutput { + /** + *

The identifier of the revoked subscription.

+ * @public + */ + id: string | undefined; -/** - *

The time series data points form.

- * @public - */ -export interface TimeSeriesDataPointFormInput { /** - *

The name of the time series data points form.

+ *

The identifier of the user who revoked the subscription.

* @public */ - formName: string | undefined; + createdBy: string | undefined; /** - *

The ID of the type of the time series data points form.

+ *

The Amazon DataZone user who revoked the subscription.

* @public */ - typeIdentifier: string | undefined; + updatedBy?: string; /** - *

The revision type of the time series data points form.

+ *

The identifier of the Amazon DataZone domain where you want to revoke a subscription.

* @public */ - typeRevision?: string; + domainId: string | undefined; /** - *

The timestamp of the time series data points form.

+ *

The status of the revoked subscription.

* @public */ - timestamp: Date | undefined; + status: SubscriptionStatus | undefined; /** - *

The content of the time series data points form.

+ *

The timestamp of when the subscription was revoked.

* @public */ - content?: string; -} + createdAt: Date | undefined; -/** - * @public - */ -export interface PostTimeSeriesDataPointsInput { /** - *

The ID of the Amazon DataZone domain in which you want to post time series data - * points.

+ *

The timestamp of when the subscription was revoked.

* @public */ - domainIdentifier: string | undefined; + updatedAt: Date | undefined; /** - *

The ID of the asset for which you want to post time series data points.

+ *

The subscribed principal of the revoked subscription.

* @public */ - entityIdentifier: string | undefined; + subscribedPrincipal: SubscribedPrincipal | undefined; /** - *

The type of the asset for which you want to post data points.

+ *

The subscribed listing of the revoked subscription.

* @public */ - entityType: TimeSeriesEntityType | undefined; + subscribedListing: SubscribedListing | undefined; /** - *

The forms that contain the data points that you want to post.

+ *

The identifier of the subscription request for the revoked subscription.

* @public */ - forms: TimeSeriesDataPointFormInput[] | undefined; + subscriptionRequestId?: string; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

Specifies whether permissions are retained when the subscription is revoked.

* @public */ - clientToken?: string; + retainPermissions?: boolean; } +/** + * @public + * @enum + */ +export const SearchOutputAdditionalAttribute = { + FORMS: "FORMS", + TIME_SERIES_DATA_POINT_FORMS: "TIME_SERIES_DATA_POINT_FORMS", +} as const; + /** * @public */ -export interface PostTimeSeriesDataPointsOutput { - /** - *

The ID of the Amazon DataZone domain in which you want to post time series data - * points.

- * @public - */ - domainId?: string; - - /** - *

The ID of the asset for which you want to post time series data points.

- * @public - */ - entityId?: string; +export type SearchOutputAdditionalAttribute = + (typeof SearchOutputAdditionalAttribute)[keyof typeof SearchOutputAdditionalAttribute]; +/** + *

A search filter in Amazon DataZone.

+ * @public + */ +export interface Filter { /** - *

The type of the asset for which you want to post data points.

+ *

A search filter attribute in Amazon DataZone.

* @public */ - entityType?: TimeSeriesEntityType; + attribute: string | undefined; /** - *

The forms that contain the data points that you have posted.

+ *

A search filter value in Amazon DataZone.

* @public */ - forms?: TimeSeriesDataPointFormOutput[]; + value: string | undefined; } /** - *

The details of the automatically generated business metadata that is rejected.

+ *

The details of the search.

* @public */ -export interface RejectChoice { - /** - *

Specifies the target (for example, a column name) where a prediction can be - * rejected.

- * @public - */ - predictionTarget: string | undefined; - +export interface SearchInItem { /** - *

Specifies the the automatically generated business metadata that can be rejected.

+ *

The search attribute.

* @public */ - predictionChoices?: number[]; + attribute: string | undefined; } /** * @public * @enum */ -export const RejectRuleBehavior = { - ALL: "ALL", - NONE: "NONE", +export const InventorySearchScope = { + ASSET: "ASSET", + GLOSSARY: "GLOSSARY", + GLOSSARY_TERM: "GLOSSARY_TERM", } as const; /** * @public */ -export type RejectRuleBehavior = (typeof RejectRuleBehavior)[keyof typeof RejectRuleBehavior]; +export type InventorySearchScope = (typeof InventorySearchScope)[keyof typeof InventorySearchScope]; /** - *

Specifies the rule and the threshold under which a prediction can be rejected.

+ *

The details of the way to sort search results.

* @public */ -export interface RejectRule { +export interface SearchSort { /** - *

Specifies whether you want to reject the top prediction for all targets or none.

+ *

The attribute detail of the way to sort search results.

* @public */ - rule?: RejectRuleBehavior; + attribute: string | undefined; /** - *

The confidence score that specifies the condition at which a prediction can be - * rejected.

+ *

The order detail of the wya to sort search results.

* @public */ - threshold?: number; + order?: SortOrder; } /** + *

The details of a business glossary.

* @public */ -export interface RejectPredictionsInput { +export interface GlossaryItem { /** - *

The identifier of the Amazon DataZone domain.

+ *

The identifier of the Amazon DataZone domain in which the business glossary exists.

* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *

The identifier of the prediction.

+ *

The identifier of the glossary.

* @public */ - identifier: string | undefined; + id: string | undefined; /** - *

The revision that is to be made to the asset.

+ *

The name of the glossary.

* @public */ - revision?: string; + name: string | undefined; /** - *

Specifies the rule (or the conditions) under which a prediction can be rejected.

+ *

The identifier of the project that owns the business glosary.

* @public */ - rejectRule?: RejectRule; + owningProjectId: string | undefined; /** - *

Specifies the prediction (aka, the automatically generated piece of metadata) and the - * target (for example, a column name) that can be rejected.

+ *

The business glossary description.

* @public */ - rejectChoices?: RejectChoice[]; + description?: string; /** - *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the - * request.

+ *

The business glossary status.

* @public */ - clientToken?: string; -} + status: GlossaryStatus | undefined; -/** - * @public - */ -export interface RejectPredictionsOutput { /** - *

The ID of the Amazon DataZone domain.

+ *

The timestamp of when the glossary was created.

* @public */ - domainId: string | undefined; + createdAt?: Date; /** - *

The ID of the asset.

+ *

The Amazon DataZone user who created the glossary.

* @public */ - assetId: string | undefined; + createdBy?: string; /** - *

The revision that is to be made to the asset.

+ *

The timestamp of when the business glossary was updated.

* @public */ - assetRevision: string | undefined; + updatedAt?: Date; + + /** + *

The Amazon DataZone user who updated the business glossary.

+ * @public + */ + updatedBy?: string; } /** + *

The details of a business glossary term.

* @public */ -export interface RejectSubscriptionRequestInput { +export interface GlossaryTermItem { /** - *

The identifier of the Amazon DataZone domain in which the subscription request was - * rejected.

+ *

The identifier of the Amazon DataZone domain in which the business glossary exists.

* @public */ - domainIdentifier: string | undefined; + domainId: string | undefined; /** - *

The identifier of the subscription request that was rejected.

+ *

The identifier of the business glossary to which the term belongs.

* @public */ - identifier: string | undefined; + glossaryId: string | undefined; /** - *

The decision comment of the rejected subscription request.

+ *

The identifier of the business glossary term.

* @public */ - decisionComment?: string; -} + id: string | undefined; -/** - * @public - */ -export interface RejectSubscriptionRequestOutput { /** - *

The identifier of the subscription request that was rejected.

+ *

The name of the business glossary term.

* @public */ - id: string | undefined; + name: string | undefined; /** - *

The timestamp of when the subscription request was rejected.

+ *

The short description of the business glossary term.

* @public */ - createdBy: string | undefined; + shortDescription?: string; /** - *

The Amazon DataZone user who updated the subscription request.

+ *

The long description of the business glossary term.

* @public */ - updatedBy?: string; + longDescription?: string; /** - *

The identifier of the Amazon DataZone domain in which the subscription request was - * rejected.

+ *

The relations of the business glossary term.

* @public */ - domainId: string | undefined; + termRelations?: TermRelations; /** - *

The status of the subscription request.

+ *

The status of the business glossary term.

* @public */ - status: SubscriptionRequestStatus | undefined; + status: GlossaryTermStatus | undefined; /** - *

The timestamp of when the subscription request was rejected.

+ *

The timestamp of when a business glossary term was created.

* @public */ - createdAt: Date | undefined; + createdAt?: Date; /** - *

The timestamp of when the subscription request was updated.

+ *

The Amazon DataZone user who created the business glossary.

* @public */ - updatedAt: Date | undefined; + createdBy?: string; /** - *

The reason for the subscription request.

+ *

The timestamp of when a business glossary term was updated.

* @public */ - requestReason: string | undefined; + updatedAt?: Date; /** - *

The subscribed principals of the subscription request.

+ *

The Amazon DataZone user who updated the business glossary term.

* @public */ - subscribedPrincipals: SubscribedPrincipal[] | undefined; + updatedBy?: string; +} + +/** + *

The details of the search results.

+ * @public + */ +export type SearchInventoryResultItem = + | SearchInventoryResultItem.AssetItemMember + | SearchInventoryResultItem.DataProductItemMember + | SearchInventoryResultItem.GlossaryItemMember + | SearchInventoryResultItem.GlossaryTermItemMember + | SearchInventoryResultItem.$UnknownMember; + +/** + * @public + */ +export namespace SearchInventoryResultItem { + /** + *

The glossary item included in the search results.

+ * @public + */ + export interface GlossaryItemMember { + glossaryItem: GlossaryItem; + glossaryTermItem?: never; + assetItem?: never; + dataProductItem?: never; + $unknown?: never; + } /** - *

The subscribed listings of the subscription request.

+ *

The glossary term item included in the search results.

* @public */ - subscribedListings: SubscribedListing[] | undefined; + export interface GlossaryTermItemMember { + glossaryItem?: never; + glossaryTermItem: GlossaryTermItem; + assetItem?: never; + dataProductItem?: never; + $unknown?: never; + } /** - *

The identifier of the subscription request reviewer.

+ *

The asset item included in the search results.

* @public */ - reviewerId?: string; + export interface AssetItemMember { + glossaryItem?: never; + glossaryTermItem?: never; + assetItem: AssetItem; + dataProductItem?: never; + $unknown?: never; + } /** - *

The decision comment of the rejected subscription request.

+ * @deprecated + * + *

The data product item included in the search results.

* @public */ - decisionComment?: string; + export interface DataProductItemMember { + glossaryItem?: never; + glossaryTermItem?: never; + assetItem?: never; + dataProductItem: DataProductSummary; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + glossaryItem?: never; + glossaryTermItem?: never; + assetItem?: never; + dataProductItem?: never; + $unknown: [string, any]; + } + + export interface Visitor { + glossaryItem: (value: GlossaryItem) => T; + glossaryTermItem: (value: GlossaryTermItem) => T; + assetItem: (value: AssetItem) => T; + dataProductItem: (value: DataProductSummary) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: SearchInventoryResultItem, visitor: Visitor): T => { + if (value.glossaryItem !== undefined) return visitor.glossaryItem(value.glossaryItem); + if (value.glossaryTermItem !== undefined) return visitor.glossaryTermItem(value.glossaryTermItem); + if (value.assetItem !== undefined) return visitor.assetItem(value.assetItem); + if (value.dataProductItem !== undefined) return visitor.dataProductItem(value.dataProductItem); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** * @public */ -export interface RevokeSubscriptionInput { +export interface SearchOutput { /** - *

The identifier of the Amazon DataZone domain where you want to revoke a subscription.

+ *

The results of the Search action.

* @public */ - domainIdentifier: string | undefined; + items?: SearchInventoryResultItem[]; /** - *

The identifier of the revoked subscription.

+ *

When the number of results 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 results, the response includes a + * pagination token named NextToken. You can specify this NextToken + * value in a subsequent call to Search to list the next set of results.

* @public */ - identifier: string | undefined; + nextToken?: string; /** - *

Specifies whether permissions are retained when the subscription is revoked.

+ *

Total number of search results.

* @public */ - retainPermissions?: boolean; + totalMatchCount?: number; } /** * @public + * @enum */ -export interface RevokeSubscriptionOutput { +export const GroupSearchType = { + DATAZONE_SSO_GROUP: "DATAZONE_SSO_GROUP", + SSO_GROUP: "SSO_GROUP", +} as const; + +/** + * @public + */ +export type GroupSearchType = (typeof GroupSearchType)[keyof typeof GroupSearchType]; + +/** + * @public + */ +export interface SearchGroupProfilesInput { /** - *

The identifier of the revoked subscription.

+ *

The identifier of the Amazon DataZone domain in which you want to search group + * profiles.

* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *

The identifier of the user who revoked the subscription.

+ *

The group type for which to search.

* @public */ - createdBy: string | undefined; + groupType: GroupSearchType | undefined; /** - *

The Amazon DataZone user who revoked the subscription.

+ *

Specifies the text for which to search.

* @public */ - updatedBy?: string; + searchText?: string; /** - *

The identifier of the Amazon DataZone domain where you want to revoke a subscription.

+ *

The maximum number of results to return in a single call to + * SearchGroupProfiles. When the number of results 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 SearchGroupProfiles to list the + * next set of results.

* @public */ - domainId: string | undefined; + maxResults?: number; /** - *

The status of the revoked subscription.

+ *

When the number of results 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 results, the response includes a + * pagination token named NextToken. You can specify this NextToken + * value in a subsequent call to SearchGroupProfiles to list the next set of + * results.

* @public */ - status: SubscriptionStatus | undefined; + nextToken?: string; +} +/** + *

The details of a group profile.

+ * @public + */ +export interface GroupProfileSummary { /** - *

The timestamp of when the subscription was revoked.

+ *

The ID of the Amazon DataZone domain of a group profile.

* @public */ - createdAt: Date | undefined; + domainId?: string; /** - *

The timestamp of when the subscription was revoked.

+ *

The ID of a group profile.

* @public */ - updatedAt: Date | undefined; + id?: string; /** - *

The subscribed principal of the revoked subscription.

+ *

The status of a group profile.

* @public */ - subscribedPrincipal: SubscribedPrincipal | undefined; + status?: GroupProfileStatus; /** - *

The subscribed listing of the revoked subscription.

+ *

The group name of a group profile.

* @public */ - subscribedListing: SubscribedListing | undefined; + groupName?: string; +} +/** + * @public + */ +export interface SearchGroupProfilesOutput { /** - *

The identifier of the subscription request for the revoked subscription.

+ *

The results of the SearchGroupProfiles action.

* @public */ - subscriptionRequestId?: string; + items?: GroupProfileSummary[]; /** - *

Specifies whether permissions are retained when the subscription is revoked.

+ *

When the number of results 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 results, the response includes a + * pagination token named NextToken. You can specify this NextToken + * value in a subsequent call to SearchGroupProfiles to list the next set of + * results.

* @public */ - retainPermissions?: boolean; + nextToken?: string; } /** - * @public - * @enum - */ -export const SearchOutputAdditionalAttribute = { - FORMS: "FORMS", - TIME_SERIES_DATA_POINT_FORMS: "TIME_SERIES_DATA_POINT_FORMS", -} as const; - -/** + *

The details of the results of the SearchListings action.

* @public */ -export type SearchOutputAdditionalAttribute = - (typeof SearchOutputAdditionalAttribute)[keyof typeof SearchOutputAdditionalAttribute]; +export type SearchResultItem = SearchResultItem.AssetListingMember | SearchResultItem.$UnknownMember; /** - *

A search filter in Amazon DataZone.

* @public */ -export interface Filter { +export namespace SearchResultItem { /** - *

A search filter attribute in Amazon DataZone.

+ *

The asset listing included in the results of the SearchListings + * action.

* @public */ - attribute: string | undefined; + export interface AssetListingMember { + assetListing: AssetListingItem; + $unknown?: never; + } /** - *

A search filter value in Amazon DataZone.

* @public */ - value: string | undefined; + export interface $UnknownMember { + assetListing?: never; + $unknown: [string, any]; + } + + export interface Visitor { + assetListing: (value: AssetListingItem) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: SearchResultItem, visitor: Visitor): T => { + if (value.assetListing !== undefined) return visitor.assetListing(value.assetListing); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** - *

The details of the search.

* @public */ -export interface SearchInItem { +export interface SearchListingsOutput { /** - *

The search attribute.

+ *

The results of the SearchListings action.

* @public */ - attribute: string | undefined; + items?: SearchResultItem[]; + + /** + *

When the number of results 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 results, the response includes a + * pagination token named NextToken. You can specify this NextToken + * value in a subsequent call to SearchListings to list the next set of + * results.

+ * @public + */ + nextToken?: string; + + /** + *

Total number of search results.

+ * @public + */ + totalMatchCount?: number; } /** * @public * @enum */ -export const InventorySearchScope = { - ASSET: "ASSET", - GLOSSARY: "GLOSSARY", - GLOSSARY_TERM: "GLOSSARY_TERM", +export const TypesSearchScope = { + ASSET_TYPE: "ASSET_TYPE", + FORM_TYPE: "FORM_TYPE", + LINEAGE_NODE_TYPE: "LINEAGE_NODE_TYPE", } as const; /** * @public */ -export type InventorySearchScope = (typeof InventorySearchScope)[keyof typeof InventorySearchScope]; - -/** - *

The details of the way to sort search results.

- * @public - */ -export interface SearchSort { - /** - *

The attribute detail of the way to sort search results.

- * @public - */ - attribute: string | undefined; - - /** - *

The order detail of the wya to sort search results.

- * @public - */ - order?: SortOrder; -} +export type TypesSearchScope = (typeof TypesSearchScope)[keyof typeof TypesSearchScope]; /** - *

The details of a business glossary.

+ *

The details of the metadata form type.

* @public */ -export interface GlossaryItem { +export interface FormTypeData { /** - *

The identifier of the Amazon DataZone domain in which the business glossary exists.

+ *

The identifier of the Amazon DataZone domain in which the form type exists.

* @public */ domainId: string | undefined; /** - *

The identifier of the glossary.

- * @public - */ - id: string | undefined; - - /** - *

The name of the glossary.

+ *

The name of the form type.

* @public */ name: string | undefined; /** - *

The identifier of the project that owns the business glosary.

- * @public - */ - owningProjectId: string | undefined; - - /** - *

The business glossary description.

- * @public - */ - description?: string; - - /** - *

The business glossary status.

+ *

The revision of the form type.

* @public */ - status: GlossaryStatus | undefined; + revision: string | undefined; /** - *

The timestamp of when the glossary was created.

+ *

The model of the form type.

* @public */ - createdAt?: Date; + model?: Model; /** - *

The Amazon DataZone user who created the glossary.

+ *

The status of the form type.

* @public */ - createdBy?: string; + status?: FormTypeStatus; /** - *

The timestamp of when the business glossary was updated.

+ *

The identifier of the project that owns the form type.

* @public */ - updatedAt?: Date; + owningProjectId?: string; /** - *

The Amazon DataZone user who updated the business glossary.

+ *

The identifier of the Amazon DataZone domain in which the form type was originally + * created.

* @public */ - updatedBy?: string; -} + originDomainId?: string; -/** - *

The details of a business glossary term.

- * @public - */ -export interface GlossaryTermItem { /** - *

The identifier of the Amazon DataZone domain in which the business glossary exists.

+ *

The identifier of the project in which the form type was originally created.

* @public */ - domainId: string | undefined; + originProjectId?: string; /** - *

The identifier of the business glossary to which the term belongs.

+ *

The timestamp of when the metadata form type was created.

* @public */ - glossaryId: string | undefined; + createdAt?: Date; /** - *

The identifier of the business glossary term.

+ *

The Amazon DataZone user who created teh metadata form type.

* @public */ - id: string | undefined; + createdBy?: string; /** - *

The name of the business glossary term.

+ *

The description of the metadata form type.

* @public */ - name: string | undefined; + description?: string; /** - *

The short description of the business glossary term.

+ *

The imports specified in the form type.

* @public */ - shortDescription?: string; + imports?: Import[]; +} +/** + *

The details of a data lineage node type.

+ * @public + */ +export interface LineageNodeTypeItem { /** - *

The long description of the business glossary term.

+ *

The ID of the domain where the data lineage node type lives.

* @public */ - longDescription?: string; + domainId: string | undefined; /** - *

The relations of the business glossary term.

+ *

The name of the data lineage node type.

* @public */ - termRelations?: TermRelations; + name?: string; /** - *

The status of the business glossary term.

+ *

The description of the data lineage node type.

* @public */ - status: GlossaryTermStatus | undefined; + description?: string; /** - *

The timestamp of when a business glossary term was created.

+ *

The timestamp at which the data lineage node type was created.

* @public */ createdAt?: Date; /** - *

The Amazon DataZone user who created the business glossary.

+ *

The user who created the data lineage node type.

* @public */ createdBy?: string; /** - *

The timestamp of when a business glossary term was updated.

+ *

The timestamp at which the data lineage node type was updated.

* @public */ updatedAt?: Date; /** - *

The Amazon DataZone user who updated the business glossary term.

+ *

The user who updated the data lineage node type.

* @public */ updatedBy?: string; + + /** + *

The revision of the data lineage node type.

+ * @public + */ + revision: string | undefined; + + /** + *

The forms output of the data lineage node type.

+ * @public + */ + formsOutput: Record | undefined; } /** - *

The details of the search results.

+ *

The details of the results of the SearchTypes action.

* @public */ -export type SearchInventoryResultItem = - | SearchInventoryResultItem.AssetItemMember - | SearchInventoryResultItem.DataProductItemMember - | SearchInventoryResultItem.GlossaryItemMember - | SearchInventoryResultItem.GlossaryTermItemMember - | SearchInventoryResultItem.$UnknownMember; +export type SearchTypesResultItem = + | SearchTypesResultItem.AssetTypeItemMember + | SearchTypesResultItem.FormTypeItemMember + | SearchTypesResultItem.LineageNodeTypeItemMember + | SearchTypesResultItem.$UnknownMember; /** * @public */ -export namespace SearchInventoryResultItem { - /** - *

The glossary item included in the search results.

- * @public - */ - export interface GlossaryItemMember { - glossaryItem: GlossaryItem; - glossaryTermItem?: never; - assetItem?: never; - dataProductItem?: never; - $unknown?: never; - } - +export namespace SearchTypesResultItem { /** - *

The glossary term item included in the search results.

+ *

The asset type included in the results of the SearchTypes action.

* @public */ - export interface GlossaryTermItemMember { - glossaryItem?: never; - glossaryTermItem: GlossaryTermItem; - assetItem?: never; - dataProductItem?: never; + export interface AssetTypeItemMember { + assetTypeItem: AssetTypeItem; + formTypeItem?: never; + lineageNodeTypeItem?: never; $unknown?: never; } /** - *

The asset item included in the search results.

+ *

The form type included in the results of the SearchTypes action.

* @public */ - export interface AssetItemMember { - glossaryItem?: never; - glossaryTermItem?: never; - assetItem: AssetItem; - dataProductItem?: never; + export interface FormTypeItemMember { + assetTypeItem?: never; + formTypeItem: FormTypeData; + lineageNodeTypeItem?: never; $unknown?: never; } /** - * @deprecated - * - *

The data product item included in the search results.

+ *

The details of a data lineage node type.

* @public */ - export interface DataProductItemMember { - glossaryItem?: never; - glossaryTermItem?: never; - assetItem?: never; - dataProductItem: DataProductSummary; + export interface LineageNodeTypeItemMember { + assetTypeItem?: never; + formTypeItem?: never; + lineageNodeTypeItem: LineageNodeTypeItem; $unknown?: never; } @@ -2423,26 +3759,23 @@ export namespace SearchInventoryResultItem { * @public */ export interface $UnknownMember { - glossaryItem?: never; - glossaryTermItem?: never; - assetItem?: never; - dataProductItem?: never; + assetTypeItem?: never; + formTypeItem?: never; + lineageNodeTypeItem?: never; $unknown: [string, any]; } export interface Visitor { - glossaryItem: (value: GlossaryItem) => T; - glossaryTermItem: (value: GlossaryTermItem) => T; - assetItem: (value: AssetItem) => T; - dataProductItem: (value: DataProductSummary) => T; + assetTypeItem: (value: AssetTypeItem) => T; + formTypeItem: (value: FormTypeData) => T; + lineageNodeTypeItem: (value: LineageNodeTypeItem) => T; _: (name: string, value: any) => T; } - export const visit = (value: SearchInventoryResultItem, visitor: Visitor): T => { - if (value.glossaryItem !== undefined) return visitor.glossaryItem(value.glossaryItem); - if (value.glossaryTermItem !== undefined) return visitor.glossaryTermItem(value.glossaryTermItem); - if (value.assetItem !== undefined) return visitor.assetItem(value.assetItem); - if (value.dataProductItem !== undefined) return visitor.dataProductItem(value.dataProductItem); + export const visit = (value: SearchTypesResultItem, visitor: Visitor): T => { + if (value.assetTypeItem !== undefined) return visitor.assetTypeItem(value.assetTypeItem); + if (value.formTypeItem !== undefined) return visitor.formTypeItem(value.formTypeItem); + if (value.lineageNodeTypeItem !== undefined) return visitor.lineageNodeTypeItem(value.lineageNodeTypeItem); return visitor._(value.$unknown[0], value.$unknown[1]); }; } @@ -2450,19 +3783,20 @@ export namespace SearchInventoryResultItem { /** * @public */ -export interface SearchOutput { +export interface SearchTypesOutput { /** - *

The results of the Search action.

+ *

The results of the SearchTypes action.

* @public */ - items?: SearchInventoryResultItem[]; + items?: SearchTypesResultItem[]; /** *

When the number of results 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 results, the response includes a * pagination token named NextToken. You can specify this NextToken - * value in a subsequent call to Search to list the next set of results.

+ * value in a subsequent call to SearchTypes to list the next set of + * results.

* @public */ nextToken?: string; @@ -2478,32 +3812,34 @@ export interface SearchOutput { * @public * @enum */ -export const GroupSearchType = { - DATAZONE_SSO_GROUP: "DATAZONE_SSO_GROUP", - SSO_GROUP: "SSO_GROUP", +export const UserSearchType = { + DATAZONE_IAM_USER: "DATAZONE_IAM_USER", + DATAZONE_SSO_USER: "DATAZONE_SSO_USER", + DATAZONE_USER: "DATAZONE_USER", + SSO_USER: "SSO_USER", } as const; /** * @public */ -export type GroupSearchType = (typeof GroupSearchType)[keyof typeof GroupSearchType]; +export type UserSearchType = (typeof UserSearchType)[keyof typeof UserSearchType]; /** * @public */ -export interface SearchGroupProfilesInput { +export interface SearchUserProfilesInput { /** - *

The identifier of the Amazon DataZone domain in which you want to search group + *

The identifier of the Amazon DataZone domain in which you want to search user * profiles.

* @public */ domainIdentifier: string | undefined; /** - *

The group type for which to search.

+ *

Specifies the user type for the SearchUserProfiles action.

* @public */ - groupType: GroupSearchType | undefined; + userType: UserSearchType | undefined; /** *

Specifies the text for which to search.

@@ -2513,10 +3849,10 @@ export interface SearchGroupProfilesInput { /** *

The maximum number of results to return in a single call to - * SearchGroupProfiles. When the number of results 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 SearchGroupProfiles to list the - * next set of results.

+ * SearchUserProfiles. When the number of results 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 SearchUserProfiles to list the next + * set of results.

* @public */ maxResults?: number; @@ -2526,7 +3862,7 @@ export interface SearchGroupProfilesInput { * MaxResults parameter, or if you explicitly specify a value for * MaxResults that is less than the number of results, the response includes a * pagination token named NextToken. You can specify this NextToken - * value in a subsequent call to SearchGroupProfiles to list the next set of + * value in a subsequent call to SearchUserProfiles to list the next set of * results.

* @public */ @@ -2534,1822 +3870,1906 @@ export interface SearchGroupProfilesInput { } /** - *

The details of a group profile.

+ *

The details of the user profile.

* @public */ -export interface GroupProfileSummary { +export interface UserProfileSummary { /** - *

The ID of the Amazon DataZone domain of a group profile.

+ *

The ID of the Amazon DataZone domain of the user profile.

* @public */ domainId?: string; /** - *

The ID of a group profile.

+ *

The ID of the user profile.

* @public */ id?: string; /** - *

The status of a group profile.

- * @public - */ - status?: GroupProfileStatus; - - /** - *

The group name of a group profile.

- * @public - */ - groupName?: string; -} - -/** - * @public - */ -export interface SearchGroupProfilesOutput { - /** - *

The results of the SearchGroupProfiles action.

- * @public - */ - items?: GroupProfileSummary[]; - - /** - *

When the number of results 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 results, the response includes a - * pagination token named NextToken. You can specify this NextToken - * value in a subsequent call to SearchGroupProfiles to list the next set of - * results.

+ *

The type of the user profile.

* @public */ - nextToken?: string; -} - -/** - *

The details of the results of the SearchListings action.

- * @public - */ -export type SearchResultItem = SearchResultItem.AssetListingMember | SearchResultItem.$UnknownMember; + type?: UserProfileType; -/** - * @public - */ -export namespace SearchResultItem { /** - *

The asset listing included in the results of the SearchListings - * action.

+ *

The status of the user profile.

* @public */ - export interface AssetListingMember { - assetListing: AssetListingItem; - $unknown?: never; - } + status?: UserProfileStatus; /** + *

The details of the user profile.

* @public */ - export interface $UnknownMember { - assetListing?: never; - $unknown: [string, any]; - } - - export interface Visitor { - assetListing: (value: AssetListingItem) => T; - _: (name: string, value: any) => T; - } - - export const visit = (value: SearchResultItem, visitor: Visitor): T => { - if (value.assetListing !== undefined) return visitor.assetListing(value.assetListing); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + details?: UserProfileDetails; } /** * @public */ -export interface SearchListingsOutput { +export interface SearchUserProfilesOutput { /** - *

The results of the SearchListings action.

+ *

The results of the SearchUserProfiles action.

* @public */ - items?: SearchResultItem[]; + items?: UserProfileSummary[]; /** *

When the number of results 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 results, the response includes a * pagination token named NextToken. You can specify this NextToken - * value in a subsequent call to SearchListings to list the next set of + * value in a subsequent call to SearchUserProfiles to list the next set of * results.

* @public */ nextToken?: string; +} +/** + * @public + */ +export interface TagResourceRequest { /** - *

Total number of search results.

+ *

The ARN of the resource to be tagged in Amazon DataZone.

* @public */ - totalMatchCount?: number; + resourceArn: string | undefined; + + /** + *

Specifies the tags for the TagResource action.

+ * @public + */ + tags: Record | undefined; } /** * @public - * @enum */ -export const TypesSearchScope = { - ASSET_TYPE: "ASSET_TYPE", - FORM_TYPE: "FORM_TYPE", - LINEAGE_NODE_TYPE: "LINEAGE_NODE_TYPE", -} as const; +export interface TagResourceResponse {} /** * @public */ -export type TypesSearchScope = (typeof TypesSearchScope)[keyof typeof TypesSearchScope]; +export interface UntagResourceRequest { + /** + *

The ARN of the resource to be untagged in Amazon DataZone.

+ * @public + */ + resourceArn: string | undefined; + + /** + *

Specifies the tag keys for the UntagResource action.

+ * @public + */ + tagKeys: string[] | undefined; +} /** - *

The details of the metadata form type.

* @public */ -export interface FormTypeData { +export interface UntagResourceResponse {} + +/** + * @public + */ +export interface UpdateEnvironmentInput { /** - *

The identifier of the Amazon DataZone domain in which the form type exists.

+ *

The identifier of the domain in which the environment is to be updated.

* @public */ - domainId: string | undefined; + domainIdentifier: string | undefined; /** - *

The name of the form type.

+ *

The identifier of the environment that is to be updated.

* @public */ - name: string | undefined; + identifier: string | undefined; /** - *

The revision of the form type.

+ *

The name to be updated as part of the UpdateEnvironment action.

* @public */ - revision: string | undefined; + name?: string; /** - *

The model of the form type.

+ *

The description to be updated as part of the UpdateEnvironment + * action.

* @public */ - model?: Model; + description?: string; /** - *

The status of the form type.

+ *

The glossary terms to be updated as part of the UpdateEnvironment + * action.

* @public */ - status?: FormTypeStatus; + glossaryTerms?: string[]; +} +/** + * @public + */ +export interface UpdateEnvironmentOutput { /** - *

The identifier of the project that owns the form type.

+ *

The project identifier of the environment.

* @public */ - owningProjectId?: string; + projectId: string | undefined; /** - *

The identifier of the Amazon DataZone domain in which the form type was originally - * created.

+ *

The identifier of the environment that is to be updated.

* @public */ - originDomainId?: string; + id?: string; /** - *

The identifier of the project in which the form type was originally created.

+ *

The identifier of the domain in which the environment is to be updated.

* @public */ - originProjectId?: string; + domainId: string | undefined; /** - *

The timestamp of when the metadata form type was created.

+ *

The Amazon DataZone user who created the environment.

* @public */ - createdAt?: Date; + createdBy: string | undefined; /** - *

The Amazon DataZone user who created teh metadata form type.

+ *

The timestamp of when the environment was created.

* @public */ - createdBy?: string; + createdAt?: Date; /** - *

The description of the metadata form type.

+ *

The timestamp of when the environment was updated.

* @public */ - description?: string; + updatedAt?: Date; /** - *

The imports specified in the form type.

+ *

The name to be updated as part of the UpdateEnvironment action.

* @public */ - imports?: Import[]; -} + name: string | undefined; -/** - *

The details of a data lineage node type.

- * @public - */ -export interface LineageNodeTypeItem { /** - *

The ID of the domain where the data lineage node type lives.

+ *

The description to be updated as part of the UpdateEnvironment + * action.

* @public */ - domainId: string | undefined; + description?: string; /** - *

The name of the data lineage node type.

+ *

The profile identifier of the environment.

* @public */ - name?: string; + environmentProfileId?: string; /** - *

The description of the data lineage node type.

+ *

The identifier of the Amazon Web Services account in which the environment is to be + * updated.

* @public */ - description?: string; + awsAccountId?: string; /** - *

The timestamp at which the data lineage node type was created.

+ *

The Amazon Web Services Region in which the environment is updated.

* @public */ - createdAt?: Date; + awsAccountRegion?: string; /** - *

The user who created the data lineage node type.

+ *

The provider identifier of the environment.

* @public */ - createdBy?: string; + provider: string | undefined; /** - *

The timestamp at which the data lineage node type was updated.

+ *

The provisioned resources to be updated as part of the UpdateEnvironment + * action.

* @public */ - updatedAt?: Date; + provisionedResources?: Resource[]; /** - *

The user who updated the data lineage node type.

+ *

The status to be updated as part of the UpdateEnvironment action.

* @public */ - updatedBy?: string; + status?: EnvironmentStatus; /** - *

The revision of the data lineage node type.

+ *

The environment actions to be updated as part of the UpdateEnvironment + * action.

* @public */ - revision: string | undefined; + environmentActions?: ConfigurableEnvironmentAction[]; /** - *

The forms output of the data lineage node type.

+ *

The glossary terms to be updated as part of the UpdateEnvironment + * action.

* @public */ - formsOutput: Record | undefined; -} - -/** - *

The details of the results of the SearchTypes action.

- * @public - */ -export type SearchTypesResultItem = - | SearchTypesResultItem.AssetTypeItemMember - | SearchTypesResultItem.FormTypeItemMember - | SearchTypesResultItem.LineageNodeTypeItemMember - | SearchTypesResultItem.$UnknownMember; + glossaryTerms?: string[]; -/** - * @public - */ -export namespace SearchTypesResultItem { /** - *

The asset type included in the results of the SearchTypes action.

+ *

The user parameters to be updated as part of the UpdateEnvironment + * action.

* @public */ - export interface AssetTypeItemMember { - assetTypeItem: AssetTypeItem; - formTypeItem?: never; - lineageNodeTypeItem?: never; - $unknown?: never; - } + userParameters?: CustomParameter[]; /** - *

The form type included in the results of the SearchTypes action.

+ *

The last deployment of the environment.

* @public */ - export interface FormTypeItemMember { - assetTypeItem?: never; - formTypeItem: FormTypeData; - lineageNodeTypeItem?: never; - $unknown?: never; - } + lastDeployment?: Deployment; /** - *

The details of a data lineage node type.

+ *

The provisioning properties to be updated as part of the UpdateEnvironment + * action.

* @public */ - export interface LineageNodeTypeItemMember { - assetTypeItem?: never; - formTypeItem?: never; - lineageNodeTypeItem: LineageNodeTypeItem; - $unknown?: never; - } + provisioningProperties?: ProvisioningProperties; /** + *

The deployment properties to be updated as part of the UpdateEnvironment + * action.

* @public */ - export interface $UnknownMember { - assetTypeItem?: never; - formTypeItem?: never; - lineageNodeTypeItem?: never; - $unknown: [string, any]; - } - - export interface Visitor { - assetTypeItem: (value: AssetTypeItem) => T; - formTypeItem: (value: FormTypeData) => T; - lineageNodeTypeItem: (value: LineageNodeTypeItem) => T; - _: (name: string, value: any) => T; - } + deploymentProperties?: DeploymentProperties; - export const visit = (value: SearchTypesResultItem, visitor: Visitor): T => { - if (value.assetTypeItem !== undefined) return visitor.assetTypeItem(value.assetTypeItem); - if (value.formTypeItem !== undefined) return visitor.formTypeItem(value.formTypeItem); - if (value.lineageNodeTypeItem !== undefined) return visitor.lineageNodeTypeItem(value.lineageNodeTypeItem); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + /** + *

The blueprint identifier of the environment.

+ * @public + */ + environmentBlueprintId?: string; } /** * @public */ -export interface SearchTypesOutput { +export interface UpdateEnvironmentActionInput { /** - *

The results of the SearchTypes action.

+ *

The domain ID of the environment action.

* @public */ - items?: SearchTypesResultItem[]; + domainIdentifier: string | undefined; /** - *

When the number of results 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 results, the response includes a - * pagination token named NextToken. You can specify this NextToken - * value in a subsequent call to SearchTypes to list the next set of - * results.

+ *

The environment ID of the environment action.

+ * @public + */ + environmentIdentifier: string | undefined; + + /** + *

The ID of the environment action.

+ * @public + */ + identifier: string | undefined; + + /** + *

The parameters of the environment action.

+ * @public + */ + parameters?: ActionParameters; + + /** + *

The name of the environment action.

* @public */ - nextToken?: string; + name?: string; /** - *

Total number of search results.

+ *

The description of the environment action.

* @public */ - totalMatchCount?: number; + description?: string; } -/** - * @public - * @enum - */ -export const UserSearchType = { - DATAZONE_IAM_USER: "DATAZONE_IAM_USER", - DATAZONE_SSO_USER: "DATAZONE_SSO_USER", - DATAZONE_USER: "DATAZONE_USER", - SSO_USER: "SSO_USER", -} as const; - /** * @public */ -export type UserSearchType = (typeof UserSearchType)[keyof typeof UserSearchType]; +export interface UpdateEnvironmentActionOutput { + /** + *

The domain ID of the environment action.

+ * @public + */ + domainId: string | undefined; -/** - * @public - */ -export interface SearchUserProfilesInput { /** - *

The identifier of the Amazon DataZone domain in which you want to search user - * profiles.

+ *

The environment ID of the environment action.

* @public */ - domainIdentifier: string | undefined; + environmentId: string | undefined; /** - *

Specifies the user type for the SearchUserProfiles action.

+ *

The ID of the environment action.

* @public */ - userType: UserSearchType | undefined; + id: string | undefined; /** - *

Specifies the text for which to search.

+ *

The name of the environment action.

* @public */ - searchText?: string; + name: string | undefined; /** - *

The maximum number of results to return in a single call to - * SearchUserProfiles. When the number of results 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 SearchUserProfiles to list the next - * set of results.

+ *

The parameters of the environment action.

* @public */ - maxResults?: number; + parameters: ActionParameters | undefined; /** - *

When the number of results 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 results, the response includes a - * pagination token named NextToken. You can specify this NextToken - * value in a subsequent call to SearchUserProfiles to list the next set of - * results.

+ *

The description of the environment action.

* @public */ - nextToken?: string; + description?: string; } /** - *

The details of the user profile.

* @public */ -export interface UserProfileSummary { +export interface UpdateEnvironmentProfileInput { /** - *

The ID of the Amazon DataZone domain of the user profile.

+ *

The identifier of the Amazon DataZone domain in which an environment profile is to be + * updated.

* @public */ - domainId?: string; + domainIdentifier: string | undefined; /** - *

The ID of the user profile.

+ *

The identifier of the environment profile that is to be updated.

* @public */ - id?: string; + identifier: string | undefined; /** - *

The type of the user profile.

+ *

The name to be updated as part of the UpdateEnvironmentProfile + * action.

* @public */ - type?: UserProfileType; + name?: string; /** - *

The status of the user profile.

+ *

The description to be updated as part of the UpdateEnvironmentProfile + * action.

* @public */ - status?: UserProfileStatus; + description?: string; /** - *

The details of the user profile.

+ *

The user parameters to be updated as part of the UpdateEnvironmentProfile + * action.

* @public */ - details?: UserProfileDetails; -} + userParameters?: EnvironmentParameter[]; -/** - * @public - */ -export interface SearchUserProfilesOutput { /** - *

The results of the SearchUserProfiles action.

+ *

The Amazon Web Services account in which a specified environment profile is to be + * udpated.

* @public */ - items?: UserProfileSummary[]; + awsAccountId?: string; /** - *

When the number of results 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 results, the response includes a - * pagination token named NextToken. You can specify this NextToken - * value in a subsequent call to SearchUserProfiles to list the next set of - * results.

+ *

The Amazon Web Services Region in which a specified environment profile is to be + * updated.

* @public */ - nextToken?: string; + awsAccountRegion?: string; } /** * @public */ -export interface TagResourceRequest { +export interface UpdateEnvironmentProfileOutput { /** - *

The ARN of the resource to be tagged in Amazon DataZone.

+ *

The identifier of the environment profile that is to be udpated.

* @public */ - resourceArn: string | undefined; + id: string | undefined; /** - *

Specifies the tags for the TagResource action.

+ *

The identifier of the Amazon DataZone domain in which the environment profile is to be + * updated.

* @public */ - tags: Record | undefined; -} - -/** - * @public - */ -export interface TagResourceResponse {} + domainId: string | undefined; -/** - * @public - */ -export interface UntagResourceRequest { /** - *

The ARN of the resource to be untagged in Amazon DataZone.

+ *

The Amazon Web Services account in which a specified environment profile is to be + * udpated.

* @public */ - resourceArn: string | undefined; + awsAccountId?: string; /** - *

Specifies the tag keys for the UntagResource action.

+ *

The Amazon Web Services Region in which a specified environment profile is to be + * updated.

* @public */ - tagKeys: string[] | undefined; -} + awsAccountRegion?: string; -/** - * @public - */ -export interface UntagResourceResponse {} + /** + *

The Amazon DataZone user who created the environment profile.

+ * @public + */ + createdBy: string | undefined; -/** - * @public - */ -export interface UpdateEnvironmentInput { /** - *

The identifier of the domain in which the environment is to be updated.

+ *

The timestamp of when the environment profile was created.

* @public */ - domainIdentifier: string | undefined; + createdAt?: Date; /** - *

The identifier of the environment that is to be updated.

+ *

The timestamp of when the environment profile was updated.

* @public */ - identifier: string | undefined; + updatedAt?: Date; /** - *

The name to be updated as part of the UpdateEnvironment action.

+ *

The name to be updated as part of the UpdateEnvironmentProfile + * action.

* @public */ - name?: string; + name: string | undefined; /** - *

The description to be updated as part of the UpdateEnvironment + *

The description to be updated as part of the UpdateEnvironmentProfile * action.

* @public */ description?: string; /** - *

The glossary terms to be updated as part of the UpdateEnvironment + *

The identifier of the blueprint of the environment profile that is to be updated.

+ * @public + */ + environmentBlueprintId: string | undefined; + + /** + *

The identifier of the project of the environment profile that is to be updated.

+ * @public + */ + projectId?: string; + + /** + *

The user parameters to be updated as part of the UpdateEnvironmentProfile * action.

* @public */ - glossaryTerms?: string[]; + userParameters?: CustomParameter[]; } /** * @public */ -export interface UpdateEnvironmentOutput { +export interface UpdateGroupProfileInput { /** - *

The project identifier of the environment.

+ *

The identifier of the Amazon DataZone domain in which a group profile is updated.

* @public */ - projectId: string | undefined; + domainIdentifier: string | undefined; /** - *

The identifier of the environment that is to be updated.

+ *

The identifier of the group profile that is updated.

* @public */ - id?: string; + groupIdentifier: string | undefined; /** - *

The identifier of the domain in which the environment is to be updated.

+ *

The status of the group profile that is updated.

* @public */ - domainId: string | undefined; + status: GroupProfileStatus | undefined; +} +/** + * @public + */ +export interface UpdateGroupProfileOutput { /** - *

The Amazon DataZone user who created the environment.

+ *

The identifier of the Amazon DataZone domain in which a group profile is updated.

* @public */ - createdBy: string | undefined; + domainId?: string; /** - *

The timestamp of when the environment was created.

+ *

The identifier of the group profile that is updated.

* @public */ - createdAt?: Date; + id?: string; /** - *

The timestamp of when the environment was updated.

+ *

The status of the group profile that is updated.

* @public */ - updatedAt?: Date; + status?: GroupProfileStatus; /** - *

The name to be updated as part of the UpdateEnvironment action.

+ *

The name of the group profile that is updated.

* @public */ - name: string | undefined; + groupName?: string; +} +/** + * @public + */ +export interface UpdateProjectInput { /** - *

The description to be updated as part of the UpdateEnvironment - * action.

+ *

The identifier of the Amazon DataZone domain in which a project is to be updated.

* @public */ - description?: string; + domainIdentifier: string | undefined; /** - *

The profile identifier of the environment.

+ *

The identifier of the project that is to be updated.

* @public */ - environmentProfileId?: string; + identifier: string | undefined; /** - *

The identifier of the Amazon Web Services account in which the environment is to be - * updated.

+ *

The name to be updated as part of the UpdateProject action.

* @public */ - awsAccountId?: string; + name?: string; /** - *

The Amazon Web Services Region in which the environment is updated.

+ *

The description to be updated as part of the UpdateProject action.

* @public */ - awsAccountRegion?: string; + description?: string; /** - *

The provider identifier of the environment.

+ *

The glossary terms to be updated as part of the UpdateProject + * action.

* @public */ - provider: string | undefined; + glossaryTerms?: string[]; +} +/** + * @public + */ +export interface UpdateProjectOutput { /** - *

The provisioned resources to be updated as part of the UpdateEnvironment - * action.

+ *

The identifier of the Amazon DataZone domain in which a project is updated.

+ * @public + */ + domainId: string | undefined; + + /** + *

The identifier of the project that is to be updated.

* @public */ - provisionedResources?: Resource[]; + id: string | undefined; /** - *

The status to be updated as part of the UpdateEnvironment action.

+ *

The name of the project that is to be updated.

* @public */ - status?: EnvironmentStatus; + name: string | undefined; /** - *

The environment actions to be updated as part of the UpdateEnvironment - * action.

+ *

The description of the project that is to be updated.

* @public */ - environmentActions?: ConfigurableEnvironmentAction[]; + description?: string; /** - *

The glossary terms to be updated as part of the UpdateEnvironment - * action.

+ *

The status of the project.

* @public */ - glossaryTerms?: string[]; + projectStatus?: ProjectStatus; /** - *

The user parameters to be updated as part of the UpdateEnvironment - * action.

+ *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

* @public */ - userParameters?: CustomParameter[]; + failureReasons?: ProjectDeletionError[]; /** - *

The last deployment of the environment.

+ *

The Amazon DataZone user who created the project.

* @public */ - lastDeployment?: Deployment; + createdBy: string | undefined; /** - *

The provisioning properties to be updated as part of the UpdateEnvironment - * action.

+ *

The timestamp of when the project was created.

* @public */ - provisioningProperties?: ProvisioningProperties; + createdAt?: Date; /** - *

The deployment properties to be updated as part of the UpdateEnvironment - * action.

+ *

The timestamp of when the project was last updated.

* @public */ - deploymentProperties?: DeploymentProperties; + lastUpdatedAt?: Date; /** - *

The blueprint identifier of the environment.

+ *

The glossary terms of the project that are to be updated.

* @public */ - environmentBlueprintId?: string; + glossaryTerms?: string[]; } /** * @public */ -export interface UpdateEnvironmentActionInput { +export interface UpdateSubscriptionGrantStatusInput { /** - *

The domain ID of the environment action.

+ *

The identifier of the Amazon DataZone domain in which a subscription grant status is to be + * updated.

* @public */ domainIdentifier: string | undefined; /** - *

The environment ID of the environment action.

+ *

The identifier of the subscription grant the status of which is to be updated.

* @public */ - environmentIdentifier: string | undefined; + identifier: string | undefined; /** - *

The ID of the environment action.

+ *

The identifier of the asset the subscription grant status of which is to be + * updated.

* @public */ - identifier: string | undefined; + assetIdentifier: string | undefined; /** - *

The parameters of the environment action.

+ *

The status to be updated as part of the UpdateSubscriptionGrantStatus + * action.

* @public */ - parameters?: ActionParameters; + status: SubscriptionGrantStatus | undefined; /** - *

The name of the environment action.

+ *

Specifies the error message that is returned if the operation cannot be successfully + * completed.

* @public */ - name?: string; + failureCause?: FailureCause; /** - *

The description of the environment action.

+ *

The target name to be updated as part of the UpdateSubscriptionGrantStatus + * action.

* @public */ - description?: string; + targetName?: string; } /** * @public */ -export interface UpdateEnvironmentActionOutput { +export interface UpdateSubscriptionGrantStatusOutput { /** - *

The domain ID of the environment action.

+ *

The identifier of the subscription grant.

* @public */ - domainId: string | undefined; + id: string | undefined; /** - *

The environment ID of the environment action.

+ *

The Amazon DataZone domain user who created the subscription grant status.

* @public */ - environmentId: string | undefined; + createdBy: string | undefined; /** - *

The ID of the environment action.

+ *

The Amazon DataZone user who updated the subscription grant status.

* @public */ - id: string | undefined; + updatedBy?: string; /** - *

The name of the environment action.

+ *

The identifier of the Amazon DataZone domain in which a subscription grant status is to be + * updated.

* @public */ - name: string | undefined; + domainId: string | undefined; /** - *

The parameters of the environment action.

+ *

The timestamp of when the subscription grant status was created.

* @public */ - parameters: ActionParameters | undefined; + createdAt: Date | undefined; /** - *

The description of the environment action.

+ *

The timestamp of when the subscription grant status is to be updated.

* @public */ - description?: string; -} + updatedAt: Date | undefined; -/** - * @public - */ -export interface UpdateEnvironmentProfileInput { /** - *

The identifier of the Amazon DataZone domain in which an environment profile is to be + *

The identifier of the subscription target whose subscription grant status is to be * updated.

* @public */ - domainIdentifier: string | undefined; + subscriptionTargetId: string | undefined; /** - *

The identifier of the environment profile that is to be updated.

+ *

The granted entity to be updated as part of the + * UpdateSubscriptionGrantStatus action.

* @public */ - identifier: string | undefined; + grantedEntity: GrantedEntity | undefined; /** - *

The name to be updated as part of the UpdateEnvironmentProfile + *

The status to be updated as part of the UpdateSubscriptionGrantStatus * action.

* @public */ - name?: string; + status: SubscriptionGrantOverallStatus | undefined; /** - *

The description to be updated as part of the UpdateEnvironmentProfile - * action.

+ *

The details of the asset for which the subscription grant is created.

* @public */ - description?: string; + assets?: SubscribedAsset[]; /** - *

The user parameters to be updated as part of the UpdateEnvironmentProfile - * action.

+ *

The identifier of the subscription.

* @public */ - userParameters?: EnvironmentParameter[]; + subscriptionId?: string; +} + +/** + * @public + */ +export interface UpdateSubscriptionRequestInput { + /** + *

The identifier of the Amazon DataZone domain in which a subscription request is to be + * updated.

+ * @public + */ + domainIdentifier: string | undefined; /** - *

The Amazon Web Services account in which a specified environment profile is to be - * udpated.

+ *

The identifier of the subscription request that is to be updated.

* @public */ - awsAccountId?: string; + identifier: string | undefined; /** - *

The Amazon Web Services Region in which a specified environment profile is to be - * updated.

+ *

The reason for the UpdateSubscriptionRequest action.

* @public */ - awsAccountRegion?: string; + requestReason: string | undefined; } /** * @public */ -export interface UpdateEnvironmentProfileOutput { +export interface UpdateSubscriptionRequestOutput { /** - *

The identifier of the environment profile that is to be udpated.

+ *

The identifier of the subscription request that is to be updated.

* @public */ id: string | undefined; /** - *

The identifier of the Amazon DataZone domain in which the environment profile is to be - * updated.

+ *

The Amazon DataZone user who created the subscription request.

* @public */ - domainId: string | undefined; + createdBy: string | undefined; /** - *

The Amazon Web Services account in which a specified environment profile is to be - * udpated.

+ *

The Amazon DataZone user who updated the subscription request.

* @public */ - awsAccountId?: string; + updatedBy?: string; /** - *

The Amazon Web Services Region in which a specified environment profile is to be + *

The identifier of the Amazon DataZone domain in which a subscription request is to be * updated.

* @public */ - awsAccountRegion?: string; + domainId: string | undefined; /** - *

The Amazon DataZone user who created the environment profile.

+ *

The status of the subscription request.

* @public */ - createdBy: string | undefined; + status: SubscriptionRequestStatus | undefined; /** - *

The timestamp of when the environment profile was created.

+ *

The timestamp of when the subscription request was created.

* @public */ - createdAt?: Date; + createdAt: Date | undefined; /** - *

The timestamp of when the environment profile was updated.

+ *

The timestamp of when the subscription request was updated.

* @public */ - updatedAt?: Date; + updatedAt: Date | undefined; /** - *

The name to be updated as part of the UpdateEnvironmentProfile - * action.

+ *

The reason for the UpdateSubscriptionRequest action.

* @public */ - name: string | undefined; + requestReason: string | undefined; /** - *

The description to be updated as part of the UpdateEnvironmentProfile - * action.

+ *

The subscribed principals of the subscription request.

* @public */ - description?: string; + subscribedPrincipals: SubscribedPrincipal[] | undefined; /** - *

The identifier of the blueprint of the environment profile that is to be updated.

+ *

The subscribed listings of the subscription request.

* @public */ - environmentBlueprintId: string | undefined; + subscribedListings: SubscribedListing[] | undefined; /** - *

The identifier of the project of the environment profile that is to be updated.

+ *

The identifier of the Amazon DataZone user who reviews the subscription request.

* @public */ - projectId?: string; + reviewerId?: string; /** - *

The user parameters to be updated as part of the UpdateEnvironmentProfile - * action.

+ *

The decision comment of the UpdateSubscriptionRequest action.

* @public */ - userParameters?: CustomParameter[]; + decisionComment?: string; } /** * @public */ -export interface UpdateGroupProfileInput { +export interface UpdateSubscriptionTargetInput { /** - *

The identifier of the Amazon DataZone domain in which a group profile is updated.

+ *

The identifier of the Amazon DataZone domain in which a subscription target is to be + * updated.

* @public */ domainIdentifier: string | undefined; /** - *

The identifier of the group profile that is updated.

+ *

The identifier of the environment in which a subscription target is to be + * updated.

* @public */ - groupIdentifier: string | undefined; + environmentIdentifier: string | undefined; /** - *

The status of the group profile that is updated.

+ *

Identifier of the subscription target that is to be updated.

* @public */ - status: GroupProfileStatus | undefined; -} + identifier: string | undefined; -/** - * @public - */ -export interface UpdateGroupProfileOutput { /** - *

The identifier of the Amazon DataZone domain in which a group profile is updated.

+ *

The name to be updated as part of the UpdateSubscriptionTarget + * action.

* @public */ - domainId?: string; + name?: string; /** - *

The identifier of the group profile that is updated.

+ *

The authorized principals to be updated as part of the + * UpdateSubscriptionTarget action.

* @public */ - id?: string; + authorizedPrincipals?: string[]; /** - *

The status of the group profile that is updated.

+ *

The applicable asset types to be updated as part of the + * UpdateSubscriptionTarget action.

* @public */ - status?: GroupProfileStatus; + applicableAssetTypes?: string[]; /** - *

The name of the group profile that is updated.

+ *

The configuration to be updated as part of the UpdateSubscriptionTarget + * action.

* @public */ - groupName?: string; + subscriptionTargetConfig?: SubscriptionTargetForm[]; + + /** + *

The manage access role to be updated as part of the + * UpdateSubscriptionTarget action.

+ * @public + */ + manageAccessRole?: string; + + /** + *

The provider to be updated as part of the UpdateSubscriptionTarget + * action.

+ * @public + */ + provider?: string; } /** * @public */ -export interface UpdateProjectInput { +export interface UpdateSubscriptionTargetOutput { /** - *

The identifier of the Amazon DataZone domain in which a project is to be updated.

+ *

Identifier of the subscription target that is to be updated.

* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *

The identifier of the project that is to be updated.

+ *

The authorized principals to be updated as part of the + * UpdateSubscriptionTarget action.

* @public */ - identifier: string | undefined; + authorizedPrincipals: string[] | undefined; /** - *

The name to be updated as part of the UpdateProject action.

+ *

The identifier of the Amazon DataZone domain in which a subscription target is to be + * updated.

* @public */ - name?: string; + domainId: string | undefined; /** - *

The description to be updated as part of the UpdateProject action.

+ *

The identifier of the project in which a subscription target is to be updated.

* @public */ - description?: string; + projectId: string | undefined; /** - *

The glossary terms to be updated as part of the UpdateProject - * action.

+ *

The identifier of the environment in which a subscription target is to be + * updated.

* @public */ - glossaryTerms?: string[]; -} + environmentId: string | undefined; -/** - * @public - */ -export interface UpdateProjectOutput { /** - *

The identifier of the Amazon DataZone domain in which a project is updated.

+ *

The name to be updated as part of the UpdateSubscriptionTarget + * action.

* @public */ - domainId: string | undefined; + name: string | undefined; /** - *

The identifier of the project that is to be updated.

+ *

The type to be updated as part of the UpdateSubscriptionTarget + * action.

* @public */ - id: string | undefined; + type: string | undefined; /** - *

The name of the project that is to be updated.

+ *

The Amazon DataZone user who created the subscription target.

* @public */ - name: string | undefined; + createdBy: string | undefined; /** - *

The description of the project that is to be updated.

+ *

The Amazon DataZone user who updated the subscription target.

* @public */ - description?: string; + updatedBy?: string; /** - *

The status of the project.

+ *

The timestamp of when a subscription target was created.

* @public */ - projectStatus?: ProjectStatus; + createdAt: Date | undefined; /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

+ *

The timestamp of when the subscription target was updated.

* @public */ - failureReasons?: ProjectDeletionError[]; + updatedAt?: Date; /** - *

The Amazon DataZone user who created the project.

+ *

The manage access role to be updated as part of the + * UpdateSubscriptionTarget action.

* @public */ - createdBy: string | undefined; + manageAccessRole: string | undefined; /** - *

The timestamp of when the project was created.

+ *

The applicable asset types to be updated as part of the + * UpdateSubscriptionTarget action.

* @public */ - createdAt?: Date; + applicableAssetTypes: string[] | undefined; /** - *

The timestamp of when the project was last updated.

+ *

The configuration to be updated as part of the UpdateSubscriptionTarget + * action.

* @public */ - lastUpdatedAt?: Date; + subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; /** - *

The glossary terms of the project that are to be updated.

+ *

The provider to be updated as part of the UpdateSubscriptionTarget + * action.

* @public */ - glossaryTerms?: string[]; + provider: string | undefined; } /** * @public */ -export interface UpdateSubscriptionGrantStatusInput { +export interface UpdateUserProfileInput { /** - *

The identifier of the Amazon DataZone domain in which a subscription grant status is to be - * updated.

+ *

The identifier of the Amazon DataZone domain in which a user profile is updated.

* @public */ domainIdentifier: string | undefined; /** - *

The identifier of the subscription grant the status of which is to be updated.

- * @public - */ - identifier: string | undefined; - - /** - *

The identifier of the asset the subscription grant status of which is to be - * updated.

- * @public - */ - assetIdentifier: string | undefined; - - /** - *

The status to be updated as part of the UpdateSubscriptionGrantStatus - * action.

+ *

The identifier of the user whose user profile is to be updated.

* @public */ - status: SubscriptionGrantStatus | undefined; + userIdentifier: string | undefined; /** - *

Specifies the error message that is returned if the operation cannot be successfully - * completed.

+ *

The type of the user profile that are to be updated.

* @public */ - failureCause?: FailureCause; + type?: UserProfileType; /** - *

The target name to be updated as part of the UpdateSubscriptionGrantStatus - * action.

+ *

The status of the user profile that are to be updated.

* @public */ - targetName?: string; + status: UserProfileStatus | undefined; } /** * @public */ -export interface UpdateSubscriptionGrantStatusOutput { +export interface UpdateUserProfileOutput { /** - *

The identifier of the subscription grant.

+ *

The identifier of the Amazon DataZone domain in which a user profile is updated.

* @public */ - id: string | undefined; + domainId?: string; /** - *

The Amazon DataZone domain user who created the subscription grant status.

+ *

The identifier of the user profile.

* @public */ - createdBy: string | undefined; + id?: string; /** - *

The Amazon DataZone user who updated the subscription grant status.

+ *

The type of the user profile.

* @public */ - updatedBy?: string; + type?: UserProfileType; /** - *

The identifier of the Amazon DataZone domain in which a subscription grant status is to be - * updated.

+ *

The status of the user profile.

* @public */ - domainId: string | undefined; + status?: UserProfileStatus; /** - *

The timestamp of when the subscription grant status was created.

+ *

The details of the user profile in Amazon DataZone.

* @public */ - createdAt: Date | undefined; + details?: UserProfileDetails; +} - /** - *

The timestamp of when the subscription grant status is to be updated.

- * @public - */ - updatedAt: Date | undefined; +/** + *

A search filter clause in Amazon DataZone.

+ * @public + */ +export type FilterClause = + | FilterClause.AndMember + | FilterClause.FilterMember + | FilterClause.OrMember + | FilterClause.$UnknownMember; +/** + * @public + */ +export namespace FilterClause { /** - *

The identifier of the subscription target whose subscription grant status is to be - * updated.

+ *

A search filter in Amazon DataZone.

* @public */ - subscriptionTargetId: string | undefined; + export interface FilterMember { + filter: Filter; + and?: never; + or?: never; + $unknown?: never; + } /** - *

The granted entity to be updated as part of the - * UpdateSubscriptionGrantStatus action.

+ *

The 'and' search filter clause in Amazon DataZone.

* @public */ - grantedEntity: GrantedEntity | undefined; + export interface AndMember { + filter?: never; + and: FilterClause[]; + or?: never; + $unknown?: never; + } /** - *

The status to be updated as part of the UpdateSubscriptionGrantStatus - * action.

+ *

The 'or' search filter clause in Amazon DataZone.

* @public */ - status: SubscriptionGrantOverallStatus | undefined; + export interface OrMember { + filter?: never; + and?: never; + or: FilterClause[]; + $unknown?: never; + } /** - *

The details of the asset for which the subscription grant is created.

* @public */ - assets?: SubscribedAsset[]; + export interface $UnknownMember { + filter?: never; + and?: never; + or?: never; + $unknown: [string, any]; + } - /** - *

The identifier of the subscription.

- * @public - */ - subscriptionId?: string; + export interface Visitor { + filter: (value: Filter) => T; + and: (value: FilterClause[]) => T; + or: (value: FilterClause[]) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: FilterClause, visitor: Visitor): T => { + if (value.filter !== undefined) return visitor.filter(value.filter); + if (value.and !== undefined) return visitor.and(value.and); + if (value.or !== undefined) return visitor.or(value.or); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** + *

The row filter.

* @public */ -export interface UpdateSubscriptionRequestInput { +export type RowFilter = + | RowFilter.AndMember + | RowFilter.ExpressionMember + | RowFilter.OrMember + | RowFilter.$UnknownMember; + +/** + * @public + */ +export namespace RowFilter { /** - *

The identifier of the Amazon DataZone domain in which a subscription request is to be - * updated.

+ *

The expression of the row filter.

* @public */ - domainIdentifier: string | undefined; + export interface ExpressionMember { + expression: RowFilterExpression; + and?: never; + or?: never; + $unknown?: never; + } /** - *

The identifier of the subscription request that is to be updated.

+ *

The 'and' clause of the row filter.

* @public */ - identifier: string | undefined; + export interface AndMember { + expression?: never; + and: RowFilter[]; + or?: never; + $unknown?: never; + } /** - *

The reason for the UpdateSubscriptionRequest action.

+ *

The 'or' clause of the row filter.

* @public */ - requestReason: string | undefined; + export interface OrMember { + expression?: never; + and?: never; + or: RowFilter[]; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + expression?: never; + and?: never; + or?: never; + $unknown: [string, any]; + } + + export interface Visitor { + expression: (value: RowFilterExpression) => T; + and: (value: RowFilter[]) => T; + or: (value: RowFilter[]) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: RowFilter, visitor: Visitor): T => { + if (value.expression !== undefined) return visitor.expression(value.expression); + if (value.and !== undefined) return visitor.and(value.and); + if (value.or !== undefined) return visitor.or(value.or); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; } /** + *

The row filter configuration details.

* @public */ -export interface UpdateSubscriptionRequestOutput { +export interface RowFilterConfiguration { /** - *

The identifier of the subscription request that is to be updated.

+ *

The row filter.

* @public */ - id: string | undefined; + rowFilter: RowFilter | undefined; /** - *

The Amazon DataZone user who created the subscription request.

+ *

Specifies whether the row filter is sensitive.

* @public */ - createdBy: string | undefined; + sensitive?: boolean; +} +/** + * @public + */ +export interface SearchInput { /** - *

The Amazon DataZone user who updated the subscription request.

+ *

The identifier of the Amazon DataZone domain.

* @public */ - updatedBy?: string; + domainIdentifier: string | undefined; /** - *

The identifier of the Amazon DataZone domain in which a subscription request is to be - * updated.

+ *

The identifier of the owning project specified for the search.

* @public */ - domainId: string | undefined; + owningProjectIdentifier?: string; /** - *

The status of the subscription request.

+ *

The maximum number of results to return in a single call to Search. When + * the number of results 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 Search to list the next set of results.

* @public */ - status: SubscriptionRequestStatus | undefined; + maxResults?: number; /** - *

The timestamp of when the subscription request was created.

+ *

When the number of results 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 results, the response includes a + * pagination token named NextToken. You can specify this NextToken + * value in a subsequent call to Search to list the next set of results.

* @public */ - createdAt: Date | undefined; + nextToken?: string; /** - *

The timestamp of when the subscription request was updated.

+ *

The scope of the search.

* @public */ - updatedAt: Date | undefined; + searchScope: InventorySearchScope | undefined; /** - *

The reason for the UpdateSubscriptionRequest action.

+ *

Specifies the text for which to search.

* @public */ - requestReason: string | undefined; + searchText?: string; /** - *

The subscribed principals of the subscription request.

+ *

The details of the search.

* @public */ - subscribedPrincipals: SubscribedPrincipal[] | undefined; + searchIn?: SearchInItem[]; /** - *

The subscribed listings of the subscription request.

+ *

Specifies the search filters.

* @public */ - subscribedListings: SubscribedListing[] | undefined; + filters?: FilterClause; /** - *

The identifier of the Amazon DataZone user who reviews the subscription request.

+ *

Specifies the way in which the search results are to be sorted.

* @public */ - reviewerId?: string; + sort?: SearchSort; /** - *

The decision comment of the UpdateSubscriptionRequest action.

+ *

Specifies additional attributes for the Search action.

* @public */ - decisionComment?: string; + additionalAttributes?: SearchOutputAdditionalAttribute[]; } /** * @public */ -export interface UpdateSubscriptionTargetInput { +export interface SearchListingsInput { /** - *

The identifier of the Amazon DataZone domain in which a subscription target is to be - * updated.

+ *

The identifier of the domain in which to search listings.

* @public */ domainIdentifier: string | undefined; /** - *

The identifier of the environment in which a subscription target is to be - * updated.

- * @public - */ - environmentIdentifier: string | undefined; - - /** - *

Identifier of the subscription target that is to be updated.

+ *

Specifies the text for which to search.

* @public */ - identifier: string | undefined; + searchText?: string; /** - *

The name to be updated as part of the UpdateSubscriptionTarget - * action.

+ *

The details of the search.

* @public */ - name?: string; + searchIn?: SearchInItem[]; /** - *

The authorized principals to be updated as part of the - * UpdateSubscriptionTarget action.

+ *

The maximum number of results to return in a single call to SearchListings. + * When the number of results 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 SearchListings to list the next set of + * results.

* @public */ - authorizedPrincipals?: string[]; + maxResults?: number; /** - *

The applicable asset types to be updated as part of the - * UpdateSubscriptionTarget action.

+ *

When the number of results 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 results, the response includes a + * pagination token named NextToken. You can specify this NextToken + * value in a subsequent call to SearchListings to list the next set of + * results.

* @public */ - applicableAssetTypes?: string[]; + nextToken?: string; /** - *

The configuration to be updated as part of the UpdateSubscriptionTarget - * action.

+ *

Specifies the filters for the search of listings.

* @public */ - subscriptionTargetConfig?: SubscriptionTargetForm[]; + filters?: FilterClause; /** - *

The manage access role to be updated as part of the - * UpdateSubscriptionTarget action.

+ *

Specifies the way for sorting the search results.

* @public */ - manageAccessRole?: string; + sort?: SearchSort; /** - *

The provider to be updated as part of the UpdateSubscriptionTarget - * action.

+ *

Specifies additional attributes for the search.

* @public */ - provider?: string; + additionalAttributes?: SearchOutputAdditionalAttribute[]; } /** * @public */ -export interface UpdateSubscriptionTargetOutput { +export interface SearchTypesInput { /** - *

Identifier of the subscription target that is to be updated.

+ *

The identifier of the Amazon DataZone domain in which to invoke the SearchTypes + * action.

* @public */ - id: string | undefined; + domainIdentifier: string | undefined; /** - *

The authorized principals to be updated as part of the - * UpdateSubscriptionTarget action.

+ *

The maximum number of results to return in a single call to SearchTypes. + * When the number of results 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 SearchTypes to list the next set of results. + *

* @public */ - authorizedPrincipals: string[] | undefined; + maxResults?: number; /** - *

The identifier of the Amazon DataZone domain in which a subscription target is to be - * updated.

+ *

When the number of results 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 results, the response includes a + * pagination token named NextToken. You can specify this NextToken + * value in a subsequent call to SearchTypes to list the next set of + * results.

* @public */ - domainId: string | undefined; + nextToken?: string; /** - *

The identifier of the project in which a subscription target is to be updated.

+ *

Specifies the scope of the search for types.

* @public */ - projectId: string | undefined; + searchScope: TypesSearchScope | undefined; /** - *

The identifier of the environment in which a subscription target is to be - * updated.

+ *

Specifies the text for which to search.

* @public */ - environmentId: string | undefined; + searchText?: string; /** - *

The name to be updated as part of the UpdateSubscriptionTarget - * action.

+ *

The details of the search.

* @public */ - name: string | undefined; + searchIn?: SearchInItem[]; /** - *

The type to be updated as part of the UpdateSubscriptionTarget - * action.

+ *

The filters for the SearchTypes action.

* @public */ - type: string | undefined; + filters?: FilterClause; /** - *

The Amazon DataZone user who created the subscription target.

+ *

The specifies the way to sort the SearchTypes results.

* @public */ - createdBy: string | undefined; + sort?: SearchSort; /** - *

The Amazon DataZone user who updated the subscription target.

+ *

Specifies whether the search is managed.

* @public */ - updatedBy?: string; + managed: boolean | undefined; +} - /** - *

The timestamp of when a subscription target was created.

- * @public - */ - createdAt: Date | undefined; +/** + *

The configuration details of the asset filter.

+ * @public + */ +export type AssetFilterConfiguration = + | AssetFilterConfiguration.ColumnConfigurationMember + | AssetFilterConfiguration.RowConfigurationMember + | AssetFilterConfiguration.$UnknownMember; +/** + * @public + */ +export namespace AssetFilterConfiguration { /** - *

The timestamp of when the subscription target was updated.

+ *

The column configuration of the asset filter.

* @public */ - updatedAt?: Date; + export interface ColumnConfigurationMember { + columnConfiguration: ColumnFilterConfiguration; + rowConfiguration?: never; + $unknown?: never; + } /** - *

The manage access role to be updated as part of the - * UpdateSubscriptionTarget action.

+ *

The row configuration of the asset filter.

* @public */ - manageAccessRole: string | undefined; + export interface RowConfigurationMember { + columnConfiguration?: never; + rowConfiguration: RowFilterConfiguration; + $unknown?: never; + } /** - *

The applicable asset types to be updated as part of the - * UpdateSubscriptionTarget action.

* @public */ - applicableAssetTypes: string[] | undefined; + export interface $UnknownMember { + columnConfiguration?: never; + rowConfiguration?: never; + $unknown: [string, any]; + } + + export interface Visitor { + columnConfiguration: (value: ColumnFilterConfiguration) => T; + rowConfiguration: (value: RowFilterConfiguration) => T; + _: (name: string, value: any) => T; + } + + export const visit = (value: AssetFilterConfiguration, visitor: Visitor): T => { + if (value.columnConfiguration !== undefined) return visitor.columnConfiguration(value.columnConfiguration); + if (value.rowConfiguration !== undefined) return visitor.rowConfiguration(value.rowConfiguration); + return visitor._(value.$unknown[0], value.$unknown[1]); + }; +} +/** + * @public + */ +export interface CreateAssetFilterInput { /** - *

The configuration to be updated as part of the UpdateSubscriptionTarget - * action.

+ *

The ID of the domain in which you want to create an asset filter.

* @public */ - subscriptionTargetConfig: SubscriptionTargetForm[] | undefined; + domainIdentifier: string | undefined; /** - *

The provider to be updated as part of the UpdateSubscriptionTarget - * action.

+ *

The ID of the data asset.

* @public */ - provider: string | undefined; -} + assetIdentifier: string | undefined; -/** - * @public - */ -export interface UpdateUserProfileInput { /** - *

The identifier of the Amazon DataZone domain in which a user profile is updated.

+ *

The name of the asset filter.

* @public */ - domainIdentifier: string | undefined; + name: string | undefined; /** - *

The identifier of the user whose user profile is to be updated.

+ *

The description of the asset filter.

* @public */ - userIdentifier: string | undefined; + description?: string; /** - *

The type of the user profile that are to be updated.

+ *

The configuration of the asset filter.

* @public */ - type?: UserProfileType; + configuration: AssetFilterConfiguration | undefined; /** - *

The status of the user profile that are to be updated.

+ *

A unique, case-sensitive identifier that is provided to ensure the idempotency of the + * request.

* @public */ - status: UserProfileStatus | undefined; + clientToken?: string; } /** * @public */ -export interface UpdateUserProfileOutput { +export interface CreateAssetFilterOutput { /** - *

The identifier of the Amazon DataZone domain in which a user profile is updated.

+ *

The ID of the asset filter.

* @public */ - domainId?: string; + id: string | undefined; /** - *

The identifier of the user profile.

+ *

The ID of the domain where the asset filter is created.

* @public */ - id?: string; + domainId: string | undefined; /** - *

The type of the user profile.

+ *

The ID of the asset.

* @public */ - type?: UserProfileType; + assetId: string | undefined; /** - *

The status of the user profile.

+ *

The name of the asset filter.

* @public */ - status?: UserProfileStatus; + name: string | undefined; /** - *

The details of the user profile in Amazon DataZone.

+ *

The description of the asset filter.

* @public */ - details?: UserProfileDetails; -} - -/** - *

A search filter clause in Amazon DataZone.

- * @public - */ -export type FilterClause = - | FilterClause.AndMember - | FilterClause.FilterMember - | FilterClause.OrMember - | FilterClause.$UnknownMember; + description?: string; -/** - * @public - */ -export namespace FilterClause { /** - *

A search filter in Amazon DataZone.

+ *

The status of the asset filter.

* @public */ - export interface FilterMember { - filter: Filter; - and?: never; - or?: never; - $unknown?: never; - } + status?: FilterStatus; /** - *

The 'and' search filter clause in Amazon DataZone.

+ *

The configuration of the asset filter.

* @public */ - export interface AndMember { - filter?: never; - and: FilterClause[]; - or?: never; - $unknown?: never; - } + configuration: AssetFilterConfiguration | undefined; /** - *

The 'or' search filter clause in Amazon DataZone.

+ *

The timestamp at which the asset filter was created.

* @public */ - export interface OrMember { - filter?: never; - and?: never; - or: FilterClause[]; - $unknown?: never; - } + createdAt?: Date; /** + *

The error message that is displayed if the asset filter is not created + * successfully.

* @public */ - export interface $UnknownMember { - filter?: never; - and?: never; - or?: never; - $unknown: [string, any]; - } + errorMessage?: string; - export interface Visitor { - filter: (value: Filter) => T; - and: (value: FilterClause[]) => T; - or: (value: FilterClause[]) => T; - _: (name: string, value: any) => T; - } + /** + *

The column names in the asset filter.

+ * @public + */ + effectiveColumnNames?: string[]; - export const visit = (value: FilterClause, visitor: Visitor): T => { - if (value.filter !== undefined) return visitor.filter(value.filter); - if (value.and !== undefined) return visitor.and(value.and); - if (value.or !== undefined) return visitor.or(value.or); - return visitor._(value.$unknown[0], value.$unknown[1]); - }; + /** + *

The row filter in the asset filter.

+ * @public + */ + effectiveRowFilter?: string; } /** * @public */ -export interface SearchInput { +export interface GetAssetFilterOutput { /** - *

The identifier of the Amazon DataZone domain.

+ *

The ID of the asset filter.

* @public */ - domainIdentifier: string | undefined; + id: string | undefined; /** - *

The identifier of the owning project specified for the search.

+ *

The ID of the domain where you want to get an asset filter.

* @public */ - owningProjectIdentifier?: string; + domainId: string | undefined; /** - *

The maximum number of results to return in a single call to Search. When - * the number of results 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 Search to list the next set of results.

+ *

The ID of the data asset.

* @public */ - maxResults?: number; + assetId: string | undefined; /** - *

When the number of results 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 results, the response includes a - * pagination token named NextToken. You can specify this NextToken - * value in a subsequent call to Search to list the next set of results.

+ *

The name of the asset filter.

* @public */ - nextToken?: string; + name: string | undefined; /** - *

The scope of the search.

+ *

The description of the asset filter.

* @public */ - searchScope: InventorySearchScope | undefined; + description?: string; /** - *

Specifies the text for which to search.

+ *

The status of the asset filter.

* @public */ - searchText?: string; + status?: FilterStatus; /** - *

The details of the search.

+ *

The configuration of the asset filter.

* @public */ - searchIn?: SearchInItem[]; + configuration: AssetFilterConfiguration | undefined; /** - *

Specifies the search filters.

+ *

The timestamp at which the asset filter was created.

* @public */ - filters?: FilterClause; + createdAt?: Date; /** - *

Specifies the way in which the search results are to be sorted.

+ *

The error message that is displayed if the action does not complete successfully.

* @public */ - sort?: SearchSort; + errorMessage?: string; /** - *

Specifies additional attributes for the Search action.

+ *

The column names of the asset filter.

* @public */ - additionalAttributes?: SearchOutputAdditionalAttribute[]; + effectiveColumnNames?: string[]; + + /** + *

The row filter of the asset filter.

+ * @public + */ + effectiveRowFilter?: string; } /** * @public */ -export interface SearchListingsInput { +export interface UpdateAssetFilterInput { /** - *

The identifier of the domain in which to search listings.

+ *

The ID of the domain where you want to update an asset filter.

* @public */ domainIdentifier: string | undefined; /** - *

Specifies the text for which to search.

+ *

The ID of the data asset.

* @public */ - searchText?: string; + assetIdentifier: string | undefined; /** - *

The details of the search.

+ *

The ID of the asset filter.

* @public */ - searchIn?: SearchInItem[]; + identifier: string | undefined; /** - *

The maximum number of results to return in a single call to SearchListings. - * When the number of results 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 SearchListings to list the next set of - * results.

+ *

The name of the asset filter.

* @public */ - maxResults?: number; + name?: string; /** - *

When the number of results 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 results, the response includes a - * pagination token named NextToken. You can specify this NextToken - * value in a subsequent call to SearchListings to list the next set of - * results.

+ *

The description of the asset filter.

* @public */ - nextToken?: string; + description?: string; /** - *

Specifies the filters for the search of listings.

+ *

The configuration of the asset filter.

* @public */ - filters?: FilterClause; + configuration?: AssetFilterConfiguration; +} +/** + * @public + */ +export interface UpdateAssetFilterOutput { /** - *

Specifies the way for sorting the search results.

+ *

The ID of the asset filter.

* @public */ - sort?: SearchSort; + id: string | undefined; /** - *

Specifies additional attributes for the search.

+ *

The ID of the domain where the asset filter was created.

* @public */ - additionalAttributes?: SearchOutputAdditionalAttribute[]; -} + domainId: string | undefined; -/** - * @public - */ -export interface SearchTypesInput { /** - *

The identifier of the Amazon DataZone domain in which to invoke the SearchTypes - * action.

+ *

The ID of the data asset.

* @public */ - domainIdentifier: string | undefined; + assetId: string | undefined; /** - *

The maximum number of results to return in a single call to SearchTypes. - * When the number of results 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 SearchTypes to list the next set of results. - *

+ *

The name of the asset filter.

* @public */ - maxResults?: number; + name: string | undefined; /** - *

When the number of results 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 results, the response includes a - * pagination token named NextToken. You can specify this NextToken - * value in a subsequent call to SearchTypes to list the next set of - * results.

+ *

The description of the asset filter.

* @public */ - nextToken?: string; + description?: string; /** - *

Specifies the scope of the search for types.

+ *

The status of the asset filter.

* @public */ - searchScope: TypesSearchScope | undefined; + status?: FilterStatus; /** - *

Specifies the text for which to search.

+ *

The configuration of the asset filter.

* @public */ - searchText?: string; + configuration: AssetFilterConfiguration | undefined; /** - *

The details of the search.

+ *

The timestamp at which the asset filter was created.

* @public */ - searchIn?: SearchInItem[]; + createdAt?: Date; /** - *

The filters for the SearchTypes action.

+ *

The error message that is displayed if the action is not completed successfully.

* @public */ - filters?: FilterClause; + errorMessage?: string; /** - *

The specifies the way to sort the SearchTypes results.

+ *

The column names of the asset filter.

* @public */ - sort?: SearchSort; + effectiveColumnNames?: string[]; /** - *

Specifies whether the search is managed.

+ *

The row filter of the asset filter.

* @public */ - managed: boolean | undefined; + effectiveRowFilter?: string; } +/** + * @internal + */ +export const EnvironmentBlueprintSummaryFilterSensitiveLog = (obj: EnvironmentBlueprintSummary): any => ({ + ...obj, + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.provisioningProperties && { provisioningProperties: obj.provisioningProperties }), +}); + +/** + * @internal + */ +export const ListEnvironmentBlueprintsOutputFilterSensitiveLog = (obj: ListEnvironmentBlueprintsOutput): any => ({ + ...obj, + ...(obj.items && { items: obj.items.map((item) => EnvironmentBlueprintSummaryFilterSensitiveLog(item)) }), +}); + +/** + * @internal + */ +export const ListEnvironmentProfilesInputFilterSensitiveLog = (obj: ListEnvironmentProfilesInput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const EnvironmentProfileSummaryFilterSensitiveLog = (obj: EnvironmentProfileSummary): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const ListEnvironmentProfilesOutputFilterSensitiveLog = (obj: ListEnvironmentProfilesOutput): any => ({ + ...obj, + ...(obj.items && { items: obj.items.map((item) => EnvironmentProfileSummaryFilterSensitiveLog(item)) }), +}); + +/** + * @internal + */ +export const EnvironmentSummaryFilterSensitiveLog = (obj: EnvironmentSummary): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const ListEnvironmentsOutputFilterSensitiveLog = (obj: ListEnvironmentsOutput): any => ({ + ...obj, + ...(obj.items && { items: obj.items.map((item) => EnvironmentSummaryFilterSensitiveLog(item)) }), +}); + +/** + * @internal + */ +export const ListingItemFilterSensitiveLog = (obj: ListingItem): any => { + if (obj.assetListing !== undefined) return { assetListing: AssetListingFilterSensitiveLog(obj.assetListing) }; + if (obj.$unknown !== undefined) return { [obj.$unknown[0]]: "UNKNOWN" }; +}; + +/** + * @internal + */ +export const GetListingOutputFilterSensitiveLog = (obj: GetListingOutput): any => ({ + ...obj, + ...(obj.item && { item: ListingItemFilterSensitiveLog(obj.item) }), + ...(obj.description && { description: SENSITIVE_STRING }), +}); + /** * @internal */ @@ -4749,3 +6169,52 @@ export const UpdateUserProfileOutputFilterSensitiveLog = (obj: UpdateUserProfile ...obj, ...(obj.details && { details: UserProfileDetailsFilterSensitiveLog(obj.details) }), }); + +/** + * @internal + */ +export const CreateAssetFilterInputFilterSensitiveLog = (obj: CreateAssetFilterInput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.configuration && { configuration: obj.configuration }), +}); + +/** + * @internal + */ +export const CreateAssetFilterOutputFilterSensitiveLog = (obj: CreateAssetFilterOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.configuration && { configuration: obj.configuration }), +}); + +/** + * @internal + */ +export const GetAssetFilterOutputFilterSensitiveLog = (obj: GetAssetFilterOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.configuration && { configuration: obj.configuration }), +}); + +/** + * @internal + */ +export const UpdateAssetFilterInputFilterSensitiveLog = (obj: UpdateAssetFilterInput): any => ({ + ...obj, + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.configuration && { configuration: obj.configuration }), +}); + +/** + * @internal + */ +export const UpdateAssetFilterOutputFilterSensitiveLog = (obj: UpdateAssetFilterOutput): any => ({ + ...obj, + ...(obj.name && { name: SENSITIVE_STRING }), + ...(obj.description && { description: SENSITIVE_STRING }), + ...(obj.configuration && { configuration: obj.configuration }), +}); diff --git a/clients/client-datazone/src/pagination/ListAssetFiltersPaginator.ts b/clients/client-datazone/src/pagination/ListAssetFiltersPaginator.ts new file mode 100644 index 0000000000000..ed4b12240484d --- /dev/null +++ b/clients/client-datazone/src/pagination/ListAssetFiltersPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListAssetFiltersCommand, + ListAssetFiltersCommandInput, + ListAssetFiltersCommandOutput, +} from "../commands/ListAssetFiltersCommand"; +import { DataZoneClient } from "../DataZoneClient"; +import { DataZonePaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListAssetFilters: ( + config: DataZonePaginationConfiguration, + input: ListAssetFiltersCommandInput, + ...rest: any[] +) => Paginator = createPaginator< + DataZonePaginationConfiguration, + ListAssetFiltersCommandInput, + ListAssetFiltersCommandOutput +>(DataZoneClient, ListAssetFiltersCommand, "nextToken", "nextToken", "maxResults"); diff --git a/clients/client-datazone/src/pagination/index.ts b/clients/client-datazone/src/pagination/index.ts index 80a867737ff5c..2ee255edbd246 100644 --- a/clients/client-datazone/src/pagination/index.ts +++ b/clients/client-datazone/src/pagination/index.ts @@ -1,5 +1,6 @@ // smithy-typescript generated code export * from "./Interfaces"; +export * from "./ListAssetFiltersPaginator"; export * from "./ListAssetRevisionsPaginator"; export * from "./ListDataSourceRunActivitiesPaginator"; export * from "./ListDataSourceRunsPaginator"; diff --git a/clients/client-datazone/src/protocols/Aws_restJson1.ts b/clients/client-datazone/src/protocols/Aws_restJson1.ts index aa81428632a9c..c6fff73d01289 100644 --- a/clients/client-datazone/src/protocols/Aws_restJson1.ts +++ b/clients/client-datazone/src/protocols/Aws_restJson1.ts @@ -49,6 +49,7 @@ import { } from "../commands/CancelMetadataGenerationRunCommand"; import { CancelSubscriptionCommandInput, CancelSubscriptionCommandOutput } from "../commands/CancelSubscriptionCommand"; import { CreateAssetCommandInput, CreateAssetCommandOutput } from "../commands/CreateAssetCommand"; +import { CreateAssetFilterCommandInput, CreateAssetFilterCommandOutput } from "../commands/CreateAssetFilterCommand"; import { CreateAssetRevisionCommandInput, CreateAssetRevisionCommandOutput, @@ -92,6 +93,7 @@ import { } from "../commands/CreateSubscriptionTargetCommand"; import { CreateUserProfileCommandInput, CreateUserProfileCommandOutput } from "../commands/CreateUserProfileCommand"; import { DeleteAssetCommandInput, DeleteAssetCommandOutput } from "../commands/DeleteAssetCommand"; +import { DeleteAssetFilterCommandInput, DeleteAssetFilterCommandOutput } from "../commands/DeleteAssetFilterCommand"; import { DeleteAssetTypeCommandInput, DeleteAssetTypeCommandOutput } from "../commands/DeleteAssetTypeCommand"; import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "../commands/DeleteDataSourceCommand"; import { DeleteDomainCommandInput, DeleteDomainCommandOutput } from "../commands/DeleteDomainCommand"; @@ -138,6 +140,7 @@ import { DisassociateEnvironmentRoleCommandOutput, } from "../commands/DisassociateEnvironmentRoleCommand"; import { GetAssetCommandInput, GetAssetCommandOutput } from "../commands/GetAssetCommand"; +import { GetAssetFilterCommandInput, GetAssetFilterCommandOutput } from "../commands/GetAssetFilterCommand"; import { GetAssetTypeCommandInput, GetAssetTypeCommandOutput } from "../commands/GetAssetTypeCommand"; import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "../commands/GetDataSourceCommand"; import { GetDataSourceRunCommandInput, GetDataSourceRunCommandOutput } from "../commands/GetDataSourceRunCommand"; @@ -192,6 +195,7 @@ import { GetTimeSeriesDataPointCommandOutput, } from "../commands/GetTimeSeriesDataPointCommand"; import { GetUserProfileCommandInput, GetUserProfileCommandOutput } from "../commands/GetUserProfileCommand"; +import { ListAssetFiltersCommandInput, ListAssetFiltersCommandOutput } from "../commands/ListAssetFiltersCommand"; import { ListAssetRevisionsCommandInput, ListAssetRevisionsCommandOutput } from "../commands/ListAssetRevisionsCommand"; import { ListDataSourceRunActivitiesCommandInput, @@ -282,6 +286,7 @@ import { } from "../commands/StartMetadataGenerationRunCommand"; import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand"; import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand"; +import { UpdateAssetFilterCommandInput, UpdateAssetFilterCommandOutput } from "../commands/UpdateAssetFilterCommand"; import { UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput } from "../commands/UpdateDataSourceCommand"; import { UpdateDomainCommandInput, UpdateDomainCommandOutput } from "../commands/UpdateDomainCommand"; import { @@ -316,6 +321,7 @@ import { AcceptRule, AccessDeniedException, ActionParameters, + AssetFilterSummary, AssetItem, AssetItemAdditionalAttributes, AssetListing, @@ -326,6 +332,7 @@ import { AssetTypeItem, AwsConsoleLinkParameters, BusinessNameGenerationConfiguration, + ColumnFilterConfiguration, ConflictException, DataProductSummary, DataSourceConfigurationInput, @@ -334,24 +341,33 @@ import { DataSourceSummary, DomainSummary, EnvironmentBlueprintConfigurationItem, - EnvironmentBlueprintSummary, EnvironmentParameter, - EnvironmentProfileSummary, - EnvironmentSummary, + EqualToExpression, FailureCause, FilterExpression, FormEntryInput, FormInput, GlueRunConfigurationInput, GrantedEntityInput, + GreaterThanExpression, + GreaterThanOrEqualToExpression, + InExpression, InternalServerException, + IsNotNullExpression, + IsNullExpression, + LakeFormationConfiguration, + LessThanExpression, + LessThanOrEqualToExpression, + LikeExpression, LineageNodeReference, - LineageNodeSummary, - ListingItem, ListingRevisionInput, Member, Model, + NotEqualToExpression, + NotInExpression, + NotLikeExpression, PredictionConfiguration, + ProvisioningConfiguration, RecommendationConfiguration, RedshiftClusterStorage, RedshiftCredentialConfiguration, @@ -360,6 +376,7 @@ import { RedshiftStorage, RelationalFilterConfiguration, ResourceNotFoundException, + RowFilterExpression, ScheduleConfiguration, ServiceQuotaExceededException, SingleSignOn, @@ -376,18 +393,26 @@ import { ValidationException, } from "../models/models_0"; import { + AssetFilterConfiguration, + EnvironmentBlueprintSummary, + EnvironmentProfileSummary, + EnvironmentSummary, Filter, FilterClause, FormTypeData, GlossaryItem, GlossaryTermItem, + LineageNodeSummary, LineageNodeTypeItem, + ListingItem, MetadataGenerationRunItem, MetadataGenerationRunTarget, NotificationOutput, ProjectSummary, RejectChoice, RejectRule, + RowFilter, + RowFilterConfiguration, SearchInItem, SearchInventoryResultItem, SearchOutputAdditionalAttribute, @@ -538,6 +563,33 @@ export const se_CreateAssetCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1CreateAssetFilterCommand + */ +export const se_CreateAssetFilterCommand = async ( + input: CreateAssetFilterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters"); + b.p("domainIdentifier", () => input.domainIdentifier!, "{domainIdentifier}", false); + b.p("assetIdentifier", () => input.assetIdentifier!, "{assetIdentifier}", false); + let body: any; + body = JSON.stringify( + take(input, { + clientToken: [true, (_) => _ ?? generateIdempotencyToken()], + configuration: (_) => se_AssetFilterConfiguration(_, context), + description: [], + name: [], + }) + ); + b.m("POST").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1CreateAssetRevisionCommand */ @@ -1052,6 +1104,24 @@ export const se_DeleteAssetCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1DeleteAssetFilterCommand + */ +export const se_DeleteAssetFilterCommand = async ( + input: DeleteAssetFilterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters/{identifier}"); + b.p("domainIdentifier", () => input.domainIdentifier!, "{domainIdentifier}", false); + b.p("assetIdentifier", () => input.assetIdentifier!, "{assetIdentifier}", false); + b.p("identifier", () => input.identifier!, "{identifier}", false); + let body: any; + b.m("DELETE").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1DeleteAssetTypeCommand */ @@ -1408,6 +1478,24 @@ export const se_GetAssetCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1GetAssetFilterCommand + */ +export const se_GetAssetFilterCommand = async ( + input: GetAssetFilterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters/{identifier}"); + b.p("domainIdentifier", () => input.domainIdentifier!, "{domainIdentifier}", false); + b.p("assetIdentifier", () => input.assetIdentifier!, "{assetIdentifier}", false); + b.p("identifier", () => input.identifier!, "{identifier}", false); + let body: any; + b.m("GET").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1GetAssetTypeCommand */ @@ -1841,6 +1929,28 @@ export const se_GetUserProfileCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1ListAssetFiltersCommand + */ +export const se_ListAssetFiltersCommand = async ( + input: ListAssetFiltersCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = {}; + b.bp("/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters"); + b.p("domainIdentifier", () => input.domainIdentifier!, "{domainIdentifier}", false); + b.p("assetIdentifier", () => input.assetIdentifier!, "{assetIdentifier}", false); + const query: any = map({ + [_s]: [, input[_s]!], + [_nT]: [, input[_nT]!], + [_mR]: [() => input.maxResults !== void 0, () => input[_mR]!.toString()], + }); + let body: any; + b.m("GET").h(headers).q(query).b(body); + return b.build(); +}; + /** * serializeAws_restJson1ListAssetRevisionsCommand */ @@ -2402,6 +2512,7 @@ export const se_PutEnvironmentBlueprintConfigurationCommand = async ( take(input, { enabledRegions: (_) => _json(_), manageAccessRoleArn: [], + provisioningConfigurations: (_) => _json(_), provisioningRoleArn: [], regionalParameters: (_) => _json(_), }) @@ -2721,6 +2832,33 @@ export const se_UntagResourceCommand = async ( return b.build(); }; +/** + * serializeAws_restJson1UpdateAssetFilterCommand + */ +export const se_UpdateAssetFilterCommand = async ( + input: UpdateAssetFilterCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const b = rb(input, context); + const headers: any = { + "content-type": "application/json", + }; + b.bp("/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters/{identifier}"); + b.p("domainIdentifier", () => input.domainIdentifier!, "{domainIdentifier}", false); + b.p("assetIdentifier", () => input.assetIdentifier!, "{assetIdentifier}", false); + b.p("identifier", () => input.identifier!, "{identifier}", false); + let body: any; + body = JSON.stringify( + take(input, { + configuration: (_) => se_AssetFilterConfiguration(_, context), + description: [], + name: [], + }) + ); + b.m("PATCH").h(headers).b(body); + return b.build(); +}; + /** * serializeAws_restJson1UpdateDataSourceCommand */ @@ -3234,6 +3372,37 @@ export const de_CreateAssetCommand = async ( return contents; }; +/** + * deserializeAws_restJson1CreateAssetFilterCommand + */ +export const de_CreateAssetFilterCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 201 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + assetId: __expectString, + configuration: (_) => de_AssetFilterConfiguration(__expectUnion(_), context), + createdAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + description: __expectString, + domainId: __expectString, + effectiveColumnNames: _json, + effectiveRowFilter: __expectString, + errorMessage: __expectString, + id: __expectString, + name: __expectString, + status: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1CreateAssetRevisionCommand */ @@ -3789,6 +3958,23 @@ export const de_DeleteAssetCommand = async ( return contents; }; +/** + * deserializeAws_restJson1DeleteAssetFilterCommand + */ +export const de_DeleteAssetFilterCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 204 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + await collectBody(output.body, context); + return contents; +}; + /** * deserializeAws_restJson1DeleteAssetTypeCommand */ @@ -4175,6 +4361,37 @@ export const de_GetAssetCommand = async ( return contents; }; +/** + * deserializeAws_restJson1GetAssetFilterCommand + */ +export const de_GetAssetFilterCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + assetId: __expectString, + configuration: (_) => de_AssetFilterConfiguration(__expectUnion(_), context), + createdAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + description: __expectString, + domainId: __expectString, + effectiveColumnNames: _json, + effectiveRowFilter: __expectString, + errorMessage: __expectString, + id: __expectString, + name: __expectString, + status: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1GetAssetTypeCommand */ @@ -4431,6 +4648,7 @@ export const de_GetEnvironmentBlueprintConfigurationCommand = async ( enabledRegions: _json, environmentBlueprintId: __expectString, manageAccessRoleArn: __expectString, + provisioningConfigurations: _json, provisioningRoleArn: __expectString, regionalParameters: _json, updatedAt: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), @@ -4914,6 +5132,28 @@ export const de_GetUserProfileCommand = async ( return contents; }; +/** + * deserializeAws_restJson1ListAssetFiltersCommand + */ +export const de_ListAssetFiltersCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + items: (_) => de_AssetFilters(_, context), + nextToken: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1ListAssetRevisionsCommand */ @@ -5436,6 +5676,7 @@ export const de_PutEnvironmentBlueprintConfigurationCommand = async ( enabledRegions: _json, environmentBlueprintId: __expectString, manageAccessRoleArn: __expectString, + provisioningConfigurations: _json, provisioningRoleArn: __expectString, regionalParameters: _json, updatedAt: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), @@ -5737,6 +5978,37 @@ export const de_UntagResourceCommand = async ( return contents; }; +/** + * deserializeAws_restJson1UpdateAssetFilterCommand + */ +export const de_UpdateAssetFilterCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise => { + if (output.statusCode !== 200 && output.statusCode >= 300) { + return de_CommandError(output, context); + } + const contents: any = map({ + $metadata: deserializeMetadata(output), + }); + const data: Record = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body"); + const doc = take(data, { + assetId: __expectString, + configuration: (_) => de_AssetFilterConfiguration(__expectUnion(_), context), + createdAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + description: __expectString, + domainId: __expectString, + effectiveColumnNames: _json, + effectiveRowFilter: __expectString, + errorMessage: __expectString, + id: __expectString, + name: __expectString, + status: __expectString, + }); + Object.assign(contents, doc); + return contents; +}; + /** * deserializeAws_restJson1UpdateDataSourceCommand */ @@ -6349,6 +6621,17 @@ const se_AcceptRule = (input: AcceptRule, context: __SerdeContext): any => { // se_ApplicableAssetTypes omitted. +/** + * serializeAws_restJson1AssetFilterConfiguration + */ +const se_AssetFilterConfiguration = (input: AssetFilterConfiguration, context: __SerdeContext): any => { + return AssetFilterConfiguration.visit(input, { + columnConfiguration: (value) => ({ columnConfiguration: _json(value) }), + rowConfiguration: (value) => ({ rowConfiguration: se_RowFilterConfiguration(value, context) }), + _: (name, value) => ({ name: value } as any), + }); +}; + // se_AssetTargetNameMap omitted. // se_AssetTargetNames omitted. @@ -6359,6 +6642,10 @@ const se_AcceptRule = (input: AcceptRule, context: __SerdeContext): any => { // se_BusinessNameGenerationConfiguration omitted. +// se_ColumnFilterConfiguration omitted. + +// se_ColumnNameList omitted. + // se_DataSourceConfigurationInput omitted. // se_EnabledRegionList omitted. @@ -6367,6 +6654,8 @@ const se_AcceptRule = (input: AcceptRule, context: __SerdeContext): any => { // se_EnvironmentParametersList omitted. +// se_EqualToExpression omitted. + // se_FailureCause omitted. // se_Filter omitted. @@ -6412,6 +6701,24 @@ const se_FilterList = (input: FilterClause[], context: __SerdeContext): any => { // se_GrantedEntityInput omitted. +// se_GreaterThanExpression omitted. + +// se_GreaterThanOrEqualToExpression omitted. + +// se_InExpression omitted. + +// se_IsNotNullExpression omitted. + +// se_IsNullExpression omitted. + +// se_LakeFormationConfiguration omitted. + +// se_LessThanExpression omitted. + +// se_LessThanOrEqualToExpression omitted. + +// se_LikeExpression omitted. + // se_ListingRevisionInput omitted. // se_Member omitted. @@ -6420,10 +6727,20 @@ const se_FilterList = (input: FilterClause[], context: __SerdeContext): any => { // se_Model omitted. +// se_NotEqualToExpression omitted. + +// se_NotInExpression omitted. + +// se_NotLikeExpression omitted. + // se_PredictionChoices omitted. // se_PredictionConfiguration omitted. +// se_ProvisioningConfiguration omitted. + +// se_ProvisioningConfigurationList omitted. + // se_RecommendationConfiguration omitted. // se_RedshiftClusterStorage omitted. @@ -6458,6 +6775,43 @@ const se_RejectRule = (input: RejectRule, context: __SerdeContext): any => { // se_RelationalFilterConfigurations omitted. +/** + * serializeAws_restJson1RowFilter + */ +const se_RowFilter = (input: RowFilter, context: __SerdeContext): any => { + return RowFilter.visit(input, { + and: (value) => ({ and: se_RowFilterList(value, context) }), + expression: (value) => ({ expression: _json(value) }), + or: (value) => ({ or: se_RowFilterList(value, context) }), + _: (name, value) => ({ name: value } as any), + }); +}; + +/** + * serializeAws_restJson1RowFilterConfiguration + */ +const se_RowFilterConfiguration = (input: RowFilterConfiguration, context: __SerdeContext): any => { + return take(input, { + rowFilter: (_) => se_RowFilter(_, context), + sensitive: [], + }); +}; + +// se_RowFilterExpression omitted. + +/** + * serializeAws_restJson1RowFilterList + */ +const se_RowFilterList = (input: RowFilter[], context: __SerdeContext): any => { + return input + .filter((e: any) => e != null) + .map((entry) => { + return se_RowFilter(entry, context); + }); +}; + +// se_S3LocationList omitted. + // se_ScheduleConfiguration omitted. // se_SearchInItem omitted. @@ -6470,6 +6824,8 @@ const se_RejectRule = (input: RejectRule, context: __SerdeContext): any => { // se_SingleSignOn omitted. +// se_StringList omitted. + // se_SubscribedListingInput omitted. // se_SubscribedListingInputs omitted. @@ -6516,6 +6872,53 @@ const se_TimeSeriesDataPointFormInputList = (input: TimeSeriesDataPointFormInput // de_ApplicableAssetTypes omitted. +/** + * deserializeAws_restJson1AssetFilterConfiguration + */ +const de_AssetFilterConfiguration = (output: any, context: __SerdeContext): AssetFilterConfiguration => { + if (output.columnConfiguration != null) { + return { + columnConfiguration: _json(output.columnConfiguration), + }; + } + if (output.rowConfiguration != null) { + return { + rowConfiguration: de_RowFilterConfiguration(output.rowConfiguration, context), + }; + } + return { $unknown: Object.entries(output)[0] }; +}; + +/** + * deserializeAws_restJson1AssetFilters + */ +const de_AssetFilters = (output: any, context: __SerdeContext): AssetFilterSummary[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_AssetFilterSummary(entry, context); + }); + return retVal; +}; + +/** + * deserializeAws_restJson1AssetFilterSummary + */ +const de_AssetFilterSummary = (output: any, context: __SerdeContext): AssetFilterSummary => { + return take(output, { + assetId: __expectString, + createdAt: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))), + description: __expectString, + domainId: __expectString, + effectiveColumnNames: _json, + effectiveRowFilter: __expectString, + errorMessage: __expectString, + id: __expectString, + name: __expectString, + status: __expectString, + }) as any; +}; + /** * deserializeAws_restJson1AssetItem */ @@ -6654,6 +7057,10 @@ const de_AssetTypeItem = (output: any, context: __SerdeContext): AssetTypeItem = // de_CloudFormationProperties omitted. +// de_ColumnFilterConfiguration omitted. + +// de_ColumnNameList omitted. + // de_ConfigurableActionParameter omitted. // de_ConfigurableActionParameterList omitted. @@ -6844,6 +7251,7 @@ const de_EnvironmentBlueprintConfigurationItem = ( enabledRegions: _json, environmentBlueprintId: __expectString, manageAccessRoleArn: __expectString, + provisioningConfigurations: _json, provisioningRoleArn: __expectString, regionalParameters: _json, updatedAt: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)), @@ -6958,6 +7366,8 @@ const de_EnvironmentSummary = (output: any, context: __SerdeContext): Environmen }) as any; }; +// de_EqualToExpression omitted. + // de_FailureCause omitted. // de_FailureReasons omitted. @@ -7040,6 +7450,10 @@ const de_GlossaryTermItem = (output: any, context: __SerdeContext): GlossaryTerm // de_GrantedEntity omitted. +// de_GreaterThanExpression omitted. + +// de_GreaterThanOrEqualToExpression omitted. + // de_GroupDetails omitted. // de_GroupProfileSummaries omitted. @@ -7052,6 +7466,20 @@ const de_GlossaryTermItem = (output: any, context: __SerdeContext): GlossaryTerm // de_ImportList omitted. +// de_InExpression omitted. + +// de_IsNotNullExpression omitted. + +// de_IsNullExpression omitted. + +// de_LakeFormationConfiguration omitted. + +// de_LessThanExpression omitted. + +// de_LessThanOrEqualToExpression omitted. + +// de_LikeExpression omitted. + /** * deserializeAws_restJson1LineageNodeReference */ @@ -7175,6 +7603,8 @@ const de_MetadataGenerationRuns = (output: any, context: __SerdeContext): Metada // de_Model omitted. +// de_NotEqualToExpression omitted. + /** * deserializeAws_restJson1NotificationOutput */ @@ -7208,6 +7638,10 @@ const de_NotificationsList = (output: any, context: __SerdeContext): Notificatio return retVal; }; +// de_NotInExpression omitted. + +// de_NotLikeExpression omitted. + // de_PredictionConfiguration omitted. // de_ProjectDeletionError omitted. @@ -7245,6 +7679,10 @@ const de_ProjectSummary = (output: any, context: __SerdeContext): ProjectSummary }) as any; }; +// de_ProvisioningConfiguration omitted. + +// de_ProvisioningConfigurationList omitted. + // de_ProvisioningProperties omitted. // de_RecommendationConfiguration omitted. @@ -7273,8 +7711,56 @@ const de_ProjectSummary = (output: any, context: __SerdeContext): ProjectSummary // de_ResourceList omitted. +/** + * deserializeAws_restJson1RowFilter + */ +const de_RowFilter = (output: any, context: __SerdeContext): RowFilter => { + if (output.and != null) { + return { + and: de_RowFilterList(output.and, context), + }; + } + if (output.expression != null) { + return { + expression: _json(__expectUnion(output.expression)), + }; + } + if (output.or != null) { + return { + or: de_RowFilterList(output.or, context), + }; + } + return { $unknown: Object.entries(output)[0] }; +}; + +/** + * deserializeAws_restJson1RowFilterConfiguration + */ +const de_RowFilterConfiguration = (output: any, context: __SerdeContext): RowFilterConfiguration => { + return take(output, { + rowFilter: (_: any) => de_RowFilter(__expectUnion(_), context), + sensitive: __expectBoolean, + }) as any; +}; + +// de_RowFilterExpression omitted. + +/** + * deserializeAws_restJson1RowFilterList + */ +const de_RowFilterList = (output: any, context: __SerdeContext): RowFilter[] => { + const retVal = (output || []) + .filter((e: any) => e != null) + .map((entry: any) => { + return de_RowFilter(__expectUnion(entry), context); + }); + return retVal; +}; + // de_RunStatisticsForAssets omitted. +// de_S3LocationList omitted. + // de_ScheduleConfiguration omitted. /** @@ -7384,6 +7870,8 @@ const de_SearchTypesResultItems = (output: any, context: __SerdeContext): Search // de_SsoUserProfileDetails omitted. +// de_StringList omitted. + /** * deserializeAws_restJson1SubscribedAsset */ diff --git a/codegen/sdk-codegen/aws-models/datazone.json b/codegen/sdk-codegen/aws-models/datazone.json index 20399662aaa13..696cb0af013d0 100644 --- a/codegen/sdk-codegen/aws-models/datazone.json +++ b/codegen/sdk-codegen/aws-models/datazone.json @@ -483,6 +483,104 @@ } ] }, + "com.amazonaws.datazone#AssetFilterConfiguration": { + "type": "union", + "members": { + "columnConfiguration": { + "target": "com.amazonaws.datazone#ColumnFilterConfiguration", + "traits": { + "smithy.api#documentation": "

The column configuration of the asset filter.

" + } + }, + "rowConfiguration": { + "target": "com.amazonaws.datazone#RowFilterConfiguration", + "traits": { + "smithy.api#documentation": "

The row configuration of the asset filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration details of the asset filter.

" + } + }, + "com.amazonaws.datazone#AssetFilterSummary": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#FilterId", + "traits": { + "smithy.api#documentation": "

The ID of the asset filter.

", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the asset filter lives.

", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the data asset.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the asset filter.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the asset filter.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#FilterStatus", + "traits": { + "smithy.api#documentation": "

The status of the asset filter.

" + } + }, + "effectiveColumnNames": { + "target": "com.amazonaws.datazone#ColumnNameList", + "traits": { + "smithy.api#documentation": "

The effective column names of the asset filter.

" + } + }, + "effectiveRowFilter": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The effective row filter of the asset filter.

" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the asset filter was created.

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The error message that is displayed if the action does not succeed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary of the asset filter.

" + } + }, + "com.amazonaws.datazone#AssetFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#AssetFilterSummary" + } + }, "com.amazonaws.datazone#AssetId": { "type": "string", "traits": { @@ -1462,6 +1560,26 @@ "smithy.api#documentation": "

Part of the provisioning properties of the environment blueprint.

" } }, + "com.amazonaws.datazone#ColumnFilterConfiguration": { + "type": "structure", + "members": { + "includedColumnNames": { + "target": "com.amazonaws.datazone#ColumnNameList", + "traits": { + "smithy.api#documentation": "

Specifies whether to include column names.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The column configuration of the asset filter.

" + } + }, + "com.amazonaws.datazone#ColumnNameList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.datazone#ConfigurableActionParameter": { "type": "structure", "members": { @@ -1590,6 +1708,177 @@ "smithy.api#idempotent": {} } }, + "com.amazonaws.datazone#CreateAssetFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#CreateAssetFilterInput" + }, + "output": { + "target": "com.amazonaws.datazone#CreateAssetFilterOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a data asset filter.

", + "smithy.api#http": { + "code": 201, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#CreateAssetFilterInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain in which you want to create an asset filter.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assetIdentifier": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the data asset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the asset filter.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the asset filter.

" + } + }, + "configuration": { + "target": "com.amazonaws.datazone#AssetFilterConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the asset filter.

", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "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#CreateAssetFilterOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#FilterId", + "traits": { + "smithy.api#documentation": "

The ID of the asset filter.

", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the asset filter is created.

", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the asset.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the asset filter.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the asset filter.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#FilterStatus", + "traits": { + "smithy.api#documentation": "

The status of the asset filter.

" + } + }, + "configuration": { + "target": "com.amazonaws.datazone#AssetFilterConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the asset filter.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the asset filter was created.

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The error message that is displayed if the asset filter is not created\n successfully.

" + } + }, + "effectiveColumnNames": { + "target": "com.amazonaws.datazone#ColumnNameList", + "traits": { + "smithy.api#documentation": "

The column names in the asset filter.

" + } + }, + "effectiveRowFilter": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The row filter in the asset filter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#CreateAssetInput": { "type": "structure", "members": { @@ -5709,6 +5998,9 @@ { "target": "com.amazonaws.datazone#CancelSubscription" }, + { + "target": "com.amazonaws.datazone#CreateAssetFilter" + }, { "target": "com.amazonaws.datazone#CreateEnvironment" }, @@ -5742,6 +6034,9 @@ { "target": "com.amazonaws.datazone#CreateUserProfile" }, + { + "target": "com.amazonaws.datazone#DeleteAssetFilter" + }, { "target": "com.amazonaws.datazone#DeleteEnvironment" }, @@ -5772,6 +6067,9 @@ { "target": "com.amazonaws.datazone#DisassociateEnvironmentRole" }, + { + "target": "com.amazonaws.datazone#GetAssetFilter" + }, { "target": "com.amazonaws.datazone#GetEnvironment" }, @@ -5814,6 +6112,9 @@ { "target": "com.amazonaws.datazone#GetUserProfile" }, + { + "target": "com.amazonaws.datazone#ListAssetFilters" + }, { "target": "com.amazonaws.datazone#ListAssetRevisions" }, @@ -5898,6 +6199,9 @@ { "target": "com.amazonaws.datazone#UntagResource" }, + { + "target": "com.amazonaws.datazone#UpdateAssetFilter" + }, { "target": "com.amazonaws.datazone#UpdateEnvironment" }, @@ -6436,27 +6740,97 @@ "smithy.api#idempotent": {} } }, - "com.amazonaws.datazone#DeleteAssetInput": { - "type": "structure", - "members": { - "domainIdentifier": { - "target": "com.amazonaws.datazone#DomainId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the asset is deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "identifier": { - "target": "com.amazonaws.datazone#AssetIdentifier", - "traits": { - "smithy.api#documentation": "

The identifier of the asset that is deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } + "com.amazonaws.datazone#DeleteAssetFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#DeleteAssetFilterInput" }, - "traits": { + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an asset filter.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#DeleteAssetFilterInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to delete an asset filter.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assetIdentifier": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the data asset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#FilterId", + "traits": { + "smithy.api#documentation": "

The ID of the asset filter that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#DeleteAssetInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon DataZone domain in which the asset is deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#AssetIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the asset that is deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { "smithy.api#input": {} } }, @@ -8559,6 +8933,12 @@ "smithy.api#documentation": "

The timestamp of when the environment blueprint was updated.

", "smithy.api#timestampFormat": "date-time" } + }, + "provisioningConfigurations": { + "target": "com.amazonaws.datazone#ProvisioningConfigurationList", + "traits": { + "smithy.api#documentation": "

The provisioning configuration of a blueprint.

" + } } }, "traits": { @@ -9001,6 +9381,28 @@ "smithy.api#documentation": "

The details of an environment.

" } }, + "com.amazonaws.datazone#EqualToExpression": { + "type": "structure", + "members": { + "columnName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value that might be equal to an expression.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies whether the value is equal to an expression.

" + } + }, "com.amazonaws.datazone#ErrorMessage": { "type": "string" }, @@ -9135,6 +9537,12 @@ "target": "com.amazonaws.datazone#FilterExpression" } }, + "com.amazonaws.datazone#FilterId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, "com.amazonaws.datazone#FilterList": { "type": "list", "member": { @@ -9147,6 +9555,34 @@ } } }, + "com.amazonaws.datazone#FilterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\w -]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#FilterStatus": { + "type": "enum", + "members": { + "VALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALID" + } + }, + "INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID" + } + } + } + }, "com.amazonaws.datazone#FirstName": { "type": "string", "traits": { @@ -9557,6 +9993,152 @@ "smithy.api#readonly": {} } }, + "com.amazonaws.datazone#GetAssetFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetAssetFilterInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetAssetFilterOutput" + }, + "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 asset filter.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetAssetFilterInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to get an asset filter.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assetIdentifier": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the data asset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#FilterId", + "traits": { + "smithy.api#documentation": "

The ID of the asset filter.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetAssetFilterOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#FilterId", + "traits": { + "smithy.api#documentation": "

The ID of the asset filter.

", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to get an asset filter.

", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the data asset.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the asset filter.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the asset filter.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#FilterStatus", + "traits": { + "smithy.api#documentation": "

The status of the asset filter.

" + } + }, + "configuration": { + "target": "com.amazonaws.datazone#AssetFilterConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the asset filter.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the asset filter was created.

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The error message that is displayed if the action does not complete successfully.

" + } + }, + "effectiveColumnNames": { + "target": "com.amazonaws.datazone#ColumnNameList", + "traits": { + "smithy.api#documentation": "

The column names of the asset filter.

" + } + }, + "effectiveRowFilter": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The row filter of the asset filter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#GetAssetInput": { "type": "structure", "members": { @@ -10669,6 +11251,13 @@ "smithy.api#documentation": "

The timestamp of when this blueprint was upated.

", "smithy.api#timestampFormat": "date-time" } + }, + "provisioningConfigurations": { + "target": "com.amazonaws.datazone#ProvisioningConfigurationList", + "traits": { + "smithy.api#documentation": "

The provisioning configuration of a blueprint.

", + "smithy.api#notProperty": {} + } } }, "traits": { @@ -13561,13 +14150,57 @@ "smithy.api#documentation": "

The details of a listing for which a subscription is to be granted.

" } }, - "com.amazonaws.datazone#GroupDetails": { + "com.amazonaws.datazone#GreaterThanExpression": { "type": "structure", "members": { - "groupId": { + "columnName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "

The identifier of the group in Amazon DataZone.

", + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value that might be greater than an expression.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies whether the value is greater than an expression.

" + } + }, + "com.amazonaws.datazone#GreaterThanOrEqualToExpression": { + "type": "structure", + "members": { + "columnName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value that might be greater than or equal to an expression.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies whether the value is greater than or equal to an expression.

" + } + }, + "com.amazonaws.datazone#GroupDetails": { + "type": "structure", + "members": { + "groupId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the group in Amazon DataZone.

", "smithy.api#required": {} } } @@ -13729,6 +14362,28 @@ } } }, + "com.amazonaws.datazone#InExpression": { + "type": "structure", + "members": { + "columnName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.datazone#StringList", + "traits": { + "smithy.api#documentation": "

The values that might be in the expression.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies whether values are in the expression.

" + } + }, "com.amazonaws.datazone#InternalServerException": { "type": "structure", "members": { @@ -13769,6 +14424,36 @@ } } }, + "com.amazonaws.datazone#IsNotNullExpression": { + "type": "structure", + "members": { + "columnName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that the expression is not null.

" + } + }, + "com.amazonaws.datazone#IsNullExpression": { + "type": "structure", + "members": { + "columnName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that the expression is null.

" + } + }, "com.amazonaws.datazone#KmsKeyArn": { "type": "string", "traits": { @@ -13779,12 +14464,98 @@ "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$" } }, + "com.amazonaws.datazone#LakeFormationConfiguration": { + "type": "structure", + "members": { + "locationRegistrationRole": { + "target": "com.amazonaws.datazone#RoleArn", + "traits": { + "smithy.api#documentation": "

The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for\n Data Lake using AWS Lake Formation hybrid access mode.

" + } + }, + "locationRegistrationExcludeS3Locations": { + "target": "com.amazonaws.datazone#S3LocationList", + "traits": { + "smithy.api#documentation": "

Specifies certain Amazon S3 locations if you do not want Amazon DataZone to\n automatically register them in hybrid mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Lake Formation configuration of the Data Lake blueprint.

" + } + }, "com.amazonaws.datazone#LastName": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#LessThanExpression": { + "type": "structure", + "members": { + "columnName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value that might be less than the expression.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that a value is less than an expression.

" + } + }, + "com.amazonaws.datazone#LessThanOrEqualToExpression": { + "type": "structure", + "members": { + "columnName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value that might be less than or equal to an expression.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that a value is less than or equal to an expression.

" + } + }, + "com.amazonaws.datazone#LikeExpression": { + "type": "structure", + "members": { + "columnName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value that might be like the expression.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that a value is like the expression.

" + } + }, "com.amazonaws.datazone#LineageEvent": { "type": "blob", "traits": { @@ -13994,6 +14765,113 @@ "smithy.api#documentation": "

The details of a data lineage node type.

" } }, + "com.amazonaws.datazone#ListAssetFilters": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#ListAssetFiltersInput" + }, + "output": { + "target": "com.amazonaws.datazone#ListAssetFiltersOutput" + }, + "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": "

Lists asset filters.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListAssetFiltersInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to list asset filters.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assetIdentifier": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the data asset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.datazone#FilterStatus", + "traits": { + "smithy.api#documentation": "

The status of the asset filter.

", + "smithy.api#httpQuery": "status" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of asset filters 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 asset filters, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListAssetFilters to\n list the next set of asset filters.

", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of asset filters to return in a single call to\n ListAssetFilters. When the number of asset filters to be listed is greater\n than the value of MaxResults, the response contains a NextToken\n value that you can use in a subsequent call to ListAssetFilters to list the\n next set of asset filters.

", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListAssetFiltersOutput": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.datazone#AssetFilters", + "traits": { + "smithy.api#documentation": "

The results of the ListAssetFilters action.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "

When the number of asset filters 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 asset filters, the response\n includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListAssetFilters to\n list the next set of asset filters.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#ListAssetRevisions": { "type": "operation", "input": { @@ -16867,6 +17745,72 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#NotEqualToExpression": { + "type": "structure", + "members": { + "columnName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value that might not be equal to the expression.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that a value is not equal to the expression.

" + } + }, + "com.amazonaws.datazone#NotInExpression": { + "type": "structure", + "members": { + "columnName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "values": { + "target": "com.amazonaws.datazone#StringList", + "traits": { + "smithy.api#documentation": "

The value that might not be in the expression.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that a value is not in the expression.

" + } + }, + "com.amazonaws.datazone#NotLikeExpression": { + "type": "structure", + "members": { + "columnName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The value that might not be like the expression.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies that a value might be not like the expression.

" + } + }, "com.amazonaws.datazone#NotificationOutput": { "type": "structure", "members": { @@ -17443,6 +18387,26 @@ "smithy.api#documentation": "

The details of a Amazon DataZone project.

" } }, + "com.amazonaws.datazone#ProvisioningConfiguration": { + "type": "union", + "members": { + "lakeFormationConfiguration": { + "target": "com.amazonaws.datazone#LakeFormationConfiguration", + "traits": { + "smithy.api#documentation": "

The Lake Formation configuration of the Data Lake blueprint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The provisioning configuration of the blueprint.

" + } + }, + "com.amazonaws.datazone#ProvisioningConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#ProvisioningConfiguration" + } + }, "com.amazonaws.datazone#ProvisioningProperties": { "type": "union", "members": { @@ -17536,6 +18500,13 @@ "traits": { "smithy.api#documentation": "

The regional parameters in the environment blueprint.

" } + }, + "provisioningConfigurations": { + "target": "com.amazonaws.datazone#ProvisioningConfigurationList", + "traits": { + "smithy.api#documentation": "

The provisioning configuration of a blueprint.

", + "smithy.api#notProperty": {} + } } }, "traits": { @@ -17596,6 +18567,13 @@ "smithy.api#documentation": "

The timestamp of when the environment blueprint was updated.

", "smithy.api#timestampFormat": "date-time" } + }, + "provisioningConfigurations": { + "target": "com.amazonaws.datazone#ProvisioningConfigurationList", + "traits": { + "smithy.api#documentation": "

The provisioning configuration of a blueprint.

", + "smithy.api#notProperty": {} + } } }, "traits": { @@ -18447,6 +19425,140 @@ "smithy.api#pattern": "^arn:aws[^:]*:iam::\\d{12}:(role|role/service-role)/[\\w+=,.@-]*$" } }, + "com.amazonaws.datazone#RowFilter": { + "type": "union", + "members": { + "expression": { + "target": "com.amazonaws.datazone#RowFilterExpression", + "traits": { + "smithy.api#documentation": "

The expression of the row filter.

" + } + }, + "and": { + "target": "com.amazonaws.datazone#RowFilterList", + "traits": { + "smithy.api#documentation": "

The 'and' clause of the row filter.

" + } + }, + "or": { + "target": "com.amazonaws.datazone#RowFilterList", + "traits": { + "smithy.api#documentation": "

The 'or' clause of the row filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The row filter.

" + } + }, + "com.amazonaws.datazone#RowFilterConfiguration": { + "type": "structure", + "members": { + "rowFilter": { + "target": "com.amazonaws.datazone#RowFilter", + "traits": { + "smithy.api#documentation": "

The row filter.

", + "smithy.api#required": {} + } + }, + "sensitive": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": true, + "smithy.api#documentation": "

Specifies whether the row filter is sensitive.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The row filter configuration details.

" + } + }, + "com.amazonaws.datazone#RowFilterExpression": { + "type": "union", + "members": { + "equalTo": { + "target": "com.amazonaws.datazone#EqualToExpression", + "traits": { + "smithy.api#documentation": "

The 'equal to' clause of the row filter expression.

" + } + }, + "notEqualTo": { + "target": "com.amazonaws.datazone#NotEqualToExpression", + "traits": { + "smithy.api#documentation": "

The 'no equal to' clause of the row filter expression.

" + } + }, + "greaterThan": { + "target": "com.amazonaws.datazone#GreaterThanExpression", + "traits": { + "smithy.api#documentation": "

The 'greater than' clause of the row filter expression.

" + } + }, + "lessThan": { + "target": "com.amazonaws.datazone#LessThanExpression", + "traits": { + "smithy.api#documentation": "

The 'less than' clause of the row filter expression.

" + } + }, + "greaterThanOrEqualTo": { + "target": "com.amazonaws.datazone#GreaterThanOrEqualToExpression", + "traits": { + "smithy.api#documentation": "

The 'greater than or equal to' clause of the filter expression.

" + } + }, + "lessThanOrEqualTo": { + "target": "com.amazonaws.datazone#LessThanOrEqualToExpression", + "traits": { + "smithy.api#documentation": "

The 'less than or equal to' clause of the row filter expression.

" + } + }, + "isNull": { + "target": "com.amazonaws.datazone#IsNullExpression", + "traits": { + "smithy.api#documentation": "

The 'is null' clause of the row filter expression.

" + } + }, + "isNotNull": { + "target": "com.amazonaws.datazone#IsNotNullExpression", + "traits": { + "smithy.api#documentation": "

The 'is not null' clause of the row filter expression.

" + } + }, + "in": { + "target": "com.amazonaws.datazone#InExpression", + "traits": { + "smithy.api#documentation": "

The 'in' clause of the row filter expression.

" + } + }, + "notIn": { + "target": "com.amazonaws.datazone#NotInExpression", + "traits": { + "smithy.api#documentation": "

The 'not in' clause of the row filter expression.

" + } + }, + "like": { + "target": "com.amazonaws.datazone#LikeExpression", + "traits": { + "smithy.api#documentation": "

The 'like' clause of the row filter expression.

" + } + }, + "notLike": { + "target": "com.amazonaws.datazone#NotLikeExpression", + "traits": { + "smithy.api#documentation": "

The 'not like' clause of the row filter expression.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The row filter expression.

" + } + }, + "com.amazonaws.datazone#RowFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#RowFilter" + } + }, "com.amazonaws.datazone#RunStatisticsForAssets": { "type": "structure", "members": { @@ -18485,6 +19597,28 @@ "smithy.api#documentation": "

The asset statistics from the data source run.

" } }, + "com.amazonaws.datazone#S3Location": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://.+$" + } + }, + "com.amazonaws.datazone#S3LocationList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#S3Location" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "com.amazonaws.datazone#ScheduleConfiguration": { "type": "structure", "members": { @@ -19807,6 +20941,12 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#StringList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.datazone#SubscribedAsset": { "type": "structure", "members": { @@ -21574,6 +22714,173 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#UpdateAssetFilter": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#UpdateAssetFilterInput" + }, + "output": { + "target": "com.amazonaws.datazone#UpdateAssetFilterOutput" + }, + "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 an asset filter.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters/{identifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#UpdateAssetFilterInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where you want to update an asset filter.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "assetIdentifier": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the data asset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#FilterId", + "traits": { + "smithy.api#documentation": "

The ID of the asset filter.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the asset filter.

" + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the asset filter.

" + } + }, + "configuration": { + "target": "com.amazonaws.datazone#AssetFilterConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the asset filter.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#UpdateAssetFilterOutput": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#FilterId", + "traits": { + "smithy.api#documentation": "

The ID of the asset filter.

", + "smithy.api#required": {} + } + }, + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "

The ID of the domain where the asset filter was created.

", + "smithy.api#required": {} + } + }, + "assetId": { + "target": "com.amazonaws.datazone#AssetId", + "traits": { + "smithy.api#documentation": "

The ID of the data asset.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.datazone#FilterName", + "traits": { + "smithy.api#documentation": "

The name of the asset filter.

", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.datazone#Description", + "traits": { + "smithy.api#documentation": "

The description of the asset filter.

" + } + }, + "status": { + "target": "com.amazonaws.datazone#FilterStatus", + "traits": { + "smithy.api#documentation": "

The status of the asset filter.

" + } + }, + "configuration": { + "target": "com.amazonaws.datazone#AssetFilterConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the asset filter.

", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "

The timestamp at which the asset filter was created.

" + } + }, + "errorMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The error message that is displayed if the action is not completed successfully.

" + } + }, + "effectiveColumnNames": { + "target": "com.amazonaws.datazone#ColumnNameList", + "traits": { + "smithy.api#documentation": "

The column names of the asset filter.

" + } + }, + "effectiveRowFilter": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The row filter of the asset filter.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#UpdateDataSource": { "type": "operation", "input": {