AWS glue documentation change
Summary
Updated API references from 'Search' to 'SearchAssets', modified filter syntax (removed MapFilter, changed attribute names to 'type'), removed aggregation functionality, and clarified behavior when no parameters are provided
Security assessment
The changes involve API renaming and parameter adjustments without any security-specific context. No vulnerabilities, exploits, or security controls are mentioned. Modifications focus on syntax updates (e.g., changing 'assetTypeId' to 'type') and feature removal (aggregations), which are functional rather than security-related.
Diff
diff --git a/glue/latest/dg/catalog-semantic-search.md b/glue/latest/dg/catalog-semantic-search.md index b43775d97..7ef750b65 100644 --- a//glue/latest/dg/catalog-semantic-search.md +++ b//glue/latest/dg/catalog-semantic-search.md @@ -7 +7 @@ -Using the Search APIRunning filter-only queriesExamples +Using the SearchAssets APIRunning filter-only queriesExamples @@ -17 +17 @@ Semantic search enables you to discover data assets by meaning in addition to ex -## Using the Search API +## Using the SearchAssets API @@ -19 +19 @@ Semantic search enables you to discover data assets by meaning in addition to ex -The `Search` API requires at least one of `SearchText` or `FilterClause`. Optional parameters: `Sort`, `Aggregations`, `MaxResults`, `NextToken`. +The `SearchAssets` API accepts `SearchText`, `FilterClause`, or both. When neither is provided, it returns all assets. Optional parameters: `Sort`, `MaxResults`, `NextToken`. @@ -24 +24 @@ The `Search` API requires at least one of `SearchText` or `FilterClause`. Option - aws glue search \ + aws glue search-assets \ @@ -32,3 +32,2 @@ Example output: - {"Id": "c9vq7sh2fk4t2h", "AssetName": "Customer Sales Transactions", "AssetTypeId": "glue-table"} - ], - "TotalCount": 2 + {"Id": "c9vq7sh2fk4t2h", "AssetName": "Customer Sales Transactions", "AssetTypeId": "Table"} + ] @@ -40 +39 @@ Limit results with `--max-results`: - aws glue search \ + aws glue search-assets \ @@ -50,2 +48,0 @@ Use `FilterClause` to narrow results. Supported filter types: - * **MapFilter** – Filters on a map attribute's key-value pair. - @@ -64 +61 @@ Filter to table assets only: - aws glue search \ + aws glue search-assets \ @@ -68 +65 @@ Filter to table assets only: - "Attribute": "assetTypeId", + "Attribute": "type", @@ -70 +67 @@ Filter to table assets only: - "Value": {"StringValue": "glue-table"} + "Value": {"StringValue": "Table"} @@ -79 +76 @@ Find table assets updated after a timestamp: - aws glue search \ + aws glue search-assets \ @@ -83 +80 @@ Find table assets updated after a timestamp: - {"AttributeFilter": {"Attribute": "assetTypeId", "Operator": "equals", "Value": {"StringValue": "glue-table"}}}, + {"AttributeFilter": {"Attribute": "type", "Operator": "equals", "Value": {"StringValue": "Table"}}}, @@ -90 +87 @@ Find table assets updated after a timestamp: -Search for tables or views: +Search for tables or skill assets: @@ -93 +90 @@ Search for tables or views: - aws glue search \ + aws glue search-assets \ @@ -97,2 +94,2 @@ Search for tables or views: - {"AttributeFilter": {"Attribute": "assetTypeId", "Operator": "equals", "Value": {"StringValue": "glue-table"}}}, - {"AttributeFilter": {"Attribute": "assetTypeId", "Operator": "equals", "Value": {"StringValue": "glue-view"}}} + {"AttributeFilter": {"Attribute": "type", "Operator": "equals", "Value": {"StringValue": "Table"}}}, + {"AttributeFilter": {"Attribute": "type", "Operator": "equals", "Value": {"StringValue": "Skill"}}} @@ -102 +99 @@ Search for tables or views: -###### To filter by a map attribute +###### To filter by glossary term @@ -104 +101 @@ Search for tables or views: -Filter by glossary term key-value pair: +Filter to assets tagged with a specific glossary term (by term ID): @@ -107 +104 @@ Filter by glossary term key-value pair: - aws glue search \ + aws glue search-assets \ @@ -110 +107 @@ Filter by glossary term key-value pair: - "MapFilter": { + "AttributeFilter": { @@ -112,2 +109,2 @@ Filter by glossary term key-value pair: - "Key": "classification", - "Value": {"StringValue": "PII"} + "Operator": "equals", + "Value": {"StringValue": "glossary-term-id"} @@ -119 +116 @@ Filter by glossary term key-value pair: -Find table or view assets with a specific glossary term: +Find table or skill assets with a specific glossary term: @@ -122 +119 @@ Find table or view assets with a specific glossary term: - aws glue search \ + aws glue search-assets \ @@ -127,2 +124,2 @@ Find table or view assets with a specific glossary term: - {"AttributeFilter": {"Attribute": "assetTypeId", "Operator": "equals", "Value": {"StringValue": "glue-table"}}}, - {"AttributeFilter": {"Attribute": "assetTypeId", "Operator": "equals", "Value": {"StringValue": "glue-view"}}} + {"AttributeFilter": {"Attribute": "type", "Operator": "equals", "Value": {"StringValue": "Table"}}}, + {"AttributeFilter": {"Attribute": "type", "Operator": "equals", "Value": {"StringValue": "Skill"}}} @@ -130 +127 @@ Find table or view assets with a specific glossary term: - {"MapFilter": {"Attribute": "glossaryTerms", "Key": "term", "Value": {"StringValue": "Revenue"}}} + {"AttributeFilter": {"Attribute": "glossaryTerms", "Operator": "equals", "Value": {"StringValue": "glossary-term-id"}}} @@ -139 +136 @@ By default, results are sorted by semantic relevance. To sort by attribute: - aws glue search \ + aws glue search-assets \ @@ -144 +141 @@ By default, results are sorted by semantic relevance. To sort by attribute: - aws glue search \ + aws glue search-assets \ @@ -152,29 +148,0 @@ When you specify a sort attribute, results are ordered by that attribute rather -### Computing aggregations - -Use `Aggregations` to compute counts grouped by attribute values. - - - aws glue search \ - --search-text "customer data" \ - --aggregations '[{"Attribute": "assetTypeId"}]' - -Example output: - - - { - "TotalCount": 15, - "Aggregations": [ - {"Attribute": "assetTypeId", "Items": [ - {"Value": "glue-table", "Count": 10}, - {"Value": "glue-view", "Count": 3} - ]} - ] - } - -Request multiple aggregations in a single call: - - - aws glue search \ - --search-text "financial data" \ - --aggregations '[{"Attribute": "assetTypeId"}, {"Attribute": "glossaryTerms"}]' - @@ -186 +154 @@ When results exceed `MaxResults`, the response includes a `NextToken`. Use it to - aws glue search \ + aws glue search-assets \ @@ -198,2 +166,2 @@ Use only `FilterClause` without `SearchText` to list assets without semantic ran - aws glue search \ - --filter-clause '{"AttributeFilter": {"Attribute": "assetTypeId", "Operator": "equals", "Value": {"StringValue": "glue-table"}}}' \ + aws glue search-assets \ + --filter-clause '{"AttributeFilter": {"Attribute": "type", "Operator": "equals", "Value": {"StringValue": "Table"}}}' \ @@ -204 +172 @@ Use only `FilterClause` without `SearchText` to list assets without semantic ran -You must provide at least one of `SearchText` or `FilterClause`. +When you omit both `SearchText` and `FilterClause`, the API returns all assets. @@ -213 +181 @@ Find skill assets related to sales data: - aws glue search \ + aws glue search-assets \ @@ -215 +183 @@ Find skill assets related to sales data: - --filter-clause '{"AttributeFilter": {"Attribute": "assetTypeId", "Operator": "equals", "Value": {"StringValue": "skill-asset"}}}' + --filter-clause '{"AttributeFilter": {"Attribute": "type", "Operator": "equals", "Value": {"StringValue": "Skill"}}}' @@ -219 +187 @@ Find skill assets related to sales data: -This query returns only custom skill assets. Managed skills are not returned by the Search API. +This query returns only custom skill assets. Managed skills are not returned by the `SearchAssets` API. @@ -221 +189 @@ This query returns only custom skill assets. Managed skills are not returned by -###### To combine text search, aggregations, and sorting +###### To combine text search and sorting @@ -226 +194 @@ Get a comprehensive view of matching assets: - aws glue search \ + aws glue search-assets \ @@ -228 +195,0 @@ Get a comprehensive view of matching assets: - --aggregations '[{"Attribute": "assetTypeId"}]' \