feat(client-datazone): This release adds support for numeric filtering and complex free-text searches cases for the Search and SearchListings APIs.

Author: awstools

clients/client-datazone/src/commands/SearchCommand.ts

@@ -28,7 +28,7 @@ export interface SearchCommandInput extends SearchInput {}
 export interface SearchCommandOutput extends SearchOutput, __MetadataBearer {}
 
 /**
- * <p>Searches for assets in Amazon DataZone.</p> <p>Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. Search can be scoped to specific types of resources (like assets, glossary terms, or data products) and can be filtered using various criteria such as creation date, owner, or status. The search functionality is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.</p> <p>Many search commands in Amazon DataZone are paginated, including <code>search</code> and <code>search-types</code>. When the result set is large, Amazon DataZone returns a <code>nextToken</code> in the response. This token can be used to retrieve the next page of results. </p> <p>Prerequisites:</p> <ul> <li> <p>The --domain-identifier must refer to an existing Amazon DataZone domain. </p> </li> <li> <p>--search-scope must be one of: ASSET, GLOSSARY_TERM, DATA_PRODUCT, or GLOSSARY.</p> </li> <li> <p>The user must have search permissions in the specified domain.</p> </li> <li> <p>If using --filters, ensure that the JSON is well-formed and that each filter includes valid attribute and value keys. </p> </li> <li> <p>For paginated results, be prepared to use --next-token to fetch additional pages.</p> </li> </ul>
+ * <p>Searches for assets in Amazon DataZone.</p> <p>Search in Amazon DataZone is a powerful capability that enables users to discover and explore data assets, glossary terms, and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. Search can be scoped to specific types of resources (like assets, glossary terms, or data products) and can be filtered using various criteria such as creation date, owner, or status. The search functionality is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.</p> <p>Many search commands in Amazon DataZone are paginated, including <code>search</code> and <code>search-types</code>. When the result set is large, Amazon DataZone returns a <code>nextToken</code> in the response. This token can be used to retrieve the next page of results. </p> <p>Prerequisites:</p> <ul> <li> <p>The --domain-identifier must refer to an existing Amazon DataZone domain. </p> </li> <li> <p>--search-scope must be one of: ASSET, GLOSSARY_TERM, DATA_PRODUCT, or GLOSSARY.</p> </li> <li> <p>The user must have search permissions in the specified domain.</p> </li> <li> <p>If using --filters, ensure that the JSON is well-formed and that each filter includes valid attribute and value keys. </p> </li> <li> <p>For paginated results, be prepared to use --next-token to fetch additional pages.</p> </li> </ul> <p>To run a standard free-text search, the <code>searchText</code> parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the <a href="https://docs.aws.amazon.com/datazone/latest/APIReference/API_CreateFormType.html">CreateFormType API documentation</a>. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable.</p> <p>To run a filtered search, provide filter clause using the <code>filters</code> parameter. To filter on glossary terms, use the special attribute <code>__DataZoneGlossaryTerms</code>. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with <code>@amazon.datazone#sortable</code>), provide a filter using the <code>intValue</code> parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with <code>@amazon.datazone#searchable</code> for free-text search). Create/update timestamp filtering is supported using the special <code>creationTime</code>/<code>lastUpdatedTime</code> attributes. Filter types can be mixed and matched to power complex queries.</p> <p> To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -52,13 +52,17 @@ export interface SearchCommandOutput extends SearchOutput, __MetadataBearer {}
  *   filters: { // FilterClause Union: only one key present
  *     filter: { // Filter
  *       attribute: "STRING_VALUE", // required
- *       value: "STRING_VALUE", // required
+ *       value: "STRING_VALUE",
+ *       intValue: Number("long"),
+ *       operator: "EQ" || "LE" || "LT" || "GE" || "GT" || "TEXT_SEARCH",
  *     },
  *     and: [ // FilterList
  *       {//  Union: only one key present
  *         filter: {
  *           attribute: "STRING_VALUE", // required
- *           value: "STRING_VALUE", // required
+ *           value: "STRING_VALUE",
+ *           intValue: Number("long"),
+ *           operator: "EQ" || "LE" || "LT" || "GE" || "GT" || "TEXT_SEARCH",
  *         },
  *         and: [
  *           "<FilterClause>",

clients/client-datazone/src/commands/SearchListingsCommand.ts

@@ -28,7 +28,7 @@ export interface SearchListingsCommandInput extends SearchListingsInput {}
 export interface SearchListingsCommandOutput extends SearchListingsOutput, __MetadataBearer {}
 
 /**
- * <p>Searches listings in Amazon DataZone.</p> <p>SearchListings is a powerful capability that enables users to discover and explore published assets and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. SearchListings also supports filtering using various criteria such as creation date, owner, or status. This API is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.</p> <p>SearchListings returns results in a paginated format. When the result set is large, the response will include a nextToken, which can be used to retrieve the next page of results.</p> <p>The SearchListings API gives users flexibility in specifying what kind of search is run.</p> <p>To run a free-text search, the <code>searchText</code> parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the <a href="https://docs.aws.amazon.com/datazone/latest/APIReference/API_CreateFormType.html">CreateFormType API documentation</a>. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable.</p> <p>To run a filtered search, provide filter clause using the filters parameter. To filter on glossary terms, use the special attribute <code>__DataZoneGlossaryTerms</code>.</p> <p> To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.</p>
+ * <p>Searches listings in Amazon DataZone.</p> <p>SearchListings is a powerful capability that enables users to discover and explore published assets and data products across their organization. It provides both basic and advanced search functionality, allowing users to find resources based on names, descriptions, metadata, and other attributes. SearchListings also supports filtering using various criteria such as creation date, owner, or status. This API is essential for making the wealth of data resources in an organization discoverable and usable, helping users find the right data for their needs quickly and efficiently.</p> <p>SearchListings returns results in a paginated format. When the result set is large, the response will include a nextToken, which can be used to retrieve the next page of results.</p> <p>The SearchListings API gives users flexibility in specifying what kind of search is run.</p> <p>To run a standard free-text search, the <code>searchText</code> parameter must be supplied. By default, all searchable fields are indexed for semantic search and will return semantic matches for SearchListings queries. To prevent semantic search indexing for a custom form attribute, see the <a href="https://docs.aws.amazon.com/datazone/latest/APIReference/API_CreateFormType.html">CreateFormType API documentation</a>. To run a lexical search query, enclose the query with double quotes (""). This will disable semantic search even for fields that have semantic search enabled and will only return results that contain the keywords wrapped by double quotes (order of tokens in the query is not enforced). Free-text search is supported for all attributes annotated with @amazon.datazone#searchable.</p> <p>To run a filtered search, provide filter clause using the <code>filters</code> parameter. To filter on glossary terms, use the special attribute <code>__DataZoneGlossaryTerms</code>. To filter on an indexed numeric attribute (i.e., a numeric attribute annotated with <code>@amazon.datazone#sortable</code>), provide a filter using the <code>intValue</code> parameter. The filters parameter can also be used to run more advanced free-text searches that target specific attributes (attributes must be annotated with <code>@amazon.datazone#searchable</code> for free-text search). Create/update timestamp filtering is supported using the special <code>creationTime</code>/<code>lastUpdatedTime</code> attributes. Filter types can be mixed and matched to power complex queries.</p> <p> To find out whether an attribute has been annotated and indexed for a given search type, use the GetFormType API to retrieve the form containing the attribute.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -50,13 +50,17 @@ export interface SearchListingsCommandOutput extends SearchListingsOutput, __Met
  *   filters: { // FilterClause Union: only one key present
  *     filter: { // Filter
  *       attribute: "STRING_VALUE", // required
- *       value: "STRING_VALUE", // required
+ *       value: "STRING_VALUE",
+ *       intValue: Number("long"),
+ *       operator: "EQ" || "LE" || "LT" || "GE" || "GT" || "TEXT_SEARCH",
  *     },
  *     and: [ // FilterList
  *       {//  Union: only one key present
  *         filter: {
  *           attribute: "STRING_VALUE", // required
- *           value: "STRING_VALUE", // required
+ *           value: "STRING_VALUE",
+ *           intValue: Number("long"),
+ *           operator: "EQ" || "LE" || "LT" || "GE" || "GT" || "TEXT_SEARCH",
  *         },
  *         and: [
  *           "<FilterClause>",

clients/client-datazone/src/commands/SearchTypesCommand.ts

@@ -51,13 +51,17 @@ export interface SearchTypesCommandOutput extends SearchTypesOutput, __MetadataB
  *   filters: { // FilterClause Union: only one key present
  *     filter: { // Filter
  *       attribute: "STRING_VALUE", // required
- *       value: "STRING_VALUE", // required
+ *       value: "STRING_VALUE",
+ *       intValue: Number("long"),
+ *       operator: "EQ" || "LE" || "LT" || "GE" || "GT" || "TEXT_SEARCH",
  *     },
  *     and: [ // FilterList
  *       {//  Union: only one key present
  *         filter: {
  *           attribute: "STRING_VALUE", // required
- *           value: "STRING_VALUE", // required
+ *           value: "STRING_VALUE",
+ *           intValue: Number("long"),
+ *           operator: "EQ" || "LE" || "LT" || "GE" || "GT" || "TEXT_SEARCH",
  *         },
  *         and: [
  *           "<FilterClause>",

clients/client-datazone/src/models/enums.ts

@@ -1366,6 +1366,23 @@ export const SearchOutputAdditionalAttribute = {
 export type SearchOutputAdditionalAttribute =
   (typeof SearchOutputAdditionalAttribute)[keyof typeof SearchOutputAdditionalAttribute];
 
+/**
+ * @public
+ * @enum
+ */
+export const FilterOperator = {
+  EQ: "EQ",
+  GE: "GE",
+  GT: "GT",
+  LE: "LE",
+  LT: "LT",
+  TEXT_SEARCH: "TEXT_SEARCH",
+} as const;
+/**
+ * @public
+ */
+export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator];
+
 /**
  * @public
  * @enum

clients/client-datazone/src/models/models_1.ts

@@ -14,6 +14,7 @@ import {
   EdgeDirection,
   EnableSetting,
   EnvironmentStatus,
+  FilterOperator,
   FilterStatus,
   FormTypeStatus,
   GlossaryStatus,
@@ -10413,10 +10414,22 @@ export interface Filter {
   attribute: string | undefined;
 
   /**
-   * <p>A search filter value in Amazon DataZone.</p>
+   * <p>A search filter string value in Amazon DataZone.</p>
    * @public
    */
