aws-sdk-quicksight 1.14.0 → 1.15.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
  SHA1:
3
- metadata.gz: 2fbdad5522c5b643975ee607200cfb3eab75cdcc
4
- data.tar.gz: 7bc2f8ad71bb7965e7933c12ad3f7bf0774f9a5d
3
+ metadata.gz: 9a9ab843cd3640e06dabbec07a2006366bb80711
4
+ data.tar.gz: 1ab04327569a2885033f50e247550536a8bbc71a
5
5
  SHA512:
6
- metadata.gz: 9c75cf0393fdc84182def7f6ffabd02528e8d7edec1f2843447e39ab9633a221c007b21ff90a8f5fd5c34f26d4af15484d894a2797195fb11fb30fce1464fc96
7
- data.tar.gz: a2906d513d5e328a019146f68d166c0391df9c1d8e8d0915935ce298be1c54bb5bbad4f29d3df86066e642ca425e9928dd9e54237c71161d755bbe814b0d7665
6
+ metadata.gz: 9cf54f39dc374079ec04656d06e8b0d80d82f80fe30ce2b6b70f481f1be183c904806c15a8f1c78f68b8bf0fbfd3b25c2bef4b692a68c23125228cdb03ba879e
7
+ data.tar.gz: fd245354dd857a725f63b06d2692a25da2185e28031dfbc8fcef26095437f78f6701ffb21458ca1a581aea44e8e9985c64e479e57e5f6a826ff76de28eee7e7a
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-quicksight/customizations'
42
42
  # @service
43
43
  module Aws::QuickSight
44
44
 
45
- GEM_VERSION = '1.14.0'
45
+ GEM_VERSION = '1.15.0'
46
46
 
47
47
  end
@@ -254,7 +254,7 @@ module Aws::QuickSight
254
254
 
255
255
  # @!group API Operations
256
256
 
257
- # Cancels an on-going ingestion of data into SPICE.
257
+ # Cancels an ongoing ingestion of data into SPICE.
258
258
  #
259
259
  # @option params [required, String] :aws_account_id
260
260
  # The AWS account ID.
@@ -307,11 +307,6 @@ module Aws::QuickSight
307
307
  # the correct permissions, you can create a dashboard from a template
308
308
  # that exists in a different AWS account.
309
309
  #
310
- # CLI syntax:
311
- #
312
- # `aws quicksight create-dashboard --cli-input-json
313
- # file://create-dashboard.json`
314
- #
315
310
  # @option params [required, String] :aws_account_id
316
311
  # AWS account ID where you want to create the dashboard.
317
312
  #
@@ -335,11 +330,11 @@ module Aws::QuickSight
335
330
  #
336
331
  # @option params [required, Types::DashboardSourceEntity] :source_entity
337
332
  # Source entity from which the dashboard is created. The souce entity
338
- # accepts the ARN of the source template or analysis and also references
339
- # the replacement datasets for the placeholders set when creating the
340
- # template. The replacement datasets need to follow the same schema as
341
- # the datasets for which placeholders were created when creating the
342
- # template.
333
+ # accepts the Amazon Resource Name (ARN) of the source template or
334
+ # analysis and also references the replacement datasets for the
335
+ # placeholders set when creating the template. The replacement datasets
336
+ # need to follow the same schema as the datasets for which placeholders
337
+ # were created when creating the template.
343
338
  #
344
339
  # If you are creating a dashboard from a source entity in a different
345
340
  # AWS account, use the ARN of the source template.
@@ -367,10 +362,6 @@ module Aws::QuickSight
367
362
  # `COLLAPSED` or `EXPANDED`. The sheet controls pane is collapsed by
368
363
  # default when set to true. Collapsed by default.
369
364
  #
370
- # Shorthand Syntax:
371
- #
372
- # `AdHocFilteringDisabled=boolean,ExportToCSVDisabled=boolean,SheetControlsCollapsed=boolean`
373
- #
374
365
  # @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
375
366
  #
376
367
  # * {Types::CreateDashboardResponse#arn #arn} => String
@@ -469,51 +460,12 @@ module Aws::QuickSight
469
460
 
470
461
  # Creates a dataset.
471
462
  #
472
- # CLI syntax:
473
- #
474
- # `aws quicksight create-data-set `
475
- #
476
- # `--aws-account-id=111122223333 `
477
- #
478
- # `--data-set-id=unique-data-set-id `
479
- #
480
- # `--name='My dataset' `
481
- #
482
- # `--import-mode=SPICE `
483
- #
484
- # `--physical-table-map='\{`
485
- #
486
- # ` "physical-table-id": \{`
487
- #
488
- # ` "RelationalTable": \{`
489
- #
490
- # ` "DataSourceArn":
491
- # "arn:aws:quicksight:us-west-2:111111111111:datasource/data-source-id",`
492
- #
493
- # ` "Name": "table1",`
494
- #
495
- # ` "InputColumns": [`
496
- #
497
- # ` \{`
498
- #
499
- # ` "Name": "column1",`
500
- #
501
- # ` "Type": "STRING"`
502
- #
503
- # ` \}`
504
- #
505
- # ` ]`
506
- #
507
- # ` \}`
508
- #
509
- # ` \}'`
510
- #
511
463
  # @option params [required, String] :aws_account_id
512
464
  # The AWS Account ID.
513
465
  #
514
466
  # @option params [required, String] :data_set_id
515
- # An ID for the dataset you want to create. This is unique per region
516
- # per AWS account.
467
+ # An ID for the dataset that you want to create. This ID is unique per
468
+ # AWS Region for each AWS account.
517
469
  #
518
470
  # @option params [required, String] :name
519
471
  # The display name for the dataset.
@@ -531,7 +483,7 @@ module Aws::QuickSight
531
483
  #
532
484
  # @option params [Array<Types::ColumnGroup>] :column_groups
533
485
  # Groupings of columns that work together in certain QuickSight
534
- # features. Currently only geospatial hierarchy is supported.
486
+ # features. Currently, only geospatial hierarchy is supported.
535
487
  #
536
488
  # @option params [Array<Types::ResourcePermission>] :permissions
537
489
  # A list of resource permissions on the dataset.
@@ -698,68 +650,41 @@ module Aws::QuickSight
698
650
 
699
651
  # Creates a data source.
700
652
  #
701
- # The permissions resource is
702
- # `arn:aws:quicksight:region:aws-account-id:datasource/data-source-id`
703
- #
704
- # CLI syntax:
705
- #
706
- # `aws quicksight create-data-source `
707
- #
708
- # `--aws-account-id=111122223333 `
709
- #
710
- # `--data-source-id=unique-data-source-id `
711
- #
712
- # `--name='My Data Source' `
713
- #
714
- # `--type=POSTGRESQL `
715
- #
716
- # `--data-source-parameters='\{ "PostgreSqlParameters": \{`
717
- #
718
- # ` "Host": "my-db-host.example.com",`
719
- #
720
- # ` "Port": 1234,`
721
- #
722
- # ` "Database": "my-db" \} \}' `
723
- #
724
- # `--credentials='\{ "CredentialPair": \{`
725
- #
726
- # ` "Username": "username",`
727
- #
728
- # ` "Password": "password" \} \}'`
729
- #
730
653
  # @option params [required, String] :aws_account_id
731
654
  # The AWS account ID.
732
655
  #
733
656
  # @option params [required, String] :data_source_id
734
- # An ID for the data source. This is unique per AWS Region per AWS
735
- # account.
657
+ # An ID for the data source. This ID is unique per AWS Region for each
658
+ # AWS account.
736
659
  #
737
660
  # @option params [required, String] :name
738
661
  # A display name for the data source.
739
662
  #
740
663
  # @option params [required, String] :type
741
- # The type of the data source. Currently the supported types for this
664
+ # The type of the data source. Currently, the supported types for this
742
665
  # operation are: `ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL,
743
666
  # POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER,
744
667
  # TERADATA`. Use `ListDataSources` to return a list of all data sources.
745
668
  #
746
669
  # @option params [Types::DataSourceParameters] :data_source_parameters
747
- # The parameters QuickSight uses to connect to your underlying source.
670
+ # The parameters that QuickSight uses to connect to your underlying
671
+ # source.
748
672
  #
749
673
  # @option params [Types::DataSourceCredentials] :credentials
750
- # The credentials QuickSight uses to connect to your underlying source.
751
- # Currently only username/password based credentials are supported.
674
+ # The credentials QuickSight that uses to connect to your underlying
675
+ # source. Currently, only credentials based on user name and password
676
+ # are supported.
752
677
  #
753
678
  # @option params [Array<Types::ResourcePermission>] :permissions
754
679
  # A list of resource permissions on the data source.
755
680
  #
756
681
  # @option params [Types::VpcConnectionProperties] :vpc_connection_properties
757
- # You need to use this parameter only when you want QuickSight to use a
758
- # VPC connection when connecting to your underlying source.
682
+ # Use this parameter only when you want QuickSight to use a VPC
683
+ # connection when connecting to your underlying source.
759
684
  #
760
685
  # @option params [Types::SslProperties] :ssl_properties
761
- # SSL properties that apply when QuickSight connects to your underlying
762
- # source.
686
+ # Secure Socket Layer (SSL) properties that apply when QuickSight
687
+ # connects to your underlying source.
763
688
  #
764
689
  # @option params [Array<Types::Tag>] :tags
765
690
  # Contains a map of the key-value pairs for the resource tag or tags
@@ -917,12 +842,6 @@ module Aws::QuickSight
917
842
  #
918
843
  # The response is a group object.
919
844
  #
