aws-sdk-qapps 1.8.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1000d62b5207d3f8d4834204630c89019185dcc270ddeb2cca300ef1c791b0ec
4
- data.tar.gz: 5bba16de63a5b9d458ee6ec9723333448405f3b9ce1617b36589eca73014d35c
3
+ metadata.gz: 32f77159ef5eb4be728e31619b1a75aa1f073bcf1186a9a8bcf70ec97f59e8d7
4
+ data.tar.gz: 7303c77852c0b4e0d7522cacfcc9283d930477552ff82938b7badc66ce92fe80
5
5
  SHA512:
6
- metadata.gz: cda6007763b58fd4d9d58843f9f96c74b6b231e1453c4874e3039d78364a25d9d2d74045b5c48e5b3aa06cb630f9a2f2dfd06052694cc7ee261d4fc8b7ae9ea2
7
- data.tar.gz: 183b6289cc99a9f7c8652c1561d21c3475e6d420a257d286b4a0420607e19d15c60dc60b22bc587e075acc9f562fbdedf868deebb7033eaf76a65c3f2b5c9400
6
+ metadata.gz: 9d3b045a893c8c6bfe8cebdc7cb2426a5989caacebd594cd53e8d96c799e285b6ce2c395e908b9ff8e6dc6e78835c107744c682c26132b48cab31383c23ff85a
7
+ data.tar.gz: e7b6875a63184038ee8b3d914902d16a2befe00823fb9eddd154d08b304c0cb3b25badc9654553f8a90046c1b274c0b866203e129b6784130f32587ef6a6af11
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.9.0 (2024-11-06)
5
+ ------------------
6
+
7
+ * Feature - Introduces category apis in AmazonQApps. Web experience users use Categories to tag and filter library items.
8
+
4
9
  1.8.0 (2024-10-18)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.8.0
1
+ 1.9.0
@@ -523,6 +523,164 @@ module Aws::QApps
523
523
  req.send_request(options)
524
524
  end
525
525
 
