Skip to content

Commit 5a8f050

Browse files
author
AWS
committed
Amazon DataZone Update: This release adds support for 1) highlighting relevant text in returned results for Search and SearchListings APIs and 2) returning aggregated counts of values for specified attributes for SearchListings API.
1 parent d8ed0bb commit 5a8f050

File tree

2 files changed

+206
-5
lines changed

2 files changed

+206
-5
lines changed

‎.changes/next-release/feature-AmazonDataZone-124db99.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon DataZone",
4+
"contributor": "",
5+
"description": "This release adds support for 1) highlighting relevant text in returned results for Search and SearchListings APIs and 2) returning aggregated counts of values for specified attributes for SearchListings API."
6+
}

‎services/datazone/src/main/resources/codegen-resources/service-2.json

Lines changed: 200 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3542,6 +3542,78 @@
35423542
},
35433543
"documentation":"<p>The details of the policy grant.</p>"
35443544
},
3545+
"AggregationAttributeDisplayValue":{"type":"string"},
3546+
"AggregationAttributeValue":{"type":"string"},
3547+
"AggregationDisplayValue":{
3548+
"type":"string",
3549+
"max":100,
3550+
"min":1
3551+
},
3552+
"AggregationList":{
3553+
"type":"list",
3554+
"member":{"shape":"AggregationListItem"},
3555+
"max":10,
3556+
"min":1
3557+
},
3558+
"AggregationListItem":{
3559+
"type":"structure",
3560+
"required":["attribute"],
3561+
"members":{
3562+
"attribute":{
3563+
"shape":"Attribute",
3564+
"documentation":"<p>An attribute on which to compute aggregations.</p>"
3565+
},
3566+
"displayValue":{
3567+
"shape":"AggregationDisplayValue",
3568+
"documentation":"<p>The display value of the aggregation list item. Supported values include <code>value</code> and <code>glossaryTerm.name</code>.</p>"
3569+
}
3570+
},
3571+
"documentation":"<p>An aggregation list item.</p>"
3572+
},
3573+
"AggregationOutput":{
3574+
"type":"structure",
3575+
"members":{
3576+
"attribute":{
3577+
"shape":"Attribute",
3578+
"documentation":"<p>The attribute for this aggregation.</p>"
3579+
},
3580+
"displayValue":{
3581+
"shape":"AggregationDisplayValue",
3582+
"documentation":"<p>The display value of the aggregation output item.</p>"
3583+
},
3584+
"items":{
3585+
"shape":"AggregationOutputItems",
3586+
"documentation":"<p>A list of aggregation output items.</p>"
3587+
}
3588+
},
3589+
"documentation":"<p>The aggregation for an attribute.</p>"
3590+
},
3591+
"AggregationOutputItem":{
3592+
"type":"structure",
3593+
"members":{
3594+
"count":{
3595+
"shape":"Integer",
3596+
"documentation":"<p>The count of the aggregation output item.</p>"
3597+
},
3598+
"displayValue":{
3599+
"shape":"AggregationAttributeDisplayValue",
3600+
"documentation":"<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>"
3601+
},
3602+
"value":{
3603+
"shape":"AggregationAttributeValue",
3604+
"documentation":"<p>The attribute value of the aggregation output item.</p>"
3605+
}
3606+
},
3607+
"documentation":"<p>An aggregation output item.</p>"
3608+
},
3609+
"AggregationOutputItems":{
3610+
"type":"list",
3611+
"member":{"shape":"AggregationOutputItem"}
3612+
},
3613+
"AggregationOutputList":{
3614+
"type":"list",
3615+
"member":{"shape":"AggregationOutput"}
3616+
},
35453617
"AllDomainUnitsGrantFilter":{
35463618
"type":"structure",
35473619
"members":{
@@ -3740,6 +3812,10 @@
37403812
"shape":"TimeSeriesDataPointSummaryFormOutputList",
37413813
"documentation":"<p>The latest time series data points forms included in the additional attributes of an asset.</p>"
37423814
},
3815+
"matchRationale":{
3816+
"shape":"MatchRationale",
3817+
"documentation":"<p>List of rationales indicating why this item was matched by search.</p>"
3818+
},
37433819
"readOnlyFormsOutput":{
37443820
"shape":"FormOutputList",
37453821
"documentation":"<p>The read-only forms included in the additional attributes of an inventory asset.</p>"
@@ -3871,6 +3947,10 @@
38713947
"latestTimeSeriesDataPointForms":{
38723948
"shape":"TimeSeriesDataPointSummaryFormOutputList",
38733949
"documentation":"<p>The latest time series data points forms included in the additional attributes of an asset.</p>"
3950+
},
3951+
"matchRationale":{
3952+
"shape":"MatchRationale",
3953+
"documentation":"<p>List of rationales indicating why this item was matched by search.</p>"
38743954
}
38753955
},
38763956
"documentation":"<p>Additional attributes of an inventory asset.</p>"
@@ -4940,7 +5020,7 @@
49405020
},
49415021
"externalIdentifier":{
49425022
"shape":"ExternalIdentifier",
4943-
"documentation":"<p>The external identifier of the asset.</p>"
5023+
"documentation":"<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>"
49445024
},
49455025
"formsInput":{
49465026
"shape":"FormInputList",
@@ -7604,6 +7684,16 @@
76047684
},
76057685
"documentation":"<p>The data product.</p>"
76067686
},
7687+
"DataProductItemAdditionalAttributes":{
7688+
"type":"structure",
7689+
"members":{
7690+
"matchRationale":{
7691+
"shape":"MatchRationale",
7692+
"documentation":"<p>List of rationales indicating why this item was matched by search.</p>"
7693+
}
7694+
},
7695+
"documentation":"<p>The additional attributes of an Amazon DataZone data product.</p>"
7696+
},
76077697
"DataProductItemType":{
76087698
"type":"string",
76097699
"enum":["ASSET"]
@@ -7711,6 +7801,10 @@
77117801
"forms":{
77127802
"shape":"Forms",
77137803
"documentation":"<p>The metadata forms of the asset of the data product. </p>"
7804+
},
7805+
"matchRationale":{
7806+
"shape":"MatchRationale",
7807+
"documentation":"<p>List of rationales indicating why this item was matched by search.</p>"
77147808
}
77157809
},
77167810
"documentation":"<p>The additional attributes of the asset of the data product. </p>"
@@ -7730,6 +7824,10 @@
77307824
"owningProjectId"
77317825
],
77327826
"members":{
7827+
"additionalAttributes":{
7828+
"shape":"DataProductItemAdditionalAttributes",
7829+
"documentation":"<p>The additional attributes of an Amazon DataZone data product.</p>"
7830+
},
77337831
"createdAt":{
77347832
"shape":"CreatedAt",
77357833
"documentation":"<p>The timestamp at which the data product was created.</p>"
@@ -10383,7 +10481,7 @@
1038310481
},
1038410482
"identifier":{
1038510483
"shape":"AssetIdentifier",
10386-
"documentation":"<p>The ID of the Amazon DataZone asset.</p>",
10484+
"documentation":"<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>",
1038710485
"location":"uri",
1038810486
"locationName":"identifier"
1038910487
},
@@ -13036,6 +13134,10 @@
1303613134
"status"
1303713135
],
1303813136
"members":{
13137+
"additionalAttributes":{
13138+
"shape":"GlossaryItemAdditionalAttributes",
13139+
"documentation":"<p>The additional attributes of an Amazon DataZone glossary.</p>"
13140+
},
1303913141
"createdAt":{
1304013142
"shape":"CreatedAt",
1304113143
"documentation":"<p>The timestamp of when the glossary was created.</p>"
@@ -13079,6 +13181,16 @@
1307913181
},
1308013182
"documentation":"<p>The details of a business glossary.</p>"
1308113183
},
13184+
"GlossaryItemAdditionalAttributes":{
13185+
"type":"structure",
13186+
"members":{
13187+
"matchRationale":{
13188+
"shape":"MatchRationale",
13189+
"documentation":"<p>List of rationales indicating why this item was matched by search.</p>"
13190+
}
13191+
},
13192+
"documentation":"<p>The additional attributes of an Amazon DataZone glossary.</p>"
13193+
},
1308213194
"GlossaryName":{
1308313195
"type":"string",
1308413196
"max":256,
@@ -13106,6 +13218,10 @@
1310613218
"status"
1310713219
],
1310813220
"members":{
13221+
"additionalAttributes":{
13222+
"shape":"GlossaryTermItemAdditionalAttributes",
13223+
"documentation":"<p>The additional attributes of an Amazon DataZone glossary term.</p>"
13224+
},
1310913225
"createdAt":{
1311013226
"shape":"CreatedAt",
1311113227
"documentation":"<p>The timestamp of when a business glossary term was created.</p>"
@@ -13157,6 +13273,16 @@
1315713273
},
1315813274
"documentation":"<p>The details of a business glossary term.</p>"
1315913275
},
13276+
"GlossaryTermItemAdditionalAttributes":{
13277+
"type":"structure",
13278+
"members":{
13279+
"matchRationale":{
13280+
"shape":"MatchRationale",
13281+
"documentation":"<p>List of rationales indicating why this item was matched by search.</p>"
13282+
}
13283+
},
13284+
"documentation":"<p>The additional attributes of an Amazon DataZone glossary term.</p>"
13285+
},
1316013286
"GlossaryTermName":{
1316113287
"type":"string",
1316213288
"max":256,
@@ -16336,6 +16462,39 @@
1633616462
"max":10,
1633716463
"min":0
1633816464
},
16465+
"MatchOffset":{
16466+
"type":"structure",
16467+
"members":{
16468+
"endOffset":{
16469+
"shape":"Integer",
16470+
"documentation":"<p>The 0-indexed number indicating the end position (exclusive) of a matched term.</p>"
16471+
},
16472+
"startOffset":{
16473+
"shape":"Integer",
16474+
"documentation":"<p>The 0-indexed number indicating the start position (inclusive) of a matched term.</p>"
16475+
}
16476+
},
16477+
"documentation":"<p>The offset of a matched term.</p>"
16478+
},
16479+
"MatchOffsets":{
16480+
"type":"list",
16481+
"member":{"shape":"MatchOffset"}
16482+
},
16483+
"MatchRationale":{
16484+
"type":"list",
16485+
"member":{"shape":"MatchRationaleItem"}
16486+
},
16487+
"MatchRationaleItem":{
16488+
"type":"structure",
16489+
"members":{
16490+
"textMatches":{
16491+
"shape":"TextMatches",
16492+
"documentation":"<p>A list of TextMatchItems.</p>"
16493+
}
16494+
},
16495+
"documentation":"<p>A rationale indicating why this item was matched by search. </p>",
16496+
"union":true
16497+
},
1633916498
"MaxResults":{
1634016499
"type":"integer",
1634116500
"box":true,
@@ -19062,6 +19221,10 @@
1906219221
"shape":"SearchOutputAdditionalAttributes",
1906319222
"documentation":"<p>Specifies additional attributes for the search.</p>"
1906419223
},
19224+
"aggregations":{
19225+
"shape":"AggregationList",
19226+
"documentation":"<p>Enables you to specify one or more attributes to compute and return counts grouped by field values.</p>"
19227+
},
1906519228
"domainIdentifier":{
1906619229
"shape":"DomainId",
1906719230
"documentation":"<p>The identifier of the domain in which to search listings.</p>",
@@ -19085,7 +19248,7 @@
1908519248
"documentation":"<p>The details of the search.</p>"
1908619249
},
1908719250
"searchText":{
19088-
"shape":"String",
19251+
"shape":"SearchListingsInputSearchTextString",
1908919252
"documentation":"<p>Specifies the text for which to search.</p>"
1909019253
},
1909119254
"sort":{
@@ -19094,9 +19257,18 @@
1909419257
}
1909519258
}
1909619259
},
19260+
"SearchListingsInputSearchTextString":{
19261+
"type":"string",
19262+
"max":512,
19263+
"min":0
19264+
},
1909719265
"SearchListingsOutput":{
1909819266
"type":"structure",
1909919267
"members":{
19268+
"aggregates":{
19269+
"shape":"AggregationOutputList",
19270+
"documentation":"<p>Contains computed counts grouped by field values based on the requested aggregation attributes for the matching listings.</p>"
19271+
},
1910019272
"items":{
1910119273
"shape":"SearchResultItems",
1910219274
"documentation":"<p>The results of the <code>SearchListings</code> action.</p>"
@@ -19132,7 +19304,8 @@
1913219304
"type":"string",
1913319305
"enum":[
1913419306
"FORMS",
19135-
"TIME_SERIES_DATA_POINT_FORMS"
19307+
"TIME_SERIES_DATA_POINT_FORMS",
19308+
"TEXT_MATCH_RATIONALE"
1913619309
]
1913719310
},
1913819311
"SearchOutputAdditionalAttributes":{
@@ -19175,7 +19348,7 @@
1917519348
},
1917619349
"SearchText":{
1917719350
"type":"string",
19178-
"max":4096,
19351+
"max":512,
1917919352
"min":1
1918019353
},
1918119354
"SearchTypesInput":{
@@ -20674,6 +20847,28 @@
2067420847
"max":10,
2067520848
"min":1
2067620849
},
20850+
"TextMatchItem":{
20851+
"type":"structure",
20852+
"members":{
20853+
"attribute":{
20854+
"shape":"Attribute",
20855+
"documentation":"<p>The name of the attribute.</p>"
20856+
},
20857+
"matchOffsets":{
20858+
"shape":"MatchOffsets",
20859+
"documentation":"<p>List of offsets indicating matching terms in the TextMatchItem text.</p>"
20860+
},
20861+
"text":{
20862+
"shape":"String",
20863+
"documentation":"<p>Snippet of attribute text containing highlighted content.</p>"
20864+
}
20865+
},
20866+
"documentation":"<p>A structure indicating matched terms for an attribute.</p>"
20867+
},
20868+
"TextMatches":{
20869+
"type":"list",
20870+
"member":{"shape":"TextMatchItem"}
20871+
},
2067720872
"ThrottlingException":{
2067820873
"type":"structure",
2067920874
"required":["message"],

0 commit comments

Comments
 (0)