920
- # **CLI Sample:**
921
- #
922
- # `aws quicksight create-group --aws-account-id=111122223333
923
- # --namespace=default --group-name="Sales-Management"
924
- # --description="Sales Management - Forecasting" `
925
- #
926
845
  # @option params [required, String] :group_name
927
846
  # A name for the group that you want to create.
928
847
  #
@@ -972,21 +891,6 @@ module Aws::QuickSight
972
891
 
973
892
  # Adds an Amazon QuickSight user to an Amazon QuickSight group.
974
893
  #
975
- # The permissions resource is
976
- # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name>
977
- # `.
978
- #
979
- # The condition resource is the user name.
980
- #
981
- # The condition key is `quicksight:UserName`.
982
- #
983
- # The response is the group member object.
984
- #
985
- # **CLI Sample:**
986
- #
987
- # `aws quicksight create-group-membership --aws-account-id=111122223333
988
- # --namespace=default --group-name=Sales --member-name=Pat `
989
- #
990
894
  # @option params [required, String] :member_name
991
895
  # The name of the user that you want to add to the group membership.
992
896
  #
@@ -1032,17 +936,9 @@ module Aws::QuickSight
1032
936
  req.send_request(options)
1033
937
  end
1034
938
 
1035
- # Creates an assignment with one specified IAM policy ARN and will
1036
- # assigned to specified groups or users of QuickSight. Users and groups
1037
- # need to be in the same namespace.
1038
- #
1039
- # CLI syntax:
1040
- #
1041
- # `aws quicksight create-iam-policy-assignment
1042
- # --aws-account-id=111122223333 --assignment-name=helpAssignment
1043
- # --policy-arn=arn:aws:iam::aws:policy/AdministratorAccess
1044
- # --identities="user=user5,engineer123,group=QS-Admin"
1045
- # --namespace=default --region=us-west-2`
939
+ # Creates an assignment with one specified IAM policy Amazon Resource
940
+ # Name (ARN) and will assigned to specified groups or users of
941
+ # QuickSight. Users and groups need to be in the same namespace.
1046
942
  #
1047
943
  # @option params [required, String] :aws_account_id
1048
944
  # The AWS Account ID where you want to assign QuickSight users or groups
@@ -1064,8 +960,8 @@ module Aws::QuickSight
1064
960
  # creating the data source.
1065
961
  #
1066
962
  # @option params [String] :policy_arn
1067
- # An IAM policy ARN that you want to apply to the QuickSight users and
1068
- # groups specified in this assignment.
963
+ # An IAM policy Amazon Resource Name (ARN) that you want to apply to the
964
+ # QuickSight users and groups specified in this assignment.
1069
965
  #
1070
966
  # @option params [Hash<String,Array>] :identities
1071
967
  # QuickSight users and/or groups that you want to assign the policy to.
@@ -1120,10 +1016,10 @@ module Aws::QuickSight
1120
1016
  # Creates and starts a new SPICE ingestion on a dataset
1121
1017
  #
1122
1018
  # Any ingestions operating on tagged datasets inherit the same tags
1123
- # automatically for use in access-control. For an example, see [How do I
1019
+ # automatically for use in access control. For an example, see [How do I
1124
1020
  # create an IAM policy to control access to Amazon EC2 resources using
1125
- # tags?][1]. Tags will be visible on the tagged dataset, but not on the
1126
- # ingestion resource.
1021
+ # tags?][1] in the AWS Knowledge Center. Tags are visible on the tagged
1022
+ # dataset, but not on the ingestion resource.
1127
1023
  #
1128
1024
  #
1129
1025
  #
@@ -1182,31 +1078,6 @@ module Aws::QuickSight
1182
1078
  # follow the same schema that was used to create the source analysis and
1183
1079
  # template.
1184
1080
  #
1185
- # To create a template from an existing analysis, use the analysis's
1186
- # ARN, `aws-account-id`, `template-id`, `source-entity`, and
1187
- # `data-set-references`.
1188
- #
1189
- # CLI syntax to create a template:
1190
- #
1191
- # `aws quicksight create-template —cli-input-json
1192
- # file://create-template.json`
1193
- #
1194
- # CLI syntax to create a template from another template in the same AWS
1195
- # account:
1196
- #
1197
- # `aws quicksight create-template --aws-account-id 111122223333
1198
- # --template-id reports_test_template --data-set-references
1199
- # DataSetPlaceholder=reports,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/0dfc789c-81f6-4f4f-b9ac-7db2453eefc8
1200
- # DataSetPlaceholder=Elblogs,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/f60da323-af68-45db-9016-08e0d1d7ded5
1201
- # --source-entity
1202
- # SourceAnalysis='\{Arn=arn:aws:quicksight:us-west-2:111122223333:analysis/7fb74527-c36d-4be8-8139-ac1be4c97365\}'`
1203
- #
1204
- # To create template from another account’s template, you need to grant
1205
- # cross account resource permission for DescribeTemplate the account
1206
- # that contains the template.
1207
- #
1208
- # You can use a file to pass JSON to the function if you prefer.
1209
- #
1210
1081
  # @option params [required, String] :aws_account_id
1211
1082
  # The ID for the AWS account that the group is in. Currently, you use
1212
1083
  # the ID for the AWS account that contains your Amazon QuickSight
@@ -1220,15 +1091,13 @@ module Aws::QuickSight
1220
1091
  # A display name for the template.
1221
1092
  #
1222
1093
  # @option params [Array<Types::ResourcePermission>] :permissions
1223
- # A list of resource permissions to be set on the template. The
1224
- # shorthand syntax should look similar to this: `Shorthand Syntax:
1225
- # Principal=string,Actions=string,string ... `
1094
+ # A list of resource permissions to be set on the template.
1226
1095
  #
1227
1096
  # @option params [required, Types::TemplateSourceEntity] :source_entity
1228
- # The ARN of the source entity from which this template is being
1229
- # created. Templates can be currently created from an analysis or
1230
- # another template. If the ARN is for an analysis, you must include its
1231
- # dataset references.
1097
+ # The Amazon Resource Name (ARN) of the source entity from which this
1098
+ # template is being created. Templates can be currently created from an
1099
+ # analysis or another template. If the ARN is for an analysis, you must
1100
+ # include its dataset references.
1232
1101
  #
1233
1102
  # @option params [Array<Types::Tag>] :tags
1234
1103
  # Contains a map of the key-value pairs for the resource tag or tags
@@ -1305,12 +1174,6 @@ module Aws::QuickSight
1305
1174
 
1306
1175
  # Creates a template alias for a template.
1307
1176
  #
1308
- # CLI syntax:
1309
- #
1310
- # `aws quicksight create-template-alias --aws-account-id 111122223333
1311
- # --template-id 'reports_test_template' --alias-name PROD
1312
- # —version-number 1`
1313
- #
1314
1177
  # @option params [required, String] :aws_account_id
1315
1178
  # AWS account ID that contains the template you are aliasing.
1316
1179
  #
@@ -1318,10 +1181,8 @@ module Aws::QuickSight
1318
1181
  # An ID for the template.
1319
1182
  #
1320
1183
  # @option params [required, String] :alias_name
1321
- # The name you want to give the template's alias. Alias names can't
1322
- # begin with a `$`, which is reserved by QuickSight. Alias names that
1323
- # start with ‘$’ sign are QuickSight reserved naming and can't be
1324
- # deleted.
1184
+ # The name that you want to give to the template alias that you're
1185
+ # creating. Aliases that start with `$` are reserved by QuickSight.
1325
1186
  #
1326
1187
  # @option params [required, Integer] :template_version_number
1327
1188
  # The version number of the template.
@@ -1360,14 +1221,6 @@ module Aws::QuickSight
1360
1221
 
1361
1222
  # Deletes a dashboard.
1362
1223
  #
1363
- # CLI syntax:
1364
- #
1365
- # `aws quicksight delete-dashboard --aws-account-id 111122223333
1366
- # —dashboard-id 123123123`
1367
- #
1368
- # `aws quicksight delete-dashboard --aws-account-id 111122223333
1369
- # —dashboard-id 123123123 —version-number 3`
1370
- #
1371
1224
  # @option params [required, String] :aws_account_id
1372
1225
  # AWS account ID that contains the dashboard you are deleting.
1373
1226
  #
@@ -1411,20 +1264,12 @@ module Aws::QuickSight
1411
1264
 
1412
1265
  # Deletes a dataset.
1413
1266
  #
1414
- # CLI syntax:
1415
- #
1416
- # `aws quicksight delete-data-set `
1417
- #
1418
- # `--aws-account-id=111111111111 `
1419
- #
1420
- # `--data-set-id=unique-data-set-id`
1421
- #
1422
1267
  # @option params [required, String] :aws_account_id
1423
- # The AWS Account ID.
1268
+ # The AWS account ID.
1424
1269
  #
1425
1270
  # @option params [required, String] :data_set_id
1426
- # The ID for the dataset you want to create. This is unique per region
1427
- # per AWS account.
1271
+ # The ID for the dataset that you want to create. This ID is unique per
1272
+ # AWS Region for each AWS account.
1428
1273
  #
1429
1274
  # @return [Types::DeleteDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1430
1275
  #
@@ -1459,20 +1304,12 @@ module Aws::QuickSight
1459
1304
  # Deletes the data source permanently. This action breaks all the
1460
1305
  # datasets that reference the deleted data source.
1461
1306
  #
1462
- # CLI syntax:
1463
- #
1464
- # `aws quicksight delete-data-source `
1465
- #
1466
- # `--aws-account-id=111122223333 `
1467
- #
1468
- # `--data-source-id=unique-data-source-id `
1469
- #
1470
1307
  # @option params [required, String] :aws_account_id
1471
1308
  # The AWS account ID.
1472
1309
  #
1473
1310
  # @option params [required, String] :data_source_id