526
+ # Creates Categories for the Amazon Q Business application environment
527
+ # instance. Web experience users use Categories to tag and filter
528
+ # library items. For more information, see [Custom labels for Amazon Q
529
+ # Apps][1].
530
+ #
531
+ #
532
+ #
533
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html
534
+ #
535
+ # @option params [required, String] :instance_id
536
+ # The unique identifier of the Amazon Q Business application environment
537
+ # instance.
538
+ #
539
+ # @option params [required, Array<Types::BatchCreateCategoryInputCategory>] :categories
540
+ # The list of category objects to be created
541
+ #
542
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
543
+ #
544
+ #
545
+ # @example Example: Creates the categories for the library
546
+ #
547
+ # resp = client.batch_create_category({
548
+ # categories: [
549
+ # {
550
+ # id: "549abfe0-f5c4-45a2-bb9b-c05987a49c6d",
551
+ # title: "HR",
552
+ # },
553
+ # {
554
+ # id: "18cbebaa-196a-4aa5-a840-88d548e07f8f",
555
+ # title: "Marketing",
556
+ # },
557
+ # ],
558
+ # instance_id: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
559
+ # })
560
+ #
561
+ # @example Request syntax with placeholder values
562
+ #
563
+ # resp = client.batch_create_category({
564
+ # instance_id: "InstanceId", # required
565
+ # categories: [ # required
566
+ # {
567
+ # id: "UUID",
568
+ # title: "BatchCreateCategoryInputCategoryTitleString", # required
569
+ # color: "BatchCreateCategoryInputCategoryColorString",
570
+ # },
571
+ # ],
572
+ # })
573
+ #
574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/BatchCreateCategory AWS API Documentation
575
+ #
576
+ # @overload batch_create_category(params = {})
577
+ # @param [Hash] params ({})
578
+ def batch_create_category(params = {}, options = {})
579
+ req = build_request(:batch_create_category, params)
580
+ req.send_request(options)
581
+ end
582
+
583
+ # Deletes Categories for the Amazon Q Business application environment
584
+ # instance. Web experience users use Categories to tag and filter
585
+ # library items. For more information, see [Custom labels for Amazon Q
586
+ # Apps][1].
587
+ #
588
+ #
589
+ #
590
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html
591
+ #
592
+ # @option params [required, String] :instance_id
593
+ # The unique identifier of the Amazon Q Business application environment
594
+ # instance.
595
+ #
596
+ # @option params [required, Array<String>] :categories
597
+ # The list of IDs of the categories to be deleted.
598
+ #
599
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
600
+ #
601
+ #
602
+ # @example Example: Deletes the categories in the library
603
+ #
604
+ # resp = client.batch_delete_category({
605
+ # categories: [
606
+ # "9c871ed4-1c41-4065-aefe-321cd4b61cf8",
607
+ # ],
608
+ # instance_id: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
609
+ # })
610
+ #
611
+ # @example Request syntax with placeholder values
612
+ #
613
+ # resp = client.batch_delete_category({
614
+ # instance_id: "InstanceId", # required
615
+ # categories: ["UUID"], # required
616
+ # })
617
+ #
618
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/BatchDeleteCategory AWS API Documentation
619
+ #
620
+ # @overload batch_delete_category(params = {})
621
+ # @param [Hash] params ({})
622
+ def batch_delete_category(params = {}, options = {})
623
+ req = build_request(:batch_delete_category, params)
624
+ req.send_request(options)
625
+ end
626
+
627
+ # Updates Categories for the Amazon Q Business application environment
628
+ # instance. Web experience users use Categories to tag and filter
629
+ # library items. For more information, see [Custom labels for Amazon Q
630
+ # Apps][1].
631
+ #
632
+ #
633
+ #
634
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html
635
+ #
636
+ # @option params [required, String] :instance_id
637
+ # The unique identifier of the Amazon Q Business application environment
638
+ # instance.
639
+ #
640
+ # @option params [required, Array<Types::CategoryInput>] :categories
641
+ # The list of categories to be updated with their new values.
642
+ #
643
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
644
+ #
645
+ #
646
+ # @example Example: Updates the categories in the library
647
+ #
648
+ # resp = client.batch_update_category({
649
+ # categories: [
650
+ # {
651
+ # id: "549abfe0-f5c4-45a2-bb9b-c05987a49c6d",
652
+ # title: "HR Management",
653
+ # },
654
+ # {
655
+ # id: "18cbebaa-196a-4aa5-a840-88d548e07f8f",
656
+ # title: "Sales",
657
+ # },
658
+ # ],
659
+ # instance_id: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
660
+ # })
661
+ #
662
+ # @example Request syntax with placeholder values
663
+ #
664
+ # resp = client.batch_update_category({
665
+ # instance_id: "InstanceId", # required
666
+ # categories: [ # required
667
+ # {
668
+ # id: "UUID", # required
669
+ # title: "CategoryInputTitleString", # required
670
+ # color: "CategoryInputColorString",
671
+ # },
672
+ # ],
673
+ # })
674
+ #
675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/BatchUpdateCategory AWS API Documentation
676
+ #
677
+ # @overload batch_update_category(params = {})
678
+ # @param [Hash] params ({})
679
+ def batch_update_category(params = {}, options = {})
680
+ req = build_request(:batch_update_category, params)
681
+ req.send_request(options)
682
+ end
683
+
526
684
  # Creates a new library item for an Amazon Q App, allowing it to be
527
685
  # discovered and used by other allowed users.
528
686
  #
@@ -1063,6 +1221,8 @@ module Aws::QApps
1063
1221
  # resp.categories #=> Array
1064
1222
  # resp.categories[0].id #=> String
1065
1223
  # resp.categories[0].title #=> String
1224
+ # resp.categories[0].color #=> String
1225
+ # resp.categories[0].app_count #=> Integer
1066
1226
  # resp.status #=> String
1067
1227
  # resp.created_at #=> Time
1068
1228
  # resp.created_by #=> String
@@ -1297,11 +1457,11 @@ module Aws::QApps
1297
1457
  # card_status: {
1298
1458
  # "1e6caeac-b481-45ff-a082-8b9a4a0b72e8" => {
1299
1459
  # current_state: "COMPLETED",
1300
- # current_value: "Earth's circumference is 24,901 miles",
1460
+ # current_value: "Based on the responses, the most popular color is red, with 1 vote from the user \"user1\".",
1301
1461
  # },
1302
1462
  # "6fb5b404-3b7b-48a4-8a8b-56406922a606" => {
1303
1463
  # current_state: "COMPLETED",
1304
- # current_value: "What is the circumference of Earth?",
1464
+ # current_value: "",
1305
1465
  # },
1306
1466
  # },
1307
1467
  # session_arn: "arn:aws:qapps:us-west-2:0123456789012:application/a929ecd6-5765-4ec7-bd3e-2ca90098b18e/qapp/65e7dce7-226a-47f9-b689-22850becef89/session/1fca878e-64c5-4dc4-b1d9-c93effed4e82",
@@ -1428,6 +1588,70 @@ module Aws::QApps
1428
1588
  req.send_request(options)
1429
1589
  end
1430
1590
 
