aws-sdk-qapps 1.9.0 → 1.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qapps/client.rb +619 -46
- data/lib/aws-sdk-qapps/client_api.rb +310 -0
- data/lib/aws-sdk-qapps/types.rb +714 -10
- data/lib/aws-sdk-qapps.rb +1 -1
- data/sig/client.rbs +165 -12
- data/sig/types.rbs +207 -10
- metadata +2 -2
data/lib/aws-sdk-qapps/types.rb
CHANGED
@@ -309,6 +309,10 @@ module Aws::QApps
|
|
309
309
|
# A container for the properties of the file upload card.
|
310
310
|
# @return [Types::FileUploadCard]
|
311
311
|
#
|
312
|
+
# @!attribute [rw] form_input
|
313
|
+
# A container for the properties of the form input card.
|
314
|
+
# @return [Types::FormInputCard]
|
315
|
+
#
|
312
316
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/Card AWS API Documentation
|
313
317
|
#
|
314
318
|
class Card < Struct.new(
|
@@ -316,6 +320,7 @@ module Aws::QApps
|
|
316
320
|
:q_query,
|
317
321
|
:q_plugin,
|
318
322
|
:file_upload,
|
323
|
+
:form_input,
|
319
324
|
:unknown)
|
320
325
|
SENSITIVE = []
|
321
326
|
include Aws::Structure
|
@@ -325,6 +330,7 @@ module Aws::QApps
|
|
325
330
|
class QQuery < Card; end
|
326
331
|
class QPlugin < Card; end
|
327
332
|
class FileUpload < Card; end
|
333
|
+
class FormInput < Card; end
|
328
334
|
class Unknown < Card; end
|
329
335
|
end
|
330
336
|
|
@@ -350,6 +356,10 @@ module Aws::QApps
|
|
350
356
|
# A container for the properties of the file upload input card.
|
351
357
|
# @return [Types::FileUploadCardInput]
|
352
358
|
#
|
359
|
+
# @!attribute [rw] form_input
|
360
|
+
# A container for the properties of the form input card.
|
361
|
+
# @return [Types::FormInputCardInput]
|
362
|
+
#
|
353
363
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/CardInput AWS API Documentation
|
354
364
|
#
|
355
365
|
class CardInput < Struct.new(
|
@@ -357,6 +367,7 @@ module Aws::QApps
|
|
357
367
|
:q_query,
|
358
368
|
:q_plugin,
|
359
369
|
:file_upload,
|
370
|
+
:form_input,
|
360
371
|
:unknown)
|
361
372
|
SENSITIVE = []
|
362
373
|
include Aws::Structure
|
@@ -366,6 +377,7 @@ module Aws::QApps
|
|
366
377
|
class QQuery < CardInput; end
|
367
378
|
class QPlugin < CardInput; end
|
368
379
|
class FileUpload < CardInput; end
|
380
|
+
class FormInput < CardInput; end
|
369
381
|
class Unknown < CardInput; end
|
370
382
|
end
|
371
383
|
|
@@ -380,11 +392,16 @@ module Aws::QApps
|
|
380
392
|
# The current value or result associated with the card.
|
381
393
|
# @return [String]
|
382
394
|
#
|
395
|
+
# @!attribute [rw] submissions
|
396
|
+
# A list of previous submissions, if the card is a form card.
|
397
|
+
# @return [Array<Types::Submission>]
|
398
|
+
#
|
383
399
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/CardStatus AWS API Documentation
|
384
400
|
#
|
385
401
|
class CardStatus < Struct.new(
|
386
402
|
:current_state,
|
387
|
-
:current_value
|
403
|
+
:current_value,
|
404
|
+
:submissions)
|
388
405
|
SENSITIVE = []
|
389
406
|
include Aws::Structure
|
390
407
|
end
|
@@ -399,11 +416,18 @@ module Aws::QApps
|
|
399
416
|
# The value or result associated with the card.
|
400
417
|
# @return [String]
|
401
418
|
#
|
419
|
+
# @!attribute [rw] submission_mutation
|
420
|
+
# The structure that describes how the current form card value is
|
421
|
+
# mutated. Only applies for form cards when multiple responses are
|
422
|
+
# allowed.
|
423
|
+
# @return [Types::SubmissionMutation]
|
424
|
+
#
|
402
425
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/CardValue AWS API Documentation
|
403
426
|
#
|
404
427
|
class CardValue < Struct.new(
|
405
428
|
:card_id,
|
406
|
-
:value
|
429
|
+
:value,
|
430
|
+
:submission_mutation)
|
407
431
|
SENSITIVE = []
|
408
432
|
include Aws::Structure
|
409
433
|
end
|
@@ -608,6 +632,81 @@ module Aws::QApps
|
|
608
632
|
include Aws::Structure
|
609
633
|
end
|
610
634
|
|
635
|
+
# @!attribute [rw] instance_id
|
636
|
+
# The unique identifier of the Amazon Q Business application
|
637
|
+
# environment instance.
|
638
|
+
# @return [String]
|
639
|
+
#
|
640
|
+
# @!attribute [rw] card_id
|
641
|
+
# The unique identifier of the card the file is associated with.
|
642
|
+
# @return [String]
|
643
|
+
#
|
644
|
+
# @!attribute [rw] app_id
|
645
|
+
# The unique identifier of the Q App the file is associated with.
|
646
|
+
# @return [String]
|
647
|
+
#
|
648
|
+
# @!attribute [rw] file_contents_sha_256
|
649
|
+
# The Base64-encoded SHA-256 digest of the contents of the file to be
|
650
|
+
# uploaded.
|
651
|
+
# @return [String]
|
652
|
+
#
|
653
|
+
# @!attribute [rw] file_name
|
654
|
+
# The name of the file to be uploaded.
|
655
|
+
# @return [String]
|
656
|
+
#
|
657
|
+
# @!attribute [rw] scope
|
658
|
+
# Whether the file is associated with a Q App definition or a specific
|
659
|
+
# Q App session.
|
660
|
+
# @return [String]
|
661
|
+
#
|
662
|
+
# @!attribute [rw] session_id
|
663
|
+
# The unique identifier of the Q App session the file is associated
|
664
|
+
# with, if applicable.
|
665
|
+
# @return [String]
|
666
|
+
#
|
667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/CreatePresignedUrlInput AWS API Documentation
|
668
|
+
#
|
669
|
+
class CreatePresignedUrlInput < Struct.new(
|
670
|
+
:instance_id,
|
671
|
+
:card_id,
|
672
|
+
:app_id,
|
673
|
+
:file_contents_sha_256,
|
674
|
+
:file_name,
|
675
|
+
:scope,
|
676
|
+
:session_id)
|
677
|
+
SENSITIVE = []
|
678
|
+
include Aws::Structure
|
679
|
+
end
|
680
|
+
|
681
|
+
# @!attribute [rw] file_id
|
682
|
+
# The unique identifier assigned to the file to be uploaded.
|
683
|
+
# @return [String]
|
684
|
+
#
|
685
|
+
# @!attribute [rw] presigned_url
|
686
|
+
# The URL for a presigned S3 POST operation used to upload a file.
|
687
|
+
# @return [String]
|
688
|
+
#
|
689
|
+
# @!attribute [rw] presigned_url_fields
|
690
|
+
# The form fields to include in the presigned S3 POST operation used
|
691
|
+
# to upload a file.
|
692
|
+
# @return [Hash<String,String>]
|
693
|
+
#
|
694
|
+
# @!attribute [rw] presigned_url_expiration
|
695
|
+
# The date and time that the presigned URL will expire in ISO 8601
|
696
|
+
# format.
|
697
|
+
# @return [Time]
|
698
|
+
#
|
699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/CreatePresignedUrlOutput AWS API Documentation
|
700
|
+
#
|
701
|
+
class CreatePresignedUrlOutput < Struct.new(
|
702
|
+
:file_id,
|
703
|
+
:presigned_url,
|
704
|
+
:presigned_url_fields,
|
705
|
+
:presigned_url_expiration)
|
706
|
+
SENSITIVE = []
|
707
|
+
include Aws::Structure
|
708
|
+
end
|
709
|
+
|
611
710
|
# @!attribute [rw] instance_id
|
612
711
|
# The unique identifier of the Amazon Q Business application
|
613
712
|
# environment instance.
|
@@ -745,6 +844,49 @@ module Aws::QApps
|
|
745
844
|
include Aws::Structure
|
746
845
|
end
|
747
846
|
|
847
|
+
# @!attribute [rw] instance_id
|
848
|
+
# The unique identifier of the Amazon Q Business application
|
849
|
+
# environment instance.
|
850
|
+
# @return [String]
|
851
|
+
#
|
852
|
+
# @!attribute [rw] app_id
|
853
|
+
# The unique identifier of the Amazon Q App for which to retrieve
|
854
|
+
# permissions.
|
855
|
+
# @return [String]
|
856
|
+
#
|
857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/DescribeQAppPermissionsInput AWS API Documentation
|
858
|
+
#
|
859
|
+
class DescribeQAppPermissionsInput < Struct.new(
|
860
|
+
:instance_id,
|
861
|
+
:app_id)
|
862
|
+
SENSITIVE = []
|
863
|
+
include Aws::Structure
|
864
|
+
end
|
865
|
+
|
866
|
+
# @!attribute [rw] resource_arn
|
867
|
+
# The Amazon Resource Name (ARN) of the Amazon Q App for which
|
868
|
+
# permissions are returned.
|
869
|
+
# @return [String]
|
870
|
+
#
|
871
|
+
# @!attribute [rw] app_id
|
872
|
+
# The unique identifier of the Amazon Q App for which permissions are
|
873
|
+
# returned.
|
874
|
+
# @return [String]
|
875
|
+
#
|
876
|
+
# @!attribute [rw] permissions
|
877
|
+
# The list of permissions granted for the Amazon Q App.
|
878
|
+
# @return [Array<Types::PermissionOutput>]
|
879
|
+
#
|
880
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/DescribeQAppPermissionsOutput AWS API Documentation
|
881
|
+
#
|
882
|
+
class DescribeQAppPermissionsOutput < Struct.new(
|
883
|
+
:resource_arn,
|
884
|
+
:app_id,
|
885
|
+
:permissions)
|
886
|
+
SENSITIVE = []
|
887
|
+
include Aws::Structure
|
888
|
+
end
|
889
|
+
|
748
890
|
# @!attribute [rw] instance_id
|
749
891
|
# The unique identifier of the Amazon Q Business application
|
750
892
|
# environment instance.
|
@@ -847,6 +989,48 @@ module Aws::QApps
|
|
847
989
|
class Unknown < DocumentAttributeValue; end
|
848
990
|
end
|
849
991
|
|
992
|
+
# @!attribute [rw] instance_id
|
993
|
+
# The unique identifier of the Amazon Q Business application
|
994
|
+
# environment instance.
|
995
|
+
# @return [String]
|
996
|
+
#
|
997
|
+
# @!attribute [rw] session_id
|
998
|
+
# The unique identifier of the Q App data collection session.
|
999
|
+
# @return [String]
|
1000
|
+
#
|
1001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ExportQAppSessionDataInput AWS API Documentation
|
1002
|
+
#
|
1003
|
+
class ExportQAppSessionDataInput < Struct.new(
|
1004
|
+
:instance_id,
|
1005
|
+
:session_id)
|
1006
|
+
SENSITIVE = []
|
1007
|
+
include Aws::Structure
|
1008
|
+
end
|
1009
|
+
|
1010
|
+
# @!attribute [rw] csv_file_link
|
1011
|
+
# The link where the exported Q App session data can be downloaded
|
1012
|
+
# from.
|
1013
|
+
# @return [String]
|
1014
|
+
#
|
1015
|
+
# @!attribute [rw] expires_at
|
1016
|
+
# The date and time when the link for the exported Q App session data
|
1017
|
+
# expires.
|
1018
|
+
# @return [Time]
|
1019
|
+
#
|
1020
|
+
# @!attribute [rw] session_arn
|
1021
|
+
# The Amazon Resource Name (ARN) of the Q App data collection session.
|
1022
|
+
# @return [String]
|
1023
|
+
#
|
1024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ExportQAppSessionDataOutput AWS API Documentation
|
1025
|
+
#
|
1026
|
+
class ExportQAppSessionDataOutput < Struct.new(
|
1027
|
+
:csv_file_link,
|
1028
|
+
:expires_at,
|
1029
|
+
:session_arn)
|
1030
|
+
SENSITIVE = []
|
1031
|
+
include Aws::Structure
|
1032
|
+
end
|
1033
|
+
|
850
1034
|
# A card in an Amazon Q App that allows the user to upload a file.
|
851
1035
|
#
|
852
1036
|
# @!attribute [rw] id
|
@@ -934,6 +1118,103 @@ module Aws::QApps
|
|
934
1118
|
include Aws::Structure
|
935
1119
|
end
|
936
1120
|
|
1121
|
+
# A card in an Amazon Q App that allows the user to submit a response.
|
1122
|
+
#
|
1123
|
+
# @!attribute [rw] id
|
1124
|
+
# The unique identifier of the form input card.
|
1125
|
+
# @return [String]
|
1126
|
+
#
|
1127
|
+
# @!attribute [rw] title
|
1128
|
+
# The title of the form input card.
|
1129
|
+
# @return [String]
|
1130
|
+
#
|
1131
|
+
# @!attribute [rw] dependencies
|
1132
|
+
# Any dependencies or requirements for the form input card.
|
1133
|
+
# @return [Array<String>]
|
1134
|
+
#
|
1135
|
+
# @!attribute [rw] type
|
1136
|
+
# The type of the card.
|
1137
|
+
# @return [String]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] metadata
|
1140
|
+
# The metadata that defines the form input card data.
|
1141
|
+
# @return [Types::FormInputCardMetadata]
|
1142
|
+
#
|
1143
|
+
# @!attribute [rw] compute_mode
|
1144
|
+
# The compute mode of the form input card. This property determines
|
1145
|
+
# whether individual participants of a data collection session can
|
1146
|
+
# submit multiple response or one response. A compute mode of `append`
|
1147
|
+
# shall allow participants to submit the same form multiple times with
|
1148
|
+
# different values. A compute mode of `replace`code> shall
|
1149
|
+
# overwrite the current value for each participant.
|
1150
|
+
# @return [String]
|
1151
|
+
#
|
1152
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/FormInputCard AWS API Documentation
|
1153
|
+
#
|
1154
|
+
class FormInputCard < Struct.new(
|
1155
|
+
:id,
|
1156
|
+
:title,
|
1157
|
+
:dependencies,
|
1158
|
+
:type,
|
1159
|
+
:metadata,
|
1160
|
+
:compute_mode)
|
1161
|
+
SENSITIVE = []
|
1162
|
+
include Aws::Structure
|
1163
|
+
end
|
1164
|
+
|
1165
|
+
# Represents a form input card for an Amazon Q App.
|
1166
|
+
#
|
1167
|
+
# @!attribute [rw] title
|
1168
|
+
# The title or label of the form input card.
|
1169
|
+
# @return [String]
|
1170
|
+
#
|
1171
|
+
# @!attribute [rw] id
|
1172
|
+
# The unique identifier of the form input card.
|
1173
|
+
# @return [String]
|
1174
|
+
#
|
1175
|
+
# @!attribute [rw] type
|
1176
|
+
# The type of the card.
|
1177
|
+
# @return [String]
|
1178
|
+
#
|
1179
|
+
# @!attribute [rw] metadata
|
1180
|
+
# The metadata that defines the form input card data.
|
1181
|
+
# @return [Types::FormInputCardMetadata]
|
1182
|
+
#
|
1183
|
+
# @!attribute [rw] compute_mode
|
1184
|
+
# The compute mode of the form input card. This property determines
|
1185
|
+
# whether individual participants of a data collection session can
|
1186
|
+
# submit multiple response or one response. A compute mode of `append`
|
1187
|
+
# shall allow participants to submit the same form multiple times with
|
1188
|
+
# different values. A compute mode of `replace`code> shall
|
1189
|
+
# overwrite the current value for each participant.
|
1190
|
+
# @return [String]
|
1191
|
+
#
|
1192
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/FormInputCardInput AWS API Documentation
|
1193
|
+
#
|
1194
|
+
class FormInputCardInput < Struct.new(
|
1195
|
+
:title,
|
1196
|
+
:id,
|
1197
|
+
:type,
|
1198
|
+
:metadata,
|
1199
|
+
:compute_mode)
|
1200
|
+
SENSITIVE = []
|
1201
|
+
include Aws::Structure
|
1202
|
+
end
|
1203
|
+
|
1204
|
+
# The metadata of the form input card.
|
1205
|
+
#
|
1206
|
+
# @!attribute [rw] schema
|
1207
|
+
# The JSON schema that defines the shape of the response data.
|
1208
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
1209
|
+
#
|
1210
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/FormInputCardMetadata AWS API Documentation
|
1211
|
+
#
|
1212
|
+
class FormInputCardMetadata < Struct.new(
|
1213
|
+
:schema)
|
1214
|
+
SENSITIVE = []
|
1215
|
+
include Aws::Structure
|
1216
|
+
end
|
1217
|
+
|
937
1218
|
# @!attribute [rw] instance_id
|
938
1219
|
# The unique identifier of the Amazon Q Business application
|
939
1220
|
# environment instance.
|
@@ -1040,11 +1321,16 @@ module Aws::QApps
|
|
1040
1321
|
# The unique identifier of the Q App to retrieve.
|
1041
1322
|
# @return [String]
|
1042
1323
|
#
|
1324
|
+
# @!attribute [rw] app_version
|
1325
|
+
# The version of the Q App.
|
1326
|
+
# @return [Integer]
|
1327
|
+
#
|
1043
1328
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/GetQAppInput AWS API Documentation
|
1044
1329
|
#
|
1045
1330
|
class GetQAppInput < Struct.new(
|
1046
1331
|
:instance_id,
|
1047
|
-
:app_id
|
1332
|
+
:app_id,
|
1333
|
+
:app_version)
|
1048
1334
|
SENSITIVE = []
|
1049
1335
|
include Aws::Structure
|
1050
1336
|
end
|
@@ -1140,6 +1426,57 @@ module Aws::QApps
|
|
1140
1426
|
include Aws::Structure
|
1141
1427
|
end
|
1142
1428
|
|
1429
|
+
# @!attribute [rw] instance_id
|
1430
|
+
# The unique identifier of the Amazon Q Business application
|
1431
|
+
# environment instance.
|
1432
|
+
# @return [String]
|
1433
|
+
#
|
1434
|
+
# @!attribute [rw] session_id
|
1435
|
+
# The unique identifier of the Q App session.
|
1436
|
+
# @return [String]
|
1437
|
+
#
|
1438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/GetQAppSessionMetadataInput AWS API Documentation
|
1439
|
+
#
|
1440
|
+
class GetQAppSessionMetadataInput < Struct.new(
|
1441
|
+
:instance_id,
|
1442
|
+
:session_id)
|
1443
|
+
SENSITIVE = []
|
1444
|
+
include Aws::Structure
|
1445
|
+
end
|
1446
|
+
|
1447
|
+
# @!attribute [rw] session_id
|
1448
|
+
# The unique identifier of the Q App session.
|
1449
|
+
# @return [String]
|
1450
|
+
#
|
1451
|
+
# @!attribute [rw] session_arn
|
1452
|
+
# The Amazon Resource Name (ARN) of the Q App session.
|
1453
|
+
# @return [String]
|
1454
|
+
#
|
1455
|
+
# @!attribute [rw] session_name
|
1456
|
+
# The name of the Q App session.
|
1457
|
+
# @return [String]
|
1458
|
+
#
|
1459
|
+
# @!attribute [rw] sharing_configuration
|
1460
|
+
# The sharing configuration of the Q App data collection session.
|
1461
|
+
# @return [Types::SessionSharingConfiguration]
|
1462
|
+
#
|
1463
|
+
# @!attribute [rw] session_owner
|
1464
|
+
# Indicates whether the current user is the owner of the Q App
|
1465
|
+
# session.
|
1466
|
+
# @return [Boolean]
|
1467
|
+
#
|
1468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/GetQAppSessionMetadataOutput AWS API Documentation
|
1469
|
+
#
|
1470
|
+
class GetQAppSessionMetadataOutput < Struct.new(
|
1471
|
+
:session_id,
|
1472
|
+
:session_arn,
|
1473
|
+
:session_name,
|
1474
|
+
:sharing_configuration,
|
1475
|
+
:session_owner)
|
1476
|
+
SENSITIVE = []
|
1477
|
+
include Aws::Structure
|
1478
|
+
end
|
1479
|
+
|
1143
1480
|
# @!attribute [rw] session_id
|
1144
1481
|
# The unique identifier of the Q App session.
|
1145
1482
|
# @return [String]
|
@@ -1148,6 +1485,18 @@ module Aws::QApps
|
|
1148
1485
|
# The Amazon Resource Name (ARN) of the Q App session.
|
1149
1486
|
# @return [String]
|
1150
1487
|
#
|
1488
|
+
# @!attribute [rw] session_name
|
1489
|
+
# The name of the Q App session.
|
1490
|
+
# @return [String]
|
1491
|
+
#
|
1492
|
+
# @!attribute [rw] app_version
|
1493
|
+
# The version of the Q App used for the session.
|
1494
|
+
# @return [Integer]
|
1495
|
+
#
|
1496
|
+
# @!attribute [rw] latest_published_app_version
|
1497
|
+
# The latest published version of the Q App used for the session.
|
1498
|
+
# @return [Integer]
|
1499
|
+
#
|
1151
1500
|
# @!attribute [rw] status
|
1152
1501
|
# The current status of the Q App session.
|
1153
1502
|
# @return [String]
|
@@ -1156,13 +1505,22 @@ module Aws::QApps
|
|
1156
1505
|
# The current status for each card in the Q App session.
|
1157
1506
|
# @return [Hash<String,Types::CardStatus>]
|
1158
1507
|
#
|
1508
|
+
# @!attribute [rw] user_is_host
|
1509
|
+
# Indicates whether the current user is the owner of the Q App data
|
1510
|
+
# collection session.
|
1511
|
+
# @return [Boolean]
|
1512
|
+
#
|
1159
1513
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/GetQAppSessionOutput AWS API Documentation
|
1160
1514
|
#
|
1161
1515
|
class GetQAppSessionOutput < Struct.new(
|
1162
1516
|
:session_id,
|
1163
1517
|
:session_arn,
|
1518
|
+
:session_name,
|
1519
|
+
:app_version,
|
1520
|
+
:latest_published_app_version,
|
1164
1521
|
:status,
|
1165
|
-
:card_status
|
1522
|
+
:card_status,
|
1523
|
+
:user_is_host)
|
1166
1524
|
SENSITIVE = []
|
1167
1525
|
include Aws::Structure
|
1168
1526
|
end
|
@@ -1173,8 +1531,7 @@ module Aws::QApps
|
|
1173
1531
|
# @return [String]
|
1174
1532
|
#
|
1175
1533
|
# @!attribute [rw] card_id
|
1176
|
-
# The unique identifier of the card the file is associated with
|
1177
|
-
# applicable.
|
1534
|
+
# The unique identifier of the card the file is associated with.
|
1178
1535
|
# @return [String]
|
1179
1536
|
#
|
1180
1537
|
# @!attribute [rw] app_id
|
@@ -1190,8 +1547,8 @@ module Aws::QApps
|
|
1190
1547
|
# @return [String]
|
1191
1548
|
#
|
1192
1549
|
# @!attribute [rw] scope
|
1193
|
-
# Whether the file is associated with
|
1194
|
-
#
|
1550
|
+
# Whether the file is associated with a Q App definition or a specific
|
1551
|
+
# Q App session.
|
1195
1552
|
# @return [String]
|
1196
1553
|
#
|
1197
1554
|
# @!attribute [rw] session_id
|
@@ -1390,6 +1747,52 @@ module Aws::QApps
|
|
1390
1747
|
include Aws::Structure
|
1391
1748
|
end
|
1392
1749
|
|
1750
|
+
# @!attribute [rw] instance_id
|
1751
|
+
# The unique identifier of the Amazon Q Business application
|
1752
|
+
# environment instance.
|
1753
|
+
# @return [String]
|
1754
|
+
#
|
1755
|
+
# @!attribute [rw] session_id
|
1756
|
+
# The unique identifier of the Q App data collection session.
|
1757
|
+
# @return [String]
|
1758
|
+
#
|
1759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ListQAppSessionDataInput AWS API Documentation
|
1760
|
+
#
|
1761
|
+
class ListQAppSessionDataInput < Struct.new(
|
1762
|
+
:instance_id,
|
1763
|
+
:session_id)
|
1764
|
+
SENSITIVE = []
|
1765
|
+
include Aws::Structure
|
1766
|
+
end
|
1767
|
+
|
1768
|
+
# @!attribute [rw] session_id
|
1769
|
+
# The unique identifier of the Q App data collection session.
|
1770
|
+
# @return [String]
|
1771
|
+
#
|
1772
|
+
# @!attribute [rw] session_arn
|
1773
|
+
# The Amazon Resource Name (ARN) of the Q App data collection session.
|
1774
|
+
# @return [String]
|
1775
|
+
#
|
1776
|
+
# @!attribute [rw] session_data
|
1777
|
+
# The collected responses of a Q App session.
|
1778
|
+
# @return [Array<Types::QAppSessionData>]
|
1779
|
+
#
|
1780
|
+
# @!attribute [rw] next_token
|
1781
|
+
# The pagination token that indicates the next set of results to
|
1782
|
+
# retrieve.
|
1783
|
+
# @return [String]
|
1784
|
+
#
|
1785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/ListQAppSessionDataOutput AWS API Documentation
|
1786
|
+
#
|
1787
|
+
class ListQAppSessionDataOutput < Struct.new(
|
1788
|
+
:session_id,
|
1789
|
+
:session_arn,
|
1790
|
+
:session_data,
|
1791
|
+
:next_token)
|
1792
|
+
SENSITIVE = []
|
1793
|
+
include Aws::Structure
|
1794
|
+
end
|
1795
|
+
|
1393
1796
|
# @!attribute [rw] instance_id
|
1394
1797
|
# The unique identifier of the Amazon Q Business application
|
1395
1798
|
# environment instance.
|
@@ -1455,6 +1858,44 @@ module Aws::QApps
|
|
1455
1858
|
include Aws::Structure
|
1456
1859
|
end
|
1457
1860
|
|
1861
|
+
# The permission to grant or revoke for a Amazon Q App.
|
1862
|
+
#
|
1863
|
+
# @!attribute [rw] action
|
1864
|
+
# The action associated with the permission.
|
1865
|
+
# @return [String]
|
1866
|
+
#
|
1867
|
+
# @!attribute [rw] principal
|
1868
|
+
# The principal user to which the permission applies.
|
1869
|
+
# @return [String]
|
1870
|
+
#
|
1871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/PermissionInput AWS API Documentation
|
1872
|
+
#
|
1873
|
+
class PermissionInput < Struct.new(
|
1874
|
+
:action,
|
1875
|
+
:principal)
|
1876
|
+
SENSITIVE = []
|
1877
|
+
include Aws::Structure
|
1878
|
+
end
|
1879
|
+
|
1880
|
+
# The permission granted to the Amazon Q App.
|
1881
|
+
#
|
1882
|
+
# @!attribute [rw] action
|
1883
|
+
# The action associated with the permission.
|
1884
|
+
# @return [String]
|
1885
|
+
#
|
1886
|
+
# @!attribute [rw] principal
|
1887
|
+
# The principal user to which the permission applies.
|
1888
|
+
# @return [Types::PrincipalOutput]
|
1889
|
+
#
|
1890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/PermissionOutput AWS API Documentation
|
1891
|
+
#
|
1892
|
+
class PermissionOutput < Struct.new(
|
1893
|
+
:action,
|
1894
|
+
:principal)
|
1895
|
+
SENSITIVE = []
|
1896
|
+
include Aws::Structure
|
1897
|
+
end
|
1898
|
+
|
1458
1899
|
# The definition of an Amazon Q App generated based on input such as a
|
1459
1900
|
# conversation or problem statement.
|
1460
1901
|
#
|
@@ -1545,6 +1986,66 @@ module Aws::QApps
|
|
1545
1986
|
include Aws::Structure
|
1546
1987
|
end
|
1547
1988
|
|
1989
|
+
# The principal for which the permission applies.
|
1990
|
+
#
|
1991
|
+
# @!attribute [rw] user_id
|
1992
|
+
# The unique identifier of the user.
|
1993
|
+
# @return [String]
|
1994
|
+
#
|
1995
|
+
# @!attribute [rw] user_type
|
1996
|
+
# The type of the user.
|
1997
|
+
# @return [String]
|
1998
|
+
#
|
1999
|
+
# @!attribute [rw] email
|
2000
|
+
# The email address associated with the user.
|
2001
|
+
# @return [String]
|
2002
|
+
#
|
2003
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/PrincipalOutput AWS API Documentation
|
2004
|
+
#
|
2005
|
+
class PrincipalOutput < Struct.new(
|
2006
|
+
:user_id,
|
2007
|
+
:user_type,
|
2008
|
+
:email)
|
2009
|
+
SENSITIVE = []
|
2010
|
+
include Aws::Structure
|
2011
|
+
end
|
2012
|
+
|
2013
|
+
# The response collected for a Amazon Q App session. This container
|
2014
|
+
# represents a single response to a Q App session.
|
2015
|
+
#
|
2016
|
+
# @!attribute [rw] card_id
|
2017
|
+
# The card Id associated with the response submitted for a Q App
|
2018
|
+
# session.
|
2019
|
+
# @return [String]
|
2020
|
+
#
|
2021
|
+
# @!attribute [rw] value
|
2022
|
+
# The response submitted for a Q App session.
|
2023
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
2024
|
+
#
|
2025
|
+
# @!attribute [rw] user
|
2026
|
+
# The user who submitted the response for a Q App session.
|
2027
|
+
# @return [Types::User]
|
2028
|
+
#
|
2029
|
+
# @!attribute [rw] submission_id
|
2030
|
+
# The unique identifier of the submission.
|
2031
|
+
# @return [String]
|
2032
|
+
#
|
2033
|
+
# @!attribute [rw] timestamp
|
2034
|
+
# The date and time when the session data is submitted.
|
2035
|
+
# @return [Time]
|
2036
|
+
#
|
2037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/QAppSessionData AWS API Documentation
|
2038
|
+
#
|
2039
|
+
class QAppSessionData < Struct.new(
|
2040
|
+
:card_id,
|
2041
|
+
:value,
|
2042
|
+
:user,
|
2043
|
+
:submission_id,
|
2044
|
+
:timestamp)
|
2045
|
+
SENSITIVE = []
|
2046
|
+
include Aws::Structure
|
2047
|
+
end
|
2048
|
+
|
1548
2049
|
# A card in an Q App that integrates with a third-party plugin or
|
1549
2050
|
# service.
|
1550
2051
|
#
|
@@ -1656,6 +2157,11 @@ module Aws::QApps
|
|
1656
2157
|
# resolving data sources
|
1657
2158
|
# @return [Types::AttributeFilter]
|
1658
2159
|
#
|
2160
|
+
# @!attribute [rw] memory_references
|
2161
|
+
# Any dependencies for the query card, where the dependencies are
|
2162
|
+
# references to the collected responses.
|
2163
|
+
# @return [Array<String>]
|
2164
|
+
#
|
1659
2165
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/QQueryCard AWS API Documentation
|
1660
2166
|
#
|
1661
2167
|
class QQueryCard < Struct.new(
|
@@ -1665,7 +2171,8 @@ module Aws::QApps
|
|
1665
2171
|
:type,
|
1666
2172
|
:prompt,
|
1667
2173
|
:output_source,
|
1668
|
-
:attribute_filter
|
2174
|
+
:attribute_filter,
|
2175
|
+
:memory_references)
|
1669
2176
|
SENSITIVE = []
|
1670
2177
|
include Aws::Structure
|
1671
2178
|
end
|
@@ -1767,6 +2274,31 @@ module Aws::QApps
|
|
1767
2274
|
include Aws::Structure
|
1768
2275
|
end
|
1769
2276
|
|
2277
|
+
# The sharing configuration of an Amazon Q App data collection session.
|
2278
|
+
#
|
2279
|
+
# @!attribute [rw] enabled
|
2280
|
+
# Indicates whether an Q App session is shareable with other users.
|
2281
|
+
# @return [Boolean]
|
2282
|
+
#
|
2283
|
+
# @!attribute [rw] accept_responses
|
2284
|
+
# Indicates whether an Q App session can accept responses from users.
|
2285
|
+
# @return [Boolean]
|
2286
|
+
#
|
2287
|
+
# @!attribute [rw] reveal_cards
|
2288
|
+
# Indicates whether collected responses for an Q App session are
|
2289
|
+
# revealed for all users.
|
2290
|
+
# @return [Boolean]
|
2291
|
+
#
|
2292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/SessionSharingConfiguration AWS API Documentation
|
2293
|
+
#
|
2294
|
+
class SessionSharingConfiguration < Struct.new(
|
2295
|
+
:enabled,
|
2296
|
+
:accept_responses,
|
2297
|
+
:reveal_cards)
|
2298
|
+
SENSITIVE = []
|
2299
|
+
include Aws::Structure
|
2300
|
+
end
|
2301
|
+
|
1770
2302
|
# @!attribute [rw] instance_id
|
1771
2303
|
# The unique identifier of the Amazon Q Business application
|
1772
2304
|
# environment instance.
|
@@ -1784,6 +2316,10 @@ module Aws::QApps
|
|
1784
2316
|
# Optional initial input values to provide for the Q App session.
|
1785
2317
|
# @return [Array<Types::CardValue>]
|
1786
2318
|
#
|
2319
|
+
# @!attribute [rw] session_id
|
2320
|
+
# The unique identifier of the a Q App session.
|
2321
|
+
# @return [String]
|
2322
|
+
#
|
1787
2323
|
# @!attribute [rw] tags
|
1788
2324
|
# Optional tags to associate with the new Q App session.
|
1789
2325
|
# @return [Hash<String,String>]
|
@@ -1795,13 +2331,14 @@ module Aws::QApps
|
|
1795
2331
|
:app_id,
|
1796
2332
|
:app_version,
|
1797
2333
|
:initial_values,
|
2334
|
+
:session_id,
|
1798
2335
|
:tags)
|
1799
2336
|
SENSITIVE = []
|
1800
2337
|
include Aws::Structure
|
1801
2338
|
end
|
1802
2339
|
|
1803
2340
|
# @!attribute [rw] session_id
|
1804
|
-
# The unique identifier of the new Q App session.
|
2341
|
+
# The unique identifier of the new or retrieved Q App session.
|
1805
2342
|
# @return [String]
|
1806
2343
|
#
|
1807
2344
|
# @!attribute [rw] session_arn
|
@@ -1835,6 +2372,49 @@ module Aws::QApps
|
|
1835
2372
|
include Aws::Structure
|
1836
2373
|
end
|
1837
2374
|
|
2375
|
+
# A record created when a user submits a form card.
|
2376
|
+
#
|
2377
|
+
# @!attribute [rw] value
|
2378
|
+
# The data submitted by the user.
|
2379
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
2380
|
+
#
|
2381
|
+
# @!attribute [rw] submission_id
|
2382
|
+
# The unique identifier of the submission.
|
2383
|
+
# @return [String]
|
2384
|
+
#
|
2385
|
+
# @!attribute [rw] timestamp
|
2386
|
+
# The date and time when the card is submitted.
|
2387
|
+
# @return [Time]
|
2388
|
+
#
|
2389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/Submission AWS API Documentation
|
2390
|
+
#
|
2391
|
+
class Submission < Struct.new(
|
2392
|
+
:value,
|
2393
|
+
:submission_id,
|
2394
|
+
:timestamp)
|
2395
|
+
SENSITIVE = []
|
2396
|
+
include Aws::Structure
|
2397
|
+
end
|
2398
|
+
|
2399
|
+
# Represents an action performed on a submission.
|
2400
|
+
#
|
2401
|
+
# @!attribute [rw] submission_id
|
2402
|
+
# The unique identifier of the submission.
|
2403
|
+
# @return [String]
|
2404
|
+
#
|
2405
|
+
# @!attribute [rw] mutation_type
|
2406
|
+
# The operation that is performed on a submission.
|
2407
|
+
# @return [String]
|
2408
|
+
#
|
2409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/SubmissionMutation AWS API Documentation
|
2410
|
+
#
|
2411
|
+
class SubmissionMutation < Struct.new(
|
2412
|
+
:submission_id,
|
2413
|
+
:mutation_type)
|
2414
|
+
SENSITIVE = []
|
2415
|
+
include Aws::Structure
|
2416
|
+
end
|
2417
|
+
|
1838
2418
|
# @!attribute [rw] resource_arn
|
1839
2419
|
# The Amazon Resource Name (ARN) of the resource to tag.
|
1840
2420
|
# @return [String]
|
@@ -2218,6 +2798,59 @@ module Aws::QApps
|
|
2218
2798
|
include Aws::Structure
|
2219
2799
|
end
|
2220
2800
|
|
2801
|
+
# @!attribute [rw] instance_id
|
2802
|
+
# The unique identifier of the Amazon Q Business application
|
2803
|
+
# environment instance.
|
2804
|
+
# @return [String]
|
2805
|
+
#
|
2806
|
+
# @!attribute [rw] app_id
|
2807
|
+
# The unique identifier of the Amazon Q App for which permissions are
|
2808
|
+
# being updated.
|
2809
|
+
# @return [String]
|
2810
|
+
#
|
2811
|
+
# @!attribute [rw] grant_permissions
|
2812
|
+
# The list of permissions to grant for the Amazon Q App.
|
2813
|
+
# @return [Array<Types::PermissionInput>]
|
2814
|
+
#
|
2815
|
+
# @!attribute [rw] revoke_permissions
|
2816
|
+
# The list of permissions to revoke for the Amazon Q App.
|
2817
|
+
# @return [Array<Types::PermissionInput>]
|
2818
|
+
#
|
2819
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/UpdateQAppPermissionsInput AWS API Documentation
|
2820
|
+
#
|
2821
|
+
class UpdateQAppPermissionsInput < Struct.new(
|
2822
|
+
:instance_id,
|
2823
|
+
:app_id,
|
2824
|
+
:grant_permissions,
|
2825
|
+
:revoke_permissions)
|
2826
|
+
SENSITIVE = []
|
2827
|
+
include Aws::Structure
|
2828
|
+
end
|
2829
|
+
|
2830
|
+
# @!attribute [rw] resource_arn
|
2831
|
+
# The Amazon Resource Name (ARN) of the Amazon Q App for which
|
2832
|
+
# permissions were updated.
|
2833
|
+
# @return [String]
|
2834
|
+
#
|
2835
|
+
# @!attribute [rw] app_id
|
2836
|
+
# The unique identifier of the Amazon Q App for which permissions were
|
2837
|
+
# updated.
|
2838
|
+
# @return [String]
|
2839
|
+
#
|
2840
|
+
# @!attribute [rw] permissions
|
2841
|
+
# The updated list of permissions for the Amazon Q App.
|
2842
|
+
# @return [Array<Types::PermissionOutput>]
|
2843
|
+
#
|
2844
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/UpdateQAppPermissionsOutput AWS API Documentation
|
2845
|
+
#
|
2846
|
+
class UpdateQAppPermissionsOutput < Struct.new(
|
2847
|
+
:resource_arn,
|
2848
|
+
:app_id,
|
2849
|
+
:permissions)
|
2850
|
+
SENSITIVE = []
|
2851
|
+
include Aws::Structure
|
2852
|
+
end
|
2853
|
+
|
2221
2854
|
# @!attribute [rw] instance_id
|
2222
2855
|
# The unique identifier of the Amazon Q Business application
|
2223
2856
|
# environment instance.
|
@@ -2242,6 +2875,63 @@ module Aws::QApps
|
|
2242
2875
|
include Aws::Structure
|
2243
2876
|
end
|
2244
2877
|
|
2878
|
+
# @!attribute [rw] instance_id
|
2879
|
+
# The unique identifier of the Amazon Q Business application
|
2880
|
+
# environment instance.
|
2881
|
+
# @return [String]
|
2882
|
+
#
|
2883
|
+
# @!attribute [rw] session_id
|
2884
|
+
# The unique identifier of the Q App session to update configuration
|
2885
|
+
# for.
|
2886
|
+
# @return [String]
|
2887
|
+
#
|
2888
|
+
# @!attribute [rw] session_name
|
2889
|
+
# The new name for the Q App session.
|
2890
|
+
# @return [String]
|
2891
|
+
#
|
2892
|
+
# @!attribute [rw] sharing_configuration
|
2893
|
+
# The new sharing configuration for the Q App data collection session.
|
2894
|
+
# @return [Types::SessionSharingConfiguration]
|
2895
|
+
#
|
2896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/UpdateQAppSessionMetadataInput AWS API Documentation
|
2897
|
+
#
|
2898
|
+
class UpdateQAppSessionMetadataInput < Struct.new(
|
2899
|
+
:instance_id,
|
2900
|
+
:session_id,
|
2901
|
+
:session_name,
|
2902
|
+
:sharing_configuration)
|
2903
|
+
SENSITIVE = []
|
2904
|
+
include Aws::Structure
|
2905
|
+
end
|
2906
|
+
|
2907
|
+
# @!attribute [rw] session_id
|
2908
|
+
# The unique identifier of the updated Q App session.
|
2909
|
+
# @return [String]
|
2910
|
+
#
|
2911
|
+
# @!attribute [rw] session_arn
|
2912
|
+
# The Amazon Resource Name (ARN) of the updated Q App session.
|
2913
|
+
# @return [String]
|
2914
|
+
#
|
2915
|
+
# @!attribute [rw] session_name
|
2916
|
+
# The new name of the updated Q App session.
|
2917
|
+
# @return [String]
|
2918
|
+
#
|
2919
|
+
# @!attribute [rw] sharing_configuration
|
2920
|
+
# The new sharing configuration of the updated Q App data collection
|
2921
|
+
# session.
|
2922
|
+
# @return [Types::SessionSharingConfiguration]
|
2923
|
+
#
|
2924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/UpdateQAppSessionMetadataOutput AWS API Documentation
|
2925
|
+
#
|
2926
|
+
class UpdateQAppSessionMetadataOutput < Struct.new(
|
2927
|
+
:session_id,
|
2928
|
+
:session_arn,
|
2929
|
+
:session_name,
|
2930
|
+
:sharing_configuration)
|
2931
|
+
SENSITIVE = []
|
2932
|
+
include Aws::Structure
|
2933
|
+
end
|
2934
|
+
|
2245
2935
|
# @!attribute [rw] session_id
|
2246
2936
|
# The unique identifier of the updated Q App session.
|
2247
2937
|
# @return [String]
|
@@ -2259,6 +2949,20 @@ module Aws::QApps
|
|
2259
2949
|
include Aws::Structure
|
2260
2950
|
end
|
2261
2951
|
|
2952
|
+
# A user of an Amazon Q App.
|
2953
|
+
#
|
2954
|
+
# @!attribute [rw] user_id
|
2955
|
+
# The unique identifier of a user.
|
2956
|
+
# @return [String]
|
2957
|
+
#
|
2958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qapps-2023-11-27/User AWS API Documentation
|
2959
|
+
#
|
2960
|
+
class User < Struct.new(
|
2961
|
+
:user_id)
|
2962
|
+
SENSITIVE = []
|
2963
|
+
include Aws::Structure
|
2964
|
+
end
|
2965
|
+
|
2262
2966
|
# An Amazon Q App associated with a user, either owned by the user or
|
2263
2967
|
# favorited.
|
2264
2968
|
#
|