-  value: string | undefined;
+  value?: string | undefined;
+
+  /**
+   * <p>A search filter integer value in Amazon DataZone.</p>
+   * @public
+   */
+  intValue?: number | undefined;
+
+  /**
+   * <p>Specifies the search filter operator.</p>
+   * @public
+   */
+  operator?: FilterOperator | undefined;
 }
 
 /**

clients/client-datazone/src/schemas/schemas_0.ts

@@ -1260,6 +1260,7 @@ const _iT = "itemType";
 const _iTd = "idempotencyToken";
 const _iTdl = "idleTimeout";
 const _iUS = "isUpdateSupported";
+const _iV = "intValue";
 const _iVE = "isValueEditable";
 const _ia = "iam";
 const _id = "id";
@@ -1365,6 +1366,7 @@ const _oPIwn = "ownerProjectId";
 const _oPN = "ownerProjectName";
 const _oPO = "overrideProjectOwners";
 const _oUI = "owningUserId";
+const _op = "operator";
 const _or = "orchestrator";
 const _or_ = "or";
 const _ord = "order";
@@ -2777,8 +2779,8 @@ export var FailureCause$: StaticStructureSchema = [3, n0, _FC,
 ];
 export var Filter$: StaticStructureSchema = [3, n0, _F,
   0,
-  [_a, _v],
-  [0, 0], 2
+  [_a, _v, _iV, _op],
+  [0, 0, 1, 0], 1
 ];
 export var FilterExpression$: StaticStructureSchema = [3, n0, _FE,
   0,

clients/client-datazone/test/index-objects.spec.mjs

@@ -404,6 +404,7 @@ import {
   FilterClause$,
   FilterExpression$,
   FilterExpressionType,
+  FilterOperator,
   FilterStatus,
   FormEntryInput$,
   FormEntryOutput$,
@@ -2166,6 +2167,7 @@ assert(typeof EnableSetting === "object");
 assert(typeof EntityType === "object");
 assert(typeof EnvironmentStatus === "object");
 assert(typeof FilterExpressionType === "object");
+assert(typeof FilterOperator === "object");
 assert(typeof FilterStatus === "object");
 assert(typeof FormTypeStatus === "object");
 assert(typeof GlossaryStatus === "object");

clients/client-datazone/test/index-types.ts

@@ -554,6 +554,7 @@ export type {
   EntityType,
   EnvironmentStatus,
   FilterExpressionType,
+  FilterOperator,
   FilterStatus,
   FormTypeStatus,
   GlossaryStatus,