aws-sdk-quicksight 1.52.0 → 1.53.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-quicksight/client.rb +421 -387
- data/lib/aws-sdk-quicksight/client_api.rb +19 -0
- data/lib/aws-sdk-quicksight/types.rb +561 -449
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b18188c71f876ac69d8821772ce1aea7721d0d99cc352624a4af5a94068e4c96
|
4
|
+
data.tar.gz: 86aff86e4aa97a7046af04ef46c302bb04aadbc85380274ba4af9747a3a8d291
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5db74e252fdbd96d7870bee4ae38d79d40f83fcfc3206eeef96553ee8b12ff0573183d7246a7664ed82cb0b215077fe4441267efb7daa2b69bfa1ef4cd501515
|
7
|
+
data.tar.gz: 5bcfbced3f9e81e7a210e6dbea99cb448e98f9ebb430bcb13639374dbf88a38ba773e7e7a5f841eb9a2ad7591f61e29d8c268ef205bd97103358d927dfdf0041
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.53.0
|
@@ -330,7 +330,7 @@ module Aws::QuickSight
|
|
330
330
|
# Cancels an ongoing ingestion of data into SPICE.
|
331
331
|
#
|
332
332
|
# @option params [required, String] :aws_account_id
|
333
|
-
# The Amazon Web Services account
|
333
|
+
# The Amazon Web Services account ID.
|
334
334
|
#
|
335
335
|
# @option params [required, String] :data_set_id
|
336
336
|
# The ID of the dataset used in the ingestion.
|
@@ -372,14 +372,15 @@ module Aws::QuickSight
|
|
372
372
|
# Creates Amazon QuickSight customizations the current Amazon Web
|
373
373
|
# Services Region;. Currently, you can add a custom default theme by
|
374
374
|
# using the `CreateAccountCustomization` or `UpdateAccountCustomization`
|
375
|
-
# API operation. To further customize QuickSight by removing
|
376
|
-
# sample assets and videos for all new users, see
|
377
|
-
# QuickSight][1] in the *Amazon QuickSight User
|
375
|
+
# API operation. To further customize Amazon QuickSight by removing
|
376
|
+
# Amazon QuickSight sample assets and videos for all new users, see
|
377
|
+
# [Customizing Amazon QuickSight][1] in the *Amazon QuickSight User
|
378
|
+
# Guide.*
|
378
379
|
#
|
379
|
-
# You can create customizations for your Amazon Web Services account
|
380
|
-
#
|
380
|
+
# You can create customizations for your Amazon Web Services account or,
|
381
|
+
# if you specify a namespace, for a Amazon QuickSight namespace instead.
|
381
382
|
# Customizations that apply to a namespace always override
|
382
|
-
# customizations that apply to an Amazon Web Services account
|
383
|
+
# customizations that apply to an Amazon Web Services account. To find
|
383
384
|
# out which customizations apply, use the `DescribeAccountCustomization`
|
384
385
|
# API operation.
|
385
386
|
#
|
@@ -397,16 +398,17 @@ module Aws::QuickSight
|
|
397
398
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html
|
398
399
|
#
|
399
400
|
# @option params [required, String] :aws_account_id
|
400
|
-
# The ID for the Amazon Web Services account
|
401
|
-
# QuickSight for.
|
401
|
+
# The ID for the Amazon Web Services account that you want to customize
|
402
|
+
# Amazon QuickSight for.
|
402
403
|
#
|
403
404
|
# @option params [String] :namespace
|
404
|
-
# The QuickSight namespace that you want to add customizations
|
405
|
+
# The Amazon QuickSight namespace that you want to add customizations
|
406
|
+
# to.
|
405
407
|
#
|
406
408
|
# @option params [required, Types::AccountCustomization] :account_customization
|
407
|
-
# The QuickSight customizations you're adding in the current
|
408
|
-
# Services Region;. You can add these to an Amazon Web
|
409
|
-
# and a QuickSight namespace.
|
409
|
+
# The Amazon QuickSight customizations you're adding in the current
|
410
|
+
# Amazon Web Services Region;. You can add these to an Amazon Web
|
411
|
+
# Services account and a Amazon QuickSight namespace.
|
410
412
|
#
|
411
413
|
# For example, you can add a default theme by setting
|
412
414
|
# `AccountCustomization` to the midnight theme: `"AccountCustomization":
|
@@ -465,7 +467,7 @@ module Aws::QuickSight
|
|
465
467
|
# Creates an analysis in Amazon QuickSight.
|
466
468
|
#
|
467
469
|
# @option params [required, String] :aws_account_id
|
468
|
-
# The ID of the Amazon Web Services account
|
470
|
+
# The ID of the Amazon Web Services account where you are creating an
|
469
471
|
# analysis.
|
470
472
|
#
|
471
473
|
# @option params [required, String] :analysis_id
|
@@ -474,7 +476,7 @@ module Aws::QuickSight
|
|
474
476
|
#
|
475
477
|
# @option params [required, String] :name
|
476
478
|
# A descriptive name for the analysis that you're creating. This name
|
477
|
-
# displays for the analysis in the QuickSight console.
|
479
|
+
# displays for the analysis in the Amazon QuickSight console.
|
478
480
|
#
|
479
481
|
# @option params [Types::Parameters] :parameters
|
480
482
|
# The parameter names and override values that you want to use. An
|
@@ -497,8 +499,8 @@ module Aws::QuickSight
|
|
497
499
|
#
|
498
500
|
# @option params [String] :theme_arn
|
499
501
|
# The ARN for the theme to apply to the analysis that you're creating.
|
500
|
-
# To see the theme in the QuickSight console, make sure that you
|
501
|
-
# access to it.
|
502
|
+
# To see the theme in the Amazon QuickSight console, make sure that you
|
503
|
+
# have access to it.
|
502
504
|
#
|
503
505
|
# @option params [Array<Types::Tag>] :tags
|
504
506
|
# Contains a map of the key-value pairs for the resource tag or tags
|
@@ -590,19 +592,19 @@ module Aws::QuickSight
|
|
590
592
|
# Creates a dashboard from a template. To first create a template, see
|
591
593
|
# the ` CreateTemplate ` API operation.
|
592
594
|
#
|
593
|
-
# A dashboard is an entity in QuickSight that identifies
|
594
|
-
# reports, created from analyses. You can share
|
595
|
-
# With the right permissions, you can create
|
596
|
-
# from them. If you have the correct
|
597
|
-
# dashboard from a template that exists in
|
598
|
-
# Services account
|
595
|
+
# A dashboard is an entity in Amazon QuickSight that identifies Amazon
|
596
|
+
# QuickSight reports, created from analyses. You can share Amazon
|
597
|
+
# QuickSight dashboards. With the right permissions, you can create
|
598
|
+
# scheduled email reports from them. If you have the correct
|
599
|
+
# permissions, you can create a dashboard from a template that exists in
|
600
|
+
# a different Amazon Web Services account.
|
599
601
|
#
|
600
602
|
# @option params [required, String] :aws_account_id
|
601
|
-
# The ID of the Amazon Web Services account
|
602
|
-
#
|
603
|
+
# The ID of the Amazon Web Services account where you want to create the
|
604
|
+
# dashboard.
|
603
605
|
#
|
604
606
|
# @option params [required, String] :dashboard_id
|
605
|
-
# The ID for the dashboard, also added to the
|
607
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
606
608
|
#
|
607
609
|
# @option params [required, String] :name
|
608
610
|
# The display name of the dashboard.
|
@@ -614,8 +616,8 @@ module Aws::QuickSight
|
|
614
616
|
#
|
615
617
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
616
618
|
# A structure that contains the permissions of the dashboard. You can
|
617
|
-
# use this structure for granting permissions by providing a list of
|
618
|
-
#
|
619
|
+
# use this structure for granting permissions by providing a list of
|
620
|
+
# IAMaction information for each principal ARN.
|
619
621
|
#
|
620
622
|
# To specify no permissions, omit the permissions list.
|
621
623
|
#
|
@@ -627,8 +629,8 @@ module Aws::QuickSight
|
|
627
629
|
# from an analysis, first convert the analysis to a template by using
|
628
630
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
629
631
|
# Amazon Resource Name (ARN) of the source template. The
|
630
|
-
# `SourceTemplate`ARN can contain any Amazon Web Services account
|
631
|
-
# any QuickSight-supported Amazon Web Services Region;.
|
632
|
+
# `SourceTemplate`ARN can contain any Amazon Web Services account and
|
633
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
632
634
|
#
|
633
635
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
634
636
|
# replacement datasets for the placeholders listed in the original. The
|
@@ -646,9 +648,9 @@ module Aws::QuickSight
|
|
646
648
|
#
|
647
649
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
|
648
650
|
# either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
649
|
-
# QuickSight disables the left filter pane on the published
|
650
|
-
# which can be used for ad hoc (one-time) filtering. This
|
651
|
-
# `ENABLED` by default.
|
651
|
+
# Amazon QuickSight disables the left filter pane on the published
|
652
|
+
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
653
|
+
# option is `ENABLED` by default.
|
652
654
|
#
|
653
655
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
654
656
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
@@ -663,7 +665,7 @@ module Aws::QuickSight
|
|
663
665
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
664
666
|
# this dashboard. If you add a value for this field, it overrides the
|
665
667
|
# value that is used in the source entity. The theme ARN must exist in
|
666
|
-
# the same Amazon Web Services account
|
668
|
+
# the same Amazon Web Services account where you create the dashboard.
|
667
669
|
#
|
668
670
|
# @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
669
671
|
#
|
@@ -765,11 +767,11 @@ module Aws::QuickSight
|
|
765
767
|
# Creates a dataset.
|
766
768
|
#
|
767
769
|
# @option params [required, String] :aws_account_id
|
768
|
-
# The Amazon Web Services account
|
770
|
+
# The Amazon Web Services account ID.
|
769
771
|
#
|
770
772
|
# @option params [required, String] :data_set_id
|
771
773
|
# An ID for the dataset that you want to create. This ID is unique per
|
772
|
-
# Amazon Web Services Region; for each Amazon Web Services account
|
774
|
+
# Amazon Web Services Region; for each Amazon Web Services account.
|
773
775
|
#
|
774
776
|
# @option params [required, String] :name
|
775
777
|
# The display name for the dataset.
|
@@ -786,7 +788,7 @@ module Aws::QuickSight
|
|
786
788
|
# Indicates whether you want to import the data into SPICE.
|
787
789
|
#
|
788
790
|
# @option params [Array<Types::ColumnGroup>] :column_groups
|
789
|
-
# Groupings of columns that work together in certain QuickSight
|
791
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
790
792
|
# features. Currently, only geospatial hierarchy is supported.
|
791
793
|
#
|
792
794
|
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
@@ -812,6 +814,10 @@ module Aws::QuickSight
|
|
812
814
|
# Contains a map of the key-value pairs for the resource tag or tags
|
813
815
|
# assigned to the dataset.
|
814
816
|
#
|
817
|
+
# @option params [Types::DataSetUsageConfiguration] :data_set_usage_configuration
|
818
|
+
# The usage configuration to apply to child datasets that reference this
|
819
|
+
# dataset as a source.
|
820
|
+
#
|
815
821
|
# @return [Types::CreateDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
816
822
|
#
|
817
823
|
# * {Types::CreateDataSetResponse#arn #arn} => String
|
@@ -910,6 +916,10 @@ module Aws::QuickSight
|
|
910
916
|
# },
|
911
917
|
# ],
|
912
918
|
# },
|
919
|
+
# untag_column_operation: {
|
920
|
+
# column_name: "ColumnName", # required
|
921
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
922
|
+
# },
|
913
923
|
# },
|
914
924
|
# ],
|
915
925
|
# source: { # required
|
@@ -926,6 +936,7 @@ module Aws::QuickSight
|
|
926
936
|
# on_clause: "OnClause", # required
|
927
937
|
# },
|
928
938
|
# physical_table_id: "PhysicalTableId",
|
939
|
+
# data_set_arn: "Arn",
|
929
940
|
# },
|
930
941
|
# },
|
931
942
|
# },
|
@@ -981,6 +992,10 @@ module Aws::QuickSight
|
|
981
992
|
# value: "TagValue", # required
|
982
993
|
# },
|
983
994
|
# ],
|
995
|
+
# data_set_usage_configuration: {
|
996
|
+
# disable_use_as_direct_query_source: false,
|
997
|
+
# disable_use_as_imported_source: false,
|
998
|
+
# },
|
984
999
|
# })
|
985
1000
|
#
|
986
1001
|
# @example Response structure
|
@@ -1004,42 +1019,39 @@ module Aws::QuickSight
|
|
1004
1019
|
# Creates a data source.
|
1005
1020
|
#
|
1006
1021
|
# @option params [required, String] :aws_account_id
|
1007
|
-
# The Amazon Web Services account
|
1022
|
+
# The Amazon Web Services account ID.
|
1008
1023
|
#
|
1009
1024
|
# @option params [required, String] :data_source_id
|
1010
1025
|
# An ID for the data source. This ID is unique per Amazon Web Services
|
1011
|
-
# Region; for each Amazon Web Services account
|
1026
|
+
# Region; for each Amazon Web Services account.
|
1012
1027
|
#
|
1013
1028
|
# @option params [required, String] :name
|
1014
1029
|
# A display name for the data source.
|
1015
1030
|
#
|
1016
1031
|
# @option params [required, String] :type
|
1017
|
-
# The type of the data source.
|
1018
|
-
#
|
1019
|
-
# AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT,
|
1020
|
-
# S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA`. Use `ListDataSources` to
|
1021
|
-
# return a list of all data sources.
|
1032
|
+
# The type of the data source. To return a list of all data sources, use
|
1033
|
+
# `ListDataSources`.
|
1022
1034
|
#
|
1023
|
-
# `AMAZON_ELASTICSEARCH`
|
1035
|
+
# Use `AMAZON_ELASTICSEARCH` for Amazon Elasticsearch Service.
|
1024
1036
|
#
|
1025
1037
|
# @option params [Types::DataSourceParameters] :data_source_parameters
|
1026
|
-
# The parameters that QuickSight uses to connect to your
|
1027
|
-
# source.
|
1038
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
1039
|
+
# underlying source.
|
1028
1040
|
#
|
1029
1041
|
# @option params [Types::DataSourceCredentials] :credentials
|
1030
|
-
# The credentials QuickSight that uses to connect to your
|
1031
|
-
# source. Currently, only credentials based on user name and
|
1032
|
-
# are supported.
|
1042
|
+
# The credentials Amazon QuickSight that uses to connect to your
|
1043
|
+
# underlying source. Currently, only credentials based on user name and
|
1044
|
+
# password are supported.
|
1033
1045
|
#
|
1034
1046
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
1035
1047
|
# A list of resource permissions on the data source.
|
1036
1048
|
#
|
1037
1049
|
# @option params [Types::VpcConnectionProperties] :vpc_connection_properties
|
1038
|
-
# Use this parameter only when you want QuickSight to use a VPC
|
1050
|
+
# Use this parameter only when you want Amazon QuickSight to use a VPC
|
1039
1051
|
# connection when connecting to your underlying source.
|
1040
1052
|
#
|
1041
1053
|
# @option params [Types::SslProperties] :ssl_properties
|
1042
|
-
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
1054
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon QuickSight
|
1043
1055
|
# connects to your underlying source.
|
1044
1056
|
#
|
1045
1057
|
# @option params [Array<Types::Tag>] :tags
|
@@ -1425,8 +1437,8 @@ module Aws::QuickSight
|
|
1425
1437
|
# A description for the group that you want to create.
|
1426
1438
|
#
|
1427
1439
|
# @option params [required, String] :aws_account_id
|
1428
|
-
# The ID for the Amazon Web Services account
|
1429
|
-
# Currently, you use the ID for the Amazon Web Services account
|
1440
|
+
# The ID for the Amazon Web Services account that the group is in.
|
1441
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
1430
1442
|
# contains your Amazon QuickSight account.
|
1431
1443
|
#
|
1432
1444
|
# @option params [required, String] :namespace
|
@@ -1474,8 +1486,8 @@ module Aws::QuickSight
|
|
1474
1486
|
# The name of the group that you want to add the user to.
|
1475
1487
|
#
|
1476
1488
|
# @option params [required, String] :aws_account_id
|
1477
|
-
# The ID for the Amazon Web Services account
|
1478
|
-
# Currently, you use the ID for the Amazon Web Services account
|
1489
|
+
# The ID for the Amazon Web Services account that the group is in.
|
1490
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
1479
1491
|
# contains your Amazon QuickSight account.
|
1480
1492
|
#
|
1481
1493
|
# @option params [required, String] :namespace
|
@@ -1512,19 +1524,19 @@ module Aws::QuickSight
|
|
1512
1524
|
req.send_request(options)
|
1513
1525
|
end
|
1514
1526
|
|
1515
|
-
# Creates an assignment with one specified
|
1527
|
+
# Creates an assignment with one specified IAMpolicy, identified by its
|
1516
1528
|
# Amazon Resource Name (ARN). This policy assignment is attached to the
|
1517
1529
|
# specified groups or users of Amazon QuickSight. Assignment names are
|
1518
|
-
# unique per Amazon Web Services account
|
1530
|
+
# unique per Amazon Web Services account. To avoid overwriting rules in
|
1519
1531
|
# other namespaces, use assignment names that are unique.
|
1520
1532
|
#
|
1521
1533
|
# @option params [required, String] :aws_account_id
|
1522
|
-
# The ID of the Amazon Web Services account
|
1523
|
-
#
|
1534
|
+
# The ID of the Amazon Web Services account where you want to assign an
|
1535
|
+
# IAMpolicy to Amazon QuickSight users or groups.
|
1524
1536
|
#
|
1525
1537
|
# @option params [required, String] :assignment_name
|
1526
1538
|
# The name of the assignment, also called a rule. It must be unique
|
1527
|
-
# within an Amazon Web Services account
|
1539
|
+
# within an Amazon Web Services account.
|
1528
1540
|
#
|
1529
1541
|
# @option params [required, String] :assignment_status
|
1530
1542
|
# The status of the assignment. Possible values are as follows:
|
@@ -1539,12 +1551,12 @@ module Aws::QuickSight
|
|
1539
1551
|
# when creating the data source.
|
1540
1552
|
#
|
1541
1553
|
# @option params [String] :policy_arn
|
1542
|
-
# The ARN for the
|
1543
|
-
# specified in this assignment.
|
1554
|
+
# The ARN for the IAMpolicy to apply to the Amazon QuickSight users and
|
1555
|
+
# groups specified in this assignment.
|
1544
1556
|
#
|
1545
1557
|
# @option params [Hash<String,Array>] :identities
|
1546
|
-
# The QuickSight users, groups, or both that you want to assign
|
1547
|
-
# policy to.
|
1558
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
1559
|
+
# the policy to.
|
1548
1560
|
#
|
1549
1561
|
# @option params [required, String] :namespace
|
1550
1562
|
# The namespace that contains the assignment.
|
@@ -1612,7 +1624,7 @@ module Aws::QuickSight
|
|
1612
1624
|
# An ID for the ingestion.
|
1613
1625
|
#
|
1614
1626
|
# @option params [required, String] :aws_account_id
|
1615
|
-
# The Amazon Web Services account
|
1627
|
+
# The Amazon Web Services account ID.
|
1616
1628
|
#
|
1617
1629
|
# @return [Types::CreateIngestionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1618
1630
|
#
|
@@ -1650,19 +1662,19 @@ module Aws::QuickSight
|
|
1650
1662
|
# (Enterprise edition only) Creates a new namespace for you to use with
|
1651
1663
|
# Amazon QuickSight.
|
1652
1664
|
#
|
1653
|
-
# A namespace allows you to isolate the QuickSight users and
|
1654
|
-
# are registered for that namespace. Users that access the
|
1655
|
-
# share assets only with other users or groups in the same
|
1656
|
-
# They can't see users and groups in other namespaces. You
|
1657
|
-
# namespace after your Amazon Web Services account
|
1658
|
-
# QuickSight. The namespace must be unique within
|
1659
|
-
# Services account
|
1660
|
-
# Amazon Web Services account
|
1661
|
-
# with Amazon Web Services Support.
|
1665
|
+
# A namespace allows you to isolate the Amazon QuickSight users and
|
1666
|
+
# groups that are registered for that namespace. Users that access the
|
1667
|
+
# namespace can share assets only with other users or groups in the same
|
1668
|
+
# namespace. They can't see users and groups in other namespaces. You
|
1669
|
+
# can create a namespace after your Amazon Web Services account is
|
1670
|
+
# subscribed to Amazon QuickSight. The namespace must be unique within
|
1671
|
+
# the Amazon Web Services account. By default, there is a limit of 100
|
1672
|
+
# namespaces per Amazon Web Services account. To increase your limit,
|
1673
|
+
# create a ticket with Amazon Web Services Support.
|
1662
1674
|
#
|
1663
1675
|
# @option params [required, String] :aws_account_id
|
1664
|
-
# The ID for the Amazon Web Services account
|
1665
|
-
#
|
1676
|
+
# The ID for the Amazon Web Services account that you want to create the
|
1677
|
+
# Amazon QuickSight namespace in.
|
1666
1678
|
#
|
1667
1679
|
# @option params [required, String] :namespace
|
1668
1680
|
# The name that you want to use to describe the new namespace.
|
@@ -1721,23 +1733,23 @@ module Aws::QuickSight
|
|
1721
1733
|
# Creates a template from an existing Amazon QuickSight analysis or
|
1722
1734
|
# template. You can use the resulting template to create a dashboard.
|
1723
1735
|
#
|
1724
|
-
# A *template* is an entity in QuickSight that encapsulates the
|
1725
|
-
# required to create an analysis and that you can use to create
|
1726
|
-
# dashboard. A template adds a layer of abstraction by using
|
1736
|
+
# A *template* is an entity in Amazon QuickSight that encapsulates the
|
1737
|
+
# metadata required to create an analysis and that you can use to create
|
1738
|
+
# s dashboard. A template adds a layer of abstraction by using
|
1727
1739
|
# placeholders to replace the dataset associated with the analysis. You
|
1728
1740
|
# can use templates to create dashboards by replacing dataset
|
1729
1741
|
# placeholders with datasets that follow the same schema that was used
|
1730
1742
|
# to create the source analysis and template.
|
1731
1743
|
#
|
1732
1744
|
# @option params [required, String] :aws_account_id
|
1733
|
-
# The ID for the Amazon Web Services account
|
1734
|
-
#
|
1735
|
-
#
|
1745
|
+
# The ID for the Amazon Web Services account that the group is in. You
|
1746
|
+
# use the ID for the Amazon Web Services account that contains your
|
1747
|
+
# Amazon QuickSight account.
|
1736
1748
|
#
|
1737
1749
|
# @option params [required, String] :template_id
|
1738
1750
|
# An ID for the template that you want to create. This template is
|
1739
1751
|
# unique per Amazon Web Services Region; in each Amazon Web Services
|
1740
|
-
# account
|
1752
|
+
# account.
|
1741
1753
|
#
|
1742
1754
|
# @option params [String] :name
|
1743
1755
|
# A display name for the template.
|
@@ -1752,8 +1764,8 @@ module Aws::QuickSight
|
|
1752
1764
|
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
1753
1765
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
1754
1766
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
1755
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
1756
|
-
# any QuickSight-supported Amazon Web Services Region;.
|
1767
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
1768
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
1757
1769
|
#
|
1758
1770
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
1759
1771
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
@@ -1836,7 +1848,7 @@ module Aws::QuickSight
|
|
1836
1848
|
# Creates a template alias for a template.
|
1837
1849
|
#
|
1838
1850
|
# @option params [required, String] :aws_account_id
|
1839
|
-
# The ID of the Amazon Web Services account
|
1851
|
+
# The ID of the Amazon Web Services account that contains the template
|
1840
1852
|
# that you creating an alias for.
|
1841
1853
|
#
|
1842
1854
|
# @option params [required, String] :template_id
|
@@ -1893,12 +1905,12 @@ module Aws::QuickSight
|
|
1893
1905
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html
|
1894
1906
|
#
|
1895
1907
|
# @option params [required, String] :aws_account_id
|
1896
|
-
# The ID of the Amazon Web Services account
|
1908
|
+
# The ID of the Amazon Web Services account where you want to store the
|
1897
1909
|
# new theme.
|
1898
1910
|
#
|
1899
1911
|
# @option params [required, String] :theme_id
|
1900
1912
|
# An ID for the theme that you want to create. The theme ID is unique
|
1901
|
-
# per Amazon Web Services Region
|
1913
|
+
# per Amazon Web Services Region in each Amazon Web Services account.
|
1902
1914
|
#
|
1903
1915
|
# @option params [required, String] :name
|
1904
1916
|
# A display name for the theme.
|
@@ -1907,7 +1919,7 @@ module Aws::QuickSight
|
|
1907
1919
|
# The ID of the theme that a custom theme will inherit from. All themes
|
1908
1920
|
# inherit from one of the starting themes defined by Amazon QuickSight.
|
1909
1921
|
# For a list of the starting themes, use `ListThemes` or choose
|
1910
|
-
# **Themes** from within a QuickSight analysis.
|
1922
|
+
# **Themes** from within a Amazon QuickSight analysis.
|
1911
1923
|
#
|
1912
1924
|
# @option params [String] :version_description
|
1913
1925
|
# A description of the first version of the theme that you're creating.
|
@@ -2017,7 +2029,7 @@ module Aws::QuickSight
|
|
2017
2029
|
# Creates a theme alias for a theme.
|
2018
2030
|
#
|
2019
2031
|
# @option params [required, String] :aws_account_id
|
2020
|
-
# The ID of the Amazon Web Services account
|
2032
|
+
# The ID of the Amazon Web Services account that contains the theme for
|
2021
2033
|
# the new theme alias.
|
2022
2034
|
#
|
2023
2035
|
# @option params [required, String] :theme_id
|
@@ -2064,16 +2076,17 @@ module Aws::QuickSight
|
|
2064
2076
|
end
|
2065
2077
|
|
2066
2078
|
# Deletes all Amazon QuickSight customizations in this Amazon Web
|
2067
|
-
# Services Region; for the specified Amazon Web Services account
|
2068
|
-
# QuickSight namespace.
|
2079
|
+
# Services Region; for the specified Amazon Web Services account and
|
2080
|
+
# Amazon QuickSight namespace.
|
2069
2081
|
#
|
2070
2082
|
# @option params [required, String] :aws_account_id
|
2071
|
-
# The ID for the Amazon Web Services account
|
2072
|
-
# QuickSight customizations from in this Amazon Web Services
|
2083
|
+
# The ID for the Amazon Web Services account that you want to delete
|
2084
|
+
# Amazon QuickSight customizations from in this Amazon Web Services
|
2085
|
+
# Region;.
|
2073
2086
|
#
|
2074
2087
|
# @option params [String] :namespace
|
2075
|
-
# The QuickSight namespace that you're deleting the
|
2076
|
-
# from.
|
2088
|
+
# The Amazon QuickSight namespace that you're deleting the
|
2089
|
+
# customizations from.
|
2077
2090
|
#
|
2078
2091
|
# @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2079
2092
|
#
|
@@ -2104,9 +2117,10 @@ module Aws::QuickSight
|
|
2104
2117
|
# Deletes an analysis from Amazon QuickSight. You can optionally include
|
2105
2118
|
# a recovery window during which you can restore the analysis. If you
|
2106
2119
|
# don't specify a recovery window value, the operation defaults to 30
|
2107
|
-
# days. QuickSight attaches a `DeletionTime` stamp to the
|
2108
|
-
# specifies the end of the recovery window. At the end of
|
2109
|
-
# window, QuickSight deletes the analysis
|
2120
|
+
# days. Amazon QuickSight attaches a `DeletionTime` stamp to the
|
2121
|
+
# response that specifies the end of the recovery window. At the end of
|
2122
|
+
# the recovery window, Amazon QuickSight deletes the analysis
|
2123
|
+
# permanently.
|
2110
2124
|
#
|
2111
2125
|
# At any time before recovery window ends, you can use the
|
2112
2126
|
# `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
|
@@ -2115,19 +2129,20 @@ module Aws::QuickSight
|
|
2115
2129
|
# make a template from it.
|
2116
2130
|
#
|
2117
2131
|
# An analysis that's scheduled for deletion isn't accessible in the
|
2118
|
-
# QuickSight console. To access it in the console, restore it.
|
2119
|
-
# an analysis doesn't delete the dashboards that you publish
|
2132
|
+
# Amazon QuickSight console. To access it in the console, restore it.
|
2133
|
+
# Deleting an analysis doesn't delete the dashboards that you publish
|
2134
|
+
# from it.
|
2120
2135
|
#
|
2121
2136
|
# @option params [required, String] :aws_account_id
|
2122
|
-
# The ID of the Amazon Web Services account
|
2137
|
+
# The ID of the Amazon Web Services account where you want to delete an
|
2123
2138
|
# analysis.
|
2124
2139
|
#
|
2125
2140
|
# @option params [required, String] :analysis_id
|
2126
2141
|
# The ID of the analysis that you're deleting.
|
2127
2142
|
#
|
2128
2143
|
# @option params [Integer] :recovery_window_in_days
|
2129
|
-
# A value that specifies the number of days that QuickSight waits
|
2130
|
-
# it deletes the analysis. You can't use this parameter with the
|
2144
|
+
# A value that specifies the number of days that Amazon QuickSight waits
|
2145
|
+
# before it deletes the analysis. You can't use this parameter with the
|
2131
2146
|
# `ForceDeleteWithoutRecovery` option in the same API call. The default
|
2132
2147
|
# value is 30.
|
2133
2148
|
#
|
@@ -2173,7 +2188,7 @@ module Aws::QuickSight
|
|
2173
2188
|
# Deletes a dashboard.
|
2174
2189
|
#
|
2175
2190
|
# @option params [required, String] :aws_account_id
|
2176
|
-
# The ID of the Amazon Web Services account
|
2191
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
2177
2192
|
# that you're deleting.
|
2178
2193
|
#
|
2179
2194
|
# @option params [required, String] :dashboard_id
|
@@ -2217,11 +2232,11 @@ module Aws::QuickSight
|
|
2217
2232
|
# Deletes a dataset.
|
2218
2233
|
#
|
2219
2234
|
# @option params [required, String] :aws_account_id
|
2220
|
-
# The Amazon Web Services account
|
2235
|
+
# The Amazon Web Services account ID.
|
2221
2236
|
#
|
2222
2237
|
# @option params [required, String] :data_set_id
|
2223
2238
|
# The ID for the dataset that you want to create. This ID is unique per
|
2224
|
-
# Amazon Web Services Region; for each Amazon Web Services account
|
2239
|
+
# Amazon Web Services Region; for each Amazon Web Services account.
|
2225
2240
|
#
|
2226
2241
|
# @return [Types::DeleteDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2227
2242
|
#
|
@@ -2257,11 +2272,11 @@ module Aws::QuickSight
|
|
2257
2272
|
# datasets that reference the deleted data source.
|
2258
2273
|
#
|
2259
2274
|
# @option params [required, String] :aws_account_id
|
2260
|
-
# The Amazon Web Services account
|
2275
|
+
# The Amazon Web Services account ID.
|
2261
2276
|
#
|
2262
2277
|
# @option params [required, String] :data_source_id
|
2263
2278
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
2264
|
-
# Region; for each Amazon Web Services account
|
2279
|
+
# Region; for each Amazon Web Services account.
|
2265
2280
|
#
|
2266
2281
|
# @return [Types::DeleteDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2267
2282
|
#
|
@@ -2382,8 +2397,8 @@ module Aws::QuickSight
|
|
2382
2397
|
# The name of the group that you want to delete.
|
2383
2398
|
#
|
2384
2399
|
# @option params [required, String] :aws_account_id
|
2385
|
-
# The ID for the Amazon Web Services account
|
2386
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2400
|
+
# The ID for the Amazon Web Services account that the group is in.
|
2401
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2387
2402
|
# contains your Amazon QuickSight account.
|
2388
2403
|
#
|
2389
2404
|
# @option params [required, String] :namespace
|
@@ -2427,8 +2442,8 @@ module Aws::QuickSight
|
|
2427
2442
|
# The name of the group that you want to delete the user from.
|
2428
2443
|
#
|
2429
2444
|
# @option params [required, String] :aws_account_id
|
2430
|
-
# The ID for the Amazon Web Services account
|
2431
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2445
|
+
# The ID for the Amazon Web Services account that the group is in.
|
2446
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2432
2447
|
# contains your Amazon QuickSight account.
|
2433
2448
|
#
|
2434
2449
|
# @option params [required, String] :namespace
|
@@ -2462,11 +2477,11 @@ module Aws::QuickSight
|
|
2462
2477
|
req.send_request(options)
|
2463
2478
|
end
|
2464
2479
|
|
2465
|
-
# Deletes an existing
|
2480
|
+
# Deletes an existing IAMpolicy assignment.
|
2466
2481
|
#
|
2467
2482
|
# @option params [required, String] :aws_account_id
|
2468
|
-
# The Amazon Web Services account
|
2469
|
-
#
|
2483
|
+
# The Amazon Web Services account ID where you want to delete the
|
2484
|
+
# IAMpolicy assignment.
|
2470
2485
|
#
|
2471
2486
|
# @option params [required, String] :assignment_name
|
2472
2487
|
# The name of the assignment.
|
@@ -2510,8 +2525,8 @@ module Aws::QuickSight
|
|
2510
2525
|
# asset.
|
2511
2526
|
#
|
2512
2527
|
# @option params [required, String] :aws_account_id
|
2513
|
-
# The ID for the Amazon Web Services account
|
2514
|
-
#
|
2528
|
+
# The ID for the Amazon Web Services account that you want to delete the
|
2529
|
+
# Amazon QuickSight namespace from.
|
2515
2530
|
#
|
2516
2531
|
# @option params [required, String] :namespace
|
2517
2532
|
# The namespace that you want to delete.
|
@@ -2545,7 +2560,7 @@ module Aws::QuickSight
|
|
2545
2560
|
# Deletes a template.
|
2546
2561
|
#
|
2547
2562
|
# @option params [required, String] :aws_account_id
|
2548
|
-
# The ID of the Amazon Web Services account
|
2563
|
+
# The ID of the Amazon Web Services account that contains the template
|
2549
2564
|
# that you're deleting.
|
2550
2565
|
#
|
2551
2566
|
# @option params [required, String] :template_id
|
@@ -2592,7 +2607,7 @@ module Aws::QuickSight
|
|
2592
2607
|
# the alias points to.
|
2593
2608
|
#
|
2594
2609
|
# @option params [required, String] :aws_account_id
|
2595
|
-
# The ID of the Amazon Web Services account
|
2610
|
+
# The ID of the Amazon Web Services account that contains the item to
|
2596
2611
|
# delete.
|
2597
2612
|
#
|
2598
2613
|
# @option params [required, String] :template_id
|
@@ -2640,8 +2655,8 @@ module Aws::QuickSight
|
|
2640
2655
|
# Deletes a theme.
|
2641
2656
|
#
|
2642
2657
|
# @option params [required, String] :aws_account_id
|
2643
|
-
# The ID of the Amazon Web Services account
|
2644
|
-
#
|
2658
|
+
# The ID of the Amazon Web Services account that contains the theme that
|
2659
|
+
# you're deleting.
|
2645
2660
|
#
|
2646
2661
|
# @option params [required, String] :theme_id
|
2647
2662
|
# An ID for the theme that you want to delete.
|
@@ -2688,7 +2703,7 @@ module Aws::QuickSight
|
|
2688
2703
|
# theme that the alias points to.
|
2689
2704
|
#
|
2690
2705
|
# @option params [required, String] :aws_account_id
|
2691
|
-
# The ID of the Amazon Web Services account
|
2706
|
+
# The ID of the Amazon Web Services account that contains the theme
|
2692
2707
|
# alias to delete.
|
2693
2708
|
#
|
2694
2709
|
# @option params [required, String] :theme_id
|
@@ -2739,8 +2754,8 @@ module Aws::QuickSight
|
|
2739
2754
|
# The name of the user that you want to delete.
|
2740
2755
|
#
|
2741
2756
|
# @option params [required, String] :aws_account_id
|
2742
|
-
# The ID for the Amazon Web Services account
|
2743
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2757
|
+
# The ID for the Amazon Web Services account that the user is in.
|
2758
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2744
2759
|
# contains your Amazon QuickSight account.
|
2745
2760
|
#
|
2746
2761
|
# @option params [required, String] :namespace
|
@@ -2779,8 +2794,8 @@ module Aws::QuickSight
|
|
2779
2794
|
# The principal ID of the user.
|
2780
2795
|
#
|
2781
2796
|
# @option params [required, String] :aws_account_id
|
2782
|
-
# The ID for the Amazon Web Services account
|
2783
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2797
|
+
# The ID for the Amazon Web Services account that the user is in.
|
2798
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2784
2799
|
# contains your Amazon QuickSight account.
|
2785
2800
|
#
|
2786
2801
|
# @option params [required, String] :namespace
|
@@ -2814,29 +2829,29 @@ module Aws::QuickSight
|
|
2814
2829
|
end
|
2815
2830
|
|
2816
2831
|
# Describes the customizations associated with the provided Amazon Web
|
2817
|
-
# Services account
|
2818
|
-
# Services Region;. The QuickSight console evaluates which
|
2832
|
+
# Services account and Amazon Amazon QuickSight namespace in an Amazon
|
2833
|
+
# Web Services Region;. The Amazon QuickSight console evaluates which
|
2819
2834
|
# customizations to apply by running this API operation with the
|
2820
2835
|
# `Resolved` flag included.
|
2821
2836
|
#
|
2822
2837
|
# To determine what customizations display when you run this command, it
|
2823
2838
|
# can help to visualize the relationship of the entities involved.
|
2824
2839
|
#
|
2825
|
-
# * `Amazon Web Services account
|
2840
|
+
# * `Amazon Web Services account` - The Amazon Web Services account
|
2826
2841
|
# exists at the top of the hierarchy. It has the potential to use all
|
2827
2842
|
# of the Amazon Web Services Regions; and AWS Services. When you
|
2828
|
-
# subscribe to QuickSight, you choose one Amazon Web Services
|
2829
|
-
# to use as your home Region. That's where your free SPICE
|
2830
|
-
# is located. You can use QuickSight in any supported
|
2831
|
-
# Services Region;.
|
2843
|
+
# subscribe to Amazon QuickSight, you choose one Amazon Web Services
|
2844
|
+
# Region; to use as your home Region. That's where your free SPICE
|
2845
|
+
# capacity is located. You can use Amazon QuickSight in any supported
|
2846
|
+
# Amazon Web Services Region;.
|
2832
2847
|
#
|
2833
2848
|
# * `Amazon Web Services Region;` - In each Amazon Web Services Region;
|
2834
|
-
# where you sign in to QuickSight at least once,
|
2835
|
-
# separate instance of the same service. If you
|
2836
|
-
# it resides in us-east-1, which is the US East
|
2837
|
-
# Generally speaking, these users have access to
|
2838
|
-
# Amazon Web Services Region;, unless they are
|
2839
|
-
# namespace.
|
2849
|
+
# where you sign in to Amazon QuickSight at least once, Amazon
|
2850
|
+
# QuickSight acts as a separate instance of the same service. If you
|
2851
|
+
# have a user directory, it resides in us-east-1, which is the US East
|
2852
|
+
# (N. Virginia). Generally speaking, these users have access to Amazon
|
2853
|
+
# QuickSight in any Amazon Web Services Region;, unless they are
|
2854
|
+
# constrained to a namespace.
|
2840
2855
|
#
|
2841
2856
|
# To run the command in a different Amazon Web Services Region;, you
|
2842
2857
|
# change your Region settings. If you're using the AWS CLI, you can
|
@@ -2850,21 +2865,21 @@ module Aws::QuickSight
|
|
2850
2865
|
# Region;. Use Enter to key the same settings for your keys. For
|
2851
2866
|
# more information, see [Configuring the AWS CLI][3].
|
2852
2867
|
#
|
2853
|
-
# * `Namespace` - A QuickSight namespace is a partition that
|
2854
|
-
# users and assets (data sources, datasets, dashboards, and
|
2855
|
-
# access assets that are in a specific namespace, users and
|
2856
|
-
# must also be part of the same namespace. People who share a
|
2868
|
+
# * `Namespace` - A Amazon QuickSight namespace is a partition that
|
2869
|
+
# contains users and assets (data sources, datasets, dashboards, and
|
2870
|
+
# so on). To access assets that are in a specific namespace, users and
|
2871
|
+
# groups must also be part of the same namespace. People who share a
|
2857
2872
|
# namespace are completely isolated from users and assets in other
|
2858
|
-
# namespaces, even if they are in the same Amazon Web Services
|
2859
|
-
#
|
2873
|
+
# namespaces, even if they are in the same Amazon Web Services account
|
2874
|
+
# and Amazon Web Services Region;.
|
2860
2875
|
#
|
2861
2876
|
# * `Applied customizations` - Within an Amazon Web Services Region;, a
|
2862
|
-
# set of QuickSight customizations can apply to an Amazon Web
|
2863
|
-
# account
|
2864
|
-
# override settings that you apply to an Amazon Web Services
|
2865
|
-
# All settings are isolated to a single Amazon Web Services
|
2866
|
-
# To apply them in other Amazon Web Services Regions;, run
|
2867
|
-
# `CreateAccountCustomization` command in each Amazon Web Services
|
2877
|
+
# set of Amazon QuickSight customizations can apply to an Amazon Web
|
2878
|
+
# Services account or to a namespace. Settings that you apply to a
|
2879
|
+
# namespace override settings that you apply to an Amazon Web Services
|
2880
|
+
# account. All settings are isolated to a single Amazon Web Services
|
2881
|
+
# Region;. To apply them in other Amazon Web Services Regions;, run
|
2882
|
+
# the `CreateAccountCustomization` command in each Amazon Web Services
|
2868
2883
|
# Region; where you want to apply the same customizations.
|
2869
2884
|
#
|
2870
2885
|
#
|
@@ -2874,20 +2889,20 @@ module Aws::QuickSight
|
|
2874
2889
|
# [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
|
2875
2890
|
#
|
2876
2891
|
# @option params [required, String] :aws_account_id
|
2877
|
-
# The ID for the Amazon Web Services account
|
2878
|
-
# QuickSight customizations for.
|
2892
|
+
# The ID for the Amazon Web Services account that you want to describe
|
2893
|
+
# Amazon QuickSight customizations for.
|
2879
2894
|
#
|
2880
2895
|
# @option params [String] :namespace
|
2881
|
-
# The QuickSight namespace that you want to describe
|
2882
|
-
# customizations for.
|
2896
|
+
# The Amazon QuickSight namespace that you want to describe Amazon
|
2897
|
+
# QuickSight customizations for.
|
2883
2898
|
#
|
2884
2899
|
# @option params [Boolean] :resolved
|
2885
2900
|
# The `Resolved` flag works with the other parameters to determine which
|
2886
|
-
# view of QuickSight customizations is returned. You can add this
|
2887
|
-
# to your command to use the same view that QuickSight uses
|
2888
|
-
# which customizations to apply to the console. Omit this
|
2889
|
-
# it to `no-resolved`, to reveal customizations that are
|
2890
|
-
# different levels.
|
2901
|
+
# view of Amazon QuickSight customizations is returned. You can add this
|
2902
|
+
# flag to your command to use the same view that Amazon QuickSight uses
|
2903
|
+
# to identify which customizations to apply to the console. Omit this
|
2904
|
+
# flag, or set it to `no-resolved`, to reveal customizations that are
|
2905
|
+
# configured at different levels.
|
2891
2906
|
#
|
2892
2907
|
# @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2893
2908
|
#
|
@@ -2924,11 +2939,11 @@ module Aws::QuickSight
|
|
2924
2939
|
req.send_request(options)
|
2925
2940
|
end
|
2926
2941
|
|
2927
|
-
# Describes the settings that were used when your QuickSight
|
2928
|
-
# subscription was first created in this Amazon Web Services account
|
2942
|
+
# Describes the settings that were used when your Amazon QuickSight
|
2943
|
+
# subscription was first created in this Amazon Web Services account.
|
2929
2944
|
#
|
2930
2945
|
# @option params [required, String] :aws_account_id
|
2931
|
-
# The ID for the Amazon Web Services account
|
2946
|
+
# The ID for the Amazon Web Services account that contains the settings
|
2932
2947
|
# that you want to list.
|
2933
2948
|
#
|
2934
2949
|
# @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2964,9 +2979,9 @@ module Aws::QuickSight
|
|
2964
2979
|
# Provides a summary of the metadata for an analysis.
|
2965
2980
|
#
|
2966
2981
|
# @option params [required, String] :aws_account_id
|
2967
|
-
# The ID of the Amazon Web Services account
|
2968
|
-
# You must be using the Amazon Web Services account
|
2969
|
-
#
|
2982
|
+
# The ID of the Amazon Web Services account that contains the analysis.
|
2983
|
+
# You must be using the Amazon Web Services account that the analysis is
|
2984
|
+
# in.
|
2970
2985
|
#
|
2971
2986
|
# @option params [required, String] :analysis_id
|
2972
2987
|
# The ID of the analysis that you're describing. The ID is part of the
|
@@ -3017,9 +3032,9 @@ module Aws::QuickSight
|
|
3017
3032
|
# Provides the read and write permissions for an analysis.
|
3018
3033
|
#
|
3019
3034
|
# @option params [required, String] :aws_account_id
|
3020
|
-
# The ID of the Amazon Web Services account
|
3035
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
3021
3036
|
# whose permissions you're describing. You must be using the Amazon Web
|
3022
|
-
# Services account
|
3037
|
+
# Services account that the analysis is in.
|
3023
3038
|
#
|
3024
3039
|
# @option params [required, String] :analysis_id
|
3025
3040
|
# The ID of the analysis whose permissions you're describing. The ID is
|
@@ -3063,7 +3078,7 @@ module Aws::QuickSight
|
|
3063
3078
|
# Provides a summary for a dashboard.
|
3064
3079
|
#
|
3065
3080
|
# @option params [required, String] :aws_account_id
|
3066
|
-
# The ID of the Amazon Web Services account
|
3081
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
3067
3082
|
# that you're describing.
|
3068
3083
|
#
|
3069
3084
|
# @option params [required, String] :dashboard_id
|
@@ -3129,11 +3144,11 @@ module Aws::QuickSight
|
|
3129
3144
|
# Describes read and write permissions for a dashboard.
|
3130
3145
|
#
|
3131
3146
|
# @option params [required, String] :aws_account_id
|
3132
|
-
# The ID of the Amazon Web Services account
|
3147
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
3133
3148
|
# that you're describing permissions for.
|
3134
3149
|
#
|
3135
3150
|
# @option params [required, String] :dashboard_id
|
3136
|
-
# The ID for the dashboard, also added to the
|
3151
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
3137
3152
|
#
|
3138
3153
|
# @return [Types::DescribeDashboardPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3139
3154
|
#
|
@@ -3173,11 +3188,11 @@ module Aws::QuickSight
|
|
3173
3188
|
# Describes a dataset.
|
3174
3189
|
#
|
3175
3190
|
# @option params [required, String] :aws_account_id
|
3176
|
-
# The Amazon Web Services account
|
3191
|
+
# The Amazon Web Services account ID.
|
3177
3192
|
#
|
3178
3193
|
# @option params [required, String] :data_set_id
|
3179
3194
|
# The ID for the dataset that you want to create. This ID is unique per
|
3180
|
-
# Amazon Web Services Region; for each Amazon Web Services account
|
3195
|
+
# Amazon Web Services Region; for each Amazon Web Services account.
|
3181
3196
|
#
|
3182
3197
|
# @return [Types::DescribeDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3183
3198
|
#
|
@@ -3241,6 +3256,9 @@ module Aws::QuickSight
|
|
3241
3256
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags #=> Array
|
3242
3257
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_geographic_role #=> String, one of "COUNTRY", "STATE", "COUNTY", "CITY", "POSTCODE", "LONGITUDE", "LATITUDE"
|
3243
3258
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_description.text #=> String
|
3259
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.column_name #=> String
|
3260
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names #=> Array
|
3261
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names[0] #=> String, one of "COLUMN_GEOGRAPHIC_ROLE", "COLUMN_DESCRIPTION"
|
3244
3262
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_operand #=> String
|
3245
3263
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_operand #=> String
|
3246
3264
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_join_key_properties.unique_key #=> Boolean
|
@@ -3248,6 +3266,7 @@ module Aws::QuickSight
|
|
3248
3266
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.type #=> String, one of "INNER", "OUTER", "LEFT", "RIGHT"
|
3249
3267
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.on_clause #=> String
|
3250
3268
|
# resp.data_set.logical_table_map["LogicalTableId"].source.physical_table_id #=> String
|
3269
|
+
# resp.data_set.logical_table_map["LogicalTableId"].source.data_set_arn #=> String
|
3251
3270
|
# resp.data_set.output_columns #=> Array
|
3252
3271
|
# resp.data_set.output_columns[0].name #=> String
|
3253
3272
|
# resp.data_set.output_columns[0].description #=> String
|
@@ -3279,6 +3298,8 @@ module Aws::QuickSight
|
|
3279
3298
|
# resp.data_set.column_level_permission_rules[0].principals[0] #=> String
|
3280
3299
|
# resp.data_set.column_level_permission_rules[0].column_names #=> Array
|
3281
3300
|
# resp.data_set.column_level_permission_rules[0].column_names[0] #=> String
|
3301
|
+
# resp.data_set.data_set_usage_configuration.disable_use_as_direct_query_source #=> Boolean
|
3302
|
+
# resp.data_set.data_set_usage_configuration.disable_use_as_imported_source #=> Boolean
|
3282
3303
|
# resp.request_id #=> String
|
3283
3304
|
# resp.status #=> Integer
|
3284
3305
|
#
|
@@ -3297,11 +3318,11 @@ module Aws::QuickSight
|
|
3297
3318
|
# `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
|
3298
3319
|
#
|
3299
3320
|
# @option params [required, String] :aws_account_id
|
3300
|
-
# The Amazon Web Services account
|
3321
|
+
# The Amazon Web Services account ID.
|
3301
3322
|
#
|
3302
3323
|
# @option params [required, String] :data_set_id
|
3303
3324
|
# The ID for the dataset that you want to create. This ID is unique per
|
3304
|
-
# Amazon Web Services Region; for each Amazon Web Services account
|
3325
|
+
# Amazon Web Services Region; for each Amazon Web Services account.
|
3305
3326
|
#
|
3306
3327
|
# @return [Types::DescribeDataSetPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3307
3328
|
#
|
@@ -3341,11 +3362,11 @@ module Aws::QuickSight
|
|
3341
3362
|
# Describes a data source.
|
3342
3363
|
#
|
3343
3364
|
# @option params [required, String] :aws_account_id
|
3344
|
-
# The Amazon Web Services account
|
3365
|
+
# The Amazon Web Services account ID.
|
3345
3366
|
#
|
3346
3367
|
# @option params [required, String] :data_source_id
|
3347
3368
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
3348
|
-
# Region; for each Amazon Web Services account
|
3369
|
+
# Region; for each Amazon Web Services account.
|
3349
3370
|
#
|
3350
3371
|
# @return [Types::DescribeDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3351
3372
|
#
|
@@ -3483,11 +3504,11 @@ module Aws::QuickSight
|
|
3483
3504
|
# Describes the resource permissions for a data source.
|
3484
3505
|
#
|
3485
3506
|
# @option params [required, String] :aws_account_id
|
3486
|
-
# The Amazon Web Services account
|
3507
|
+
# The Amazon Web Services account ID.
|
3487
3508
|
#
|
3488
3509
|
# @option params [required, String] :data_source_id
|
3489
3510
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
3490
|
-
# Region; for each Amazon Web Services account
|
3511
|
+
# Region; for each Amazon Web Services account.
|
3491
3512
|
#
|
3492
3513
|
# @return [Types::DescribeDataSourcePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3493
3514
|
#
|
@@ -3662,8 +3683,8 @@ module Aws::QuickSight
|
|
3662
3683
|
# The name of the group that you want to describe.
|
3663
3684
|
#
|
3664
3685
|
# @option params [required, String] :aws_account_id
|
3665
|
-
# The ID for the Amazon Web Services account
|
3666
|
-
# Currently, you use the ID for the Amazon Web Services account
|
3686
|
+
# The ID for the Amazon Web Services account that the group is in.
|
3687
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
3667
3688
|
# contains your Amazon QuickSight account.
|
3668
3689
|
#
|
3669
3690
|
# @option params [required, String] :namespace
|
@@ -3701,12 +3722,12 @@ module Aws::QuickSight
|
|
3701
3722
|
req.send_request(options)
|
3702
3723
|
end
|
3703
3724
|
|
3704
|
-
# Describes an existing
|
3725
|
+
# Describes an existing IAMpolicy assignment, as specified by the
|
3705
3726
|
# assignment name.
|
3706
3727
|
#
|
3707
3728
|
# @option params [required, String] :aws_account_id
|
3708
|
-
# The ID of the Amazon Web Services account
|
3709
|
-
#
|
3729
|
+
# The ID of the Amazon Web Services account that contains the assignment
|
3730
|
+
# that you want to describe.
|
3710
3731
|
#
|
3711
3732
|
# @option params [required, String] :assignment_name
|
3712
3733
|
# The name of the assignment, also called a rule.
|
@@ -3753,7 +3774,7 @@ module Aws::QuickSight
|
|
3753
3774
|
# Describes a SPICE ingestion.
|
3754
3775
|
#
|
3755
3776
|
# @option params [required, String] :aws_account_id
|
3756
|
-
# The Amazon Web Services account
|
3777
|
+
# The Amazon Web Services account ID.
|
3757
3778
|
#
|
3758
3779
|
# @option params [required, String] :data_set_id
|
3759
3780
|
# The ID of the dataset used in the ingestion.
|
@@ -3806,7 +3827,7 @@ module Aws::QuickSight
|
|
3806
3827
|
# Describes the current namespace.
|
3807
3828
|
#
|
3808
3829
|
# @option params [required, String] :aws_account_id
|
3809
|
-
# The ID for the Amazon Web Services account
|
3830
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
3810
3831
|
# QuickSight namespace that you want to describe.
|
3811
3832
|
#
|
3812
3833
|
# @option params [required, String] :namespace
|
@@ -3849,7 +3870,7 @@ module Aws::QuickSight
|
|
3849
3870
|
# Describes a template's metadata.
|
3850
3871
|
#
|
3851
3872
|
# @option params [required, String] :aws_account_id
|
3852
|
-
# The ID of the Amazon Web Services account
|
3873
|
+
# The ID of the Amazon Web Services account that contains the template
|
3853
3874
|
# that you're describing.
|
3854
3875
|
#
|
3855
3876
|
# @option params [required, String] :template_id
|
@@ -3926,7 +3947,7 @@ module Aws::QuickSight
|
|
3926
3947
|
# Describes the template alias for a template.
|
3927
3948
|
#
|
3928
3949
|
# @option params [required, String] :aws_account_id
|
3929
|
-
# The ID of the Amazon Web Services account
|
3950
|
+
# The ID of the Amazon Web Services account that contains the template
|
3930
3951
|
# alias that you're describing.
|
3931
3952
|
#
|
3932
3953
|
# @option params [required, String] :template_id
|
@@ -3973,7 +3994,7 @@ module Aws::QuickSight
|
|
3973
3994
|
# Describes read and write permissions on a template.
|
3974
3995
|
#
|
3975
3996
|
# @option params [required, String] :aws_account_id
|
3976
|
-
# The ID of the Amazon Web Services account
|
3997
|
+
# The ID of the Amazon Web Services account that contains the template
|
3977
3998
|
# that you're describing.
|
3978
3999
|
#
|
3979
4000
|
# @option params [required, String] :template_id
|
@@ -4017,8 +4038,8 @@ module Aws::QuickSight
|
|
4017
4038
|
# Describes a theme.
|
4018
4039
|
#
|
4019
4040
|
# @option params [required, String] :aws_account_id
|
4020
|
-
# The ID of the Amazon Web Services account
|
4021
|
-
#
|
4041
|
+
# The ID of the Amazon Web Services account that contains the theme that
|
4042
|
+
# you're describing.
|
4022
4043
|
#
|
4023
4044
|
# @option params [required, String] :theme_id
|
4024
4045
|
# The ID for the theme.
|
@@ -4106,7 +4127,7 @@ module Aws::QuickSight
|
|
4106
4127
|
# Describes the alias for a theme.
|
4107
4128
|
#
|
4108
4129
|
# @option params [required, String] :aws_account_id
|
4109
|
-
# The ID of the Amazon Web Services account
|
4130
|
+
# The ID of the Amazon Web Services account that contains the theme
|
4110
4131
|
# alias that you're describing.
|
4111
4132
|
#
|
4112
4133
|
# @option params [required, String] :theme_id
|
@@ -4149,8 +4170,8 @@ module Aws::QuickSight
|
|
4149
4170
|
# Describes the read and write permissions for a theme.
|
4150
4171
|
#
|
4151
4172
|
# @option params [required, String] :aws_account_id
|
4152
|
-
# The ID of the Amazon Web Services account
|
4153
|
-
#
|
4173
|
+
# The ID of the Amazon Web Services account that contains the theme that
|
4174
|
+
# you're describing.
|
4154
4175
|
#
|
4155
4176
|
# @option params [required, String] :theme_id
|
4156
4177
|
# The ID for the theme that you want to describe permissions for.
|
@@ -4196,8 +4217,8 @@ module Aws::QuickSight
|
|
4196
4217
|
# The name of the user that you want to describe.
|
4197
4218
|
#
|
4198
4219
|
# @option params [required, String] :aws_account_id
|
4199
|
-
# The ID for the Amazon Web Services account
|
4200
|
-
# Currently, you use the ID for the Amazon Web Services account
|
4220
|
+
# The ID for the Amazon Web Services account that the user is in.
|
4221
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
4201
4222
|
# contains your Amazon QuickSight account.
|
4202
4223
|
#
|
4203
4224
|
# @option params [required, String] :namespace
|
@@ -4440,9 +4461,9 @@ module Aws::QuickSight
|
|
4440
4461
|
end
|
4441
4462
|
|
4442
4463
|
# Generates a session URL and authorization code that you can use to
|
4443
|
-
# embed an Amazon QuickSight read-only dashboard in your web
|
4444
|
-
# code. Before you use this command, make sure that you have
|
4445
|
-
# the dashboards and permissions.
|
4464
|
+
# embed an Amazon Amazon QuickSight read-only dashboard in your web
|
4465
|
+
# server code. Before you use this command, make sure that you have
|
4466
|
+
# configured the dashboards and permissions.
|
4446
4467
|
#
|
4447
4468
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
4448
4469
|
# not from the user's browser. The following rules apply to the
|
@@ -4469,8 +4490,8 @@ module Aws::QuickSight
|
|
4469
4490
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
|
4470
4491
|
#
|
4471
4492
|
# @option params [required, String] :aws_account_id
|
4472
|
-
# The ID for the Amazon Web Services account
|
4473
|
-
#
|
4493
|
+
# The ID for the Amazon Web Services account that contains the dashboard
|
4494
|
+
# that you're embedding.
|
4474
4495
|
#
|
4475
4496
|
# @option params [required, String] :dashboard_id
|
4476
4497
|
# The ID for the dashboard, also added to the Identity and Access
|
@@ -4495,11 +4516,11 @@ module Aws::QuickSight
|
|
4495
4516
|
# Adds persistence of state for the user session in an embedded
|
4496
4517
|
# dashboard. Persistence applies to the sheet and the parameter
|
4497
4518
|
# settings. These are control settings that the dashboard subscriber
|
4498
|
-
# (QuickSight reader) chooses while viewing the dashboard. If
|
4499
|
-
# set to `TRUE`, the settings are the same when the subscriber
|
4500
|
-
# the same dashboard URL. The state is stored in
|
4501
|
-
# browser cookie. If this is set to FALSE, the
|
4502
|
-
# is not persisted. The default is `FALSE`.
|
4519
|
+
# (Amazon QuickSight reader) chooses while viewing the dashboard. If
|
4520
|
+
# this is set to `TRUE`, the settings are the same when the subscriber
|
4521
|
+
# reopens the same dashboard URL. The state is stored in Amazon
|
4522
|
+
# QuickSight, not in a browser cookie. If this is set to FALSE, the
|
4523
|
+
# state of the user session is not persisted. The default is `FALSE`.
|
4503
4524
|
#
|
4504
4525
|
# @option params [String] :user_arn
|
4505
4526
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
@@ -4511,23 +4532,22 @@ module Aws::QuickSight
|
|
4511
4532
|
#
|
4512
4533
|
# * Invited nonfederated users
|
4513
4534
|
#
|
4514
|
-
# *
|
4515
|
-
#
|
4516
|
-
# federation.
|
4535
|
+
# * IAMusers and IAMrole-based sessions authenticated through Federated
|
4536
|
+
# Single Sign-On using SAML, OpenID Connect, or IAMfederation.
|
4517
4537
|
#
|
4518
|
-
# Omit this parameter for users in the third group –
|
4538
|
+
# Omit this parameter for users in the third group – IAMusers and IAM
|
4519
4539
|
# role-based sessions.
|
4520
4540
|
#
|
4521
4541
|
# @option params [String] :namespace
|
4522
|
-
# The Amazon QuickSight namespace that the
|
4523
|
-
# you
|
4524
|
-
#
|
4542
|
+
# The Amazon QuickSight namespace that contains the dashboard IDs in
|
4543
|
+
# this request. If you're not using a custom namespace, set `Namespace
|
4544
|
+
# = default`.
|
4525
4545
|
#
|
4526
4546
|
# @option params [Array<String>] :additional_dashboard_ids
|
4527
4547
|
# A list of one or more dashboard IDs that you want to add to a session
|
4528
4548
|
# that includes anonymous users. The `IdentityType` parameter must be
|
4529
4549
|
# set to `ANONYMOUS` for this to work, because other identity types
|
4530
|
-
# authenticate as QuickSight or
|
4550
|
+
# authenticate as Amazon QuickSight or IAMusers. For example, if you set
|
4531
4551
|
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
4532
4552
|
# identity-type ANONYMOUS`", the session can access all three
|
4533
4553
|
# dashboards.
|
@@ -4569,29 +4589,28 @@ module Aws::QuickSight
|
|
4569
4589
|
end
|
4570
4590
|
|
4571
4591
|
# Generates a session URL and authorization code that you can use to
|
4572
|
-
# embed the Amazon QuickSight console in your web server code.
|
4573
|
-
# `GetSessionEmbedUrl` where you want to provide an authoring portal
|
4592
|
+
# embed the Amazon Amazon QuickSight console in your web server code.
|
4593
|
+
# Use `GetSessionEmbedUrl` where you want to provide an authoring portal
|
4574
4594
|
# that allows users to create data sources, datasets, analyses, and
|
4575
|
-
# dashboards. The users who access an embedded QuickSight console
|
4576
|
-
# belong to the author or admin security cohort. If you want to
|
4577
|
-
# permissions to some of these features, add a custom
|
4578
|
-
# profile to the user with the ` UpdateUser ` API operation.
|
4579
|
-
# RegisterUser ` API operation to add a new user with a custom
|
4595
|
+
# dashboards. The users who access an embedded Amazon QuickSight console
|
4596
|
+
# need belong to the author or admin security cohort. If you want to
|
4597
|
+
# restrict permissions to some of these features, add a custom
|
4598
|
+
# permissions profile to the user with the ` UpdateUser ` API operation.
|
4599
|
+
# Use ` RegisterUser ` API operation to add a new user with a custom
|
4580
4600
|
# permission profile attached. For more information, see the following
|
4581
4601
|
# sections in the *Amazon QuickSight User Guide*\:
|
4582
4602
|
#
|
4583
|
-
# * [Embedding
|
4584
|
-
# GetSessionEmbedUrl][1]
|
4603
|
+
# * [Embedding Analytics][1]
|
4585
4604
|
#
|
4586
4605
|
# * [Customizing Access to the Amazon QuickSight Console][2]
|
4587
4606
|
#
|
4588
4607
|
#
|
4589
4608
|
#
|
4590
|
-
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics
|
4609
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html
|
4591
4610
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
|
4592
4611
|
#
|
4593
4612
|
# @option params [required, String] :aws_account_id
|
4594
|
-
# The ID for the Amazon Web Services account
|
4613
|
+
# The ID for the Amazon Web Services account associated with your Amazon
|
4595
4614
|
# QuickSight subscription.
|
4596
4615
|
#
|
4597
4616
|
# @option params [String] :entry_point
|
@@ -4607,10 +4626,10 @@ module Aws::QuickSight
|
|
4607
4626
|
# * `/start/favorites`
|
4608
4627
|
#
|
4609
4628
|
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
4610
|
-
# key from the QuickSight console URL of the dashboard
|
4629
|
+
# key from the Amazon QuickSight console URL of the dashboard
|
4611
4630
|
#
|
4612
4631
|
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
4613
|
-
# from the QuickSight console URL of the analysis
|
4632
|
+
# from the Amazon QuickSight console URL of the analysis
|
4614
4633
|
#
|
4615
4634
|
# @option params [Integer] :session_lifetime_in_minutes
|
4616
4635
|
# How many minutes the session is valid. The session lifetime must be
|
@@ -4664,10 +4683,10 @@ module Aws::QuickSight
|
|
4664
4683
|
end
|
4665
4684
|
|
4666
4685
|
# Lists Amazon QuickSight analyses that exist in the specified Amazon
|
4667
|
-
# Web Services account
|
4686
|
+
# Web Services account.
|
4668
4687
|
#
|
4669
4688
|
# @option params [required, String] :aws_account_id
|
4670
|
-
# The ID of the Amazon Web Services account
|
4689
|
+
# The ID of the Amazon Web Services account that contains the analyses.
|
4671
4690
|
#
|
4672
4691
|
# @option params [String] :next_token
|
4673
4692
|
# A pagination token that can be used in a subsequent request.
|
@@ -4714,11 +4733,11 @@ module Aws::QuickSight
|
|
4714
4733
|
req.send_request(options)
|
4715
4734
|
end
|
4716
4735
|
|
4717
|
-
# Lists all the versions of the dashboards in the QuickSight
|
4736
|
+
# Lists all the versions of the dashboards in the Amazon QuickSight
|
4718
4737
|
# subscription.
|
4719
4738
|
#
|
4720
4739
|
# @option params [required, String] :aws_account_id
|
4721
|
-
# The ID of the Amazon Web Services account
|
4740
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
4722
4741
|
# that you're listing versions for.
|
4723
4742
|
#
|
4724
4743
|
# @option params [required, String] :dashboard_id
|
@@ -4771,11 +4790,11 @@ module Aws::QuickSight
|
|
4771
4790
|
req.send_request(options)
|
4772
4791
|
end
|
4773
4792
|
|
4774
|
-
# Lists dashboards in an Amazon Web Services account
|
4793
|
+
# Lists dashboards in an Amazon Web Services account.
|
4775
4794
|
#
|
4776
4795
|
# @option params [required, String] :aws_account_id
|
4777
|
-
# The ID of the Amazon Web Services account
|
4778
|
-
#
|
4796
|
+
# The ID of the Amazon Web Services account that contains the dashboards
|
4797
|
+
# that you're listing.
|
4779
4798
|
#
|
4780
4799
|
# @option params [String] :next_token
|
4781
4800
|
# The token for the next set of results, or null if there are no more
|
@@ -4825,13 +4844,13 @@ module Aws::QuickSight
|
|
4825
4844
|
end
|
4826
4845
|
|
4827
4846
|
# Lists all of the datasets belonging to the current Amazon Web Services
|
4828
|
-
# account
|
4847
|
+
# account in an Amazon Web Services Region;.
|
4829
4848
|
#
|
4830
4849
|
# The permissions resource is
|
4831
4850
|
# `arn:aws:quicksight:region:aws-account-id:dataset/*`.
|
4832
4851
|
#
|
4833
4852
|
# @option params [required, String] :aws_account_id
|
4834
|
-
# The Amazon Web Services account
|
4853
|
+
# The Amazon Web Services account ID.
|
4835
4854
|
#
|
4836
4855
|
# @option params [String] :next_token
|
4837
4856
|
# The token for the next set of results, or null if there are no more
|
@@ -4887,10 +4906,10 @@ module Aws::QuickSight
|
|
4887
4906
|
end
|
4888
4907
|
|
4889
4908
|
# Lists data sources in current Amazon Web Services Region; that belong
|
4890
|
-
# to this Amazon Web Services account
|
4909
|
+
# to this Amazon Web Services account.
|
4891
4910
|
#
|
4892
4911
|
# @option params [required, String] :aws_account_id
|
4893
|
-
# The Amazon Web Services account
|
4912
|
+
# The Amazon Web Services account ID.
|
4894
4913
|
#
|
4895
4914
|
# @option params [String] :next_token
|
4896
4915
|
# The token for the next set of results, or null if there are no more
|
@@ -5148,8 +5167,8 @@ module Aws::QuickSight
|
|
5148
5167
|
# The maximum number of results to return from this request.
|
5149
5168
|
#
|
5150
5169
|
# @option params [required, String] :aws_account_id
|
5151
|
-
# The ID for the Amazon Web Services account
|
5152
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5170
|
+
# The ID for the Amazon Web Services account that the group is in.
|
5171
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5153
5172
|
# contains your Amazon QuickSight account.
|
5154
5173
|
#
|
5155
5174
|
# @option params [required, String] :namespace
|
@@ -5193,8 +5212,8 @@ module Aws::QuickSight
|
|
5193
5212
|
# Lists all user groups in Amazon QuickSight.
|
5194
5213
|
#
|
5195
5214
|
# @option params [required, String] :aws_account_id
|
5196
|
-
# The ID for the Amazon Web Services account
|
5197
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5215
|
+
# The ID for the Amazon Web Services account that the group is in.
|
5216
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5198
5217
|
# contains your Amazon QuickSight account.
|
5199
5218
|
#
|
5200
5219
|
# @option params [String] :next_token
|
@@ -5242,11 +5261,11 @@ module Aws::QuickSight
|
|
5242
5261
|
req.send_request(options)
|
5243
5262
|
end
|
5244
5263
|
|
5245
|
-
# Lists
|
5264
|
+
# Lists IAMpolicy assignments in the current Amazon QuickSight account.
|
5246
5265
|
#
|
5247
5266
|
# @option params [required, String] :aws_account_id
|
5248
|
-
# The ID of the Amazon Web Services account
|
5249
|
-
#
|
5267
|
+
# The ID of the Amazon Web Services account that contains these
|
5268
|
+
# IAMpolicy assignments.
|
5250
5269
|
#
|
5251
5270
|
# @option params [String] :assignment_status
|
5252
5271
|
# The status of the assignments.
|
@@ -5296,12 +5315,12 @@ module Aws::QuickSight
|
|
5296
5315
|
req.send_request(options)
|
5297
5316
|
end
|
5298
5317
|
|
5299
|
-
# Lists all the
|
5318
|
+
# Lists all the IAMpolicy assignments, including the Amazon Resource
|
5300
5319
|
# Names (ARNs) for the IAM policies assigned to the specified user and
|
5301
5320
|
# group or groups that the user belongs to.
|
5302
5321
|
#
|
5303
5322
|
# @option params [required, String] :aws_account_id
|
5304
|
-
# The ID of the Amazon Web Services account
|
5323
|
+
# The ID of the Amazon Web Services account that contains the
|
5305
5324
|
# assignments.
|
5306
5325
|
#
|
5307
5326
|
# @option params [required, String] :user_name
|
@@ -5362,7 +5381,7 @@ module Aws::QuickSight
|
|
5362
5381
|
# results.
|
5363
5382
|
#
|
5364
5383
|
# @option params [required, String] :aws_account_id
|
5365
|
-
# The Amazon Web Services account
|
5384
|
+
# The Amazon Web Services account ID.
|
5366
5385
|
#
|
5367
5386
|
# @option params [Integer] :max_results
|
5368
5387
|
# The maximum number of results to be returned per request.
|
@@ -5415,10 +5434,10 @@ module Aws::QuickSight
|
|
5415
5434
|
req.send_request(options)
|
5416
5435
|
end
|
5417
5436
|
|
5418
|
-
# Lists the namespaces for the specified Amazon Web Services account
|
5437
|
+
# Lists the namespaces for the specified Amazon Web Services account.
|
5419
5438
|
#
|
5420
5439
|
# @option params [required, String] :aws_account_id
|
5421
|
-
# The ID for the Amazon Web Services account
|
5440
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
5422
5441
|
# QuickSight namespaces that you want to list.
|
5423
5442
|
#
|
5424
5443
|
# @option params [String] :next_token
|
@@ -5505,7 +5524,7 @@ module Aws::QuickSight
|
|
5505
5524
|
# Lists all the aliases of a template.
|
5506
5525
|
#
|
5507
5526
|
# @option params [required, String] :aws_account_id
|
5508
|
-
# The ID of the Amazon Web Services account
|
5527
|
+
# The ID of the Amazon Web Services account that contains the template
|
5509
5528
|
# aliases that you're listing.
|
5510
5529
|
#
|
5511
5530
|
# @option params [required, String] :template_id
|
@@ -5559,7 +5578,7 @@ module Aws::QuickSight
|
|
5559
5578
|
# QuickSight account.
|
5560
5579
|
#
|
5561
5580
|
# @option params [required, String] :aws_account_id
|
5562
|
-
# The ID of the Amazon Web Services account
|
5581
|
+
# The ID of the Amazon Web Services account that contains the templates
|
5563
5582
|
# that you're listing.
|
5564
5583
|
#
|
5565
5584
|
# @option params [required, String] :template_id
|
@@ -5614,7 +5633,7 @@ module Aws::QuickSight
|
|
5614
5633
|
# Lists all the templates in the current Amazon QuickSight account.
|
5615
5634
|
#
|
5616
5635
|
# @option params [required, String] :aws_account_id
|
5617
|
-
# The ID of the Amazon Web Services account
|
5636
|
+
# The ID of the Amazon Web Services account that contains the templates
|
5618
5637
|
# that you're listing.
|
5619
5638
|
#
|
5620
5639
|
# @option params [String] :next_token
|
@@ -5666,7 +5685,7 @@ module Aws::QuickSight
|
|
5666
5685
|
# Lists all the aliases of a theme.
|
5667
5686
|
#
|
5668
5687
|
# @option params [required, String] :aws_account_id
|
5669
|
-
# The ID of the Amazon Web Services account
|
5688
|
+
# The ID of the Amazon Web Services account that contains the theme
|
5670
5689
|
# aliases that you're listing.
|
5671
5690
|
#
|
5672
5691
|
# @option params [required, String] :theme_id
|
@@ -5715,10 +5734,10 @@ module Aws::QuickSight
|
|
5715
5734
|
end
|
5716
5735
|
|
5717
5736
|
# Lists all the versions of the themes in the current Amazon Web
|
5718
|
-
# Services account
|
5737
|
+
# Services account.
|
5719
5738
|
#
|
5720
5739
|
# @option params [required, String] :aws_account_id
|
5721
|
-
# The ID of the Amazon Web Services account
|
5740
|
+
# The ID of the Amazon Web Services account that contains the themes
|
5722
5741
|
# that you're listing.
|
5723
5742
|
#
|
5724
5743
|
# @option params [required, String] :theme_id
|
@@ -5770,10 +5789,10 @@ module Aws::QuickSight
|
|
5770
5789
|
req.send_request(options)
|
5771
5790
|
end
|
5772
5791
|
|
5773
|
-
# Lists all the themes in the current Amazon Web Services account
|
5792
|
+
# Lists all the themes in the current Amazon Web Services account.
|
5774
5793
|
#
|
5775
5794
|
# @option params [required, String] :aws_account_id
|
5776
|
-
# The ID of the Amazon Web Services account
|
5795
|
+
# The ID of the Amazon Web Services account that contains the themes
|
5777
5796
|
# that you're listing.
|
5778
5797
|
#
|
5779
5798
|
# @option params [String] :next_token
|
@@ -5843,8 +5862,8 @@ module Aws::QuickSight
|
|
5843
5862
|
# memberships for.
|
5844
5863
|
#
|
5845
5864
|
# @option params [required, String] :aws_account_id
|
5846
|
-
# The Amazon Web Services account
|
5847
|
-
#
|
5865
|
+
# The Amazon Web Services account ID that the user is in. Currently, you
|
5866
|
+
# use the ID for the Amazon Web Services account that contains your
|
5848
5867
|
# Amazon QuickSight account.
|
5849
5868
|
#
|
5850
5869
|
# @option params [required, String] :namespace
|
@@ -5897,8 +5916,8 @@ module Aws::QuickSight
|
|
5897
5916
|
# account.
|
5898
5917
|
#
|
5899
5918
|
# @option params [required, String] :aws_account_id
|
5900
|
-
# The ID for the Amazon Web Services account
|
5901
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5919
|
+
# The ID for the Amazon Web Services account that the user is in.
|
5920
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5902
5921
|
# contains your Amazon QuickSight account.
|
5903
5922
|
#
|
5904
5923
|
# @option params [String] :next_token
|
@@ -5961,7 +5980,7 @@ module Aws::QuickSight
|
|
5961
5980
|
# Amazon QuickSight supports several ways of managing the identity of
|
5962
5981
|
# users. This parameter accepts two values:
|
5963
5982
|
#
|
5964
|
-
# * `IAM`\: A user whose identity maps to an existing
|
5983
|
+
# * `IAM`\: A user whose identity maps to an existing IAMuser or role.
|
5965
5984
|
#
|
5966
5985
|
# * `QUICKSIGHT`\: A user whose identity is owned and managed internally
|
5967
5986
|
# by Amazon QuickSight.
|
@@ -5986,25 +6005,25 @@ module Aws::QuickSight
|
|
5986
6005
|
# * `RESTRICTED_AUTHOR`\: This role isn't currently available for use.
|
5987
6006
|
#
|
5988
6007
|
# @option params [String] :iam_arn
|
5989
|
-
# The ARN of the
|
6008
|
+
# The ARN of the IAMuser or role that you are registering with Amazon
|
5990
6009
|
# QuickSight.
|
5991
6010
|
#
|
5992
6011
|
# @option params [String] :session_name
|
5993
6012
|
# You need to use this parameter only when you register one or more
|
5994
|
-
# users using an assumed
|
5995
|
-
#
|
5996
|
-
#
|
5997
|
-
#
|
5998
|
-
#
|
5999
|
-
#
|
6013
|
+
# users using an assumed IAMrole. You don't need to provide the session
|
6014
|
+
# name for other scenarios, for example when you are registering an
|
6015
|
+
# IAMuser or an Amazon QuickSight user. You can register multiple users
|
6016
|
+
# using the same IAMrole if each user has a different session name. For
|
6017
|
+
# more information on assuming IAMroles, see [ `assume-role` ][1] in the
|
6018
|
+
# *AWS CLI Reference.*
|
6000
6019
|
#
|
6001
6020
|
#
|
6002
6021
|
#
|
6003
6022
|
# [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
|
6004
6023
|
#
|
6005
6024
|
# @option params [required, String] :aws_account_id
|
6006
|
-
# The ID for the Amazon Web Services account
|
6007
|
-
# Currently, you use the ID for the Amazon Web Services account
|
6025
|
+
# The ID for the Amazon Web Services account that the user is in.
|
6026
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
6008
6027
|
# contains your Amazon QuickSight account.
|
6009
6028
|
#
|
6010
6029
|
# @option params [required, String] :namespace
|
@@ -6033,22 +6052,22 @@ module Aws::QuickSight
|
|
6033
6052
|
#
|
6034
6053
|
# A set of custom permissions includes any combination of these
|
6035
6054
|
# restrictions. Currently, you need to create the profile names for
|
6036
|
-
# custom permission sets by using the QuickSight console. Then,
|
6037
|
-
# the `RegisterUser` API operation to assign the named set of
|
6038
|
-
# permissions to a QuickSight user.
|
6055
|
+
# custom permission sets by using the Amazon QuickSight console. Then,
|
6056
|
+
# you use the `RegisterUser` API operation to assign the named set of
|
6057
|
+
# permissions to a Amazon QuickSight user.
|
6039
6058
|
#
|
6040
|
-
# QuickSight custom permissions are applied through
|
6059
|
+
# Amazon QuickSight custom permissions are applied through IAMpolicies.
|
6041
6060
|
# Therefore, they override the permissions typically granted by
|
6042
|
-
# assigning QuickSight users to one of the default security
|
6043
|
-
# QuickSight (admin, author, reader).
|
6061
|
+
# assigning Amazon QuickSight users to one of the default security
|
6062
|
+
# cohorts in Amazon QuickSight (admin, author, reader).
|
6044
6063
|
#
|
6045
|
-
# This feature is available only to QuickSight Enterprise edition
|
6064
|
+
# This feature is available only to Amazon QuickSight Enterprise edition
|
6046
6065
|
# subscriptions.
|
6047
6066
|
#
|
6048
6067
|
# @option params [String] :external_login_federation_provider_type
|
6049
6068
|
# The type of supported external login provider that provides identity
|
6050
|
-
# to let a user federate into Amazon QuickSight with an associated
|
6051
|
-
# Identity and Access Management
|
6069
|
+
# to let a user federate into Amazon QuickSight with an associated
|
6070
|
+
# Identity and Access Management(IAM) role. The type of supported
|
6052
6071
|
# external login provider can be one of the following.
|
6053
6072
|
#
|
6054
6073
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
@@ -6062,10 +6081,10 @@ module Aws::QuickSight
|
|
6062
6081
|
#
|
6063
6082
|
# @option params [String] :custom_federation_provider_url
|
6064
6083
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
6065
|
-
# identity to let a user federate into QuickSight with an
|
6066
|
-
# Identity and Access Management
|
6067
|
-
# be used when `ExternalLoginFederationProviderType`
|
6068
|
-
# `CUSTOM_OIDC`.
|
6084
|
+
# identity to let a user federate into Amazon QuickSight with an
|
6085
|
+
# associated Identity and Access Management(IAM) role. This parameter
|
6086
|
+
# should only be used when `ExternalLoginFederationProviderType`
|
6087
|
+
# parameter is set to `CUSTOM_OIDC`.
|
6069
6088
|
#
|
6070
6089
|
# @option params [String] :external_login_id
|
6071
6090
|
# The identity ID for a user in the external login provider.
|
@@ -6123,7 +6142,7 @@ module Aws::QuickSight
|
|
6123
6142
|
# Restores an analysis.
|
6124
6143
|
#
|
6125
6144
|
# @option params [required, String] :aws_account_id
|
6126
|
-
# The ID of the Amazon Web Services account
|
6145
|
+
# The ID of the Amazon Web Services account that contains the analysis.
|
6127
6146
|
#
|
6128
6147
|
# @option params [required, String] :analysis_id
|
6129
6148
|
# The ID of the analysis that you're restoring.
|
@@ -6166,7 +6185,7 @@ module Aws::QuickSight
|
|
6166
6185
|
# </note>
|
6167
6186
|
#
|
6168
6187
|
# @option params [required, String] :aws_account_id
|
6169
|
-
# The ID of the Amazon Web Services account
|
6188
|
+
# The ID of the Amazon Web Services account that contains the analyses
|
6170
6189
|
# that you're searching for.
|
6171
6190
|
#
|
6172
6191
|
# @option params [required, Array<Types::AnalysisSearchFilter>] :filters
|
@@ -6233,8 +6252,8 @@ module Aws::QuickSight
|
|
6233
6252
|
# </note>
|
6234
6253
|
#
|
6235
6254
|
# @option params [required, String] :aws_account_id
|
6236
|
-
# The ID of the Amazon Web Services account
|
6237
|
-
#
|
6255
|
+
# The ID of the Amazon Web Services account that contains the user whose
|
6256
|
+
# dashboards you're searching for.
|
6238
6257
|
#
|
6239
6258
|
# @option params [required, Array<Types::DashboardSearchFilter>] :filters
|
6240
6259
|
# The filters to apply to the search. Currently, you can search only by
|
@@ -6358,8 +6377,8 @@ module Aws::QuickSight
|
|
6358
6377
|
req.send_request(options)
|
6359
6378
|
end
|
6360
6379
|
|
6361
|
-
# Assigns one or more tags (key-value pairs) to the specified
|
6362
|
-
# resource.
|
6380
|
+
# Assigns one or more tags (key-value pairs) to the specified Amazon
|
6381
|
+
# QuickSight resource.
|
6363
6382
|
#
|
6364
6383
|
# Tags can help you organize and categorize your resources. You can also
|
6365
6384
|
# use them to scope user permissions, by granting a user permission to
|
@@ -6370,18 +6389,19 @@ module Aws::QuickSight
|
|
6370
6389
|
# key that is already associated with the resource, the new tag value
|
6371
6390
|
# that you specify replaces the previous value for that tag.
|
6372
6391
|
#
|
6373
|
-
# You can associate as many as 50 tags with a resource.
|
6374
|
-
# supports tagging on data set, data source, dashboard, and
|
6392
|
+
# You can associate as many as 50 tags with a resource. Amazon
|
6393
|
+
# QuickSight supports tagging on data set, data source, dashboard, and
|
6394
|
+
# template.
|
6375
6395
|
#
|
6376
|
-
# Tagging for QuickSight works in a similar way to tagging for
|
6377
|
-
# services, except for the following:
|
6396
|
+
# Tagging for Amazon QuickSight works in a similar way to tagging for
|
6397
|
+
# other AWS services, except for the following:
|
6378
6398
|
#
|
6379
|
-
# * You can't use tags to track AWS costs for QuickSight. This
|
6380
|
-
# restriction is because QuickSight costs are based on users
|
6381
|
-
# capacity, which aren't taggable resources.
|
6399
|
+
# * You can't use tags to track AWS costs for Amazon QuickSight. This
|
6400
|
+
# restriction is because Amazon QuickSight costs are based on users
|
6401
|
+
# and SPICE capacity, which aren't taggable resources.
|
6382
6402
|
#
|
6383
|
-
# * QuickSight doesn't currently support the Tag Editor for
|
6384
|
-
# Groups.
|
6403
|
+
# * Amazon QuickSight doesn't currently support the Tag Editor for
|
6404
|
+
# Resource Groups.
|
6385
6405
|
#
|
6386
6406
|
# @option params [required, String] :resource_arn
|
6387
6407
|
# The Amazon Resource Name (ARN) of the resource that you want to tag.
|
@@ -6460,23 +6480,24 @@ module Aws::QuickSight
|
|
6460
6480
|
# Services Region;. Currently, the only customization you can use is a
|
6461
6481
|
# theme.
|
6462
6482
|
#
|
6463
|
-
# You can use customizations for your Amazon Web Services account
|
6464
|
-
#
|
6483
|
+
# You can use customizations for your Amazon Web Services account or, if
|
6484
|
+
# you specify a namespace, for a Amazon QuickSight namespace instead.
|
6465
6485
|
# Customizations that apply to a namespace override customizations that
|
6466
|
-
# apply to an Amazon Web Services account
|
6486
|
+
# apply to an Amazon Web Services account. To find out which
|
6467
6487
|
# customizations apply, use the `DescribeAccountCustomization` API
|
6468
6488
|
# operation.
|
6469
6489
|
#
|
6470
6490
|
# @option params [required, String] :aws_account_id
|
6471
|
-
# The ID for the Amazon Web Services account
|
6472
|
-
# QuickSight customizations for.
|
6491
|
+
# The ID for the Amazon Web Services account that you want to update
|
6492
|
+
# Amazon QuickSight customizations for.
|
6473
6493
|
#
|
6474
6494
|
# @option params [String] :namespace
|
6475
|
-
# The namespace that you want to update QuickSight customizations
|
6495
|
+
# The namespace that you want to update Amazon QuickSight customizations
|
6496
|
+
# for.
|
6476
6497
|
#
|
6477
6498
|
# @option params [required, Types::AccountCustomization] :account_customization
|
6478
|
-
# The QuickSight customizations you're updating in the current
|
6479
|
-
# Web Services Region;.
|
6499
|
+
# The Amazon QuickSight customizations you're updating in the current
|
6500
|
+
# Amazon Web Services Region;.
|
6480
6501
|
#
|
6481
6502
|
# @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6482
6503
|
#
|
@@ -6516,22 +6537,22 @@ module Aws::QuickSight
|
|
6516
6537
|
end
|
6517
6538
|
|
6518
6539
|
# Updates the Amazon QuickSight settings in your Amazon Web Services
|
6519
|
-
# account
|
6540
|
+
# account.
|
6520
6541
|
#
|
6521
6542
|
# @option params [required, String] :aws_account_id
|
6522
|
-
# The ID for the Amazon Web Services account
|
6543
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
6523
6544
|
# QuickSight settings that you want to list.
|
6524
6545
|
#
|
6525
6546
|
# @option params [required, String] :default_namespace
|
6526
|
-
# The default namespace for this Amazon Web Services account
|
6527
|
-
#
|
6528
|
-
#
|
6529
|
-
#
|
6547
|
+
# The default namespace for this Amazon Web Services account. Currently,
|
6548
|
+
# the default is `default`. Identity and Access Management (IAM) users
|
6549
|
+
# that register for the first time with Amazon QuickSight provide an
|
6550
|
+
# email that becomes associated with the default namespace.
|
6530
6551
|
#
|
6531
6552
|
# @option params [String] :notification_email
|
6532
|
-
# The email address that you want QuickSight to send
|
6533
|
-
# regarding your Amazon Web Services account
|
6534
|
-
# subscription.
|
6553
|
+
# The email address that you want Amazon QuickSight to send
|
6554
|
+
# notifications to regarding your Amazon Web Services account or Amazon
|
6555
|
+
# QuickSight subscription.
|
6535
6556
|
#
|
6536
6557
|
# @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6537
6558
|
#
|
@@ -6563,7 +6584,7 @@ module Aws::QuickSight
|
|
6563
6584
|
# Updates an analysis in Amazon QuickSight
|
6564
6585
|
#
|
6565
6586
|
# @option params [required, String] :aws_account_id
|
6566
|
-
# The ID of the Amazon Web Services account
|
6587
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
6567
6588
|
# that you're updating.
|
6568
6589
|
#
|
6569
6590
|
# @option params [required, String] :analysis_id
|
@@ -6572,7 +6593,7 @@ module Aws::QuickSight
|
|
6572
6593
|
#
|
6573
6594
|
# @option params [required, String] :name
|
6574
6595
|
# A descriptive name for the analysis that you're updating. This name
|
6575
|
-
# displays for the analysis in the QuickSight console.
|
6596
|
+
# displays for the analysis in the Amazon QuickSight console.
|
6576
6597
|
#
|
6577
6598
|
# @option params [Types::Parameters] :parameters
|
6578
6599
|
# The parameter names and override values that you want to use. An
|
@@ -6586,8 +6607,8 @@ module Aws::QuickSight
|
|
6586
6607
|
#
|
6587
6608
|
# @option params [String] :theme_arn
|
6588
6609
|
# The Amazon Resource Name (ARN) for the theme to apply to the analysis
|
6589
|
-
# that you're creating. To see the theme in the QuickSight
|
6590
|
-
# make sure that you have access to it.
|
6610
|
+
# that you're creating. To see the theme in the Amazon QuickSight
|
6611
|
+
# console, make sure that you have access to it.
|
6591
6612
|
#
|
6592
6613
|
# @return [Types::UpdateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6593
6614
|
#
|
@@ -6663,9 +6684,9 @@ module Aws::QuickSight
|
|
6663
6684
|
# Updates the read and write permissions for an analysis.
|
6664
6685
|
#
|
6665
6686
|
# @option params [required, String] :aws_account_id
|
6666
|
-
# The ID of the Amazon Web Services account
|
6687
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
6667
6688
|
# whose permissions you're updating. You must be using the Amazon Web
|
6668
|
-
# Services account
|
6689
|
+
# Services account that the analysis is in.
|
6669
6690
|
#
|
6670
6691
|
# @option params [required, String] :analysis_id
|
6671
6692
|
# The ID of the analysis whose permissions you're updating. The ID is
|
@@ -6726,7 +6747,7 @@ module Aws::QuickSight
|
|
6726
6747
|
req.send_request(options)
|
6727
6748
|
end
|
6728
6749
|
|
6729
|
-
# Updates a dashboard in an Amazon Web Services account
|
6750
|
+
# Updates a dashboard in an Amazon Web Services account.
|
6730
6751
|
#
|
6731
6752
|
# <note markdown="1"> Updating a Dashboard creates a new dashboard version but does not
|
6732
6753
|
# immediately publish the new version. You can update the published
|
@@ -6736,7 +6757,7 @@ module Aws::QuickSight
|
|
6736
6757
|
# </note>
|
6737
6758
|
#
|
6738
6759
|
# @option params [required, String] :aws_account_id
|
6739
|
-
# The ID of the Amazon Web Services account
|
6760
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
6740
6761
|
# that you're updating.
|
6741
6762
|
#
|
6742
6763
|
# @option params [required, String] :dashboard_id
|
@@ -6753,8 +6774,8 @@ module Aws::QuickSight
|
|
6753
6774
|
# from an analysis, first convert the analysis to a template by using
|
6754
6775
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
6755
6776
|
# Amazon Resource Name (ARN) of the source template. The
|
6756
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
6757
|
-
# any QuickSight-supported Amazon Web Services Region;.
|
6777
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
6778
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
6758
6779
|
#
|
6759
6780
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
6760
6781
|
# replacement datasets for the placeholders listed in the original. The
|
@@ -6773,9 +6794,9 @@ module Aws::QuickSight
|
|
6773
6794
|
#
|
6774
6795
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
|
6775
6796
|
# either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
6776
|
-
# QuickSight disables the left filter pane on the published
|
6777
|
-
# which can be used for ad hoc (one-time) filtering. This
|
6778
|
-
# `ENABLED` by default.
|
6797
|
+
# Amazon QuickSight disables the left filter pane on the published
|
6798
|
+
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
6799
|
+
# option is `ENABLED` by default.
|
6779
6800
|
#
|
6780
6801
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
6781
6802
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
@@ -6790,7 +6811,7 @@ module Aws::QuickSight
|
|
6790
6811
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
6791
6812
|
# this dashboard. If you add a value for this field, it overrides the
|
6792
6813
|
# value that was originally associated with the entity. The theme ARN
|
6793
|
-
# must exist in the same Amazon Web Services account
|
6814
|
+
# must exist in the same Amazon Web Services account where you create
|
6794
6815
|
# the dashboard.
|
6795
6816
|
#
|
6796
6817
|
# @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -6881,7 +6902,7 @@ module Aws::QuickSight
|
|
6881
6902
|
# Updates read and write permissions on a dashboard.
|
6882
6903
|
#
|
6883
6904
|
# @option params [required, String] :aws_account_id
|
6884
|
-
# The ID of the Amazon Web Services account
|
6905
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
6885
6906
|
# whose permissions you're updating.
|
6886
6907
|
#
|
6887
6908
|
# @option params [required, String] :dashboard_id
|
@@ -6943,7 +6964,7 @@ module Aws::QuickSight
|
|
6943
6964
|
# Updates the published version of a dashboard.
|
6944
6965
|
#
|
6945
6966
|
# @option params [required, String] :aws_account_id
|
6946
|
-
# The ID of the Amazon Web Services account
|
6967
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
6947
6968
|
# that you're updating.
|
6948
6969
|
#
|
6949
6970
|
# @option params [required, String] :dashboard_id
|
@@ -6986,11 +7007,11 @@ module Aws::QuickSight
|
|
6986
7007
|
# Updates a dataset.
|
6987
7008
|
#
|
6988
7009
|
# @option params [required, String] :aws_account_id
|
6989
|
-
# The Amazon Web Services account
|
7010
|
+
# The Amazon Web Services account ID.
|
6990
7011
|
#
|
6991
7012
|
# @option params [required, String] :data_set_id
|
6992
7013
|
# The ID for the dataset that you want to update. This ID is unique per
|
6993
|
-
# Amazon Web Services Region; for each Amazon Web Services account
|
7014
|
+
# Amazon Web Services Region; for each Amazon Web Services account.
|
6994
7015
|
#
|
6995
7016
|
# @option params [required, String] :name
|
6996
7017
|
# The display name for the dataset.
|
@@ -7007,7 +7028,7 @@ module Aws::QuickSight
|
|
7007
7028
|
# Indicates whether you want to import the data into SPICE.
|
7008
7029
|
#
|
7009
7030
|
# @option params [Array<Types::ColumnGroup>] :column_groups
|
7010
|
-
# Groupings of columns that work together in certain QuickSight
|
7031
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
7011
7032
|
# features. Currently, only geospatial hierarchy is supported.
|
7012
7033
|
#
|
7013
7034
|
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
@@ -7025,6 +7046,10 @@ module Aws::QuickSight
|
|
7025
7046
|
# @option params [Array<Types::ColumnLevelPermissionRule>] :column_level_permission_rules
|
7026
7047
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
7027
7048
|
#
|
7049
|
+
# @option params [Types::DataSetUsageConfiguration] :data_set_usage_configuration
|
7050
|
+
# The usage configuration to apply to child datasets that reference this
|
7051
|
+
# dataset as a source.
|
7052
|
+
#
|
7028
7053
|
# @return [Types::UpdateDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7029
7054
|
#
|
7030
7055
|
# * {Types::UpdateDataSetResponse#arn #arn} => String
|
@@ -7123,6 +7148,10 @@ module Aws::QuickSight
|
|
7123
7148
|
# },
|
7124
7149
|
# ],
|
7125
7150
|
# },
|
7151
|
+
# untag_column_operation: {
|
7152
|
+
# column_name: "ColumnName", # required
|
7153
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
7154
|
+
# },
|
7126
7155
|
# },
|
7127
7156
|
# ],
|
7128
7157
|
# source: { # required
|
@@ -7139,6 +7168,7 @@ module Aws::QuickSight
|
|
7139
7168
|
# on_clause: "OnClause", # required
|
7140
7169
|
# },
|
7141
7170
|
# physical_table_id: "PhysicalTableId",
|
7171
|
+
# data_set_arn: "Arn",
|
7142
7172
|
# },
|
7143
7173
|
# },
|
7144
7174
|
# },
|
@@ -7182,6 +7212,10 @@ module Aws::QuickSight
|
|
7182
7212
|
# column_names: ["String"],
|
7183
7213
|
# },
|
7184
7214
|
# ],
|
7215
|
+
# data_set_usage_configuration: {
|
7216
|
+
# disable_use_as_direct_query_source: false,
|
7217
|
+
# disable_use_as_imported_source: false,
|
7218
|
+
# },
|
7185
7219
|
# })
|
7186
7220
|
#
|
7187
7221
|
# @example Response structure
|
@@ -7208,12 +7242,12 @@ module Aws::QuickSight
|
|
7208
7242
|
# `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
|
7209
7243
|
#
|
7210
7244
|
# @option params [required, String] :aws_account_id
|
7211
|
-
# The Amazon Web Services account
|
7245
|
+
# The Amazon Web Services account ID.
|
7212
7246
|
#
|
7213
7247
|
# @option params [required, String] :data_set_id
|
7214
7248
|
# The ID for the dataset whose permissions you want to update. This ID
|
7215
7249
|
# is unique per Amazon Web Services Region; for each Amazon Web Services
|
7216
|
-
# account
|
7250
|
+
# account.
|
7217
7251
|
#
|
7218
7252
|
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
7219
7253
|
# The resource permissions that you want to grant to the dataset.
|
@@ -7266,30 +7300,30 @@ module Aws::QuickSight
|
|
7266
7300
|
# Updates a data source.
|
7267
7301
|
#
|
7268
7302
|
# @option params [required, String] :aws_account_id
|
7269
|
-
# The Amazon Web Services account
|
7303
|
+
# The Amazon Web Services account ID.
|
7270
7304
|
#
|
7271
7305
|
# @option params [required, String] :data_source_id
|
7272
7306
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
7273
|
-
# Region; for each Amazon Web Services account
|
7307
|
+
# Region; for each Amazon Web Services account.
|
7274
7308
|
#
|
7275
7309
|
# @option params [required, String] :name
|
7276
7310
|
# A display name for the data source.
|
7277
7311
|
#
|
7278
7312
|
# @option params [Types::DataSourceParameters] :data_source_parameters
|
7279
|
-
# The parameters that QuickSight uses to connect to your
|
7280
|
-
# source.
|
7313
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
7314
|
+
# underlying source.
|
7281
7315
|
#
|
7282
7316
|
# @option params [Types::DataSourceCredentials] :credentials
|
7283
|
-
# The credentials that QuickSight that uses to connect to your
|
7317
|
+
# The credentials that Amazon QuickSight that uses to connect to your
|
7284
7318
|
# underlying source. Currently, only credentials based on user name and
|
7285
7319
|
# password are supported.
|
7286
7320
|
#
|
7287
7321
|
# @option params [Types::VpcConnectionProperties] :vpc_connection_properties
|
7288
|
-
# Use this parameter only when you want QuickSight to use a VPC
|
7322
|
+
# Use this parameter only when you want Amazon QuickSight to use a VPC
|
7289
7323
|
# connection when connecting to your underlying source.
|
7290
7324
|
#
|
7291
7325
|
# @option params [Types::SslProperties] :ssl_properties
|
7292
|
-
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
7326
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon QuickSight
|
7293
7327
|
# connects to your underlying source.
|
7294
7328
|
#
|
7295
7329
|
# @return [Types::UpdateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -7525,11 +7559,11 @@ module Aws::QuickSight
|
|
7525
7559
|
# Updates the permissions to a data source.
|
7526
7560
|
#
|
7527
7561
|
# @option params [required, String] :aws_account_id
|
7528
|
-
# The Amazon Web Services account
|
7562
|
+
# The Amazon Web Services account ID.
|
7529
7563
|
#
|
7530
7564
|
# @option params [required, String] :data_source_id
|
7531
7565
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
7532
|
-
# Region; for each Amazon Web Services account
|
7566
|
+
# Region; for each Amazon Web Services account.
|
7533
7567
|
#
|
7534
7568
|
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
7535
7569
|
# A list of resource permissions that you want to grant on the data
|
@@ -7693,8 +7727,8 @@ module Aws::QuickSight
|
|
7693
7727
|
# The description for the group that you want to update.
|
7694
7728
|
#
|
7695
7729
|
# @option params [required, String] :aws_account_id
|
7696
|
-
# The ID for the Amazon Web Services account
|
7697
|
-
# Currently, you use the ID for the Amazon Web Services account
|
7730
|
+
# The ID for the Amazon Web Services account that the group is in.
|
7731
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
7698
7732
|
# contains your Amazon QuickSight account.
|
7699
7733
|
#
|
7700
7734
|
# @option params [required, String] :namespace
|
@@ -7733,17 +7767,17 @@ module Aws::QuickSight
|
|
7733
7767
|
req.send_request(options)
|
7734
7768
|
end
|
7735
7769
|
|
7736
|
-
# Updates an existing
|
7770
|
+
# Updates an existing IAMpolicy assignment. This operation updates only
|
7737
7771
|
# the optional parameter or parameters that are specified in the
|
7738
7772
|
# request. This overwrites all of the users included in `Identities`.
|
7739
7773
|
#
|
7740
7774
|
# @option params [required, String] :aws_account_id
|
7741
|
-
# The ID of the Amazon Web Services account
|
7742
|
-
#
|
7775
|
+
# The ID of the Amazon Web Services account that contains the IAMpolicy
|
7776
|
+
# assignment.
|
7743
7777
|
#
|
7744
7778
|
# @option params [required, String] :assignment_name
|
7745
7779
|
# The name of the assignment, also called a rule. This name must be
|
7746
|
-
# unique within an Amazon Web Services account
|
7780
|
+
# unique within an Amazon Web Services account.
|
7747
7781
|
#
|
7748
7782
|
# @option params [required, String] :namespace
|
7749
7783
|
# The namespace of the assignment.
|
@@ -7761,12 +7795,12 @@ module Aws::QuickSight
|
|
7761
7795
|
# when creating the data source.
|
7762
7796
|
#
|
7763
7797
|
# @option params [String] :policy_arn
|
7764
|
-
# The ARN for the
|
7765
|
-
# specified in this assignment.
|
7798
|
+
# The ARN for the IAMpolicy to apply to the Amazon QuickSight users and
|
7799
|
+
# groups specified in this assignment.
|
7766
7800
|
#
|
7767
7801
|
# @option params [Hash<String,Array>] :identities
|
7768
|
-
# The QuickSight users, groups, or both that you want to assign
|
7769
|
-
# policy to.
|
7802
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
7803
|
+
# the policy to.
|
7770
7804
|
#
|
7771
7805
|
# @return [Types::UpdateIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7772
7806
|
#
|
@@ -7816,7 +7850,7 @@ module Aws::QuickSight
|
|
7816
7850
|
# another template.
|
7817
7851
|
#
|
7818
7852
|
# @option params [required, String] :aws_account_id
|
7819
|
-
# The ID of the Amazon Web Services account
|
7853
|
+
# The ID of the Amazon Web Services account that contains the template
|
7820
7854
|
# that you're updating.
|
7821
7855
|
#
|
7822
7856
|
# @option params [required, String] :template_id
|
@@ -7829,8 +7863,8 @@ module Aws::QuickSight
|
|
7829
7863
|
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
7830
7864
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
7831
7865
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
7832
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
7833
|
-
# any QuickSight-supported Amazon Web Services Region;.
|
7866
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
7867
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
7834
7868
|
#
|
7835
7869
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
7836
7870
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
@@ -7899,7 +7933,7 @@ module Aws::QuickSight
|
|
7899
7933
|
# Updates the template alias of a template.
|
7900
7934
|
#
|
7901
7935
|
# @option params [required, String] :aws_account_id
|
7902
|
-
# The ID of the Amazon Web Services account
|
7936
|
+
# The ID of the Amazon Web Services account that contains the template
|
7903
7937
|
# alias that you're updating.
|
7904
7938
|
#
|
7905
7939
|
# @option params [required, String] :template_id
|
@@ -7950,7 +7984,7 @@ module Aws::QuickSight
|
|
7950
7984
|
# Updates the resource permissions for a template.
|
7951
7985
|
#
|
7952
7986
|
# @option params [required, String] :aws_account_id
|
7953
|
-
# The ID of the Amazon Web Services account
|
7987
|
+
# The ID of the Amazon Web Services account that contains the template.
|
7954
7988
|
#
|
7955
7989
|
# @option params [required, String] :template_id
|
7956
7990
|
# The ID for the template.
|
@@ -8011,8 +8045,8 @@ module Aws::QuickSight
|
|
8011
8045
|
# Updates a theme.
|
8012
8046
|
#
|
8013
8047
|
# @option params [required, String] :aws_account_id
|
8014
|
-
# The ID of the Amazon Web Services account
|
8015
|
-
#
|
8048
|
+
# The ID of the Amazon Web Services account that contains the theme that
|
8049
|
+
# you're updating.
|
8016
8050
|
#
|
8017
8051
|
# @option params [required, String] :theme_id
|
8018
8052
|
# The ID for the theme.
|
@@ -8114,7 +8148,7 @@ module Aws::QuickSight
|
|
8114
8148
|
# Updates an alias of a theme.
|
8115
8149
|
#
|
8116
8150
|
# @option params [required, String] :aws_account_id
|
8117
|
-
# The ID of the Amazon Web Services account
|
8151
|
+
# The ID of the Amazon Web Services account that contains the theme
|
8118
8152
|
# alias that you're updating.
|
8119
8153
|
#
|
8120
8154
|
# @option params [required, String] :theme_id
|
@@ -8203,7 +8237,7 @@ module Aws::QuickSight
|
|
8203
8237
|
# * To specify no permissions, omit the permissions list.
|
8204
8238
|
#
|
8205
8239
|
# @option params [required, String] :aws_account_id
|
8206
|
-
# The ID of the Amazon Web Services account
|
8240
|
+
# The ID of the Amazon Web Services account that contains the theme.
|
8207
8241
|
#
|
8208
8242
|
# @option params [required, String] :theme_id
|
8209
8243
|
# The ID for the theme.
|
@@ -8267,8 +8301,8 @@ module Aws::QuickSight
|
|
8267
8301
|
# The Amazon QuickSight user name that you want to update.
|
8268
8302
|
#
|
8269
8303
|
# @option params [required, String] :aws_account_id
|
8270
|
-
# The ID for the Amazon Web Services account
|
8271
|
-
# Currently, you use the ID for the Amazon Web Services account
|
8304
|
+
# The ID for the Amazon Web Services account that the user is in.
|
8305
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
8272
8306
|
# contains your Amazon QuickSight account.
|
8273
8307
|
#
|
8274
8308
|
# @option params [required, String] :namespace
|
@@ -8289,8 +8323,8 @@ module Aws::QuickSight
|
|
8289
8323
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
8290
8324
|
# QuickSight settings.
|
8291
8325
|
#
|
8292
|
-
# The name of the QuickSight role is invisible to the user except
|
8293
|
-
# the console screens dealing with permissions.
|
8326
|
+
# The name of the Amazon QuickSight role is invisible to the user except
|
8327
|
+
# for the console screens dealing with permissions.
|
8294
8328
|
#
|
8295
8329
|
# @option params [String] :custom_permissions_name
|
8296
8330
|
# (Enterprise edition only) The name of the custom permissions profile
|
@@ -8308,16 +8342,16 @@ module Aws::QuickSight
|
|
8308
8342
|
#
|
8309
8343
|
# A set of custom permissions includes any combination of these
|
8310
8344
|
# restrictions. Currently, you need to create the profile names for
|
8311
|
-
# custom permission sets by using the QuickSight console. Then,
|
8312
|
-
# the `RegisterUser` API operation to assign the named set of
|
8313
|
-
# permissions to a QuickSight user.
|
8345
|
+
# custom permission sets by using the Amazon QuickSight console. Then,
|
8346
|
+
# you use the `RegisterUser` API operation to assign the named set of
|
8347
|
+
# permissions to a Amazon QuickSight user.
|
8314
8348
|
#
|
8315
|
-
# QuickSight custom permissions are applied through
|
8349
|
+
# Amazon QuickSight custom permissions are applied through IAMpolicies.
|
8316
8350
|
# Therefore, they override the permissions typically granted by
|
8317
|
-
# assigning QuickSight users to one of the default security
|
8318
|
-
# QuickSight (admin, author, reader).
|
8351
|
+
# assigning Amazon QuickSight users to one of the default security
|
8352
|
+
# cohorts in Amazon QuickSight (admin, author, reader).
|
8319
8353
|
#
|
8320
|
-
# This feature is available only to QuickSight Enterprise edition
|
8354
|
+
# This feature is available only to Amazon QuickSight Enterprise edition
|
8321
8355
|
# subscriptions.
|
8322
8356
|
#
|
8323
8357
|
# @option params [Boolean] :unapply_custom_permissions
|
@@ -8329,9 +8363,9 @@ module Aws::QuickSight
|
|
8329
8363
|
#
|
8330
8364
|
# @option params [String] :external_login_federation_provider_type
|
8331
8365
|
# The type of supported external login provider that provides identity
|
8332
|
-
# to let a user federate into QuickSight with an associated
|
8333
|
-
# and Access Management
|
8334
|
-
# provider can be one of the following.
|
8366
|
+
# to let a user federate into Amazon QuickSight with an associated
|
8367
|
+
# Identity and Access Management(IAM) role. The type of supported
|
8368
|
+
# external login provider can be one of the following.
|
8335
8369
|
#
|
8336
8370
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
8337
8371
|
# cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
|
@@ -8348,10 +8382,10 @@ module Aws::QuickSight
|
|
8348
8382
|
#
|
8349
8383
|
# @option params [String] :custom_federation_provider_url
|
8350
8384
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
8351
|
-
# identity to let a user federate into QuickSight with an
|
8352
|
-
# Identity and Access Management
|
8353
|
-
# be used when `ExternalLoginFederationProviderType`
|
8354
|
-
# `CUSTOM_OIDC`.
|
8385
|
+
# identity to let a user federate into Amazon QuickSight with an
|
8386
|
+
# associated Identity and Access Management(IAM) role. This parameter
|
8387
|
+
# should only be used when `ExternalLoginFederationProviderType`
|
8388
|
+
# parameter is set to `CUSTOM_OIDC`.
|
8355
8389
|
#
|
8356
8390
|
# @option params [String] :external_login_id
|
8357
8391
|
# The identity ID for a user in the external login provider.
|
@@ -8415,7 +8449,7 @@ module Aws::QuickSight
|
|
8415
8449
|
params: params,
|
8416
8450
|
config: config)
|
8417
8451
|
context[:gem_name] = 'aws-sdk-quicksight'
|
8418
|
-
context[:gem_version] = '1.
|
8452
|
+
context[:gem_version] = '1.53.0'
|
8419
8453
|
Seahorse::Client::Request.new(handlers, context)
|
8420
8454
|
end
|
8421
8455
|
|