@aws-sdk/client-datazone 3.535.0 → 3.546.0

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

@@ -11,13 +11,18 @@ export interface AcceptChoice {
      *          accepted.</p>
      * @public
      */
-    predictionTarget?: string;
+    predictionTarget: string | undefined;
     /**
      * <p>Specifies the prediction (aka, the automatically generated piece of metadata) that can
      *          be accepted.</p>
      * @public
      */
     predictionChoice?: number;
+    /**
+     * <p>The edit of the prediction.</p>
+     * @public
+     */
+    editedValue?: string;
 }
 /**
  * @public
@@ -58,12 +63,12 @@ export interface AcceptPredictionsInput {
      */
     domainIdentifier: string | undefined;
     /**
-     * <p/>
+     * <p>The identifier of the asset.</p>
      * @public
      */
     identifier: string | undefined;
     /**
-     * <p/>
+     * <p>The revision that is to be made to the asset.</p>
      * @public
      */
     revision?: string;
@@ -73,7 +78,8 @@ export interface AcceptPredictionsInput {
      */
     acceptRule?: AcceptRule;
     /**
-     * <p/>
+     * <p>Specifies the prediction (aka, the automatically generated piece of metadata) and the
+     *          target (for example, a column name) that can be accepted.</p>
      * @public
      */
     acceptChoices?: AcceptChoice[];
@@ -89,17 +95,17 @@ export interface AcceptPredictionsInput {
  */
 export interface AcceptPredictionsOutput {
     /**
-     * <p/>
+     * <p>The identifier of the Amazon DataZone domain.</p>
      * @public
      */
     domainId: string | undefined;
     /**
-     * <p/>
+     * <p>The ID of the asset.</p>
      * @public
      */
     assetId: string | undefined;
     /**
-     * <p/>
+     * <p>The revision that is to be made to the asset.</p>
      * @public
      */
     revision: string | undefined;
@@ -554,7 +560,7 @@ export interface CreateAssetInput {
      */
     domainIdentifier: string | undefined;
     /**
-     * <p/>
+     * <p>The external identifier of the asset.</p>
      * @public
      */
     externalIdentifier?: string;
@@ -652,7 +658,7 @@ export interface CreateAssetOutput {
      */
     typeRevision: string | undefined;
     /**
-     * <p/>
+     * <p>The external identifier of the asset.</p>
      * @public
      */
     externalIdentifier?: string;
@@ -702,7 +708,7 @@ export interface CreateAssetOutput {
      */
     domainId: string | undefined;
     /**
-     * <p/>
+     * <p>The details of an asset published in an Amazon DataZone catalog.</p>
      * @public
      */
     listing?: AssetListingDetails;
@@ -812,7 +818,7 @@ export interface CreateAssetRevisionOutput {
      */
     typeRevision: string | undefined;
     /**
-     * <p/>
+     * <p>The external identifier of the asset.</p>
      * @public
      */
     externalIdentifier?: string;
@@ -862,7 +868,7 @@ export interface CreateAssetRevisionOutput {
      */
     domainId: string | undefined;
     /**
-     * <p/>
+     * <p>The details of an asset published in an Amazon DataZone catalog. </p>
      * @public
      */
     listing?: AssetListingDetails;
@@ -949,7 +955,7 @@ export interface GetAssetOutput {
      */
     typeRevision: string | undefined;
     /**
-     * <p/>
+     * <p>The external ID of the asset.</p>
      * @public
      */
     externalIdentifier?: string;
@@ -999,7 +1005,7 @@ export interface GetAssetOutput {
      */
     domainId: string | undefined;
     /**
-     * <p/>
+     * <p>The listing of the asset.</p>
      * @public
      */
     listing?: AssetListingDetails;
@@ -1262,7 +1268,7 @@ export interface AssetRevision {
     createdAt?: Date;
 }
 /**
- * <p/>
+ * <p>The name map for assets.</p>
  * @public
  */
 export interface AssetTargetNameMap {
@@ -1599,6 +1605,27 @@ export declare const AuthType: {
  * @public
  */
 export type AuthType = (typeof AuthType)[keyof typeof AuthType];
+/**
+ * @public
+ */
+export interface CancelMetadataGenerationRunInput {
+    /**
+     * <p>The ID of the Amazon DataZone domain in which the metadata generation run is to be
+     *          cancelled.</p>
+     * @public
+     */
+    domainIdentifier: string | undefined;
+    /**
+     * <p>The ID of the metadata generation run.</p>
+     * @public
+     */
+    identifier: string | undefined;
+}
+/**
+ * @public
+ */
+export interface CancelMetadataGenerationRunOutput {
+}
 /**
  * @public
  */
@@ -2217,8 +2244,8 @@ export interface RedshiftRunConfigurationOutput {
      */
     accountId?: string;
     /**
-     * <p>The Amazon Web Services region included in the configuration details of the Amazon Redshift
-     *          data source.</p>
+     * <p>The Amazon Web Services region included in the configuration details of the Amazon Redshift data
+     *          source.</p>
      * @public
      */
     region?: string;
@@ -3106,7 +3133,7 @@ export interface CreateEnvironmentProfileOutput {
     userParameters?: CustomParameter[];
 }
 /**
- * <p/>
+ * <p>The model of the API.</p>
  * @public
  */
 export type Model = Model.SmithyMember | Model.$UnknownMember;
@@ -3115,7 +3142,7 @@ export type Model = Model.SmithyMember | Model.$UnknownMember;
  */
 export declare namespace Model {
     /**
-     * <p/>
+     * <p>Indicates the smithy model of the API.</p>
      * @public
      */
     interface SmithyMember {
@@ -3500,32 +3527,33 @@ export type EntityType = (typeof EntityType)[keyof typeof EntityType];
  */
 export interface CreateListingChangeSetInput {
     /**
-     * <p/>
+     * <p>The ID of the Amazon DataZone domain.</p>
      * @public
      */
     domainIdentifier: string | undefined;
     /**
-     * <p/>
+     * <p>The ID of the asset.</p>
      * @public
      */
     entityIdentifier: string | undefined;
     /**
-     * <p/>
+     * <p>The type of an entity.</p>
      * @public
      */
     entityType: EntityType | undefined;
     /**
-     * <p/>
+     * <p>The revision of an asset.</p>
      * @public
      */
     entityRevision?: string;
     /**
-     * <p/>
+     * <p>Specifies whether to publish or unpublish a listing.</p>
      * @public
      */
     action: ChangeAction | undefined;
     /**
-     * <p/>
+     * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the
+     *          request.</p>
      * @public
      */
     clientToken?: string;
@@ -3535,17 +3563,17 @@ export interface CreateListingChangeSetInput {
  */
 export interface CreateListingChangeSetOutput {
     /**
-     * <p/>
+     * <p>The ID of the listing (a record of an asset at a given time).</p>
      * @public
      */
     listingId: string | undefined;
     /**
-     * <p/>
+     * <p>The revision of a listing.</p>
      * @public
      */
     listingRevision: string | undefined;
     /**
-     * <p/>
+     * <p>Specifies the status of the listing.</p>
      * @public
      */
     status: ListingStatus | undefined;
@@ -3576,17 +3604,18 @@ export interface CreateProjectInput {
     glossaryTerms?: string[];
 }
 /**
- * Error that occurred during project deletion
+ * <p>Specifies the error message that is returned if the operation cannot be successfully
+ *          completed.</p>
  * @public
  */
 export interface ProjectDeletionError {
     /**
-     * Project Deletion Error Code
+     * <p>The code of the project deletion error.</p>
      * @public
      */
     code?: string;
     /**
-     * Project Deletion Error Message
+     * <p>The message of the project deletion error.</p>
      * @public
      */
     message?: string;
@@ -3629,12 +3658,13 @@ export interface CreateProjectOutput {
      */
     description?: string;
     /**
-     * Status of the project
+     * <p>The status of the Amazon DataZone project that was created.</p>
      * @public
      */
     projectStatus?: ProjectStatus;
     /**
-     * Reasons for failed project deletion
+     * <p>Specifies the error message that is returned if the operation cannot be successfully
+     *          completed.</p>
      * @public
      */
     failureReasons?: ProjectDeletionError[];
@@ -4091,7 +4121,7 @@ export interface CreateSubscriptionRequestInput {
      */
     subscribedPrincipals: SubscribedPrincipalInput[] | undefined;
     /**
-     * <p/>
+     * <p>The published asset for which the subscription grant is to be created.</p>
      * @public
      */
     subscribedListings: SubscribedListingInput[] | undefined;
@@ -4157,7 +4187,7 @@ export interface CreateSubscriptionRequestOutput {
      */
     subscribedPrincipals: SubscribedPrincipal[] | undefined;
     /**
-     * <p/>
+     * <p>The published asset for which the subscription grant is to be created.</p>
      * @public
      */
     subscribedListings: SubscribedListing[] | undefined;
@@ -4779,7 +4809,7 @@ export interface GetDataSourceOutput {
      */
     configuration?: DataSourceConfigurationOutput;
     /**
-     * <p/>
+     * <p>The recommendation configuration of the data source.</p>
      * @public
      */
     recommendation?: RecommendationConfiguration;
@@ -5611,7 +5641,7 @@ export interface DeleteProjectInput {
      */
     identifier: string | undefined;
     /**
-     * Optional flag to asynchronously delete child entities within the project
+     * <p>Specifies the optional flag to delete all child entities within the project.</p>
      * @public
      */
     skipDeletionCheck?: boolean;
@@ -5773,7 +5803,7 @@ export interface DeleteDomainInput {
      */
     clientToken?: string;
     /**
-     * Optional flag to delete all child entities within the domain
+     * <p>Specifies the optional flag to delete all child entities within the domain.</p>
      * @public
      */
     skipDeletionCheck?: boolean;
@@ -6800,12 +6830,13 @@ export interface GetProjectOutput {
      */
     description?: string;
     /**
-     * Status of the project
+     * <p>The status of the project.</p>
      * @public
      */
     projectStatus?: ProjectStatus;
     /**
-     * Reasons for failed project deletion
+     * <p>Specifies the error message that is returned if the operation cannot be successfully
+     *          completed.</p>
      * @public
      */
     failureReasons?: ProjectDeletionError[];
@@ -6890,7 +6921,7 @@ export interface GetSubscriptionOutput {
      */
     subscribedPrincipal: SubscribedPrincipal | undefined;
     /**
-     * <p/>
+     * <p>The details of the published asset for which the subscription grant is created.</p>
      * @public
      */
     subscribedListing: SubscribedListing | undefined;
@@ -7973,7 +8004,7 @@ export interface ListEnvironmentsInput {
      */
     provider?: string;
     /**
-     * <p/>
+     * <p>The name of the environment.</p>
      * @public
      */
     name?: string;
@@ -8093,12 +8124,12 @@ export interface ListEnvironmentsOutput {
  */
 export interface DeleteListingInput {
     /**
-     * <p/>
+     * <p>The ID of the Amazon DataZone domain.</p>
      * @public
      */
     domainIdentifier: string | undefined;
     /**
-     * <p/>
+     * <p>The ID of the listing to be deleted.</p>
      * @public
      */
     identifier: string | undefined;
@@ -8113,17 +8144,17 @@ export interface DeleteListingOutput {
  */
 export interface GetListingInput {
     /**
-     * <p/>
+     * <p>The ID of the Amazon DataZone domain.</p>
      * @public
      */
     domainIdentifier: string | undefined;
     /**
-     * <p/>
+     * <p>The ID of the listing.</p>
      * @public
      */
     identifier: string | undefined;
     /**
-     * <p/>
+     * <p>The revision of the listing.</p>
      * @public
      */
     listingRevision?: string;
@@ -8163,22 +8194,22 @@ export declare namespace ListingItem {
  */
 export interface GetListingOutput {
     /**
-     * <p/>
+     * <p>The ID of the Amazon DataZone domain.</p>
      * @public
      */
     domainId: string | undefined;
     /**
-     * <p/>
+     * <p>The ID of the listing.</p>
      * @public
      */
     id: string | undefined;
     /**
-     * <p/>
+     * <p>The revision of a listing.</p>
      * @public
      */
     listingRevision: string | undefined;
     /**
-     * <p/>
+     * <p>The timestamp of when the listing was created.</p>
      * @public
      */
     createdAt?: Date;
@@ -8198,22 +8229,22 @@ export interface GetListingOutput {
      */
     updatedBy?: string;
     /**
-     * <p/>
+     * <p>The details of a listing.</p>
      * @public
      */
     item?: ListingItem;
     /**
-     * <p/>
+     * <p>The name of the listing.</p>
      * @public
      */
     name?: string;
     /**
-     * <p/>
+     * <p>The description of the listing.</p>
      * @public
      */
     description?: string;
     /**
-     * <p/>
+     * <p>The status of the listing.</p>
      * @public
      */
     status?: ListingStatus;
@@ -8633,7 +8664,7 @@ export interface ListProjectsInput {
      */
     groupIdentifier?: string;
     /**
-     * <p/>
+     * <p>The name of the project.</p>
      * @public
      */
     name?: string;
@@ -8683,12 +8714,13 @@ export interface ProjectSummary {
      */
     description?: string;
     /**
-     * Status of the project
+     * <p>The status of the project.</p>
      * @public
      */
     projectStatus?: ProjectStatus;
     /**
-     * Reasons for failed project deletion
+     * <p>Specifies the error message that is returned if the operation cannot be successfully
+     *          completed.</p>
      * @public
      */
     failureReasons?: ProjectDeletionError[];
@@ -9345,87 +9377,44 @@ export interface ListTagsForResourceResponse {
     tags?: Record<string, string>;
 }
 /**
- * <p>The details of the automatically generated business metadata that is rejected.</p>
  * @public
  */
-export interface RejectChoice {
+export interface GetMetadataGenerationRunInput {
     /**
-     * <p>Specifies the target (for example, a column name) where a prediction can be
-     *          rejected.</p>
+     * <p>The ID of the Amazon DataZone domain the metadata generation run of which you want to
+     *          get.</p>
      * @public
      */
-    predictionTarget?: string;
+    domainIdentifier: string | undefined;
     /**
-     * <p>Specifies the the automatically generated business metadata that can be rejected.</p>
+     * <p>The identifier of the metadata generation run.</p>
      * @public
      */
-    predictionChoices?: number[];
+    identifier: string | undefined;
 }
 /**
  * @public
  * @enum
  */
-export declare const RejectRuleBehavior: {
-    readonly ALL: "ALL";
-    readonly NONE: "NONE";
+export declare const MetadataGenerationRunStatus: {
+    readonly CANCELED: "CANCELED";
+    readonly FAILED: "FAILED";
+    readonly IN_PROGRESS: "IN_PROGRESS";
+    readonly SUBMITTED: "SUBMITTED";
+    readonly SUCCEEDED: "SUCCEEDED";
 };
 /**
  * @public
  */
-export type RejectRuleBehavior = (typeof RejectRuleBehavior)[keyof typeof RejectRuleBehavior];
+export type MetadataGenerationRunStatus = (typeof MetadataGenerationRunStatus)[keyof typeof MetadataGenerationRunStatus];
 /**
- * <p>Specifies the rule and the threshold under which a prediction can be rejected.</p>
- * @public
+ * @internal
  */
-export interface RejectRule {
-    /**
-     * <p>Specifies whether you want to reject the top prediction for all targets or none.</p>
-     * @public
-     */
-    rule?: RejectRuleBehavior;
-    /**
-     * <p>The confidence score that specifies the condition at which a prediction can be
-     *          rejected.</p>
-     * @public
-     */
-    threshold?: number;
-}
+export declare const AcceptChoiceFilterSensitiveLog: (obj: AcceptChoice) => any;
 /**
- * @public
+ * @internal
  */
-export interface RejectPredictionsInput {
-    /**
-     * <p>The identifier of the Amazon DataZone domain.</p>
-     * @public
-     */
-    domainIdentifier: string | undefined;
-    /**
-     * <p>The identifier of the prediction.</p>
-     * @public
-     */
-    identifier: string | undefined;
-    /**
-     * <p/>
-     * @public
-     */
-    revision?: string;
-    /**
-     * <p/>
-     * @public
-     */
-    rejectRule?: RejectRule;
-    /**
-     * <p/>
-     * @public
-     */
-    rejectChoices?: RejectChoice[];
-    /**
-     * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the
-     *          request.</p>
-     * @public
-     */
-    clientToken?: string;
-}
+export declare const AcceptPredictionsInputFilterSensitiveLog: (obj: AcceptPredictionsInput) => any;
 /**
  * @internal
  */