1474
- # The ID of the data source. This is unique per AWS Region per AWS
1475
- # account.
1311
+ # The ID of the data source. This ID is unique per AWS Region for each
1312
+ # AWS account.
1476
1313
  #
1477
1314
  # @return [Types::DeleteDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1478
1315
  #
@@ -1506,15 +1343,6 @@ module Aws::QuickSight
1506
1343
 
1507
1344
  # Removes a user group from Amazon QuickSight.
1508
1345
  #
1509
- # The permissions resource is
1510
- # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name>
1511
- # `.
1512
- #
1513
- # **CLI Sample:**
1514
- #
1515
- # `aws quicksight delete-group -\-aws-account-id=111122223333
1516
- # -\-namespace=default -\-group-name=Sales-Management `
1517
- #
1518
1346
  # @option params [required, String] :group_name
1519
1347
  # The name of the group that you want to delete.
1520
1348
  #
@@ -1556,20 +1384,6 @@ module Aws::QuickSight
1556
1384
  # Removes a user from a group so that the user is no longer a member of
1557
1385
  # the group.
1558
1386
  #
1559
- # The permissions resource is
1560
- # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name>
1561
- # `.
1562
- #
1563
- # The condition resource is the user name.
1564
- #
1565
- # The condition key is `quicksight:UserName`.
1566
- #
1567
- # **CLI Sample:**
1568
- #
1569
- # `aws quicksight delete-group-membership --aws-account-id=111122223333
1570
- # --namespace=default --group-name=Sales-Management
1571
- # --member-name=Charlie `
1572
- #
1573
1387
  # @option params [required, String] :member_name
1574
1388
  # The name of the user that you want to delete from the group
1575
1389
  # membership.
@@ -1615,12 +1429,6 @@ module Aws::QuickSight
1615
1429
 
1616
1430
  # Deletes an existing assignment.
1617
1431
  #
1618
- # CLI syntax:
1619
- #
1620
- # `aws quicksight delete-iam-policy-assignment
1621
- # --aws-account-id=111122223333 --assignment-name=testtest
1622
- # --region=us-east-1 --namespace=default`
1623
- #
1624
1432
  # @option params [required, String] :aws_account_id
1625
1433
  # The AWS account ID where you want to delete an IAM policy assignment.
1626
1434
  #
@@ -1661,30 +1469,6 @@ module Aws::QuickSight
1661
1469
 
1662
1470
  # Deletes a template.
1663
1471
  #
1664
- # CLI syntax:
1665
- #
1666
- # * `aws quicksight delete-template --aws-account-id 111122223333
1667
- # —-template-id reports_test_template --version-number 2 `
1668
- #
1669
- # * `aws quicksight delete-template —aws-account-id 111122223333
1670
- # —template-id reports_test_template —alias-name STAGING `
1671
- #
1672
- # * `aws quicksight delete-template —aws-account-id 111122223333
1673
- # —template-id reports_test_template —alias-name ‘\$LATEST’ `
1674
- #
1675
- # * `aws quicksight delete-template --aws-account-id 111122223333
1676
- # —-template-id reports_test_template`
1677
- #
1678
- # If version number which is an optional field is not passed the
1679
- # template (including all the versions) is deleted by the API, if
1680
- # version number is provided, the specific template version is deleted
1681
- # by the API.
1682
- #
1683
- # Users can explicitly describe the latest version of the template by
1684
- # passing `$LATEST` to the `alias-name` parameter. `$LATEST` is an
1685
- # internally supported alias, which points to the latest version of the
1686
- # template.
1687
- #
1688
1472
  # @option params [required, String] :aws_account_id
1689
1473
  # AWS account ID that contains the template you are deleting.
1690
1474
  #
@@ -1692,7 +1476,9 @@ module Aws::QuickSight
1692
1476
  # An ID for the template you want to delete.
1693
1477
  #
1694
1478
  # @option params [Integer] :version_number
1695
- # The version number
1479
+ # Specifies the version of the template that you want to delete. If you
1480
+ # don't provide a version number, `DeleteTemplate` deletes all versions
1481
+ # of the template.
1696
1482
  #
1697
1483
  # @return [Types::DeleteTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1698
1484
  #
@@ -1727,11 +1513,6 @@ module Aws::QuickSight
1727
1513
 
1728
1514
  # Update template alias of given template.
1729
1515
  #
1730
- # CLI syntax:
1731
- #
1732
- # `aws quicksight delete-template-alias --aws-account-id 111122223333
1733
- # --template-id 'reports_test_template' --alias-name 'STAGING'`
1734
- #
1735
1516
  # @option params [required, String] :aws_account_id
1736
1517
  # AWS account ID that contains the template alias you are deleting.
1737
1518
  #
@@ -1739,9 +1520,10 @@ module Aws::QuickSight
1739
1520
  # An ID for the template.
1740
1521
  #
1741
1522
  # @option params [required, String] :alias_name
1742
- # The alias of the template. If alias-name is provided, the version that
1743
- # the alias-name points to is deleted. Alias names that start with `$`
1744
- # are reserved by QuickSight and can't be deleted.”
1523
+ # The alias of the template that you want to delete. If you provide a
1524
+ # specific alias, you delete the version that the alias points to. You
1525
+ # can specify the latest version of the template by providing the
1526
+ # keyword `$LATEST` in the `AliasName` parameter.
1745
1527
  #
1746
1528
  # @return [Types::DeleteTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1747
1529
  #
@@ -1781,11 +1563,6 @@ module Aws::QuickSight
1781
1563
  # that's making the call. The IAM user isn't deleted as a result of
1782
1564
  # this call.
1783
1565
  #
1784
- # **CLI Sample:**
1785
- #
1786
- # `aws quicksight delete-user --aws-account-id=111122223333
1787
- # --namespace=default --user-name=Pat `
1788
- #
1789
1566
  # @option params [required, String] :user_name
1790
1567
  # The name of the user that you want to delete.
1791
1568
  #
@@ -1825,12 +1602,6 @@ module Aws::QuickSight
1825
1602
 
1826
1603
  # Deletes a user identified by its principal ID.
1827
1604
  #
1828
- # **CLI Sample:**
1829
- #
1830
- # `aws quicksight delete-user-by-principal-id
1831
- # --aws-account-id=111122223333 --namespace=default
1832
- # --principal-id=ABCDEFJA26JLI7EUUOEHS `
1833
- #
1834
1605
  # @option params [required, String] :principal_id
1835
1606
  # The principal ID of the user.
1836
1607
  #
@@ -1870,14 +1641,6 @@ module Aws::QuickSight
1870
1641
 
1871
1642
  # Provides a summary for a dashboard.
1872
1643
  #
1873
- # CLI syntax:
1874
- #
1875
- # * `aws quicksight describe-dashboard --aws-account-id 111122223333
1876
- # —dashboard-id reports_test_report -version-number 2`
1877
- #
1878
- # * ` aws quicksight describe-dashboard --aws-account-id 111122223333
1879
- # —dashboard-id reports_test_report -alias-name ‘$PUBLISHED’ `
1880
- #
1881
1644
  # @option params [required, String] :aws_account_id
1882
1645
  # AWS account ID that contains the dashboard you are describing.
1883
1646
  #
@@ -1937,11 +1700,6 @@ module Aws::QuickSight
1937
1700
 
1938
1701
  # Describes read and write permissions on a dashboard.
1939
1702
  #
1940
- # CLI syntax:
1941
- #
1942
- # `aws quicksight describe-dashboard-permissions --aws-account-id
1943
- # 735340738645 —dashboard-id reports_test_bob_report`
1944
- #
1945
1703
  # @option params [required, String] :aws_account_id
1946
1704
  # AWS account ID that contains the dashboard you are describing
1947
1705
  # permissions of.
@@ -1986,20 +1744,12 @@ module Aws::QuickSight
1986
1744
 
1987
1745
  # Describes a dataset.
1988
1746
  #
1989
- # CLI syntax:
1990
- #
1991
- # `aws quicksight describe-data-set `
1992
- #
1993
- # `--aws-account-id=111111111111 `
1994
- #
1995
- # `--data-set-id=unique-data-set-id`
1996
- #
1997
1747
  # @option params [required, String] :aws_account_id
1998
1748
  # The AWS Account ID.
1999
1749
  #
2000
1750
  # @option params [required, String] :data_set_id
2001
- # The ID for the dataset you want to create. This is unique per region
2002
- # per AWS account.
1751
+ # The ID for the dataset that you want to create. This ID is unique per
1752
+ # AWS Region for each AWS account.
2003
1753
  #
2004
1754
  # @return [Types::DescribeDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2005
1755
  #
@@ -2093,22 +1843,14 @@ module Aws::QuickSight
2093
1843
  # Describes the permissions on a dataset.
2094
1844
  #
2095
1845
  # The permissions resource is
2096
- # `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`
2097
- #
2098
- # CLI syntax:
2099
- #
2100
- # `aws quicksight describe-data-set-permissions `
2101
- #
2102
- # `--aws-account-id=111122223333 `
2103
- #
2104
- # `--data-set-id=unique-data-set-id `
1846
+ # `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
2105
1847
  #
2106
1848
  # @option params [required, String] :aws_account_id
2107
1849
  # The AWS Account ID.
2108
1850
  #
2109
1851
  # @option params [required, String] :data_set_id
2110
- # The ID for the dataset you want to create. This is unique per region
2111
- # per AWS account.
1852
+ # The ID for the dataset that you want to create. This ID is unique per
1853
+ # AWS Region for each AWS account.
2112
1854
  #
2113
1855
  # @return [Types::DescribeDataSetPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2114
1856
  #
@@ -2147,15 +1889,12 @@ module Aws::QuickSight
2147
1889
 