1591
+ # Lists the categories of a Amazon Q Business application environment
1592
+ # instance. For more information, see [Custom labels for Amazon Q
1593
+ # Apps][1].
1594
+ #
1595
+ #
1596
+ #
1597
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/qapps-custom-labels.html
1598
+ #
1599
+ # @option params [required, String] :instance_id
1600
+ # The unique identifier of the Amazon Q Business application environment
1601
+ # instance.
1602
+ #
1603
+ # @return [Types::ListCategoriesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1604
+ #
1605
+ # * {Types::ListCategoriesOutput#categories #categories} => Array&lt;Types::Category&gt;
1606
+ #
1607
+ #
1608
+ # @example Example: List categories available for the library items in this instance
1609
+ #
1610
+ # resp = client.list_categories({
1611
+ # instance_id: "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
1612
+ # })
1613
+ #
1614
+ # resp.to_h outputs the following:
1615
+ # {
1616
+ # categories: [
1617
+ # {
1618
+ # app_count: 10,
1619
+ # color: "#FF6600",
1620
+ # id: "549abfe0-f5c4-45a2-bb9b-c05987a49c6d",
1621
+ # title: "HR",
1622
+ # },
1623
+ # {
1624
+ # app_count: 11,
1625
+ # color: "#FFFF00",
1626
+ # id: "18cbebaa-196a-4aa5-a840-88d548e07f8f",
1627
+ # title: "Marketing",
1628
+ # },
1629
+ # ],
1630
+ # }
1631
+ #
1632
+ # @example Request syntax with placeholder values
1633
+ #
1634
+ # resp = client.list_categories({
1635
+ # instance_id: "InstanceId", # required
1636
+ # })
1637
+ #
1638
+ # @example Response structure
1639
+ #
1640
+ # resp.categories #=> Array
1641
+ # resp.categories[0].id #=> String
1642
+ # resp.categories[0].title #=> String
1643
+ # resp.categories[0].color #=> String
1644
+ # resp.categories[0].app_count #=> Integer
1645
+ #
1646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ListCategories AWS API Documentation
1647
+ #
1648
+ # @overload list_categories(params = {})
1649
+ # @param [Hash] params ({})
1650
+ def list_categories(params = {}, options = {})
1651
+ req = build_request(:list_categories, params)
1652
+ req.send_request(options)
1653
+ end
1654
+
1431
1655
  # Lists the library items for Amazon Q Apps that are published and
1432
1656
  # available for users in your Amazon Web Services account.
1433
1657
  #
@@ -1548,6 +1772,8 @@ module Aws::QApps
1548
1772
  # resp.library_items[0].categories #=> Array
1549
1773
  # resp.library_items[0].categories[0].id #=> String
1550
1774
  # resp.library_items[0].categories[0].title #=> String
1775
+ # resp.library_items[0].categories[0].color #=> String
1776
+ # resp.library_items[0].categories[0].app_count #=> Integer
1551
1777
  # resp.library_items[0].status #=> String
1552
1778
  # resp.library_items[0].created_at #=> Time
1553
1779
  # resp.library_items[0].created_by #=> String
@@ -2137,6 +2363,8 @@ module Aws::QApps
2137
2363
  # resp.categories #=> Array
2138
2364
  # resp.categories[0].id #=> String
2139
2365
  # resp.categories[0].title #=> String
2366
+ # resp.categories[0].color #=> String
2367
+ # resp.categories[0].app_count #=> Integer
2140
2368
  # resp.status #=> String
2141
2369
  # resp.created_at #=> Time
2142
2370
  # resp.created_by #=> String
@@ -2505,7 +2733,7 @@ module Aws::QApps
2505
2733
  tracer: tracer
2506
2734
  )
2507
2735
  context[:gem_name] = 'aws-sdk-qapps'
2508
- context[:gem_version] = '1.8.0'
2736
+ context[:gem_version] = '1.9.0'
2509
2737
  Seahorse::Client::Request.new(handlers, context)
2510
2738
  end
2511
2739
 
@@ -27,6 +27,13 @@ module Aws::QApps
27
27
  AssociateQAppWithUserInput = Shapes::StructureShape.new(name: 'AssociateQAppWithUserInput')
28
28
  AttributeFilter = Shapes::StructureShape.new(name: 'AttributeFilter')
29
29
  AttributeFilters = Shapes::ListShape.new(name: 'AttributeFilters')
