@aws-sdk/client-datazone 3.846.0 → 3.853.0

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

@@ -1,5 +1,262 @@
-import { ActionParameters, AssetItem, AssetListingItem, AssetTypeItem, AwsLocation, ColumnFilterConfiguration, ConfigurableEnvironmentAction, ConnectionPropertiesOutput, ConnectionPropertiesPatch, ConnectionType, CustomParameter, Deployment, DeploymentProperties, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, EnvironmentParameter, EnvironmentStatus, FailureCause, FilterStatus, FormEntryOutput, FormOutput, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GrantedEntity, GroupProfileStatus, Model, PhysicalEndpoint, ProjectDeletionError, ProjectStatus, ProvisioningProperties, Resource, RowFilterExpression, RuleAction, RuleDetail, RuleScope, RuleTarget, RuleType, Status, SubscribedAsset, SubscribedListing, SubscribedPrincipal, SubscriptionGrantStatus, SubscriptionRequestStatus, TermRelations } from "./models_0";
-import { DataProductListingItem, DataProductResultItem, Import, SortOrder, SubscriptionGrantOverallStatus, SubscriptionTargetForm, UserProfileDetails, UserProfileStatus, UserProfileType } from "./models_1";
+import { ActionParameters, AggregationListItem, AggregationOutput, AssetItem, AssetListingItem, AssetTypeItem, AwsLocation, ColumnFilterConfiguration, ConfigurableEnvironmentAction, ConnectionPropertiesOutput, ConnectionPropertiesPatch, ConnectionType, CustomParameter, Deployment, DeploymentProperties, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, EnvironmentParameter, EnvironmentStatus, FilterStatus, FormEntryOutput, FormOutput, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GroupProfileStatus, MatchRationaleItem, Model, PhysicalEndpoint, ProjectDeletionError, ProjectStatus, ProvisioningProperties, Resource, RowFilterExpression, RuleAction, RuleDetail, RuleScope, RuleTarget, RuleTargetType, RuleType, Status, SubscribedListing, SubscribedPrincipal, SubscriptionRequestStatus, TermRelations } from "./models_0";
+import { DataProductListingItem, DataProductResultItem, FailureCause, GrantedEntity, Import, SortOrder, SubscribedAsset, SubscriptionGrantOverallStatus, SubscriptionGrantStatus, SubscriptionTargetForm, UserProfileDetails, UserProfileStatus, UserProfileType } from "./models_1";
+/**
+ * @public
+ */
+export interface DeleteRuleInput {
+    /**
+     * <p>The ID of the domain that where the rule is to be deleted.</p>
+     * @public
+     */
+    domainIdentifier: string | undefined;
+    /**
+     * <p>The ID of the rule that is to be deleted.</p>
+     * @public
+     */
+    identifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DeleteRuleOutput {
+}
+/**
+ * @public
+ */
+export interface GetRuleInput {
+    /**
+     * <p>The ID of the domain where the <code>GetRule</code> action is to be invoked.</p>
+     * @public
+     */
+    domainIdentifier: string | undefined;
+    /**
+     * <p>The ID of the rule.</p>
+     * @public
+     */
+    identifier: string | undefined;
+    /**
+     * <p>The revision of the rule.</p>
+     * @public
+     */
+    revision?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetRuleOutput {
+    /**
+     * <p>The ID of the rule.</p>
+     * @public
+     */
+    identifier: string | undefined;
+    /**
+     * <p>The revision of the rule.</p>
+     * @public
+     */
+    revision: string | undefined;
+    /**
+     * <p>The name of the rule.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The type of the rule.</p>
+     * @public
+     */
+    ruleType: RuleType | undefined;
+    /**
+     * <p>The target of the rule.</p>
+     * @public
+     */
+    target: RuleTarget | undefined;
+    /**
+     * <p>The action of the rule.</p>
+     * @public
+     */
+    action: RuleAction | undefined;
+    /**
+     * <p>The scope of the rule.</p>
+     * @public
+     */
+    scope: RuleScope | undefined;
+    /**
+     * <p>The detail of the rule.</p>
+     * @public
+     */
+    detail: RuleDetail | undefined;
+    /**
+     * <p>The target type of the rule.</p>
+     * @public
+     */
+    targetType?: RuleTargetType | undefined;
+    /**
+     * <p>The description of the rule.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>The timestamp at which the rule was created.</p>
+     * @public
+     */
+    createdAt: Date | undefined;
+    /**
+     * <p>The timestamp at which the rule was last updated.</p>
+     * @public
+     */
+    updatedAt: Date | undefined;
+    /**
+     * <p>The user who created the rule.</p>
+     * @public
+     */
+    createdBy: string | undefined;
+    /**
+     * <p>The timestamp at which the rule was last updated.</p>
+     * @public
+     */
+    lastUpdatedBy: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRulesInput {
+    /**
+     * <p>The ID of the domain in which the rules are to be listed.</p>
+     * @public
+     */
+    domainIdentifier: string | undefined;
+    /**
+     * <p>The target type of the rule.</p>
+     * @public
+     */
+    targetType: RuleTargetType | undefined;
+    /**
+     * <p>The target ID of the rule.</p>
+     * @public
+     */
+    targetIdentifier: string | undefined;
+    /**
+     * <p>The type of the rule.</p>
+     * @public
+     */
+    ruleType?: RuleType | undefined;
+    /**
+     * <p>The action of the rule.</p>
+     * @public
+     */
+    action?: RuleAction | undefined;
+    /**
+     * <p>The IDs of projects in which rules are to be listed.</p>
+     * @public
+     */
+    projectIds?: string[] | undefined;
+    /**
+     * <p>The asset types of the rule.</p>
+     * @public
+     */
+    assetTypes?: string[] | undefined;
+    /**
+     * <p>The data product of the rule.</p>
+     * @public
+     */
+    dataProduct?: boolean | undefined;
+    /**
+     * <p>Specifies whether to include cascading rules in the results.</p>
+     * @public
+     */
+    includeCascaded?: boolean | undefined;
+    /**
+     * <p>The maximum number of rules to return in a single call to <code>ListRules</code>. When
+     *          the number of rules to be listed is greater than the value of <code>MaxResults</code>, the
+     *          response contains a <code>NextToken</code> value that you can use in a subsequent call to
+     *             <code>ListRules</code> to list the next set of rules.</p>
+     * @public
+     */
+    maxResults?: number | undefined;
+    /**
+     * <p>When the number of rules is greater than the default value for the
+     *             <code>MaxResults</code> parameter, or if you explicitly specify a value for
+     *             <code>MaxResults</code> that is less than the number of rules, the response includes a
+     *          pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code>
+     *          value in a subsequent call to <code>ListRules</code> to list the next set of rules.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
+/**
+ * <p>The summary of the rule.</p>
+ * @public
+ */
+export interface RuleSummary {
+    /**
+     * <p>The ID of the rule.</p>
+     * @public
+     */
+    identifier?: string | undefined;
+    /**
+     * <p>The revision of the rule.</p>
+     * @public
+     */
+    revision?: string | undefined;
+    /**
+     * <p>The type of the rule.</p>
+     * @public
+     */
+    ruleType?: RuleType | undefined;
+    /**
+     * <p>The name of the rule.</p>
+     * @public
+     */
+    name?: string | undefined;
+    /**
+     * <p>The target type of the rule.</p>
+     * @public
+     */
+    targetType?: RuleTargetType | undefined;
+    /**
+     * <p>The target of the rule.</p>
+     * @public
+     */
+    target?: RuleTarget | undefined;
+    /**
+     * <p>The action of the rule.</p>
+     * @public
+     */
+    action?: RuleAction | undefined;
+    /**
+     * <p>The scope of the rule.</p>
+     * @public
+     */
+    scope?: RuleScope | undefined;
+    /**
+     * <p>The timestamp at which the rule was last updated.</p>
+     * @public
+     */
+    updatedAt?: Date | undefined;
+    /**
+     * <p>The timestamp at which the rule was last updated.</p>
+     * @public
+     */
+    lastUpdatedBy?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRulesOutput {
+    /**
+     * <p>The results of the <code>ListRules</code> action.</p>
+     * @public
+     */
+    items: RuleSummary[] | undefined;
+    /**
+     * <p>When the number of rules is greater than the default value for the
+     *             <code>MaxResults</code> parameter, or if you explicitly specify a value for
+     *             <code>MaxResults</code> that is less than the number of rules, the response includes a
+     *          pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code>
+     *          value in a subsequent call to <code>ListRules</code> to list the next set of rules.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
+}
 /**
  * @public
  */
@@ -116,6 +373,7 @@ export interface UpdateRuleOutput {
  */
 export declare const SearchOutputAdditionalAttribute: {
     readonly FORMS: "FORMS";
+    readonly TEXT_MATCH_RATIONALE: "TEXT_MATCH_RATIONALE";
     readonly TIME_SERIES_DATA_POINT_FORMS: "TIME_SERIES_DATA_POINT_FORMS";
 };
 /**
@@ -179,6 +437,17 @@ export interface SearchSort {
      */
     order?: SortOrder | undefined;
 }
+/**
+ * <p>The additional attributes of an Amazon DataZone glossary.</p>
+ * @public
+ */
+export interface GlossaryItemAdditionalAttributes {
+    /**
+     * <p>List of rationales indicating why this item was matched by search.</p>
+     * @public
+     */
+    matchRationale?: MatchRationaleItem[] | undefined;
+}
 /**
  * <p>The details of a business glossary.</p>
  * @public
@@ -234,6 +503,22 @@ export interface GlossaryItem {
      * @public
      */
     updatedBy?: string | undefined;
+    /**
+     * <p>The additional attributes of an Amazon DataZone glossary.</p>
+     * @public
+     */
+    additionalAttributes?: GlossaryItemAdditionalAttributes | undefined;
+}
+/**
+ * <p>The additional attributes of an Amazon DataZone glossary term.</p>
+ * @public
+ */
+export interface GlossaryTermItemAdditionalAttributes {
+    /**
+     * <p>List of rationales indicating why this item was matched by search.</p>
+     * @public
+     */
+    matchRationale?: MatchRationaleItem[] | undefined;
 }
 /**
  * <p>The details of a business glossary term.</p>
@@ -300,6 +585,11 @@ export interface GlossaryTermItem {
      * @public
      */
     updatedBy?: string | undefined;
+    /**
+     * <p>The additional attributes of an Amazon DataZone glossary term.</p>
+     * @public
+     */
+    additionalAttributes?: GlossaryTermItemAdditionalAttributes | undefined;
 }
 /**
  * <p>The details of the search results.</p>
@@ -562,6 +852,12 @@ export interface SearchListingsOutput {
      * @public
      */
     totalMatchCount?: number | undefined;
+    /**
+     * <p>Contains computed counts grouped by field values based on the requested aggregation
+     *          attributes for the matching listings.</p>
+     * @public
+     */
+    aggregates?: AggregationOutput[] | undefined;
 }
 /**
  * @public
@@ -2265,6 +2561,12 @@ export interface SearchListingsInput {
      * @public
      */
     filters?: FilterClause | undefined;
+    /**
+     * <p>Enables you to specify one or more attributes to compute and return counts grouped by
+     *          field values.</p>
+     * @public
+     */
+    aggregations?: AggregationListItem[] | undefined;
     /**
      * <p>Specifies the way for sorting the search results.</p>
      * @public
@@ -2630,6 +2932,18 @@ export interface UpdateAssetFilterOutput {
      */
     effectiveRowFilter?: string | undefined;
 }
+/**
+ * @internal
+ */
+export declare const GetRuleOutputFilterSensitiveLog: (obj: GetRuleOutput) => any;
+/**
+ * @internal
+ */
+export declare const RuleSummaryFilterSensitiveLog: (obj: RuleSummary) => any;
+/**
+ * @internal
+ */
+export declare const ListRulesOutputFilterSensitiveLog: (obj: ListRulesOutput) => any;
 /**
  * @internal
  */

package/dist-types/ts3.4/commands/CreateSubscriptionGrantCommand.d.ts

@@ -5,8 +5,10 @@ import {
   ServiceInputTypes,
   ServiceOutputTypes,
 } from "../DataZoneClient";
-import { CreateSubscriptionGrantInput } from "../models/models_0";
-import { CreateSubscriptionGrantOutput } from "../models/models_1";
+import {
+  CreateSubscriptionGrantInput,
+  CreateSubscriptionGrantOutput,
+} from "../models/models_1";
 export { __MetadataBearer };
 export { $Command };
 export interface CreateSubscriptionGrantCommandInput

package/dist-types/ts3.4/commands/DeleteRuleCommand.d.ts

@@ -5,7 +5,7 @@ import {
   ServiceInputTypes,
   ServiceOutputTypes,
 } from "../DataZoneClient";
-import { DeleteRuleInput, DeleteRuleOutput } from "../models/models_1";
+import { DeleteRuleInput, DeleteRuleOutput } from "../models/models_2";
 export { __MetadataBearer };
 export { $Command };
 export interface DeleteRuleCommandInput extends DeleteRuleInput {}

package/dist-types/ts3.4/commands/GetRuleCommand.d.ts

@@ -5,7 +5,7 @@ import {
   ServiceInputTypes,
   ServiceOutputTypes,
 } from "../DataZoneClient";
-import { GetRuleInput, GetRuleOutput } from "../models/models_1";
+import { GetRuleInput, GetRuleOutput } from "../models/models_2";
 export { __MetadataBearer };
 export { $Command };
 export interface GetRuleCommandInput extends GetRuleInput {}

package/dist-types/ts3.4/commands/ListRulesCommand.d.ts

@@ -5,7 +5,7 @@ import {
   ServiceInputTypes,
   ServiceOutputTypes,
 } from "../DataZoneClient";
-import { ListRulesInput, ListRulesOutput } from "../models/models_1";
+import { ListRulesInput, ListRulesOutput } from "../models/models_2";
 export { __MetadataBearer };
 export { $Command };
 export interface ListRulesCommandInput extends ListRulesInput {}

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

@@ -809,6 +809,20 @@ export interface AddPolicyGrantInput {
   clientToken?: string | undefined;
 }
 export interface AddPolicyGrantOutput {}
+export interface AggregationListItem {
+  attribute: string | undefined;
+  displayValue?: string | undefined;
+}
+export interface AggregationOutputItem {
+  value?: string | undefined;
+  count?: number | undefined;
+  displayValue?: string | undefined;
+}
+export interface AggregationOutput {
+  attribute?: string | undefined;
+  displayValue?: string | undefined;
+  items?: AggregationOutputItem[] | undefined;
+}
 export declare const ListingStatus: {
   readonly ACTIVE: "ACTIVE";
   readonly CREATING: "CREATING";
@@ -1234,12 +1248,40 @@ export interface AssetFilterSummary {
   createdAt?: Date | undefined;
   errorMessage?: string | undefined;
 }
+export interface MatchOffset {
+  startOffset?: number | undefined;
+  endOffset?: number | undefined;
+}
+export interface TextMatchItem {
+  attribute?: string | undefined;
+  text?: string | undefined;
+  matchOffsets?: MatchOffset[] | undefined;
+}
+export type MatchRationaleItem =
+  | MatchRationaleItem.TextMatchesMember
+  | MatchRationaleItem.$UnknownMember;
+export declare namespace MatchRationaleItem {
+  interface TextMatchesMember {
+    textMatches: TextMatchItem[];
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    textMatches?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    textMatches: (value: TextMatchItem[]) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: MatchRationaleItem, visitor: Visitor<T>) => T;
+}
 export interface AssetItemAdditionalAttributes {
   formsOutput?: FormOutput[] | undefined;
   readOnlyFormsOutput?: FormOutput[] | undefined;
   latestTimeSeriesDataPointFormsOutput?:
     | TimeSeriesDataPointSummaryFormOutput[]
     | undefined;
+  matchRationale?: MatchRationaleItem[] | undefined;
 }
 export interface AssetItem {
   domainId: string | undefined;
@@ -1271,6 +1313,7 @@ export interface AssetListing {
 }
 export interface AssetListingItemAdditionalAttributes {
   forms?: string | undefined;
+  matchRationale?: MatchRationaleItem[] | undefined;
   latestTimeSeriesDataPointForms?:
     | TimeSeriesDataPointSummaryFormOutput[]
     | undefined;
@@ -3314,61 +3357,6 @@ export declare namespace GrantedEntityInput {
   }
   const visit: <T>(value: GrantedEntityInput, visitor: Visitor<T>) => T;
 }
-export interface CreateSubscriptionGrantInput {
-  domainIdentifier: string | undefined;
-  environmentIdentifier: string | undefined;
-  subscriptionTargetIdentifier?: string | undefined;
-  grantedEntity: GrantedEntityInput | undefined;
-  assetTargetNames?: AssetTargetNameMap[] | undefined;
-  clientToken?: string | undefined;
-}
-export interface FailureCause {
-  message?: string | undefined;
-}
-export declare const SubscriptionGrantStatus: {
-  readonly GRANTED: "GRANTED";
-  readonly GRANT_FAILED: "GRANT_FAILED";
-  readonly GRANT_IN_PROGRESS: "GRANT_IN_PROGRESS";
-  readonly GRANT_PENDING: "GRANT_PENDING";
-  readonly REVOKED: "REVOKED";
-  readonly REVOKE_FAILED: "REVOKE_FAILED";
-  readonly REVOKE_IN_PROGRESS: "REVOKE_IN_PROGRESS";
-  readonly REVOKE_PENDING: "REVOKE_PENDING";
-};
-export type SubscriptionGrantStatus =
-  (typeof SubscriptionGrantStatus)[keyof typeof SubscriptionGrantStatus];
-export interface SubscribedAsset {
-  assetId: string | undefined;
-  assetRevision: string | undefined;
-  status: SubscriptionGrantStatus | undefined;
-  targetName?: string | undefined;
-  failureCause?: FailureCause | undefined;
-  grantedTimestamp?: Date | undefined;
-  failureTimestamp?: Date | undefined;
-  assetScope?: AssetScope | undefined;
-}
-export interface ListingRevision {
-  id: string | undefined;
-  revision: string | undefined;
-}
-export type GrantedEntity =
-  | GrantedEntity.ListingMember
-  | GrantedEntity.$UnknownMember;
-export declare namespace GrantedEntity {
-  interface ListingMember {
-    listing: ListingRevision;
-    $unknown?: never;
-  }
-  interface $UnknownMember {
-    listing?: never;
-    $unknown: [string, any];
-  }
-  interface Visitor<T> {
-    listing: (value: ListingRevision) => T;
-    _: (name: string, value: any) => T;
-  }
-  const visit: <T>(value: GrantedEntity, visitor: Visitor<T>) => T;
-}
 export declare const AcceptChoiceFilterSensitiveLog: (obj: AcceptChoice) => any;
 export declare const AcceptPredictionsInputFilterSensitiveLog: (
   obj: AcceptPredictionsInput