@aws-sdk/client-datazone 3.846.0 → 3.853.0

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

@@ -1,4 +1,164 @@
-import { ActionParameters, AssetFilterSummary, AssetListing, AssetRevision, ConfigurableEnvironmentAction, ConnectionCredentials, ConnectionPropertiesOutput, ConnectionSummary, ConnectionType, CustomParameter, DataProductItem, DataProductStatus, DataSourceConfigurationInput, DataSourceConfigurationOutput, DataSourceErrorMessage, DataSourceRunStatus, DataSourceStatus, DataZoneEntityType, Deployment, DeploymentProperties, DetailedGlossaryTerm, DomainStatus, DomainUnitOwnerProperties, DomainVersion, EnableSetting, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, EnvironmentStatus, FilterStatus, FormInput, FormOutput, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GrantedEntity, GroupProfileStatus, ListingStatus, ManagedPolicyType, Member, Model, OwnerProperties, PhysicalEndpoint, PolicyGrantDetail, PolicyGrantPrincipal, ProjectDeletionError, ProjectStatus, ProvisioningProperties, RecommendationConfiguration, Resource, RuleAction, RuleDetail, RuleScope, RuleTarget, RuleTargetType, RuleType, ScheduleConfiguration, SingleSignOn, Status, SubscribedAsset, SubscribedListing, SubscribedPrincipal, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TermRelations, TimeSeriesDataPointSummaryFormOutput, UserDesignation } from "./models_0";
+import { ActionParameters, AssetFilterSummary, AssetListing, AssetRevision, AssetScope, AssetTargetNameMap, ConfigurableEnvironmentAction, ConnectionCredentials, ConnectionPropertiesOutput, ConnectionSummary, ConnectionType, CustomParameter, DataProductItem, DataProductStatus, DataSourceConfigurationInput, DataSourceConfigurationOutput, DataSourceErrorMessage, DataSourceRunStatus, DataSourceStatus, DataZoneEntityType, Deployment, DeploymentProperties, DetailedGlossaryTerm, DomainStatus, DomainUnitOwnerProperties, DomainVersion, EnableSetting, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, EnvironmentStatus, FilterStatus, FormInput, FormOutput, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GrantedEntityInput, GroupProfileStatus, ListingStatus, ManagedPolicyType, MatchRationaleItem, Member, Model, OwnerProperties, PhysicalEndpoint, PolicyGrantDetail, PolicyGrantPrincipal, ProjectDeletionError, ProjectStatus, ProvisioningProperties, RecommendationConfiguration, Resource, ScheduleConfiguration, SingleSignOn, Status, SubscribedListing, SubscribedPrincipal, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TermRelations, TimeSeriesDataPointSummaryFormOutput, UserDesignation } from "./models_0";
+/**
+ * @public
+ */
+export interface CreateSubscriptionGrantInput {
+    /**
+     * <p>The ID of the Amazon DataZone domain in which the subscription grant is created.</p>
+     * @public
+     */
+    domainIdentifier: string | undefined;
+    /**
+     * <p>The ID of the environment in which the subscription grant is created.</p>
+     * @public
+     */
+    environmentIdentifier: string | undefined;
+    /**
+     * <p>The ID of the subscription target for which the subscription grant is created.</p>
+     * @public
+     */
+    subscriptionTargetIdentifier?: string | undefined;
+    /**
+     * <p>The entity to which the subscription is to be granted.</p>
+     * @public
+     */
+    grantedEntity: GrantedEntityInput | undefined;
+    /**
+     * <p>The names of the assets for which the subscription grant is created.</p>
+     * @public
+     */
+    assetTargetNames?: AssetTargetNameMap[] | undefined;
+    /**
+     * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the
+     *          request.</p>
+     * @public
+     */
+    clientToken?: string | undefined;
+}
+/**
+ * <p>Specifies the error message that is returned if the operation cannot be successfully
+ *          completed.</p>
+ * @public
+ */
+export interface FailureCause {
+    /**
+     * <p>The description of the error message.</p>
+     * @public
+     */
+    message?: string | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+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";
+};
+/**
+ * @public
+ */
+export type SubscriptionGrantStatus = (typeof SubscriptionGrantStatus)[keyof typeof SubscriptionGrantStatus];
+/**
+ * <p>The details of the asset for which the subscription grant is created.</p>
+ * @public
+ */
+export interface SubscribedAsset {
+    /**
+     * <p>The identifier of the asset for which the subscription grant is created.</p>
+     * @public
+     */
+    assetId: string | undefined;
+    /**
+     * <p>The revision of the asset for which the subscription grant is created.</p>
+     * @public
+     */
+    assetRevision: string | undefined;
+    /**
+     * <p>The status of the asset for which the subscription grant is created.</p>
+     * @public
+     */
+    status: SubscriptionGrantStatus | undefined;
+    /**
+     * <p>The target name of the asset for which the subscription grant is created.</p>
+     * @public
+     */
+    targetName?: string | undefined;
+    /**
+     * <p>The failure cause included in the details of the asset for which the subscription grant
+     *          is created.</p>
+     * @public
+     */
+    failureCause?: FailureCause | undefined;
+    /**
+     * <p>The timestamp of when the subscription grant to the asset is created.</p>
+     * @public
+     */
+    grantedTimestamp?: Date | undefined;
+    /**
+     * <p>The failure timestamp included in the details of the asset for which the subscription
+     *          grant is created.</p>
+     * @public
+     */
+    failureTimestamp?: Date | undefined;
+    /**
+     * <p>The asset scope of the subscribed asset.</p>
+     * @public
+     */
+    assetScope?: AssetScope | undefined;
+}
+/**
+ * <p>A revision of an asset published in a Amazon DataZone catalog.</p>
+ * @public
+ */
+export interface ListingRevision {
+    /**
+     * <p>An identifier of a revision of an asset published in a Amazon DataZone catalog.</p>
+     * @public
+     */
+    id: string | undefined;
+    /**
+     * <p>The details of a revision of an asset published in a Amazon DataZone catalog.</p>
+     * @public
+     */
+    revision: string | undefined;
+}
+/**
+ * <p>The details of a listing for which a subscription is granted.</p>
+ * @public
+ */
+export type GrantedEntity = GrantedEntity.ListingMember | GrantedEntity.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace GrantedEntity {
+    /**
+     * <p>The listing for which a subscription is granted.</p>
+     * @public
+     */
+    interface ListingMember {
+        listing: ListingRevision;
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    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;
+}
 /**
  * @public
  * @enum
@@ -696,6 +856,17 @@ export interface GetDataProductOutput {
      */
     firstRevisionCreatedBy?: string | undefined;
 }