30
+ BatchCreateCategoryInput = Shapes::StructureShape.new(name: 'BatchCreateCategoryInput')
31
+ BatchCreateCategoryInputCategory = Shapes::StructureShape.new(name: 'BatchCreateCategoryInputCategory')
32
+ BatchCreateCategoryInputCategoryColorString = Shapes::StringShape.new(name: 'BatchCreateCategoryInputCategoryColorString')
33
+ BatchCreateCategoryInputCategoryList = Shapes::ListShape.new(name: 'BatchCreateCategoryInputCategoryList')
34
+ BatchCreateCategoryInputCategoryTitleString = Shapes::StringShape.new(name: 'BatchCreateCategoryInputCategoryTitleString')
35
+ BatchDeleteCategoryInput = Shapes::StructureShape.new(name: 'BatchDeleteCategoryInput')
36
+ BatchUpdateCategoryInput = Shapes::StructureShape.new(name: 'BatchUpdateCategoryInput')
30
37
  Boolean = Shapes::BooleanShape.new(name: 'Boolean')
31
38
  Card = Shapes::UnionShape.new(name: 'Card')
32
39
  CardInput = Shapes::UnionShape.new(name: 'CardInput')
@@ -39,9 +46,14 @@ module Aws::QApps
39
46
  CardValue = Shapes::StructureShape.new(name: 'CardValue')
40
47
  CardValueList = Shapes::ListShape.new(name: 'CardValueList')
41
48
  CardValueValueString = Shapes::StringShape.new(name: 'CardValueValueString')
49
+ CategoriesList = Shapes::ListShape.new(name: 'CategoriesList')
42
50
  Category = Shapes::StructureShape.new(name: 'Category')
43
51
  CategoryIdList = Shapes::ListShape.new(name: 'CategoryIdList')
52
+ CategoryInput = Shapes::StructureShape.new(name: 'CategoryInput')
53
+ CategoryInputColorString = Shapes::StringShape.new(name: 'CategoryInputColorString')
54
+ CategoryInputTitleString = Shapes::StringShape.new(name: 'CategoryInputTitleString')
44
55
  CategoryList = Shapes::ListShape.new(name: 'CategoryList')
56
+ CategoryListInput = Shapes::ListShape.new(name: 'CategoryListInput')
45
57
  ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
46
58
  ContentTooLargeException = Shapes::StructureShape.new(name: 'ContentTooLargeException')
47
59
  ConversationMessage = Shapes::StructureShape.new(name: 'ConversationMessage')
@@ -51,6 +63,7 @@ module Aws::QApps
51
63
  CreateQAppInput = Shapes::StructureShape.new(name: 'CreateQAppInput')
52
64
  CreateQAppOutput = Shapes::StructureShape.new(name: 'CreateQAppOutput')
53
65
  Default = Shapes::StringShape.new(name: 'Default')
66
+ DeleteCategoryInputList = Shapes::ListShape.new(name: 'DeleteCategoryInputList')
54
67
  DeleteLibraryItemInput = Shapes::StructureShape.new(name: 'DeleteLibraryItemInput')
55
68
  DeleteQAppInput = Shapes::StructureShape.new(name: 'DeleteQAppInput')
56
69
  DependencyList = Shapes::ListShape.new(name: 'DependencyList')
@@ -82,6 +95,8 @@ module Aws::QApps
82
95
  LibraryItemList = Shapes::ListShape.new(name: 'LibraryItemList')
83
96
  LibraryItemMember = Shapes::StructureShape.new(name: 'LibraryItemMember')
84
97
  LibraryItemStatus = Shapes::StringShape.new(name: 'LibraryItemStatus')
98
+ ListCategoriesInput = Shapes::StructureShape.new(name: 'ListCategoriesInput')
99
+ ListCategoriesOutput = Shapes::StructureShape.new(name: 'ListCategoriesOutput')
85
100
  ListLibraryItemsInput = Shapes::StructureShape.new(name: 'ListLibraryItemsInput')
86
101
  ListLibraryItemsOutput = Shapes::StructureShape.new(name: 'ListLibraryItemsOutput')
87
102
  ListQAppsInput = Shapes::StructureShape.new(name: 'ListQAppsInput')
@@ -177,6 +192,25 @@ module Aws::QApps
177
192
 
178
193
  AttributeFilters.member = Shapes::ShapeRef.new(shape: AttributeFilter)
179
194
 