2148
1890
  # Describes a data source.
2149
1891
  #
2150
- # The permissions resource is
2151
- # `arn:aws:quicksight:region:aws-account-id:datasource/data-source-id`
2152
- #
2153
1892
  # @option params [required, String] :aws_account_id
2154
1893
  # The AWS account ID.
2155
1894
  #
2156
1895
  # @option params [required, String] :data_source_id
2157
- # The ID of the data source. This is unique per AWS Region per AWS
2158
- # account.
1896
+ # The ID of the data source. This ID is unique per AWS Region for each
1897
+ # AWS account.
2159
1898
  #
2160
1899
  # @return [Types::DescribeDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2161
1900
  #
@@ -2241,15 +1980,12 @@ module Aws::QuickSight
2241
1980
 
2242
1981
  # Describes the resource permissions for a data source.
2243
1982
  #
2244
- # The permissions resource is
2245
- # `aws:quicksight:region:aws-account-id:datasource/data-source-id`
2246
- #
2247
1983
  # @option params [required, String] :aws_account_id
2248
1984
  # The AWS account ID.
2249
1985
  #
2250
1986
  # @option params [required, String] :data_source_id
2251
- # The ID of the data source. This is unique per AWS Region per AWS
2252
- # account.
1987
+ # The ID of the data source. This ID is unique per AWS Region for each
1988
+ # AWS account.
2253
1989
  #
2254
1990
  # @return [Types::DescribeDataSourcePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2255
1991
  #
@@ -2289,17 +2025,6 @@ module Aws::QuickSight
2289
2025
  # Returns an Amazon QuickSight group's description and Amazon Resource
2290
2026
  # Name (ARN).
2291
2027
  #
2292
- # The permissions resource is
2293
- # `arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name>
2294
- # `.
2295
- #
2296
- # The response is the group object.
2297
- #
2298
- # **CLI Sample:**
2299
- #
2300
- # `aws quicksight describe-group -\-aws-account-id=11112222333
2301
- # -\-namespace=default -\-group-name=Sales `
2302
- #
2303
2028
  # @option params [required, String] :group_name
2304
2029
  # The name of the group that you want to describe.
2305
2030
  #
@@ -2346,12 +2071,6 @@ module Aws::QuickSight
2346
2071
  # Describes an existing IAMPolicy Assignment by specified assignment
2347
2072
  # name.
2348
2073
  #
2349
- # CLI syntax:
2350
- #
2351
- # `aws quicksight describe-iam-policy-assignment
2352
- # --aws-account-id=111122223333 --assignment-name=testtest
2353
- # --namespace=default --region=us-east-1 `
2354
- #
2355
2074
  # @option params [required, String] :aws_account_id
2356
2075
  # The AWS account ID that contains the assignment you want to describe.
2357
2076
  #
@@ -2452,22 +2171,6 @@ module Aws::QuickSight
2452
2171
 
2453
2172
  # Describes a template's metadata.
2454
2173
  #
2455
- # CLI syntax:
2456
- #
2457
- # `aws quicksight describe-template --aws-account-id 111122223333
2458
- # --template-id reports_test_template `
2459
- #
2460
- # `aws quicksight describe-template --aws-account-id 111122223333
2461
- # --template-id reports_test_template --version-number-2`
2462
- #
2463
- # `aws quicksight describe-template --aws-account-id 111122223333
2464
- # --template-id reports_test_template --alias-name '\$LATEST' `
2465
- #
2466
- # Users can explicitly describe the latest version of the dashboard by
2467
- # passing `$LATEST` to the `alias-name` parameter. `$LATEST` is an
2468
- # internally supported alias, which points to the latest version of the
2469
- # dashboard.
2470
- #
2471
2174
  # @option params [required, String] :aws_account_id
2472
2175
  # AWS account ID that contains the template you are describing.
2473
2176
  #
@@ -2480,10 +2183,11 @@ module Aws::QuickSight
2480
2183
  # version of the template is described.
2481
2184
  #
2482
2185
  # @option params [String] :alias_name
2483
- # This is an optional field, when an alias name is provided, the version
2484
- # referenced by the alias is described. Refer to `CreateTemplateAlias`
2485
- # to create a template alias. `$PUBLISHED` is not supported for
2486
- # template.
2186
+ # The alias of the template that you want to describe. If you provide a
2187
+ # specific alias, you describe the version that the alias points to. You
2188
+ # can specify the latest version of the template by providing the
2189
+ # keyword `$LATEST` in the `AliasName` parameter. The keyword
2190
+ # `$PUBLISHED` doesn't apply to templates.
2487
2191
  #
2488
2192
  # @return [Types::DescribeTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2489
2193
  #
@@ -2537,11 +2241,6 @@ module Aws::QuickSight
2537
2241
 
2538
2242
  # Describes the template aliases of a template.
2539
2243
  #
2540
- # CLI syntax:
2541
- #
2542
- # `aws quicksight describe-template-alias --aws-account-id 111122223333
2543
- # --template-id 'reports_test_template' --alias-name 'STAGING'`
2544
- #
2545
2244
  # @option params [required, String] :aws_account_id
2546
2245
  # AWS account ID that contains the template alias you are describing.
2547
2246
  #
@@ -2549,7 +2248,11 @@ module Aws::QuickSight
2549
2248
  # An ID for the template.
2550
2249
  #
2551
2250
  # @option params [required, String] :alias_name
2552
- # The alias name. `$PUBLISHED` is not supported for template.
2251
+ # The alias of the template that you want to describe. If you provide a
2252
+ # specific alias, you describe the version that the alias points to. You
2253
+ # can specify the latest version of the template by providing the
2254
+ # keyword `$LATEST` in the `AliasName` parameter. The keyword
2255
+ # `$PUBLISHED` doesn't apply to templates.
2553
2256
  #
2554
2257
  # @return [Types::DescribeTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2555
2258
  #
@@ -2584,11 +2287,6 @@ module Aws::QuickSight
2584
2287
 
2585
2288
  # Describes read and write permissions on a template.
2586
2289
  #
2587
- # CLI syntax:
2588
- #
2589
- # `aws quicksight describe-template-permissions —aws-account-id
2590
- # 735340738645 —template-id reports_test_template`
2591
- #
2592
2290
  # @option params [required, String] :aws_account_id
2593
2291
  # AWS account ID that contains the template you are describing.
2594
2292
  #
@@ -2632,15 +2330,6 @@ module Aws::QuickSight
2632
2330
 
2633
2331
  # Returns information about a user, given the user name.
2634
2332
  #
2635
- # The response is a user object that contains the user's Amazon
2636
- # Resource Name (ARN), AWS Identity and Access Management (IAM) role,
2637
- # and email address.
2638
- #
2639
- # **CLI Sample:**
2640
- #
2641
- # `aws quicksight describe-user --aws-account-id=111122223333
2642
- # --namespace=default --user-name=Pat `
2643
- #
2644
2333
  # @option params [required, String] :user_name
2645
2334
  # The name of the user that you want to describe.
2646
2335
  #
@@ -2688,49 +2377,18 @@ module Aws::QuickSight
2688
2377
 
2689
2378
  # Generates a server-side embeddable URL and authorization code. Before
2690
2379
  # this can work properly, first you need to configure the dashboards and
2691
- # user permissions. For more information, see [ Embedding Amazon
2692
- # QuickSight Dashboards][1].
2380
+ # user permissions. For more information, see the Amazon QuickSight User
2381
+ # Guide section on [Embedding Amazon QuickSight Dashboards][1] or see
2382
+ # the Amazon QuickSight API Reference section on [Embedding Amazon
2383
+ # QuickSight Dashboards][2] .
2693
2384
  #
2694
2385
  # Currently, you can use `GetDashboardEmbedURL` only from the server,
2695
2386
  # not from the user’s browser.
2696
2387
  #
2697
- # **CLI Sample:**
2698
- #
2699
- # Assume the role with permissions enabled for actions:
2700
- # `quickSight:RegisterUser` and `quicksight:GetDashboardEmbedURL`. You
2701
- # can use assume-role, assume-role-with-web-identity, or
2702
- # assume-role-with-saml.
2703
- #
2704
- # `aws sts assume-role --role-arn
2705
- # "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role"
2706
- # --role-session-name embeddingsession`
2707
- #
2708
- # If the user does not exist in QuickSight, register the user:
2709
- #
2710
- # `aws quicksight register-user --aws-account-id 111122223333
2711
- # --namespace default --identity-type IAM --iam-arn
2712
- # "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role"
2713
- # --user-role READER --session-name "embeddingsession" --email
2714
- # user123@example.com --region us-east-1`
2715
- #
2716
- # Get the URL for the embedded dashboard (`IAM` identity
2717
- # authentication):
2718
2388
  #
2719
- # `aws quicksight get-dashboard-embed-url --aws-account-id 111122223333
2720
- # --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type
2721
- # IAM`
2722
2389
  #
2723
- # Get the URL for the embedded dashboard (`QUICKSIGHT` identity
2724
- # authentication):
2725
- #
2726
- # `aws quicksight get-dashboard-embed-url --aws-account-id 111122223333
2727
- # --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type
2728
- # QUICKSIGHT --user-arn
2729
- # arn:aws:quicksight:us-east-1:111122223333:user/default/embedding_quicksight_dashboard_role/embeddingsession`
2730
- #
2731
- #
2732
- #
2733
- # [1]: https://docs.aws.example.com/en_us/quicksight/latest/user/embedding.html
2390
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html
2391
+ # [2]: https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html
2734
2392
  #
2735
2393
  # @option params [required, String] :aws_account_id
2736
2394
  # AWS account ID that contains the dashboard you are embedding.