+/**
+ * <p>The additional attributes of an Amazon DataZone data product.</p>
+ * @public
+ */
+export interface DataProductItemAdditionalAttributes {
+    /**
+     * <p>List of rationales indicating why this item was matched by search.</p>
+     * @public
+     */
+    matchRationale?: MatchRationaleItem[] | undefined;
+}
 /**
  * <p>The summary of the listing of the data product.</p>
  * @public
@@ -768,6 +939,11 @@ export interface DataProductListingItemAdditionalAttributes {
      * @public
      */
     forms?: string | undefined;
+    /**
+     * <p>List of rationales indicating why this item was matched by search.</p>
+     * @public
+     */
+    matchRationale?: MatchRationaleItem[] | undefined;
 }
 /**
  * <p>The results of the data product summary.</p>
@@ -916,6 +1092,11 @@ export interface DataProductResultItem {
      * @public
      */
     firstRevisionCreatedBy?: string | undefined;
+    /**
+     * <p>The additional attributes of an Amazon DataZone data product.</p>
+     * @public
+     */
+    additionalAttributes?: DataProductItemAdditionalAttributes | undefined;
 }
 /**
  * <p>The data product revision.</p>
@@ -9290,263 +9471,6 @@ export interface RevokeSubscriptionOutput {
      */
     retainPermissions?: boolean | undefined;
 }
-/**
- * @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;
-}
 /**
  * @internal
  */
@@ -9863,15 +9787,3 @@ export declare const RejectSubscriptionRequestOutputFilterSensitiveLog: (obj: Re
  * @internal
  */
 export declare const RevokeSubscriptionOutputFilterSensitiveLog: (obj: RevokeSubscriptionOutput) => any;
-/**
- * @internal
- */
-export declare const GetRuleOutputFilterSensitiveLog: (obj: GetRuleOutput) => any;
-/**
- * @internal
- */
-export declare const RuleSummaryFilterSensitiveLog: (obj: RuleSummary) => any;
-/**
- * @internal
- */
-export declare const ListRulesOutputFilterSensitiveLog: (obj: ListRulesOutput) => any;