195
+ BatchCreateCategoryInput.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "header", location_name: "instance-id"))
196
+ BatchCreateCategoryInput.add_member(:categories, Shapes::ShapeRef.new(shape: BatchCreateCategoryInputCategoryList, required: true, location_name: "categories"))
197
+ BatchCreateCategoryInput.struct_class = Types::BatchCreateCategoryInput
198
+
199
+ BatchCreateCategoryInputCategory.add_member(:id, Shapes::ShapeRef.new(shape: UUID, location_name: "id"))
200
+ BatchCreateCategoryInputCategory.add_member(:title, Shapes::ShapeRef.new(shape: BatchCreateCategoryInputCategoryTitleString, required: true, location_name: "title"))
201
+ BatchCreateCategoryInputCategory.add_member(:color, Shapes::ShapeRef.new(shape: BatchCreateCategoryInputCategoryColorString, location_name: "color"))
202
+ BatchCreateCategoryInputCategory.struct_class = Types::BatchCreateCategoryInputCategory
203
+
204
+ BatchCreateCategoryInputCategoryList.member = Shapes::ShapeRef.new(shape: BatchCreateCategoryInputCategory)
205
+
206
+ BatchDeleteCategoryInput.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "header", location_name: "instance-id"))
207
+ BatchDeleteCategoryInput.add_member(:categories, Shapes::ShapeRef.new(shape: DeleteCategoryInputList, required: true, location_name: "categories"))
208
+ BatchDeleteCategoryInput.struct_class = Types::BatchDeleteCategoryInput
209
+
210
+ BatchUpdateCategoryInput.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "header", location_name: "instance-id"))
211
+ BatchUpdateCategoryInput.add_member(:categories, Shapes::ShapeRef.new(shape: CategoryListInput, required: true, location_name: "categories"))
212
+ BatchUpdateCategoryInput.struct_class = Types::BatchUpdateCategoryInput
213
+
180
214
  Card.add_member(:text_input, Shapes::ShapeRef.new(shape: TextInputCard, location_name: "textInput"))
181
215
  Card.add_member(:q_query, Shapes::ShapeRef.new(shape: QQueryCard, location_name: "qQuery"))
182
216
  Card.add_member(:q_plugin, Shapes::ShapeRef.new(shape: QPluginCard, location_name: "qPlugin"))
@@ -218,14 +252,25 @@ module Aws::QApps
218
252
 
219
253
  CardValueList.member = Shapes::ShapeRef.new(shape: CardValue)
220
254
 
255
+ CategoriesList.member = Shapes::ShapeRef.new(shape: Category)
256
+
221
257
  Category.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "id"))
222
258
  Category.add_member(:title, Shapes::ShapeRef.new(shape: String, required: true, location_name: "title"))
259
+ Category.add_member(:color, Shapes::ShapeRef.new(shape: String, location_name: "color"))
260
+ Category.add_member(:app_count, Shapes::ShapeRef.new(shape: Integer, location_name: "appCount"))
223
261
  Category.struct_class = Types::Category
224
262
 
225
263
  CategoryIdList.member = Shapes::ShapeRef.new(shape: UUID)
226
264
 
265
+ CategoryInput.add_member(:id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "id"))
266
+ CategoryInput.add_member(:title, Shapes::ShapeRef.new(shape: CategoryInputTitleString, required: true, location_name: "title"))
267
+ CategoryInput.add_member(:color, Shapes::ShapeRef.new(shape: CategoryInputColorString, location_name: "color"))
268
+ CategoryInput.struct_class = Types::CategoryInput
269
+
227
270
  CategoryList.member = Shapes::ShapeRef.new(shape: Category)
228
271
 
272
+ CategoryListInput.member = Shapes::ShapeRef.new(shape: CategoryInput)
273
+
229
274
  ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message"))
230
275
  ConflictException.add_member(:resource_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "resourceId"))
231
276
  ConflictException.add_member(:resource_type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "resourceType"))
@@ -277,6 +322,8 @@ module Aws::QApps
277
322
  CreateQAppOutput.add_member(:required_capabilities, Shapes::ShapeRef.new(shape: AppRequiredCapabilities, location_name: "requiredCapabilities"))
278
323
  CreateQAppOutput.struct_class = Types::CreateQAppOutput
279
324
 
325
+ DeleteCategoryInputList.member = Shapes::ShapeRef.new(shape: UUID)
326
+
280
327
  DeleteLibraryItemInput.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "header", location_name: "instance-id"))
281
328
  DeleteLibraryItemInput.add_member(:library_item_id, Shapes::ShapeRef.new(shape: UUID, required: true, location_name: "libraryItemId"))
282
329
  DeleteLibraryItemInput.struct_class = Types::DeleteLibraryItemInput
@@ -412,6 +459,12 @@ module Aws::QApps
412
459
  LibraryItemMember.add_member(:is_verified, Shapes::ShapeRef.new(shape: Boolean, location_name: "isVerified"))
413
460
  LibraryItemMember.struct_class = Types::LibraryItemMember
414
461
 