@@ -2739,7 +2397,7 @@ module Aws::QuickSight
2739
2397
  # The ID for the dashboard, also added to IAM policy
2740
2398
  #
2741
2399
  # @option params [required, String] :identity_type
2742
- # The authentication method the user uses to sign in (IAM only).
2400
+ # The authentication method the user uses to sign in.
2743
2401
  #
2744
2402
  # @option params [Integer] :session_lifetime_in_minutes
2745
2403
  # How many minutes the session is valid. The session lifetime must be
@@ -2754,9 +2412,10 @@ module Aws::QuickSight
2754
2412
  # which allows the reset button.
2755
2413
  #
2756
2414
  # @option params [String] :user_arn
2757
- # The Amazon QuickSight user's ARN, for use with `QUICKSIGHT` identity
2758
- # type. You can use this for any Amazon QuickSight users in your account
2759
- # (readers, authors, or admins) authenticated as one of the following:
2415
+ # The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
2416
+ # `QUICKSIGHT` identity type. You can use this for any Amazon QuickSight
2417
+ # users in your account (readers, authors, or admins) authenticated as
2418
+ # one of the following:
2760
2419
  #
2761
2420
  # * Active Directory (AD) users or group members
2762
2421
  #
@@ -2802,11 +2461,6 @@ module Aws::QuickSight
2802
2461
  # Lists all the versions of the dashboards in the Quicksight
2803
2462
  # subscription.
2804
2463
  #
2805
- # CLI syntax:
2806
- #
2807
- # aws quicksight list-template-versions —aws-account-id 111122223333
2808
- # —template-id reports-test-template
2809
- #
2810
2464
  # @option params [required, String] :aws_account_id
2811
2465
  # AWS account ID that contains the dashboard you are listing.
2812
2466
  #
@@ -2860,11 +2514,6 @@ module Aws::QuickSight
2860
2514
 
2861
2515
  # Lists dashboards in the AWS account.
2862
2516
  #
2863
- # CLI syntax:
2864
- #
2865
- # `aws quicksight list-dashboards --aws-account-id 111122223333
2866
- # --max-results 5 —next-token 'next-10'`
2867
- #
2868
2517
  # @option params [required, String] :aws_account_id
2869
2518
  # AWS account ID that contains the dashboards you are listing.
2870
2519
  #
@@ -2916,10 +2565,7 @@ module Aws::QuickSight
2916
2565
  # Lists all of the datasets belonging to this account in an AWS region.
2917
2566
  #
2918
2567
  # The permissions resource is
2919
- # `arn:aws:quicksight:region:aws-account-id:dataset/*`
2920
- #
2921
- # CLI syntax: `aws quicksight list-data-sets
2922
- # --aws-account-id=111111111111`
2568
+ # `arn:aws:quicksight:region:aws-account-id:dataset/*`.
2923
2569
  #
2924
2570
  # @option params [required, String] :aws_account_id
2925
2571
  # The AWS Account ID.
@@ -2970,15 +2616,9 @@ module Aws::QuickSight
2970
2616
  req.send_request(options)
2971
2617
  end
2972
2618
 
2973
- # Lists data sources in current AWS region that belong to this AWS
2619
+ # Lists data sources in current AWS Region that belong to this AWS
2974
2620
  # account.
2975
2621
  #
2976
- # The permissions resource is:
2977
- # `arn:aws:quicksight:region:aws-account-id:datasource/*`
2978
- #
2979
- # CLI syntax: `aws quicksight list-data-sources
2980
- # --aws-account-id=111122223333`
2981
- #
2982
2622
  # @option params [required, String] :aws_account_id
2983
2623
  # The AWS account ID.
2984
2624
  #
@@ -3077,17 +2717,6 @@ module Aws::QuickSight
3077
2717
 
3078
2718
  # Lists member users in a group.
3079
2719
  #
3080
- # The permissions resource is
3081
- # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name>
3082
- # `.
3083
- #
3084
- # The response is a list of group member objects.
3085
- #
3086
- # **CLI Sample:**
3087
- #
3088
- # `aws quicksight list-group-memberships -\-aws-account-id=111122223333
3089
- # -\-namespace=default `
3090
- #
3091
2720
  # @option params [required, String] :group_name
3092
2721
  # The name of the group that you want to see a membership list of.
3093
2722
  #
@@ -3142,16 +2771,6 @@ module Aws::QuickSight
3142
2771
 
3143
2772
  # Lists all user groups in Amazon QuickSight.
3144
2773
  #
3145
- # The permissions resource is
3146
- # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*`.
3147
- #
3148
- # The response is a list of group objects.
3149
- #
3150
- # **CLI Sample:**
3151
- #
3152
- # `aws quicksight list-groups -\-aws-account-id=111122223333
3153
- # -\-namespace=default `
3154
- #
3155
2774
  # @option params [required, String] :aws_account_id
3156
2775
  # The ID for the AWS account that the group is in. Currently, you use
3157
2776
  # the ID for the AWS account that contains your Amazon QuickSight
@@ -3204,13 +2823,6 @@ module Aws::QuickSight
3204
2823
 
3205
2824
  # Lists assignments in current QuickSight account.
3206
2825
  #
3207
- # CLI syntax:
3208
- #
3209
- # `aws quicksight list-iam-policy-assignments
3210
- # --aws-account-id=111122223333 --max-result=5
3211
- # --assignment-status=ENABLED --namespace=default --region=us-east-1
3212
- # --next-token=3 `
3213
- #
3214
2826
  # @option params [required, String] :aws_account_id
3215
2827
  # The AWS account ID that contains this IAM policy assignment.
3216
2828
  #
@@ -3262,15 +2874,9 @@ module Aws::QuickSight
3262
2874
  req.send_request(options)
3263
2875
  end
3264
2876
 
3265
- # Lists all the assignments and the ARNs for the associated IAM policies
3266
- # assigned to the specified user and the group or groups that the user
3267
- # belongs to.
3268
- #
3269
- # CLI syntax:
3270
- #
3271
- # `aws quicksight list-iam-policy-assignments-for-user
3272
- # --aws-account-id=111122223333 --user-name=user5 --namespace=default
3273
- # --max-result=6 --region=us-east-1 `
2877
+ # Lists all the assignments and the Amazon Resource Names (ARNs) for the
2878
+ # associated IAM policies assigned to the specified user and the group
2879
+ # or groups that the user belongs to.
3274
2880
  #
3275
2881
  # @option params [required, String] :aws_account_id
3276
2882
  # The AWS account ID that contains the assignment.
@@ -3386,16 +2992,9 @@ module Aws::QuickSight
3386
2992
 
3387
2993
  # Lists the tags assigned to a resource.
3388
2994
  #
3389
- # CLI syntax:
3390
- #
3391
- # * `aws quicksight list-tags-for-resource --resource-arn
3392
- # arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --region
3393
- # us-east-1`
3394
- #
3395
- # ^
3396
- #
3397
2995
  # @option params [required, String] :resource_arn
3398
- # The ARN of the resource you want a list of tags for.
2996
+ # The Amazon Resource Name (ARN) of the resource that you want a list of
2997
+ # tags for.
3399
2998
  #
3400
2999
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3401
3000
  #
@@ -3428,11 +3027,6 @@ module Aws::QuickSight
3428
3027
 
3429
3028
  # Lists all the aliases of a template.
3430
3029
  #
3431
- # CLI syntax:
3432
- #
3433
- # `aws quicksight list-template-aliases --aws-account-id 111122223333
3434
- # —template-id 'reports_test_template'`
3435
- #
3436
3030
  # @option params [required, String] :aws_account_id
3437
3031
  # AWS account ID that contains the template aliases you are listing.
3438
3032
  #
@@ -3483,11 +3077,6 @@ module Aws::QuickSight
3483
3077
 
3484
3078
  # Lists all the versions of the templates in the Quicksight account.
3485
3079
  #
3486
- # CLI syntax:
3487
- #
3488
- # aws quicksight list-template-versions --aws-account-id 111122223333
3489
- # --aws-account-id 196359894473 --template-id reports-test-template
3490
- #
3491
3080
  # @option params [required, String] :aws_account_id
3492
3081
  # AWS account ID that contains the templates you are listing.
3493
3082
  #
@@ -3540,11 +3129,6 @@ module Aws::QuickSight
3540
3129
 
3541
3130
  # Lists all the templates in the QuickSight account.
3542
3131
  #
3543
- # CLI syntax:
3544
- #
3545
- # `aws quicksight list-templates --aws-account-id 111122223333
3546
- # --max-results 1 —next-token AYADeJuxwOypAndSoOn`
3547
- #
3548
3132
  # @option params [required, String] :aws_account_id
3549
3133
  # AWS account ID that contains the templates you are listing.
3550
3134
  #
@@ -3595,14 +3179,6 @@ module Aws::QuickSight
3595
3179
  # Lists the Amazon QuickSight groups that an Amazon QuickSight user is a
3596
3180
  # member of.
3597
3181
  #
3598
- # The response is a one or more group objects.
3599
- #
3600
- # **CLI Sample:**
3601
- #
3602
- # `aws quicksight list-user-groups -\-user-name=Pat
3603
- # -\-aws-account-id=111122223333 -\-namespace=default
3604
- # -\-region=us-east-1 `
3605
- #
3606
3182
  # @option params [required, String] :user_name
3607
3183
  # The Amazon QuickSight user name that you want to list group
3608
3184
  # memberships for.
@@ -3660,15 +3236,6 @@ module Aws::QuickSight
3660
3236
  # Returns a list of all of the Amazon QuickSight users belonging to this
3661
3237
  # account.
3662
3238
  #
