Skip to content

Commit da2c182

Browse files
author
AWS
committed
QApps Update: Introduces category apis in AmazonQApps. Web experience users use Categories to tag and filter library items.
1 parent 81ff312 commit da2c182

File tree

2 files changed

+258
-1
lines changed

2 files changed

+258
-1
lines changed

‎.changes/next-release/feature-QApps-52ebac4.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": "QApps",
4+
"contributor": "",
5+
"description": "Introduces category apis in AmazonQApps. Web experience users use Categories to tag and filter library items."
6+
}

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

Lines changed: 252 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,63 @@
5252
],
5353
"documentation":"<p>This operation creates a link between the user's identity calling the operation and a specific Q App. This is useful to mark the Q App as a <i>favorite</i> for the user if the user doesn't own the Amazon Q App so they can still run it and see it in their inventory of Q Apps.</p>"
5454
},
55+
"BatchCreateCategory":{
56+
"name":"BatchCreateCategory",
57+
"http":{
58+
"method":"POST",
59+
"requestUri":"/catalog.createCategories",
60+
"responseCode":200
61+
},
62+
"input":{"shape":"BatchCreateCategoryInput"},
63+
"errors":[
64+
{"shape":"ResourceNotFoundException"},
65+
{"shape":"AccessDeniedException"},
66+
{"shape":"ConflictException"},
67+
{"shape":"ValidationException"},
68+
{"shape":"InternalServerException"},
69+
{"shape":"UnauthorizedException"},
70+
{"shape":"ThrottlingException"}
71+
],
72+
"documentation":"<p>Creates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html\">Custom labels for Amazon Q Apps</a>.</p>"
73+
},
74+
"BatchDeleteCategory":{
75+
"name":"BatchDeleteCategory",
76+
"http":{
77+
"method":"POST",
78+
"requestUri":"/catalog.deleteCategories",
79+
"responseCode":200
80+
},
81+
"input":{"shape":"BatchDeleteCategoryInput"},
82+
"errors":[
83+
{"shape":"ResourceNotFoundException"},
84+
{"shape":"AccessDeniedException"},
85+
{"shape":"ConflictException"},
86+
{"shape":"ValidationException"},
87+
{"shape":"InternalServerException"},
88+
{"shape":"UnauthorizedException"},
89+
{"shape":"ThrottlingException"}
90+
],
91+
"documentation":"<p>Deletes Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html\">Custom labels for Amazon Q Apps</a>.</p>"
92+
},
93+
"BatchUpdateCategory":{
94+
"name":"BatchUpdateCategory",
95+
"http":{
96+
"method":"POST",
97+
"requestUri":"/catalog.updateCategories",
98+
"responseCode":200
99+
},
100+
"input":{"shape":"BatchUpdateCategoryInput"},
101+
"errors":[
102+
{"shape":"ResourceNotFoundException"},
103+
{"shape":"AccessDeniedException"},
104+
{"shape":"ConflictException"},
105+
{"shape":"ValidationException"},
106+
{"shape":"InternalServerException"},
107+
{"shape":"UnauthorizedException"},
108+
{"shape":"ThrottlingException"}
109+
],
110+
"documentation":"<p>Updates Categories for the Amazon Q Business application environment instance. Web experience users use Categories to tag and filter library items. For more information, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html\">Custom labels for Amazon Q Apps</a>.</p>"
111+
},
55112
"CreateLibraryItem":{
56113
"name":"CreateLibraryItem",
57114
"http":{
@@ -249,6 +306,25 @@
249306
],
250307
"documentation":"<p>Uploads a file that can then be used either as a default in a <code>FileUploadCard</code> from Q App definition or as a file that is used inside a single Q App run. The purpose of the document is determined by a scope parameter that indicates whether it is at the app definition level or at the app session level.</p>"
251308
},
309+
"ListCategories":{
310+
"name":"ListCategories",
311+
"http":{
312+
"method":"GET",
313+
"requestUri":"/catalog.listCategories",
314+
"responseCode":200
315+
},
316+
"input":{"shape":"ListCategoriesInput"},
317+
"output":{"shape":"ListCategoriesOutput"},
318+
"errors":[
319+
{"shape":"ResourceNotFoundException"},
320+
{"shape":"AccessDeniedException"},
321+
{"shape":"ValidationException"},
322+
{"shape":"InternalServerException"},
323+
{"shape":"UnauthorizedException"},
324+
{"shape":"ThrottlingException"}
325+
],
326+
"documentation":"<p>Lists the categories of a Amazon Q Business application environment instance. For more information, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html\">Custom labels for Amazon Q Apps</a>.</p>"
327+
},
252328
"ListLibraryItems":{
253329
"name":"ListLibraryItems",
254330
"http":{
@@ -653,6 +729,100 @@
653729
"type":"list",
654730
"member":{"shape":"AttributeFilter"}
655731
},
732+
"BatchCreateCategoryInput":{
733+
"type":"structure",
734+
"required":[
735+
"instanceId",
736+
"categories"
737+
],
738+
"members":{
739+
"instanceId":{
740+
"shape":"InstanceId",
741+
"documentation":"<p>The unique identifier of the Amazon Q Business application environment instance.</p>",
742+
"location":"header",
743+
"locationName":"instance-id"
744+
},
745+
"categories":{
746+
"shape":"BatchCreateCategoryInputCategoryList",
747+
"documentation":"<p>The list of category objects to be created</p>"
748+
}
749+
}
750+
},
751+
"BatchCreateCategoryInputCategory":{
752+
"type":"structure",
753+
"required":["title"],
754+
"members":{
755+
"id":{
756+
"shape":"UUID",
757+
"documentation":"<p>The unique identifier to be associated with a category. If you don't include a value, the category is automatically assigned a unique identifier.</p>"
758+
},
759+
"title":{
760+
"shape":"BatchCreateCategoryInputCategoryTitleString",
761+
"documentation":"<p>The name of the category.</p>"
762+
},
763+
"color":{
764+
"shape":"BatchCreateCategoryInputCategoryColorString",
765+
"documentation":"<p>The color to be associated with a category. The color must be a hexadecimal value of either 3 or 6 digits.</p>"
766+
}
767+
},
768+
"documentation":"<p>The category object to be created.</p>"
769+
},
770+
"BatchCreateCategoryInputCategoryColorString":{
771+
"type":"string",
772+
"max":7,
773+
"min":4,
774+
"pattern":"#([A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})"
775+
},
776+
"BatchCreateCategoryInputCategoryList":{
777+
"type":"list",
778+
"member":{"shape":"BatchCreateCategoryInputCategory"},
779+
"max":10,
780+
"min":0
781+
},
782+
"BatchCreateCategoryInputCategoryTitleString":{
783+
"type":"string",
784+
"max":30,
785+
"min":1,
786+
"pattern":"[a-zA-Z0-9_]+( [a-zA-Z0-9_]+)*"
787+
},
788+
"BatchDeleteCategoryInput":{
789+
"type":"structure",
790+
"required":[
791+
"instanceId",
792+
"categories"
793+
],
794+
"members":{
795+
"instanceId":{
796+
"shape":"InstanceId",
797+
"documentation":"<p>The unique identifier of the Amazon Q Business application environment instance.</p>",
798+
"location":"header",
799+
"locationName":"instance-id"
800+
},
801+
"categories":{
802+
"shape":"DeleteCategoryInputList",
803+
"documentation":"<p>The list of IDs of the categories to be deleted.</p>"
804+
}
805+
}
806+
},
807+
"BatchUpdateCategoryInput":{
808+
"type":"structure",
809+
"required":[
810+
"instanceId",
811+
"categories"
812+
],
813+
"members":{
814+
"instanceId":{
815+
"shape":"InstanceId",
816+
"documentation":"<p>The unique identifier of the Amazon Q Business application environment instance.</p>",
817+
"location":"header",
818+
"locationName":"instance-id"
819+
},
820+
"categories":{
821+
"shape":"CategoryListInput",
822+
"documentation":"<p>The list of categories to be updated with their new values.</p>"
823+
}
824+
}
825+
},
656826
"Boolean":{
657827
"type":"boolean",
658828
"box":true
@@ -783,6 +953,12 @@
783953
"max":5000,
784954
"min":0
785955
},
956+
"CategoriesList":{
957+
"type":"list",
958+
"member":{"shape":"Category"},
959+
"max":10,
960+
"min":0
961+
},
786962
"Category":{
787963
"type":"structure",
788964
"required":[
@@ -797,6 +973,14 @@
797973
"title":{
798974
"shape":"String",
799975
"documentation":"<p>The title or name of the category.</p>"
976+
},
977+
"color":{
978+
"shape":"String",
979+
"documentation":"<p>The color of the category</p>"
980+
},
981+
"appCount":{
982+
"shape":"Integer",
983+
"documentation":"<p>The number of published Amazon Q Apps associated with a category</p>"
800984
}
801985
},
802986
"documentation":"<p>A category used to classify and filter library items for Amazon Q Apps.</p>"
@@ -807,12 +991,52 @@
807991
"max":3,
808992
"min":0
809993
},
994+
"CategoryInput":{
995+
"type":"structure",
996+
"required":[
997+
"id",
998+
"title"
999+
],
1000+
"members":{
1001+
"id":{
1002+
"shape":"UUID",
1003+
"documentation":"<p>The unique identifier of the category.</p>"
1004+
},
1005+
"title":{
1006+
"shape":"CategoryInputTitleString",
1007+
"documentation":"<p>The name of the category.</p>"
1008+
},
1009+
"color":{
1010+
"shape":"CategoryInputColorString",
1011+
"documentation":"<p>The color of the category, represented as a hexadecimal value of either 3 or 6 digits.</p>"
1012+
}
1013+
},
1014+
"documentation":"<p>A label that web experience users associate with a library item. Web experience users use Categories to tag and filter library items.</p>"
1015+
},
1016+
"CategoryInputColorString":{
1017+
"type":"string",
1018+
"max":7,
1019+
"min":4,
1020+
"pattern":"#([A-Fa-f0-9]{3}|[A-Fa-f0-9]{6})"
1021+
},
1022+
"CategoryInputTitleString":{
1023+
"type":"string",
1024+
"max":30,
1025+
"min":1,
1026+
"pattern":"[a-zA-Z0-9_]+( [a-zA-Z0-9_]+)*"
1027+
},
8101028
"CategoryList":{
8111029
"type":"list",
8121030
"member":{"shape":"Category"},
8131031
"max":3,
8141032
"min":0
8151033
},
1034+
"CategoryListInput":{
1035+
"type":"list",
1036+
"member":{"shape":"CategoryInput"},
1037+
"max":10,
1038+
"min":0
1039+
},
8161040
"ConflictException":{
8171041
"type":"structure",
8181042
"required":[
@@ -1060,6 +1284,12 @@
10601284
"max":500,
10611285
"min":0
10621286
},
1287+
"DeleteCategoryInputList":{
1288+
"type":"list",
1289+
"member":{"shape":"UUID"},
1290+
"max":10,
1291+
"min":0
1292+
},
10631293
"DeleteLibraryItemInput":{
10641294
"type":"structure",
10651295
"required":[
@@ -1687,6 +1917,27 @@
16871917
"DISABLED"
16881918
]
16891919
},
1920+
"ListCategoriesInput":{
1921+
"type":"structure",
1922+
"required":["instanceId"],
1923+
"members":{
1924+
"instanceId":{
1925+
"shape":"InstanceId",
1926+
"documentation":"<p>The unique identifier of the Amazon Q Business application environment instance.</p>",
1927+
"location":"header",
1928+
"locationName":"instance-id"
1929+
}
1930+
}
1931+
},
1932+
"ListCategoriesOutput":{
1933+
"type":"structure",
1934+
"members":{
1935+
"categories":{
1936+
"shape":"CategoriesList",
1937+
"documentation":"<p>The categories of a Amazon Q Business application environment instance.</p>"
1938+
}
1939+
}
1940+
},
16901941
"ListLibraryItemsInput":{
16911942
"type":"structure",
16921943
"required":["instanceId"],
@@ -2367,7 +2618,7 @@
23672618
},
23682619
"UUID":{
23692620
"type":"string",
2370-
"pattern":"[\\da-f]{8}-[\\da-f]{4}-4[\\da-f]{3}-[89ABab][\\da-f]{3}-[\\da-f]{12}"
2621+
"pattern":"[\\da-f]{8}-[\\da-f]{4}-[45][\\da-f]{3}-[89ABab][\\da-f]{3}-[\\da-f]{12}"
23712622
},
23722623
"UnauthorizedException":{
23732624
"type":"structure",

0 commit comments

Comments
 (0)