462
+ ListCategoriesInput.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "header", location_name: "instance-id"))
463
+ ListCategoriesInput.struct_class = Types::ListCategoriesInput
464
+
465
+ ListCategoriesOutput.add_member(:categories, Shapes::ShapeRef.new(shape: CategoriesList, location_name: "categories"))
466
+ ListCategoriesOutput.struct_class = Types::ListCategoriesOutput
467
+
415
468
  ListLibraryItemsInput.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location: "header", location_name: "instance-id"))
416
469
  ListLibraryItemsInput.add_member(:limit, Shapes::ShapeRef.new(shape: PageLimit, location: "querystring", location_name: "limit"))
417
470
  ListLibraryItemsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location: "querystring", location_name: "nextToken"))
@@ -685,6 +738,51 @@ module Aws::QApps
685
738
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
686
739
  end)
687
740
 
741
+ api.add_operation(:batch_create_category, Seahorse::Model::Operation.new.tap do |o|
742
+ o.name = "BatchCreateCategory"
743
+ o.http_method = "POST"
744
+ o.http_request_uri = "/catalog.createCategories"
745
+ o.input = Shapes::ShapeRef.new(shape: BatchCreateCategoryInput)
746
+ o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
747
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
748
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
749
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
750
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
751
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
752
+ o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
753
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
754
+ end)
755
+
756
+ api.add_operation(:batch_delete_category, Seahorse::Model::Operation.new.tap do |o|
757
+ o.name = "BatchDeleteCategory"
758
+ o.http_method = "POST"
759
+ o.http_request_uri = "/catalog.deleteCategories"
760
+ o.input = Shapes::ShapeRef.new(shape: BatchDeleteCategoryInput)
761
+ o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
762
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
763
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
764
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
765
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
766
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
767
+ o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
768
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
769
+ end)
770
+
771
+ api.add_operation(:batch_update_category, Seahorse::Model::Operation.new.tap do |o|
772
+ o.name = "BatchUpdateCategory"
773
+ o.http_method = "POST"
774
+ o.http_request_uri = "/catalog.updateCategories"
775
+ o.input = Shapes::ShapeRef.new(shape: BatchUpdateCategoryInput)
776
+ o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
777
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
778
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
779
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
780
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
781
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
782
+ o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
783
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
784
+ end)
785
+
688
786
  api.add_operation(:create_library_item, Seahorse::Model::Operation.new.tap do |o|
689
787
  o.name = "CreateLibraryItem"
690
788
  o.http_method = "POST"
@@ -834,6 +932,20 @@ module Aws::QApps
834
932
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
835
933
  end)
836
934
 
