Skip to content

Commit 8ee8321

Browse files
author
AWS
committed
AWS Clean Rooms Service Update: Feature: New schemaStatusDetails field to the existing Schema object that displays a status on Schema API responses to show whether a schema is queryable or not. New BatchGetSchemaAnalysisRule API to retrieve multiple schemaAnalysisRules using a single API call.
1 parent c6116f0 commit 8ee8321

File tree

2 files changed

+223
-10
lines changed

2 files changed

+223
-10
lines changed

‎.changes/next-release/feature-AWSCleanRoomsService-acab917.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": "AWS Clean Rooms Service",
4+
"contributor": "",
5+
"description": "Feature: New schemaStatusDetails field to the existing Schema object that displays a status on Schema API responses to show whether a schema is queryable or not. New BatchGetSchemaAnalysisRule API to retrieve multiple schemaAnalysisRules using a single API call."
6+
}

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

Lines changed: 217 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,24 @@
4848
],
4949
"documentation":"<p>Retrieves multiple schemas by their identifiers.</p>"
5050
},
51+
"BatchGetSchemaAnalysisRule":{
52+
"name":"BatchGetSchemaAnalysisRule",
53+
"http":{
54+
"method":"POST",
55+
"requestUri":"/collaborations/{collaborationIdentifier}/batch-schema-analysis-rule",
56+
"responseCode":200
57+
},
58+
"input":{"shape":"BatchGetSchemaAnalysisRuleInput"},
59+
"output":{"shape":"BatchGetSchemaAnalysisRuleOutput"},
60+
"errors":[
61+
{"shape":"ResourceNotFoundException"},
62+
{"shape":"InternalServerException"},
63+
{"shape":"ValidationException"},
64+
{"shape":"ThrottlingException"},
65+
{"shape":"AccessDeniedException"}
66+
],
67+
"documentation":"<p>Retrieves multiple analysis rule schemas.</p>"
68+
},
5169
"CreateAnalysisTemplate":{
5270
"name":"CreateAnalysisTemplate",
5371
"http":{
@@ -1391,11 +1409,11 @@
13911409
"members":{
13921410
"allowedAnalyses":{
13931411
"shape":"AnalysisRuleCustomAllowedAnalysesList",
1394-
"documentation":"<p>The analysis templates that are allowed by the custom analysis rule.</p>"
1412+
"documentation":"<p>The ARN of the analysis templates that are allowed by the custom analysis rule.</p>"
13951413
},
13961414
"allowedAnalysisProviders":{
13971415
"shape":"AnalysisRuleCustomAllowedAnalysisProvidersList",
1398-
"documentation":"<p>The Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when <code>allowedAnalyses</code> is <code>ANY_QUERY</code>.</p>"
1416+
"documentation":"<p>The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when <code>allowedAnalyses</code> is <code>ANY_QUERY</code>.</p>"
13991417
},
14001418
"differentialPrivacy":{
14011419
"shape":"DifferentialPrivacyConfiguration",
@@ -1736,6 +1754,76 @@
17361754
}
17371755
}
17381756
},
1757+
"BatchGetSchemaAnalysisRuleError":{
1758+
"type":"structure",
1759+
"required":[
1760+
"name",
1761+
"type",
1762+
"code",
1763+
"message"
1764+
],
1765+
"members":{
1766+
"name":{
1767+
"shape":"TableAlias",
1768+
"documentation":"<p>An error name for the error.</p>"
1769+
},
1770+
"type":{
1771+
"shape":"AnalysisRuleType",
1772+
"documentation":"<p>The analysis rule type.</p>"
1773+
},
1774+
"code":{
1775+
"shape":"String",
1776+
"documentation":"<p>An error code for the error.</p>"
1777+
},
1778+
"message":{
1779+
"shape":"String",
1780+
"documentation":"<p>A description of why the call failed.</p>"
1781+
}
1782+
},
1783+
"documentation":"<p>An error that describes why a schema could not be fetched.</p>"
1784+
},
1785+
"BatchGetSchemaAnalysisRuleErrorList":{
1786+
"type":"list",
1787+
"member":{"shape":"BatchGetSchemaAnalysisRuleError"},
1788+
"max":25,
1789+
"min":0
1790+
},
1791+
"BatchGetSchemaAnalysisRuleInput":{
1792+
"type":"structure",
1793+
"required":[
1794+
"collaborationIdentifier",
1795+
"schemaAnalysisRuleRequests"
1796+
],
1797+
"members":{
1798+
"collaborationIdentifier":{
1799+
"shape":"CollaborationIdentifier",
1800+
"documentation":"<p>The unique identifier of the collaboration that contains the schema analysis rule.</p>",
1801+
"location":"uri",
1802+
"locationName":"collaborationIdentifier"
1803+
},
1804+
"schemaAnalysisRuleRequests":{
1805+
"shape":"SchemaAnalysisRuleRequestList",
1806+
"documentation":"<p>The information that's necessary to retrieve a schema analysis rule.</p>"
1807+
}
1808+
}
1809+
},
1810+
"BatchGetSchemaAnalysisRuleOutput":{
1811+
"type":"structure",
1812+
"required":[
1813+
"analysisRules",
1814+
"errors"
1815+
],
1816+
"members":{
1817+
"analysisRules":{
1818+
"shape":"SchemaAnalysisRuleList",
1819+
"documentation":"<p>The retrieved list of analysis rules.</p>"
1820+
},
1821+
"errors":{
1822+
"shape":"BatchGetSchemaAnalysisRuleErrorList",
1823+
"documentation":"<p>Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.</p>"
1824+
}
1825+
}
1826+
},
17391827
"BatchGetSchemaError":{
17401828
"type":"structure",
17411829
"required":[
@@ -1780,7 +1868,7 @@
17801868
},
17811869
"names":{
17821870
"shape":"TableAliasList",
1783-
"documentation":"<p>The names for the schema objects to retrieve.&gt;</p>"
1871+
"documentation":"<p>The names for the schema objects to retrieve.</p>"
17841872
}
17851873
}
17861874
},
@@ -5950,19 +6038,30 @@
59506038
"ScalarFunctions":{
59516039
"type":"string",
59526040
"enum":[
5953-
"TRUNC",
59546041
"ABS",
6042+
"CAST",
59556043
"CEILING",
6044+
"COALESCE",
6045+
"CONVERT",
6046+
"CURRENT_DATE",
6047+
"DATEADD",
6048+
"EXTRACT",
59566049
"FLOOR",
6050+
"GETDATE",
59576051
"LN",
59586052
"LOG",
5959-
"ROUND",
5960-
"SQRT",
5961-
"CAST",
59626053
"LOWER",
6054+
"ROUND",
59636055
"RTRIM",
5964-
"UPPER",
5965-
"COALESCE"
6056+
"SQRT",
6057+
"SUBSTRING",
6058+
"TO_CHAR",
6059+
"TO_DATE",
6060+
"TO_NUMBER",
6061+
"TO_TIMESTAMP",
6062+
"TRIM",
6063+
"TRUNC",
6064+
"UPPER"
59666065
]
59676066
},
59686067
"ScalarFunctionsList":{
@@ -5982,7 +6081,8 @@
59826081
"description",
59836082
"createTime",
59846083
"updateTime",
5985-
"type"
6084+
"type",
6085+
"schemaStatusDetails"
59866086
],
59876087
"members":{
59886088
"columns":{
@@ -6032,16 +6132,123 @@
60326132
"type":{
60336133
"shape":"SchemaType",
60346134
"documentation":"<p>The type of schema. The only valid value is currently `TABLE`.</p>"
6135+
},
6136+
"schemaStatusDetails":{
6137+
"shape":"SchemaStatusDetailList",
6138+
"documentation":"<p>Details about the status of the schema. Currently, only one entry is present.</p>"
60356139
}
60366140
},
60376141
"documentation":"<p>A schema is a relation within a collaboration.</p>"
60386142
},
6143+
"SchemaAnalysisRuleList":{
6144+
"type":"list",
6145+
"member":{"shape":"AnalysisRule"},
6146+
"max":25,
6147+
"min":0
6148+
},
6149+
"SchemaAnalysisRuleRequest":{
6150+
"type":"structure",
6151+
"required":[
6152+
"name",
6153+
"type"
6154+
],
6155+
"members":{
6156+
"name":{
6157+
"shape":"TableAlias",
6158+
"documentation":"<p>The name of the analysis rule schema that you are requesting.</p>"
6159+
},
6160+
"type":{
6161+
"shape":"AnalysisRuleType",
6162+
"documentation":"<p>The type of analysis rule schema that you are requesting.</p>"
6163+
}
6164+
},
6165+
"documentation":"<p>Defines the information that's necessary to retrieve an analysis rule schema. Schema analysis rules are uniquely identified by a combination of the schema name and the analysis rule type for a given collaboration.</p>"
6166+
},
6167+
"SchemaAnalysisRuleRequestList":{
6168+
"type":"list",
6169+
"member":{"shape":"SchemaAnalysisRuleRequest"},
6170+
"max":25,
6171+
"min":1
6172+
},
6173+
"SchemaConfiguration":{
6174+
"type":"string",
6175+
"enum":["DIFFERENTIAL_PRIVACY"]
6176+
},
6177+
"SchemaConfigurationList":{
6178+
"type":"list",
6179+
"member":{"shape":"SchemaConfiguration"}
6180+
},
60396181
"SchemaList":{
60406182
"type":"list",
60416183
"member":{"shape":"Schema"},
60426184
"max":25,
60436185
"min":0
60446186
},
6187+
"SchemaStatus":{
6188+
"type":"string",
6189+
"enum":[
6190+
"READY",
6191+
"NOT_READY"
6192+
]
6193+
},
6194+
"SchemaStatusDetail":{
6195+
"type":"structure",
6196+
"required":["status"],
6197+
"members":{
6198+
"status":{
6199+
"shape":"SchemaStatus",
6200+
"documentation":"<p>The status of the schema.</p>"
6201+
},
6202+
"reasons":{
6203+
"shape":"SchemaStatusReasonList",
6204+
"documentation":"<p>The reasons why the schema status is set to its current state.</p>"
6205+
},
6206+
"analysisRuleType":{
6207+
"shape":"AnalysisRuleType",
6208+
"documentation":"<p>The analysis rule type for which the schema status has been evaluated.</p>"
6209+
},
6210+
"configurations":{
6211+
"shape":"SchemaConfigurationList",
6212+
"documentation":"<p>The configuration details of the schema analysis rule for the given type.</p>"
6213+
}
6214+
},
6215+
"documentation":"<p>Information about the schema status.</p> <p>A status of <code>READY</code> means that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.</p>"
6216+
},
6217+
"SchemaStatusDetailList":{
6218+
"type":"list",
6219+
"member":{"shape":"SchemaStatusDetail"}
6220+
},
6221+
"SchemaStatusReason":{
6222+
"type":"structure",
6223+
"required":[
6224+
"code",
6225+
"message"
6226+
],
6227+
"members":{
6228+
"code":{
6229+
"shape":"SchemaStatusReasonCode",
6230+
"documentation":"<p>The schema status reason code.</p>"
6231+
},
6232+
"message":{
6233+
"shape":"String",
6234+
"documentation":"<p>An explanation of the schema status reason code.</p>"
6235+
}
6236+
},
6237+
"documentation":"<p>A reason why the schema status is set to its current value.</p>"
6238+
},
6239+
"SchemaStatusReasonCode":{
6240+
"type":"string",
6241+
"enum":[
6242+
"ANALYSIS_RULE_MISSING",
6243+
"ANALYSIS_TEMPLATES_NOT_CONFIGURED",
6244+
"ANALYSIS_PROVIDERS_NOT_CONFIGURED",
6245+
"DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED"
6246+
]
6247+
},
6248+
"SchemaStatusReasonList":{
6249+
"type":"list",
6250+
"member":{"shape":"SchemaStatusReason"}
6251+
},
60456252
"SchemaSummary":{
60466253
"type":"structure",
60476254
"required":[

0 commit comments

Comments
 (0)