3663
- # The response is a list of user objects, containing each user's Amazon
3664
- # Resource Name (ARN), AWS Identity and Access Management (IAM) role,
3665
- # and email address.
3666
- #
3667
- # **CLI Sample:**
3668
- #
3669
- # `aws quicksight list-users --aws-account-id=111122223333
3670
- # --namespace=default `
3671
- #
3672
3239
  # @option params [required, String] :aws_account_id
3673
3240
  # The ID for the AWS account that the user is in. Currently, you use the
3674
3241
  # ID for the AWS account that contains your Amazon QuickSight account.
@@ -3725,12 +3292,6 @@ module Aws::QuickSight
3725
3292
  # the AWS Identity and Access Management (IAM) identity or role
3726
3293
  # specified in the request.
3727
3294
  #
3728
- # **CLI Sample:**
3729
- #
3730
- # `aws quicksight register-user -\-aws-account-id=111122223333
3731
- # -\-namespace=default -\-email=pat@example.com -\-identity-type=IAM
3732
- # -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat `
3733
- #
3734
3295
  # @option params [required, String] :identity_type
3735
3296
  # Amazon QuickSight supports several ways of managing the identity of
3736
3297
  # users. This parameter accepts two values:
@@ -3829,42 +3390,33 @@ module Aws::QuickSight
3829
3390
  req.send_request(options)
3830
3391
  end
3831
3392
 
3832
- # Assigns a tag or tags to a resource.
3833
- #
3834
3393
  # Assigns one or more tags (key-value pairs) to the specified QuickSight
3835
- # resource. Tags can help you organize and categorize your resources.
3836
- # You can also use them to scope user permissions, by granting a user
3837
- # permission to access or change only resources with certain tag values.
3838
- # You can use the TagResource action with a resource that already has
3839
- # tags. If you specify a new tag key for the resource, this tag is
3840
- # appended to the list of tags associated with the resource. If you
3841
- # specify a tag key that is already associated with the resource, the
3842
- # new tag value that you specify replaces the previous value for that
3843
- # tag.
3394
+ # resource.
3395
+ #
3396
+ # Tags can help you organize and categorize your resources. You can also
3397
+ # use them to scope user permissions, by granting a user permission to
3398
+ # access or change only resources with certain tag values. You can use
3399
+ # the `TagResource` operation with a resource that already has tags. If
3400
+ # you specify a new tag key for the resource, this tag is appended to
3401
+ # the list of tags associated with the resource. If you specify a tag
3402
+ # key that is already associated with the resource, the new tag value
3403
+ # that you specify replaces the previous value for that tag.
3844
3404
  #
3845
3405
  # You can associate as many as 50 tags with a resource. QuickSight
3846
- # supports tagging on data-set, data-source, dashboard, template.
3406
+ # supports tagging on data set, data source, dashboard, and template.
3847
3407
  #
3848
- # Tagging for QuickSight works in a similar was to tagging for other AWS
3408
+ # Tagging for QuickSight works in a similar way to tagging for other AWS
3849
3409
  # services, except for the following:
3850
3410
  #
3851
- # * You can't use tags to track AWS costs for QuickSight, because
3852
- # QuickSight costs are based on users and SPICE capacity, which
3853
- # aren't taggable resources.
3411
+ # * You can't use tags to track AWS costs for QuickSight. This
3412
+ # restriction is because QuickSight costs are based on users and SPICE
3413
+ # capacity, which aren't taggable resources.
3854
3414
  #
3855
3415
  # * QuickSight doesn't currently support the Tag Editor for AWS
3856
3416
  # Resource Groups.
3857
3417
  #
3858
- # CLI syntax to tag a resource:
3859
- #
3860
- # * `aws quicksight tag-resource --resource-arn
3861
- # arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --tags
3862
- # Key=K1,Value=V1 Key=K2,Value=V2 --region us-east-1`
3863
- #
3864
- # ^
3865
- #
3866
3418
  # @option params [required, String] :resource_arn
3867
- # The ARN of the resource you want to tag.
3419
+ # The Amazon Resource Name (ARN) of the resource that you want to tag.
3868
3420
  #
3869
3421
  # @option params [required, Array<Types::Tag>] :tags
3870
3422
  # Contains a map of the key-value pairs for the resource tag or tags
@@ -3903,16 +3455,8 @@ module Aws::QuickSight
3903
3455
 
3904
3456
  # Removes a tag or tags from a resource.
3905
3457
  #
3906
- # CLI syntax:
3907
- #
3908
- # * `aws quicksight untag-resource --resource-arn
3909
- # arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1
3910
- # --tag-keys K1 K2 --region us-east-1`
3911
- #
3912
- # ^
3913
- #
3914
3458
  # @option params [required, String] :resource_arn
3915
- # The ARN of the resource you to untag.
3459
+ # The Amazon Resource Name (ARN) of the resource that you want to untag.
3916
3460
  #
3917
3461
  # @option params [required, Array<String>] :tag_keys
3918
3462
  # The keys of the key-value pairs for the resource tag or tags assigned
@@ -3946,18 +3490,6 @@ module Aws::QuickSight
3946
3490
 
3947
3491
  # Updates a dashboard in the AWS account.
3948
3492
  #
3949
- # CLI syntax:
3950
- #
3951
- # `aws quicksight update-dashboard --aws-account-id 111122223333
3952
- # --dashboard-id 123123123 --dashboard-name "test-update102"
3953
- # --source-entity
3954
- # SourceTemplate=\{Arn=arn:aws:quicksight:us-west-2:111122223333:template/sales-report-template2\}
3955
- # --data-set-references
3956
- # DataSetPlaceholder=SalesDataSet,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/0e251aef-9ebf-46e1-b852-eb4fa33c1d3a`
3957
- #
3958
- # `aws quicksight update-dashboard --cli-input-json
3959
- # file://update-dashboard.json `
3960
- #
3961
3493
  # @option params [required, String] :aws_account_id
3962
3494
  # AWS account ID that contains the dashboard you are updating.
3963
3495
  #
@@ -4083,73 +3615,6 @@ module Aws::QuickSight
4083
3615
 
4084
3616
  # Updates read and write permissions on a dashboard.
4085
3617
  #
4086
- # CLI syntax:
4087
- #
4088
- # `aws quicksight update-dashboard-permissions —cli-input-json
4089
- # file://update-permission.json`
4090
- #
4091
- # A sample update-permissions.json for granting read only permissions:
4092
- #
4093
- # `\{ "AwsAccountId": "111122223333", "DashboardId":
4094
- # "reports_test_report", "GrantPermissions": [ \{ "Principal":
4095
- # "arn:aws:quicksight:us-east-1:111122223333:user/default/user2",
4096
- # "Actions": [ "quicksight:DescribeDashboard",
4097
- # "quicksight:ListDashboardVersions",
4098
- # "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard" ]
4099
- # \} ] \}`
4100
- #
4101
- # A sample update-permissions.json for granting read and write
4102
- # permissions:
4103
- #
4104
- # `\{ "AwsAccountId": "111122223333", "DashboardId":
4105
- # "reports_test_report", "GrantPermissions": [ \{ "Principal":
4106
- # "arn:aws:quicksight:us-east-1:111122223333:user/default/user2",
4107
- # "Actions": [ "quicksight:DescribeDashboard",
4108
- # "quicksight:ListDashboardVersions",
4109
- # "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard",
4110
- # "quicksight:DescribeDashboardPermissions",
4111
- # "quicksight:UpdateDashboardPermissions",
4112
- # "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard",
4113
- # "quicksight:UpdateDashboard",
4114
- # "quicksight:UpdateDashboardPublishedVersion", ] \} ] \}`
4115
- #
4116
- # A sample update-permissions.json for revoking write permissions:
4117
- #
4118
- # `\{ "AwsAccountId": "111122223333", "DashboardId":
4119
- # "reports_test_report", "RevokePermissions": [ \{ "Principal":
4120
- # "arn:aws:quicksight:us-east-1:111122223333:user/default/user2",
4121
- # "Actions": [ "quicksight:DescribeDashboardPermissions",
4122
- # "quicksight:UpdateDashboardPermissions",
4123
- # "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard",
4124
- # "quicksight:UpdateDashboard",
4125
- # "quicksight:UpdateDashboardPublishedVersion", ] \} ] \}`
4126
- #
4127
- # A sample update-permissions.json for revoking read and write
4128
- # permissions:
4129
- #
4130
- # `\{ "AwsAccountId": "111122223333", "DashboardId":
4131
- # "reports_test_report", "RevokePermissions": [ \{ "Principal":
4132
- # "arn:aws:quicksight:us-east-1:111122223333:user/default/user2",
4133
- # "Actions": [ "quicksight:DescribeDashboard",
4134
- # "quicksight:ListDashboardVersions",
4135
- # "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard",
4136
- # "quicksight:DescribeDashboardPermissions",
4137
- # "quicksight:UpdateDashboardPermissions",
4138
- # "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard",
4139
- # "quicksight:UpdateDashboard",
4140
- # "quicksight:UpdateDashboardPublishedVersion", ] \} ] \}`
4141
- #
4142
- # To obtain the principal name of a QuickSight user or group, you can
4143
- # use describe-group or describe-user. For example:
4144
- #
4145
- # `aws quicksight describe-user --aws-account-id 111122223333
4146
- # --namespace default --user-name user2 --region us-east-1 \{ "User": \{
4147
- # "Arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2",
4148
- # "Active": true, "Email": "user2@example.com", "Role": "ADMIN",
4149
- # "UserName": "user2", "PrincipalId":
4150
- # "federated/iam/abcd2abcdabcdeabc5ab5" \}, "RequestId":
4151
- # "8f74bb31-6291-448a-a71c-a765a44bae31", "Status": 200 \}`
4152
- #
4153
3618
  # @option params [required, String] :aws_account_id