935
+ api.add_operation(:list_categories, Seahorse::Model::Operation.new.tap do |o|
936
+ o.name = "ListCategories"
937
+ o.http_method = "GET"
938
+ o.http_request_uri = "/catalog.listCategories"
939
+ o.input = Shapes::ShapeRef.new(shape: ListCategoriesInput)
940
+ o.output = Shapes::ShapeRef.new(shape: ListCategoriesOutput)
941
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
942
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
943
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
944
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
945
+ o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
946
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
947
+ end)
948
+
837
949
  api.add_operation(:list_library_items, Seahorse::Model::Operation.new.tap do |o|
838
950
  o.name = "ListLibraryItems"
839
951
  o.http_method = "GET"
@@ -208,6 +208,87 @@ module Aws::QApps
208
208
  include Aws::Structure
209
209
  end
210
210
 
211
+ # @!attribute [rw] instance_id
212
+ # The unique identifier of the Amazon Q Business application
213
+ # environment instance.
214
+ # @return [String]
215
+ #
216
+ # @!attribute [rw] categories
217
+ # The list of category objects to be created
218
+ # @return [Array<Types::BatchCreateCategoryInputCategory>]
219
+ #
220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/BatchCreateCategoryInput AWS API Documentation
221
+ #
222
+ class BatchCreateCategoryInput < Struct.new(
223
+ :instance_id,
224
+ :categories)
225
+ SENSITIVE = []
226
+ include Aws::Structure
227
+ end
228
+
229
+ # The category object to be created.
230
+ #
231
+ # @!attribute [rw] id
232
+ # The unique identifier to be associated with a category. If you
233
+ # don't include a value, the category is automatically assigned a
234
+ # unique identifier.
235
+ # @return [String]
236
+ #
237
+ # @!attribute [rw] title
238
+ # The name of the category.
239
+ # @return [String]
240
+ #
241
+ # @!attribute [rw] color
242
+ # The color to be associated with a category. The color must be a
243
+ # hexadecimal value of either 3 or 6 digits.
244
+ # @return [String]
245
+ #
246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/BatchCreateCategoryInputCategory AWS API Documentation
247
+ #
248
+ class BatchCreateCategoryInputCategory < Struct.new(
249
+ :id,
250
+ :title,
251
+ :color)
252
+ SENSITIVE = []
253
+ include Aws::Structure
254
+ end
255
+
256
+ # @!attribute [rw] instance_id
257
+ # The unique identifier of the Amazon Q Business application
258
+ # environment instance.
259
+ # @return [String]
260
+ #
261
+ # @!attribute [rw] categories
262
+ # The list of IDs of the categories to be deleted.
263
+ # @return [Array<String>]
264
+ #
265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/BatchDeleteCategoryInput AWS API Documentation
266
+ #
267
+ class BatchDeleteCategoryInput < Struct.new(
268
+ :instance_id,
269
+ :categories)
270
+ SENSITIVE = []
271
+ include Aws::Structure
272
+ end
273
+
274
+ # @!attribute [rw] instance_id
275
+ # The unique identifier of the Amazon Q Business application
276
+ # environment instance.
277
+ # @return [String]
278
+ #
279
+ # @!attribute [rw] categories
280
+ # The list of categories to be updated with their new values.
281
+ # @return [Array<Types::CategoryInput>]
282
+ #
283
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/BatchUpdateCategoryInput AWS API Documentation
284
+ #
285
+ class BatchUpdateCategoryInput < Struct.new(
286
+ :instance_id,
287
+ :categories)
288
+ SENSITIVE = []
289
+ include Aws::Structure
290
+ end
291
+
211
292
  # A card representing a component or step in an Amazon Q App's flow.
212
293
  #
213
294
  # @note Card is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Card corresponding to the set member.
@@ -338,11 +419,47 @@ module Aws::QApps
338
419
  # The title or name of the category.
339
420
  # @return [String]
340
421
  #
422
+ # @!attribute [rw] color
423
+ # The color of the category
424
+ # @return [String]
425
+ #
426
+ # @!attribute [rw] app_count
427
+ # The number of published Amazon Q Apps associated with a category
428
+ # @return [Integer]
429
+ #
341
430
  # @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/Category AWS API Documentation
342
431
  #
343
432
  class Category < Struct.new(
344
433
  :id,
345
- :title)
434
+ :title,
435
+ :color,
436
+ :app_count)
437
+ SENSITIVE = []
438
+ include Aws::Structure
439
+ end
440
+
441
+ # A label that web experience users associate with a library item. Web
442
+ # experience users use Categories to tag and filter library items.
443
+ #
444
+ # @!attribute [rw] id
445
+ # The unique identifier of the category.
446
+ # @return [String]
447
+ #
448
+ # @!attribute [rw] title
449
+ # The name of the category.
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] color
453
+ # The color of the category, represented as a hexadecimal value of
454
+ # either 3 or 6 digits.
455
+ # @return [String]
456
+ #
457
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/CategoryInput AWS API Documentation
458
+ #
459
+ class CategoryInput < Struct.new(
460
+ :id,
461
+ :title,
462
+ :color)
346
463
  SENSITIVE = []
347
464
  include Aws::Structure
348
465
  end
@@ -1202,6 +1319,32 @@ module Aws::QApps
1202
1319
  include Aws::Structure
1203
1320
  end
1204
1321
 
1322
+ # @!attribute [rw] instance_id
1323
+ # The unique identifier of the Amazon Q Business application
1324
+ # environment instance.
1325
+ # @return [String]
1326
+ #
1327
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ListCategoriesInput AWS API Documentation
1328
+ #
1329
+ class ListCategoriesInput < Struct.new(
1330
+ :instance_id)
1331
+ SENSITIVE = []
1332
+ include Aws::Structure
1333
+ end
1334
+
1335
+ # @!attribute [rw] categories
1336
+ # The categories of a Amazon Q Business application environment
1337
+ # instance.
1338
+ # @return [Array<Types::Category>]
1339
+ #
1340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ListCategoriesOutput AWS API Documentation
1341
+ #
1342
+ class ListCategoriesOutput < Struct.new(
1343
+ :categories)
1344
+ SENSITIVE = []
1345
+ include Aws::Structure
1346
+ end
1347
+
1205
1348
  # @!attribute [rw] instance_id
1206
1349
  # The unique identifier of the Amazon Q Business application
1207
1350
  # environment instance.
data/lib/aws-sdk-qapps.rb CHANGED
@@ -55,7 +55,7 @@ module Aws::QApps
55
55
  autoload :EndpointProvider, 'aws-sdk-qapps/endpoint_provider'
56
56
  autoload :Endpoints, 'aws-sdk-qapps/endpoints'
57
57
 
