@aws-sdk/client-datazone 3.848.0 → 3.855.0

package/dist-types/commands/SearchCommand.d.ts

@@ -74,7 +74,7 @@ declare const SearchCommand_base: {
  *     order: "ASCENDING" || "DESCENDING",
  *   },
  *   additionalAttributes: [ // SearchOutputAdditionalAttributes
- *     "FORMS" || "TIME_SERIES_DATA_POINT_FORMS",
+ *     "FORMS" || "TIME_SERIES_DATA_POINT_FORMS" || "TEXT_MATCH_RATIONALE",
  *   ],
  * };
  * const command = new SearchCommand(input);
@@ -93,6 +93,24 @@ declare const SearchCommand_base: {
  * //         createdBy: "STRING_VALUE",
  * //         updatedAt: new Date("TIMESTAMP"),
  * //         updatedBy: "STRING_VALUE",
+ * //         additionalAttributes: { // GlossaryItemAdditionalAttributes
+ * //           matchRationale: [ // MatchRationale
+ * //             { // MatchRationaleItem Union: only one key present
+ * //               textMatches: [ // TextMatches
+ * //                 { // TextMatchItem
+ * //                   attribute: "STRING_VALUE",
+ * //                   text: "STRING_VALUE",
+ * //                   matchOffsets: [ // MatchOffsets
+ * //                     { // MatchOffset
+ * //                       startOffset: Number("int"),
+ * //                       endOffset: Number("int"),
+ * //                     },
+ * //                   ],
+ * //                 },
+ * //               ],
+ * //             },
+ * //           ],
+ * //         },
  * //       },
  * //       glossaryTermItem: { // GlossaryTermItem
  * //         domainId: "STRING_VALUE", // required
@@ -114,6 +132,24 @@ declare const SearchCommand_base: {
  * //         createdBy: "STRING_VALUE",
  * //         updatedAt: new Date("TIMESTAMP"),
  * //         updatedBy: "STRING_VALUE",
+ * //         additionalAttributes: { // GlossaryTermItemAdditionalAttributes
+ * //           matchRationale: [
+ * //             {//  Union: only one key present
+ * //               textMatches: [
+ * //                 {
+ * //                   attribute: "STRING_VALUE",
+ * //                   text: "STRING_VALUE",
+ * //                   matchOffsets: [
+ * //                     {
+ * //                       startOffset: Number("int"),
+ * //                       endOffset: Number("int"),
+ * //                     },
+ * //                   ],
+ * //                 },
+ * //               ],
+ * //             },
+ * //           ],
+ * //         },
  * //       },
  * //       assetItem: { // AssetItem
  * //         domainId: "STRING_VALUE", // required
@@ -158,6 +194,22 @@ declare const SearchCommand_base: {
  * //               id: "STRING_VALUE",
  * //             },
  * //           ],
+ * //           matchRationale: [
+ * //             {//  Union: only one key present
+ * //               textMatches: [
+ * //                 {
+ * //                   attribute: "STRING_VALUE",
+ * //                   text: "STRING_VALUE",
+ * //                   matchOffsets: [
+ * //                     {
+ * //                       startOffset: Number("int"),
+ * //                       endOffset: Number("int"),
+ * //                     },
+ * //                   ],
+ * //                 },
+ * //               ],
+ * //             },
+ * //           ],
  * //         },
  * //       },
  * //       dataProductItem: { // DataProductResultItem
@@ -173,6 +225,24 @@ declare const SearchCommand_base: {
  * //         createdBy: "STRING_VALUE",
  * //         firstRevisionCreatedAt: new Date("TIMESTAMP"),
  * //         firstRevisionCreatedBy: "STRING_VALUE",
+ * //         additionalAttributes: { // DataProductItemAdditionalAttributes
+ * //           matchRationale: [
+ * //             {//  Union: only one key present
+ * //               textMatches: [
+ * //                 {
+ * //                   attribute: "STRING_VALUE",
+ * //                   text: "STRING_VALUE",
+ * //                   matchOffsets: [
+ * //                     {
+ * //                       startOffset: Number("int"),
+ * //                       endOffset: Number("int"),
+ * //                     },
+ * //                   ],
+ * //                 },
+ * //               ],
+ * //             },
+ * //           ],
+ * //         },
  * //       },
  * //     },
  * //   ],

package/dist-types/commands/SearchListingsCommand.d.ts

@@ -67,12 +67,18 @@ declare const SearchListingsCommand_base: {
  *       "<FilterClause>",
  *     ],
  *   },
+ *   aggregations: [ // AggregationList
+ *     { // AggregationListItem
+ *       attribute: "STRING_VALUE", // required
+ *       displayValue: "STRING_VALUE",
+ *     },
+ *   ],
  *   sort: { // SearchSort
  *     attribute: "STRING_VALUE", // required
  *     order: "ASCENDING" || "DESCENDING",
  *   },
  *   additionalAttributes: [ // SearchOutputAdditionalAttributes
- *     "FORMS" || "TIME_SERIES_DATA_POINT_FORMS",
+ *     "FORMS" || "TIME_SERIES_DATA_POINT_FORMS" || "TEXT_MATCH_RATIONALE",
  *   ],
  * };
  * const command = new SearchListingsCommand(input);
@@ -100,6 +106,22 @@ declare const SearchListingsCommand_base: {
  * //         owningProjectId: "STRING_VALUE",
  * //         additionalAttributes: { // AssetListingItemAdditionalAttributes
  * //           forms: "STRING_VALUE",
+ * //           matchRationale: [ // MatchRationale
+ * //             { // MatchRationaleItem Union: only one key present
+ * //               textMatches: [ // TextMatches
+ * //                 { // TextMatchItem
+ * //                   attribute: "STRING_VALUE",
+ * //                   text: "STRING_VALUE",
+ * //                   matchOffsets: [ // MatchOffsets
+ * //                     { // MatchOffset
+ * //                       startOffset: Number("int"),
+ * //                       endOffset: Number("int"),
+ * //                     },
+ * //                   ],
+ * //                 },
+ * //               ],
+ * //             },
+ * //           ],
  * //           latestTimeSeriesDataPointForms: [ // TimeSeriesDataPointSummaryFormOutputList
  * //             { // TimeSeriesDataPointSummaryFormOutput
  * //               formName: "STRING_VALUE", // required
@@ -131,6 +153,22 @@ declare const SearchListingsCommand_base: {
  * //         owningProjectId: "STRING_VALUE",
  * //         additionalAttributes: { // DataProductListingItemAdditionalAttributes
  * //           forms: "STRING_VALUE",
+ * //           matchRationale: [
+ * //             {//  Union: only one key present
+ * //               textMatches: [
+ * //                 {
+ * //                   attribute: "STRING_VALUE",
+ * //                   text: "STRING_VALUE",
+ * //                   matchOffsets: [
+ * //                     {
+ * //                       startOffset: Number("int"),
+ * //                       endOffset: Number("int"),
+ * //                     },
+ * //                   ],
+ * //                 },
+ * //               ],
+ * //             },
+ * //           ],
  * //         },
  * //         items: [ // ListingSummaryItems
  * //           { // ListingSummaryItem
@@ -149,6 +187,19 @@ declare const SearchListingsCommand_base: {
  * //   ],
  * //   nextToken: "STRING_VALUE",
  * //   totalMatchCount: Number("int"),
+ * //   aggregates: [ // AggregationOutputList
+ * //     { // AggregationOutput
+ * //       attribute: "STRING_VALUE",
+ * //       displayValue: "STRING_VALUE",
+ * //       items: [ // AggregationOutputItems
+ * //         { // AggregationOutputItem
+ * //           value: "STRING_VALUE",
+ * //           count: Number("int"),
+ * //           displayValue: "STRING_VALUE",
+ * //         },
+ * //       ],
+ * //     },
+ * //   ],
  * // };
  *
  * ```

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

@@ -1650,6 +1650,67 @@ export interface AddPolicyGrantInput {
  */
 export interface AddPolicyGrantOutput {
 }
+/**
+ * <p>An aggregation list item.</p>
+ * @public
+ */
+export interface AggregationListItem {
+    /**
+     * <p>An attribute on which to compute aggregations.</p>
+     * @public
+     */
+    attribute: string | undefined;
+    /**
+     * <p>The display value of the aggregation list item. Supported values include
+     *             <code>value</code> and <code>glossaryTerm.name</code>.</p>
+     * @public
+     */
+    displayValue?: string | undefined;
+}
+/**
+ * <p>An aggregation output item.</p>
+ * @public
+ */
+export interface AggregationOutputItem {
+    /**
+     * <p>The attribute value of the aggregation output item.</p>
+     * @public
+     */
+    value?: string | undefined;
+    /**
+     * <p>The count of the aggregation output item.</p>
+     * @public
+     */
+    count?: number | undefined;
+    /**
+     * <p>The display value of the aggregation. If the attribute being aggregated corresponds to
+     *          the id of a public resource, the service automatically resolves the id to the provided
+     *          display value.</p>
+     * @public
+     */
+    displayValue?: string | undefined;
+}
+/**
+ * <p>The aggregation for an attribute.</p>
+ * @public
+ */
+export interface AggregationOutput {
+    /**
+     * <p>The attribute for this aggregation.</p>
+     * @public
+     */
+    attribute?: string | undefined;
+    /**
+     * <p>The display value of the aggregation output item.</p>
+     * @public
+     */
+    displayValue?: string | undefined;
+    /**
+     * <p>A list of aggregation output items.</p>
+     * @public
+     */
+    items?: AggregationOutputItem[] | undefined;
+}
 /**
  * @public
  * @enum
@@ -1743,6 +1804,8 @@ export interface CreateAssetInput {
     domainIdentifier: string | undefined;
     /**
      * <p>The external identifier of the asset.</p>
+     *          <p>If the value for the <code>externalIdentifier</code> parameter is specified, it must be
+     *          a unique value.</p>
      * @public
      */
     externalIdentifier?: string | undefined;
@@ -2111,6 +2174,9 @@ export interface GetAssetInput {
     domainIdentifier: string | undefined;
     /**
      * <p>The ID of the Amazon DataZone asset.</p>
+     *          <p>This parameter supports either the value of <code>assetId</code> or <code>externalIdentifier</code>
+     *          as input. If you are passing the value of <code>externalIdentifier</code>, you must prefix this
+     *          value with <code>externalIdentifer%2F</code>.</p>
      * @public
      */
     identifier: string | undefined;
@@ -2748,6 +2814,73 @@ export interface AssetFilterSummary {
      */
     errorMessage?: string | undefined;
 }
+/**
+ * <p>The offset of a matched term.</p>
+ * @public
+ */
+export interface MatchOffset {
+    /**
+     * <p>The 0-indexed number indicating the start position (inclusive) of a matched term.</p>
+     * @public
+     */
+    startOffset?: number | undefined;
+    /**
+     * <p>The 0-indexed number indicating the end position (exclusive) of a matched term.</p>
+     * @public
+     */
+    endOffset?: number | undefined;
+}
+/**
+ * <p>A structure indicating matched terms for an attribute.</p>
+ * @public
+ */
+export interface TextMatchItem {
+    /**
+     * <p>The name of the attribute.</p>
+     * @public
+     */
+    attribute?: string | undefined;
+    /**
+     * <p>Snippet of attribute text containing highlighted content.</p>
+     * @public
+     */
+    text?: string | undefined;
+    /**
+     * <p>List of offsets indicating matching terms in the TextMatchItem text.</p>
+     * @public
+     */
+    matchOffsets?: MatchOffset[] | undefined;
+}
+/**
+ * <p>A rationale indicating why this item was matched by search. </p>
+ * @public
+ */
+export type MatchRationaleItem = MatchRationaleItem.TextMatchesMember | MatchRationaleItem.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace MatchRationaleItem {
+    /**
+     * <p>A list of TextMatchItems.</p>
+     * @public
+     */
+    interface TextMatchesMember {
+        textMatches: TextMatchItem[];
+        $unknown?: never;
+    }
+    /**
+     * @public
+     */
+    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;
+}
 /**
  * <p>The additional attributes of an inventory asset.</p>
  * @public
@@ -2769,6 +2902,11 @@ export interface AssetItemAdditionalAttributes {
      * @public
      */
     latestTimeSeriesDataPointFormsOutput?: TimeSeriesDataPointSummaryFormOutput[] | undefined;
+    /**
+     * <p>List of rationales indicating why this item was matched by search.</p>
+     * @public
+     */
+    matchRationale?: MatchRationaleItem[] | undefined;
 }
 /**
  * <p>A Amazon DataZone inventory asset.</p>
@@ -2904,6 +3042,11 @@ export interface AssetListingItemAdditionalAttributes {
      * @public
      */
     forms?: string | undefined;
+    /**
+     * <p>List of rationales indicating why this item was matched by search.</p>
+     * @public
+     */
+    matchRationale?: MatchRationaleItem[] | undefined;
     /**
      * <p>The latest time series data points forms included in the additional attributes of an
      *          asset.</p>
@@ -4267,7 +4410,8 @@ export interface S3PropertiesInput {
      */
     s3Uri: string | undefined;
     /**
-     * <p>The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection.</p>
+     * <p>The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a
+     *          connection.</p>
      * @public
      */
     s3AccessGrantLocationId?: string | undefined;
@@ -4695,7 +4839,8 @@ export interface S3PropertiesOutput {
      */
     s3Uri: string | undefined;
     /**
-     * <p>The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection.</p>
+     * <p>The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a
+     *          connection.</p>
      * @public
      */
     s3AccessGrantLocationId?: string | undefined;
@@ -5078,7 +5223,8 @@ export interface S3PropertiesPatch {
      */
     s3Uri: string | undefined;
     /**
-     * <p>The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties patch of a connection.</p>
+     * <p>The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties patch of
+     *          a connection.</p>
      * @public
      */
     s3AccessGrantLocationId?: string | undefined;
@@ -8886,166 +9032,6 @@ export declare namespace GrantedEntityInput {
     }
     const visit: <T>(value: GrantedEntityInput, visitor: Visitor<T>) => T;
 }
-/**
- * @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;
-}
 /**
  * @internal
  */