4154
3619
  # AWS account ID that contains the dashboard you are updating.
4155
3620
  #
@@ -4211,11 +3676,6 @@ module Aws::QuickSight
4211
3676
 
4212
3677
  # Updates the published version of a dashboard.
4213
3678
  #
4214
- # CLI syntax:
4215
- #
4216
- # `aws quicksight update-dashboard-published-version --aws-account-id
4217
- # 111122223333 --dashboard-id dashboard-w1 ---version-number 2`
4218
- #
4219
3679
  # @option params [required, String] :aws_account_id
4220
3680
  # AWS account ID that contains the dashboard you are updating.
4221
3681
  #
@@ -4258,51 +3718,12 @@ module Aws::QuickSight
4258
3718
 
4259
3719
  # Updates a dataset.
4260
3720
  #
4261
- # CLI syntax:
4262
- #
4263
- # `aws quicksight update-data-set `
4264
- #
4265
- # `--aws-account-id=111122223333 `
4266
- #
4267
- # `--data-set-id=unique-data-set-id `
4268
- #
4269
- # `--name='My dataset' `
4270
- #
4271
- # `--import-mode=SPICE `
4272
- #
4273
- # `--physical-table-map='\{`
4274
- #
4275
- # ` "physical-table-id": \{`
4276
- #
4277
- # ` "RelationalTable": \{`
4278
- #
4279
- # ` "DataSourceArn":
4280
- # "arn:aws:quicksight:us-west-2:111111111111:datasource/data-source-id",`
4281
- #
4282
- # ` "Name": "table1",`
4283
- #
4284
- # ` "InputColumns": [`
4285
- #
4286
- # ` \{`
4287
- #
4288
- # ` "Name": "column1",`
4289
- #
4290
- # ` "Type": "STRING"`
4291
- #
4292
- # ` \}`
4293
- #
4294
- # ` ]`
4295
- #
4296
- # ` \}`
4297
- #
4298
- # ` \}'`
4299
- #
4300
3721
  # @option params [required, String] :aws_account_id
4301
3722
  # The AWS Account ID.
4302
3723
  #
4303
3724
  # @option params [required, String] :data_set_id
4304
- # The ID for the dataset you want to create. This is unique per region
4305
- # per AWS account.
3725
+ # The ID for the dataset that you want to create. This ID is unique per
3726
+ # AWS Region for each AWS account.
4306
3727
  #
4307
3728
  # @option params [required, String] :name
4308
3729
  # The display name for the dataset.
@@ -4320,7 +3741,7 @@ module Aws::QuickSight
4320
3741
  #
4321
3742
  # @option params [Array<Types::ColumnGroup>] :column_groups
4322
3743
  # Groupings of columns that work together in certain QuickSight
4323
- # features. Currently only geospatial hierarchy is supported.
3744
+ # features. Currently, only geospatial hierarchy is supported.
4324
3745
  #
4325
3746
  # @option params [Types::RowLevelPermissionDataSet] :row_level_permission_data_set
4326
3747
  # Row-level security configuration on the data you want to create.
@@ -4469,27 +3890,14 @@ module Aws::QuickSight
4469
3890
  # Updates the permissions on a dataset.
4470
3891
  #
4471
3892
  # The permissions resource is
4472
- # `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`
4473
- #
4474
- # CLI syntax:
4475
- #
4476
- # `aws quicksight update-data-set-permissions `
4477
- #
4478
- # `--aws-account-id=111122223333 `
4479
- #
4480
- # `--data-set-id=unique-data-set-id `
4481
- #
4482
- # `--grant-permissions='[\{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user1","Actions":["quicksight:DescribeDataSet","quicksight:DescribeDataSetPermissions","quicksight:PassDataSet","quicksight:ListIngestions","quicksight:DescribeIngestion"]\}]'
4483
- # `
4484
- #
4485
- # `--revoke-permissions='[\{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user2","Actions":["quicksight:UpdateDataSet","quicksight:DeleteDataSet","quicksight:UpdateDataSetPermissions","quicksight:CreateIngestion","quicksight:CancelIngestion"]\}]'`
3893
+ # `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
4486
3894
  #
4487
3895
  # @option params [required, String] :aws_account_id
4488
3896
  # The AWS Account ID.
4489
3897
  #
4490
3898
  # @option params [required, String] :data_set_id
4491
- # The ID for the dataset you want to create. This is unique per region
4492
- # per AWS account.
3899
+ # The ID for the dataset that you want to create. This ID is unique per
3900
+ # AWS Region for each AWS account.
4493
3901
  #
4494
3902
  # @option params [Array<Types::ResourcePermission>] :grant_permissions
4495
3903
  # The resource permissions that you want to grant to the dataset.
@@ -4541,48 +3949,32 @@ module Aws::QuickSight
4541
3949
 
4542
3950
  # Updates a data source.
4543
3951
  #
4544
- # The permissions resource is
4545
- # `arn:aws:quicksight:region:aws-account-id:datasource/data-source-id`
4546
- #
4547
- # CLI syntax:
4548
- #
4549
- # `aws quicksight update-data-source `
4550
- #
4551
- # `--aws-account-id=111122223333 `
4552
- #
4553
- # `--data-source-id=unique-data-source-id `
4554
- #
4555
- # `--name='My Data Source' `
4556
- #
4557
- # `--data-source-parameters='\{"PostgreSqlParameters":\{"Host":"my-db-host.example.com","Port":1234,"Database":"my-db"\}\}'
4558
- # `
4559
- #
4560
- # `--credentials='\{"CredentialPair":\{"Username":"username","Password":"password"\}\}`
4561
- #
4562
3952
  # @option params [required, String] :aws_account_id
4563
3953
  # The AWS account ID.
4564
3954
  #
4565
3955
  # @option params [required, String] :data_source_id
4566
- # The ID of the data source. This is unique per AWS Region per AWS
4567
- # account.
3956
+ # The ID of the data source. This ID is unique per AWS Region for each
3957
+ # AWS account.
4568
3958
  #
4569
3959
  # @option params [required, String] :name
4570
3960
  # A display name for the data source.
4571
3961
  #
4572
3962
  # @option params [Types::DataSourceParameters] :data_source_parameters
4573
- # The parameters QuickSight uses to connect to your underlying source.
3963
+ # The parameters that QuickSight uses to connect to your underlying
3964
+ # source.
4574
3965
  #
4575
3966
  # @option params [Types::DataSourceCredentials] :credentials
4576
- # The credentials QuickSight uses to connect to your underlying source.
4577
- # Currently only username/password based credentials are supported.
3967
+ # The credentials that QuickSight that uses to connect to your
3968
+ # underlying source. Currently, only credentials based on user name and
3969
+ # password are supported.
4578
3970
  #
4579
3971
  # @option params [Types::VpcConnectionProperties] :vpc_connection_properties
4580
- # You need to use this parameter only when you want QuickSight to use a
4581
- # VPC connection when connecting to your underlying source.
3972
+ # Use this parameter only when you want QuickSight to use a VPC
3973
+ # connection when connecting to your underlying source.
4582
3974
  #
4583
3975
  # @option params [Types::SslProperties] :ssl_properties
4584
- # SSL properties that apply when QuickSight connects to your underlying
4585
- # source.
3976
+ # Secure Socket Layer (SSL) properties that apply when QuickSight
3977
+ # connects to your underlying source.
4586
3978
  #
4587
3979
  # @return [Types::UpdateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4588
3980
  #
@@ -4717,30 +4109,12 @@ module Aws::QuickSight
4717
4109
 
4718
4110
  # Updates the permissions to a data source.
4719
4111
  #
4720
- # The permissions resource is
4721
- # `arn:aws:quicksight:region:aws-account-id:datasource/data-source-id`
4722
- #
4723
- # CLI syntax:
4724
- #
4725
- # `aws quicksight update-data-source-permissions `
4726
- #
4727
- # `--aws-account-id=111122223333 `
4728
- #
4729
- # `--data-source-id=unique-data-source-id `
4730
- #
4731
- # `--name='My Data Source' `
4732
- #
4733
- # `--grant-permissions='[\{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user1","Actions":["quicksight:DescribeDataSource","quicksight:DescribeDataSourcePermissions","quicksight:PassDataSource"]\}]'
4734
- # `
4735
- #
4736
- # `--revoke-permissions='[\{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user2","Actions":["quicksight:UpdateDataSource","quicksight:DeleteDataSource","quicksight:UpdateDataSourcePermissions"]\}]'`
4737
- #
4738
4112
  # @option params [required, String] :aws_account_id
4739
4113
  # The AWS account ID.
4740
4114
  #
4741
4115
  # @option params [required, String] :data_source_id
4742
- # The ID of the data source. This is unique per AWS Region per AWS
4743
- # account.
4116
+ # The ID of the data source. This ID is unique per AWS Region for each
4117
+ # AWS account.
4744
4118
  #
4745
4119
  # @option params [Array<Types::ResourcePermission>] :grant_permissions
4746
4120
  # A list of resource permissions that you want to grant on the data
@@ -4794,18 +4168,6 @@ module Aws::QuickSight
4794
4168
 
4795
4169
  # Changes a group description.
4796
4170
  #
4797
- # The permissions resource is
4798
- # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name>
4799
- # `.
4800
- #
4801
- # The response is a group object.
4802
- #
4803
- # **CLI Sample:**
4804
- #
4805
- # `aws quicksight update-group --aws-account-id=111122223333
4806
- # --namespace=default --group-name=Sales --description="Sales BI
4807
- # Dashboards" `
4808
- #
4809
4171
  # @option params [required, String] :group_name