58
- GEM_VERSION = '1.8.0'
58
+ GEM_VERSION = '1.9.0'
59
59
 
60
60
  end
61
61
 
data/sig/client.rbs CHANGED
@@ -89,6 +89,39 @@ module Aws
89
89
  ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
90
90
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
91
91
 
92
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#batch_create_category-instance_method
93
+ def batch_create_category: (
94
+ instance_id: ::String,
95
+ categories: Array[
96
+ {
97
+ id: ::String?,
98
+ title: ::String,
99
+ color: ::String?
100
+ },
101
+ ]
102
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
103
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
104
+
105
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#batch_delete_category-instance_method
106
+ def batch_delete_category: (
107
+ instance_id: ::String,
108
+ categories: Array[::String]
109
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
110
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
111
+
112
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#batch_update_category-instance_method
113
+ def batch_update_category: (
114
+ instance_id: ::String,
115
+ categories: Array[
116
+ {
117
+ id: ::String,
118
+ title: ::String,
119
+ color: ::String?
120
+ },
121
+ ]
122
+ ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
123
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
124
+
92
125
  interface _CreateLibraryItemResponseSuccess
93
126
  include ::Seahorse::Client::_ResponseSuccess[Types::CreateLibraryItemOutput]
94
127
  def library_item_id: () -> ::String
@@ -346,6 +379,16 @@ module Aws
346
379
  ) -> _ImportDocumentResponseSuccess
347
380
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ImportDocumentResponseSuccess
348
381
 
382
+ interface _ListCategoriesResponseSuccess
383
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListCategoriesOutput]
384
+ def categories: () -> ::Array[Types::Category]
385
+ end
386
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QApps/Client.html#list_categories-instance_method
387
+ def list_categories: (
388
+ instance_id: ::String
389
+ ) -> _ListCategoriesResponseSuccess
390
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCategoriesResponseSuccess
391
+
349
392
  interface _ListLibraryItemsResponseSuccess
350
393
  include ::Seahorse::Client::_ResponseSuccess[Types::ListLibraryItemsOutput]
351
394
  def library_items: () -> ::Array[Types::LibraryItemMember]
data/sig/types.rbs CHANGED
@@ -52,6 +52,31 @@ module Aws::QApps
52
52
  SENSITIVE: []
53
53
  end
54
54
 
55
+ class BatchCreateCategoryInput
56
+ attr_accessor instance_id: ::String
57
+ attr_accessor categories: ::Array[Types::BatchCreateCategoryInputCategory]
58
+ SENSITIVE: []
59
+ end
60
+
61
+ class BatchCreateCategoryInputCategory
62
+ attr_accessor id: ::String
63
+ attr_accessor title: ::String
64
+ attr_accessor color: ::String
65
+ SENSITIVE: []
66
+ end
67
+
68
+ class BatchDeleteCategoryInput
69
+ attr_accessor instance_id: ::String
70
+ attr_accessor categories: ::Array[::String]
71
+ SENSITIVE: []
72
+ end
73
+
74
+ class BatchUpdateCategoryInput
75
+ attr_accessor instance_id: ::String
76
+ attr_accessor categories: ::Array[Types::CategoryInput]
77
+ SENSITIVE: []
78
+ end
79
+
55
80
  class Card
56
81
  attr_accessor text_input: Types::TextInputCard
57
82
  attr_accessor q_query: Types::QQueryCard
@@ -107,6 +132,15 @@ module Aws::QApps
107
132
  class Category
108
133
  attr_accessor id: ::String
109
134
  attr_accessor title: ::String
135
+ attr_accessor color: ::String
136
+ attr_accessor app_count: ::Integer
137
+ SENSITIVE: []
138
+ end
139
+
140
+ class CategoryInput
141
+ attr_accessor id: ::String
142
+ attr_accessor title: ::String
143
+ attr_accessor color: ::String
110
144
  SENSITIVE: []
111
145
  end
112
146
 
@@ -346,6 +380,16 @@ module Aws::QApps
346
380
  SENSITIVE: []
347
381
  end
348
382
 
383
+ class ListCategoriesInput
384
+ attr_accessor instance_id: ::String
385
+ SENSITIVE: []
386
+ end
387
+
388
+ class ListCategoriesOutput
389
+ attr_accessor categories: ::Array[Types::Category]
390
+ SENSITIVE: []
391
+ end
392
+
349
393
  class ListLibraryItemsInput
350
394
  attr_accessor instance_id: ::String
351
395
  attr_accessor limit: ::Integer
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-qapps
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.8.0
4
+ version: 1.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-10-18 00:00:00.000000000 Z
11
+ date: 2024-11-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core