Skip to content

Commit b0b230f

Browse files
author
AWS
committed
QApps Update: Adds UpdateLibraryItemMetadata api to change status of app for admin verification feature and returns isVerified field in any api returning the app or library item.
1 parent 82046bf commit b0b230f

File tree

2 files changed

+76
-3
lines changed

2 files changed

+76
-3
lines changed
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": "Adds UpdateLibraryItemMetadata api to change status of app for admin verification feature and returns isVerified field in any api returning the app or library item."
6+
}

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

Lines changed: 70 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
"errors":[
2525
{"shape":"ResourceNotFoundException"},
2626
{"shape":"AccessDeniedException"},
27+
{"shape":"ConflictException"},
2728
{"shape":"ValidationException"},
2829
{"shape":"InternalServerException"},
2930
{"shape":"UnauthorizedException"},
@@ -142,6 +143,7 @@
142143
"errors":[
143144
{"shape":"ResourceNotFoundException"},
144145
{"shape":"AccessDeniedException"},
146+
{"shape":"ConflictException"},
145147
{"shape":"ValidationException"},
146148
{"shape":"InternalServerException"},
147149
{"shape":"UnauthorizedException"},
@@ -410,12 +412,33 @@
410412
"errors":[
411413
{"shape":"ResourceNotFoundException"},
412414
{"shape":"AccessDeniedException"},
415+
{"shape":"ConflictException"},
413416
{"shape":"ValidationException"},
414417
{"shape":"InternalServerException"},
415418
{"shape":"UnauthorizedException"},
416419
{"shape":"ThrottlingException"}
417420
],
418-
"documentation":"<p>Updates the metadata and status of a library item for an Amazon Q App.</p>"
421+
"documentation":"<p>Updates the library item for an Amazon Q App.</p>"
422+
},
423+
"UpdateLibraryItemMetadata":{
424+
"name":"UpdateLibraryItemMetadata",
425+
"http":{
426+
"method":"POST",
427+
"requestUri":"/catalog.updateItemMetadata",
428+
"responseCode":200
429+
},
430+
"input":{"shape":"UpdateLibraryItemMetadataInput"},
431+
"errors":[
432+
{"shape":"ResourceNotFoundException"},
433+
{"shape":"AccessDeniedException"},
434+
{"shape":"ConflictException"},
435+
{"shape":"ValidationException"},
436+
{"shape":"InternalServerException"},
437+
{"shape":"UnauthorizedException"},
438+
{"shape":"ThrottlingException"}
439+
],
440+
"documentation":"<p>Updates the verification status of a library item for an Amazon Q App.</p>",
441+
"idempotent":true
419442
},
420443
"UpdateQApp":{
421444
"name":"UpdateQApp",
@@ -929,6 +952,10 @@
929952
"ratingCount":{
930953
"shape":"Integer",
931954
"documentation":"<p>The number of ratings the library item has received from users.</p>"
955+
},
956+
"isVerified":{
957+
"shape":"Boolean",
958+
"documentation":"<p>Indicates whether the library item has been verified.</p>"
932959
}
933960
}
934961
},
@@ -1356,6 +1383,10 @@
13561383
"userCount":{
13571384
"shape":"Integer",
13581385
"documentation":"<p>The number of users who have associated the Q App with their account.</p>"
1386+
},
1387+
"isVerified":{
1388+
"shape":"Boolean",
1389+
"documentation":"<p>Indicates whether the library item has been verified.</p>"
13591390
}
13601391
}
13611392
},
@@ -1641,6 +1672,10 @@
16411672
"userCount":{
16421673
"shape":"Integer",
16431674
"documentation":"<p>The number of users who have the associated Q App.</p>"
1675+
},
1676+
"isVerified":{
1677+
"shape":"Boolean",
1678+
"documentation":"<p>Indicates whether the library item has been verified.</p>"
16441679
}
16451680
},
16461681
"documentation":"<p>A library item is a snapshot of an Amazon Q App that can be published so the users in their Amazon Q Apps library can discover it, clone it, and run it.</p>"
@@ -2327,7 +2362,8 @@
23272362
"Title":{
23282363
"type":"string",
23292364
"max":100,
2330-
"min":0
2365+
"min":0,
2366+
"pattern":"[^{}\\\\\"<>]+"
23312367
},
23322368
"UUID":{
23332369
"type":"string",
@@ -2399,6 +2435,29 @@
23992435
}
24002436
}
24012437
},
2438+
"UpdateLibraryItemMetadataInput":{
2439+
"type":"structure",
2440+
"required":[
2441+
"instanceId",
2442+
"libraryItemId"
2443+
],
2444+
"members":{
2445+
"instanceId":{
2446+
"shape":"InstanceId",
2447+
"documentation":"<p>The unique identifier of the Amazon Q Business application environment instance.</p>",
2448+
"location":"header",
2449+
"locationName":"instance-id"
2450+
},
2451+
"libraryItemId":{
2452+
"shape":"UUID",
2453+
"documentation":"<p>The unique identifier of the updated library item.</p>"
2454+
},
2455+
"isVerified":{
2456+
"shape":"Boolean",
2457+
"documentation":"<p>The verification status of the library item</p>"
2458+
}
2459+
}
2460+
},
24022461
"UpdateLibraryItemOutput":{
24032462
"type":"structure",
24042463
"required":[
@@ -2459,6 +2518,10 @@
24592518
"userCount":{
24602519
"shape":"Integer",
24612520
"documentation":"<p>The number of users who have the associated Q App.</p>"
2521+
},
2522+
"isVerified":{
2523+
"shape":"Boolean",
2524+
"documentation":"<p>Indicates whether the library item has been verified.</p>"
24622525
}
24632526
}
24642527
},
@@ -2633,6 +2696,10 @@
26332696
"status":{
26342697
"shape":"String",
26352698
"documentation":"<p>The status of the user's association with the Q App.</p>"
2699+
},
2700+
"isVerified":{
2701+
"shape":"Boolean",
2702+
"documentation":"<p>Indicates whether the Q App has been verified.</p>"
26362703
}
26372704
},
26382705
"documentation":"<p>An Amazon Q App associated with a user, either owned by the user or favorited.</p>"
@@ -2655,5 +2722,5 @@
26552722
"exception":true
26562723
}
26572724
},
2658-
"documentation":"<p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create an Q Appthat exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for marketing content-generation like writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/purpose-built-qapps.html\">Amazon Q App</a> in the <i>Amazon Q Business User Guide</i>. </p>"
2725+
"documentation":"<p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create a Q App that exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information on the capabilities, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html#q-apps-actions\">Amazon Q Apps capabilities</a> in the <i>Amazon Q Business User Guide</i>. </p> <p>For an overview of the Amazon Q App APIs, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Operations_QApps.html\">Overview of Amazon Q Apps API operations</a>.</p> <p>For information about the IAM access control permissions you need to use the Amazon Q Apps API, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html\"> IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in the <i>Amazon Q Business User Guide</i>.</p>"
26592726
}

0 commit comments

Comments
 (0)