4810
4172
  # The name of the group that you want to update.
4811
4173
  #
@@ -4856,15 +4218,6 @@ module Aws::QuickSight
4856
4218
  # Updates an existing assignment. This operation updates only the
4857
4219
  # optional parameter or parameters that are specified in the request.
4858
4220
  #
4859
- # CLI syntax:
4860
- #
4861
- # ``aws quicksight update-iam-policy-assignment
4862
- # --aws-account-id=111122223333 --assignment-name=FullAccessAssignment
4863
- # --assignment-status=DRAFT
4864
- # --policy-arns=arn:aws:iam::aws:policy/AdministratorAccess
4865
- # --identities="user=user-1,user-2,group=admin" --namespace=default
4866
- # --region=us-east-1
4867
- #
4868
4221
  # @option params [required, String] :aws_account_id
4869
4222
  # The AWS account ID that contains the IAM policy assignment.
4870
4223
  #
@@ -4887,8 +4240,8 @@ module Aws::QuickSight
4887
4240
  # creating the data source.
4888
4241
  #
4889
4242
  # @option params [String] :policy_arn
4890
- # An IAM policy ARN that will be applied to specified QuickSight users
4891
- # and groups in this assignment.
4243
+ # An IAM policy Amazon Resource Name (ARN) that will be applied to
4244
+ # specified QuickSight users and groups in this assignment.
4892
4245
  #
4893
4246
  # @option params [Hash<String,Array>] :identities
4894
4247
  # QuickSight users and/or groups that you want to assign to the
@@ -4940,18 +4293,6 @@ module Aws::QuickSight
4940
4293
 
4941
4294
  # Updates a template from an existing QuickSight analysis.
4942
4295
  #
4943
- # CLI syntax:
4944
- #
4945
- # `aws quicksight update-template --aws-account-id 111122223333
4946
- # --template-id reports_test_template --data-set-references
4947
- # DataSetPlaceholder=reports,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/c684a204-d134-4c53-a63c-451f72c60c28
4948
- # DataSetPlaceholder=Elblogs,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/15840b7d-b542-4491-937b-602416b367b3
4949
- # —source-entity
4950
- # SourceAnalysis=’\{Arn=arn:aws:quicksight:us-west-2:111122223333:analysis/c5731fe9-4708-4598-8f6d-cf2a70875b6d\}`
4951
- #
4952
- # You can also pass in a json file: `aws quicksight update-template
4953
- # —cli-input-json file://create-template.json`
4954
- #
4955
4296
  # @option params [required, String] :aws_account_id
4956
4297
  # AWS account ID that contains the template you are updating.
4957
4298
  #
@@ -4964,11 +4305,10 @@ module Aws::QuickSight
4964
4305
  # another template.
4965
4306
  #
4966
4307
  # @option params [String] :version_description
4967
- # A description of the current template version being created. This API
4968
- # created the first version of the template. Every time UpdateTemplate
4969
- # is called a new version is created. Each version of the template
4970
- # maintains a description of the version in the VersionDescription
4971
- # field.
4308
+ # A description of the current template version being updated. Every
4309
+ # time you cal `UpdateTemplate` you create a new version. Each version
4310
+ # of the template maintains a description of the version in the
4311
+ # `VersionDescription` field.
4972
4312
  #
4973
4313
  # @option params [String] :name
4974
4314
  # The name for the template.
@@ -5025,12 +4365,6 @@ module Aws::QuickSight
5025
4365
 
5026
4366
  # Updates the template alias of a template.
5027
4367
  #
5028
- # CLI syntax:
5029
- #
5030
- # `aws quicksight update-template-alias --aws-account-id 111122223333
5031
- # --template-id 'reports_test_template' --alias-name STAGING
5032
- # —template-version-number 2 `
5033
- #
5034
4368
  # @option params [required, String] :aws_account_id
5035
4369
  # AWS account ID that contains the template aliases you are updating.
5036
4370
  #
@@ -5038,7 +4372,11 @@ module Aws::QuickSight
5038
4372
  # The ID for the template.
5039
4373
  #
5040
4374
  # @option params [required, String] :alias_name
5041
- # The alias name.
4375
+ # The alias of the template that you want to update. If you provide a
4376
+ # specific alias, you update the version that the alias points to. You
4377
+ # can specify the latest version of the template by providing the
4378
+ # keyword `$LATEST` in the `AliasName` parameter. The keyword
4379
+ # `$PUBLISHED` doesn't apply to templates.
5042
4380
  #
5043
4381
  # @option params [required, Integer] :template_version_number
5044
4382
  # The version number of the template.
@@ -5077,90 +4415,6 @@ module Aws::QuickSight
5077
4415
 
5078
4416
  # Updates the permissions on a template.
5079
4417
  #
5080
- # CLI syntax:
5081
- #
5082
- # * `aws quicksight describe-template-permissions —aws-account-id
5083
- # 111122223333 —template-id reports_test_template`
5084
- #
5085
- # * `aws quicksight update-template-permissions —cli-input-json
5086
- # file://update-permission.json `
5087
- #
5088
- # * The structure of `update-permissions.json` to add permissions:
5089
- #
5090
- # `\{ "AwsAccountId": "111122223333",`
5091
- #
5092
- # ` "DashboardId": "reports_test_template",`
5093
- #
5094
- # ` "GrantPermissions": [`
5095
- #
5096
- # ` \{ "Principal":
5097
- # "arn:aws:quicksight:us-east-1:196359894473:user/default/user3",`
5098
- #
5099
- # ` "Actions": [`
5100
- #
5101
- # ` "quicksight:DescribeTemplate",`
5102
- #
5103
- # ` "quicksight:ListTemplateVersions"`
5104
- #
5105
- # ` ] \} ] \}`
5106
- #
5107
- # The structure of `update-permissions.json` to add permissions:
5108
- #
5109
- # `\{ "AwsAccountId": "111122223333",`
5110
- #
5111
- # ` "DashboardId": "reports_test_template",`
5112
- #
5113
- # ` "RevokePermissions": [`
5114
- #
5115
- # ` \{ "Principal":
5116
- # "arn:aws:quicksight:us-east-1:196359894473:user/default/user3",`
5117
- #
5118
- # ` "Actions": [`
5119
- #
5120
- # ` "quicksight:DescribeTemplate",`
5121
- #
5122
- # ` "quicksight:ListTemplateVersions"`
5123
- #
5124
- # ` ] \} ] \}`
5125
- #
5126
- # To obtain the principal name of a QuickSight group or user, use user
5127
- # describe-group or describe-user. For example:
5128
- #
5129
- # `aws quicksight describe-user `
5130
- #
5131
- # `--aws-account-id 111122223333`
5132
- #
5133
- # `--namespace default`
5134
- #
5135
- # `--user-name user2 `
5136
- #
5137
- # `--region us-east-1`
5138
- #
5139
- # `\{`
5140
- #
5141
- # ` "User": \{`
5142
- #
5143
- # ` "Arn":
5144
- # "arn:aws:quicksight:us-east-1:111122223333:user/default/user2",`
5145
- #
5146
- # ` "Active": true,`
5147
- #
5148
- # ` "Email": "user2@example.com",`
5149
- #
5150
- # ` "Role": "ADMIN",`
5151
- #
5152
- # ` "UserName": "user2",`
5153
- #
5154
- # ` "PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5"`
5155
- #
5156
- # ` \},`
5157
- #
5158
- # ` "RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31",`
5159
- #
5160
- # ` "Status": 200`
5161
- #
5162
- # `\}`
5163
- #
5164
4418
  # @option params [required, String] :aws_account_id
5165
4419
  # AWS account ID that contains the template.
5166
4420
  #
@@ -5168,15 +4422,10 @@ module Aws::QuickSight
5168
4422
  # The ID for the template.
5169
4423
  #
5170
4424
  # @option params [Array<Types::ResourcePermission>] :grant_permissions
5171
- # A list of resource permissions to be granted on the template. The
5172
- # following example shows the shorthand syntax:
5173
- #
5174
- # `Shorthand Syntax: Principal=string,Actions=string,string ... `
4425
+ # A list of resource permissions to be granted on the template.
5175
4426
  #
5176
4427
  # @option params [Array<Types::ResourcePermission>] :revoke_permissions
5177
4428
  # A list of resource permissions to be revoked from the template.
5178
- # Shorthand syntax: `Shorthand Syntax:
5179
- # Principal=string,Actions=string,string ... `
5180
4429
  #
5181
4430
  # @return [Types::UpdateTemplatePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5182
4431
  #
@@ -5227,17 +4476,6 @@ module Aws::QuickSight
5227
4476
 
5228
4477
  # Updates an Amazon QuickSight user.
5229
4478
  #
5230
- # The response is a user object that contains the user's Amazon
5231
- # QuickSight user name, email address, active or inactive status in
5232
- # Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name
5233
- # (ARN).
5234
- #
5235
- # **CLI Sample:**
5236
- #
5237
- # `aws quicksight update-user --user-name=Pat --role=ADMIN
5238
- # --email=new_address@example.com --aws-account-id=111122223333
5239
- # --namespace=default --region=us-east-1 `
5240
- #
5241
4479
  # @option params [required, String] :user_name
5242
4480
  # The Amazon QuickSight user name that you want to update.
5243
4481
  #
@@ -5313,7 +4551,7 @@ module Aws::QuickSight
5313
4551
  params: params,
5314
4552
  config: config)
5315
4553
  context[:gem_name] = 'aws-sdk-quicksight'
5316
- context[:gem_version] = '1.14.0'
4554
+ context[:gem_version] = '1.15.0'
5317
4555
  Seahorse::Client::Request.new(handlers, context)
5318
4556
  end
5319
4557