aws-sdk-quicksight 1.50.0 → 1.54.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +473 -413
- data/lib/aws-sdk-quicksight/client_api.rb +24 -0
- data/lib/aws-sdk-quicksight/types.rb +643 -471
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3270943981a3280ffe47f9c0fe27dabe96c491f9a3cfa53d59e588d11aa83172
|
4
|
+
data.tar.gz: 97bc0dc0e95138e23c6c7018ea4542e6029355fb46b212f19a345f33100a665c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 320894f90aec3ef3b4aff0a5be6ab4feaa3ab8e3efd2f4a646659b3549d9d30754e41ec1ced3d88352220b6c0cd2e726877416d11f3ed00faba023bfcc6dba13
|
7
|
+
data.tar.gz: 47acc7ef9029aaf61054a29ba6961b2b8ad595cf4d050fb3385bb2c94d848e61c69aa293358feb6369be3fb5a462e6b3d9a8316f733a862c4e15c4df25bf867d
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.54.0 (2021-09-10)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Add new data source type for Amazon OpenSearch (successor to Amazon ElasticSearch).
|
8
|
+
|
9
|
+
1.53.0 (2021-09-02)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds support for referencing parent datasets as sources in a child dataset.
|
13
|
+
|
14
|
+
1.52.0 (2021-09-01)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.51.0 (2021-08-13)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Documentation updates for QuickSight.
|
23
|
+
|
4
24
|
1.50.0 (2021-07-30)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.54.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.
|
@@ -369,17 +369,18 @@ module Aws::QuickSight
|
|
369
369
|
req.send_request(options)
|
370
370
|
end
|
371
371
|
|
372
|
-
# Creates Amazon QuickSight customizations the current
|
373
|
-
# Currently, you can add a custom default theme by
|
374
|
-
# `CreateAccountCustomization` or `UpdateAccountCustomization`
|
375
|
-
# 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
|
372
|
+
# Creates Amazon QuickSight customizations the current Amazon Web
|
373
|
+
# Services Region;. Currently, you can add a custom default theme by
|
374
|
+
# using the `CreateAccountCustomization` or `UpdateAccountCustomization`
|
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
|
-
# You can add these to an Amazon Web
|
409
|
-
# 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 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
|
-
# 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
|
-
# An ID for the data source. This ID is unique per
|
1011
|
-
# Amazon Web Services account
|
1025
|
+
# An ID for the data source. This ID is unique per Amazon Web Services
|
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
|
@@ -1060,7 +1072,7 @@ module Aws::QuickSight
|
|
1060
1072
|
# aws_account_id: "AwsAccountId", # required
|
1061
1073
|
# data_source_id: "ResourceId", # required
|
1062
1074
|
# name: "ResourceName", # required
|
1063
|
-
# type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM
|
1075
|
+
# type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM, AMAZON_OPENSEARCH
|
1064
1076
|
# data_source_parameters: {
|
1065
1077
|
# amazon_elasticsearch_parameters: {
|
1066
1078
|
# domain: "Domain", # required
|
@@ -1151,6 +1163,9 @@ module Aws::QuickSight
|
|
1151
1163
|
# query: "Query", # required
|
1152
1164
|
# max_rows: 1, # required
|
1153
1165
|
# },
|
1166
|
+
# amazon_open_search_parameters: {
|
1167
|
+
# domain: "Domain", # required
|
1168
|
+
# },
|
1154
1169
|
# },
|
1155
1170
|
# credentials: {
|
1156
1171
|
# credential_pair: {
|
@@ -1247,6 +1262,9 @@ module Aws::QuickSight
|
|
1247
1262
|
# query: "Query", # required
|
1248
1263
|
# max_rows: 1, # required
|
1249
1264
|
# },
|
1265
|
+
# amazon_open_search_parameters: {
|
1266
|
+
# domain: "Domain", # required
|
1267
|
+
# },
|
1250
1268
|
# },
|
1251
1269
|
# ],
|
1252
1270
|
# },
|
@@ -1425,8 +1443,8 @@ module Aws::QuickSight
|
|
1425
1443
|
# A description for the group that you want to create.
|
1426
1444
|
#
|
1427
1445
|
# @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
|
1446
|
+
# The ID for the Amazon Web Services account that the group is in.
|
1447
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
1430
1448
|
# contains your Amazon QuickSight account.
|
1431
1449
|
#
|
1432
1450
|
# @option params [required, String] :namespace
|
@@ -1474,8 +1492,8 @@ module Aws::QuickSight
|
|
1474
1492
|
# The name of the group that you want to add the user to.
|
1475
1493
|
#
|
1476
1494
|
# @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
|
1495
|
+
# The ID for the Amazon Web Services account that the group is in.
|
1496
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
1479
1497
|
# contains your Amazon QuickSight account.
|
1480
1498
|
#
|
1481
1499
|
# @option params [required, String] :namespace
|
@@ -1512,19 +1530,19 @@ module Aws::QuickSight
|
|
1512
1530
|
req.send_request(options)
|
1513
1531
|
end
|
1514
1532
|
|
1515
|
-
# Creates an assignment with one specified
|
1533
|
+
# Creates an assignment with one specified IAMpolicy, identified by its
|
1516
1534
|
# Amazon Resource Name (ARN). This policy assignment is attached to the
|
1517
1535
|
# specified groups or users of Amazon QuickSight. Assignment names are
|
1518
|
-
# unique per Amazon Web Services account
|
1536
|
+
# unique per Amazon Web Services account. To avoid overwriting rules in
|
1519
1537
|
# other namespaces, use assignment names that are unique.
|
1520
1538
|
#
|
1521
1539
|
# @option params [required, String] :aws_account_id
|
1522
|
-
# The ID of the Amazon Web Services account
|
1523
|
-
#
|
1540
|
+
# The ID of the Amazon Web Services account where you want to assign an
|
1541
|
+
# IAMpolicy to Amazon QuickSight users or groups.
|
1524
1542
|
#
|
1525
1543
|
# @option params [required, String] :assignment_name
|
1526
1544
|
# The name of the assignment, also called a rule. It must be unique
|
1527
|
-
# within an Amazon Web Services account
|
1545
|
+
# within an Amazon Web Services account.
|
1528
1546
|
#
|
1529
1547
|
# @option params [required, String] :assignment_status
|
1530
1548
|
# The status of the assignment. Possible values are as follows:
|
@@ -1539,12 +1557,12 @@ module Aws::QuickSight
|
|
1539
1557
|
# when creating the data source.
|
1540
1558
|
#
|
1541
1559
|
# @option params [String] :policy_arn
|
1542
|
-
# The ARN for the
|
1543
|
-
# specified in this assignment.
|
1560
|
+
# The ARN for the IAMpolicy to apply to the Amazon QuickSight users and
|
1561
|
+
# groups specified in this assignment.
|
1544
1562
|
#
|
1545
1563
|
# @option params [Hash<String,Array>] :identities
|
1546
|
-
# The QuickSight users, groups, or both that you want to assign
|
1547
|
-
# policy to.
|
1564
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
1565
|
+
# the policy to.
|
1548
1566
|
#
|
1549
1567
|
# @option params [required, String] :namespace
|
1550
1568
|
# The namespace that contains the assignment.
|
@@ -1612,7 +1630,7 @@ module Aws::QuickSight
|
|
1612
1630
|
# An ID for the ingestion.
|
1613
1631
|
#
|
1614
1632
|
# @option params [required, String] :aws_account_id
|
1615
|
-
# The Amazon Web Services account
|
1633
|
+
# The Amazon Web Services account ID.
|
1616
1634
|
#
|
1617
1635
|
# @return [Types::CreateIngestionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1618
1636
|
#
|
@@ -1650,19 +1668,19 @@ module Aws::QuickSight
|
|
1650
1668
|
# (Enterprise edition only) Creates a new namespace for you to use with
|
1651
1669
|
# Amazon QuickSight.
|
1652
1670
|
#
|
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.
|
1671
|
+
# A namespace allows you to isolate the Amazon QuickSight users and
|
1672
|
+
# groups that are registered for that namespace. Users that access the
|
1673
|
+
# namespace can share assets only with other users or groups in the same
|
1674
|
+
# namespace. They can't see users and groups in other namespaces. You
|
1675
|
+
# can create a namespace after your Amazon Web Services account is
|
1676
|
+
# subscribed to Amazon QuickSight. The namespace must be unique within
|
1677
|
+
# the Amazon Web Services account. By default, there is a limit of 100
|
1678
|
+
# namespaces per Amazon Web Services account. To increase your limit,
|
1679
|
+
# create a ticket with Amazon Web Services Support.
|
1662
1680
|
#
|
1663
1681
|
# @option params [required, String] :aws_account_id
|
1664
|
-
# The ID for the Amazon Web Services account
|
1665
|
-
#
|
1682
|
+
# The ID for the Amazon Web Services account that you want to create the
|
1683
|
+
# Amazon QuickSight namespace in.
|
1666
1684
|
#
|
1667
1685
|
# @option params [required, String] :namespace
|
1668
1686
|
# The name that you want to use to describe the new namespace.
|
@@ -1721,22 +1739,23 @@ module Aws::QuickSight
|
|
1721
1739
|
# Creates a template from an existing Amazon QuickSight analysis or
|
1722
1740
|
# template. You can use the resulting template to create a dashboard.
|
1723
1741
|
#
|
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
|
1742
|
+
# A *template* is an entity in Amazon QuickSight that encapsulates the
|
1743
|
+
# metadata required to create an analysis and that you can use to create
|
1744
|
+
# s dashboard. A template adds a layer of abstraction by using
|
1727
1745
|
# placeholders to replace the dataset associated with the analysis. You
|
1728
1746
|
# can use templates to create dashboards by replacing dataset
|
1729
1747
|
# placeholders with datasets that follow the same schema that was used
|
1730
1748
|
# to create the source analysis and template.
|
1731
1749
|
#
|
1732
1750
|
# @option params [required, String] :aws_account_id
|
1733
|
-
# The ID for the Amazon Web Services account
|
1734
|
-
#
|
1735
|
-
#
|
1751
|
+
# The ID for the Amazon Web Services account that the group is in. You
|
1752
|
+
# use the ID for the Amazon Web Services account that contains your
|
1753
|
+
# Amazon QuickSight account.
|
1736
1754
|
#
|
1737
1755
|
# @option params [required, String] :template_id
|
1738
1756
|
# An ID for the template that you want to create. This template is
|
1739
|
-
# unique per Region; in each Amazon Web Services
|
1757
|
+
# unique per Amazon Web Services Region; in each Amazon Web Services
|
1758
|
+
# account.
|
1740
1759
|
#
|
1741
1760
|
# @option params [String] :name
|
1742
1761
|
# A display name for the template.
|
@@ -1751,8 +1770,8 @@ module Aws::QuickSight
|
|
1751
1770
|
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
1752
1771
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
1753
1772
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
1754
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
1755
|
-
# any QuickSight-supported Region;.
|
1773
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
1774
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
1756
1775
|
#
|
1757
1776
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
1758
1777
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
@@ -1835,7 +1854,7 @@ module Aws::QuickSight
|
|
1835
1854
|
# Creates a template alias for a template.
|
1836
1855
|
#
|
1837
1856
|
# @option params [required, String] :aws_account_id
|
1838
|
-
# The ID of the Amazon Web Services account
|
1857
|
+
# The ID of the Amazon Web Services account that contains the template
|
1839
1858
|
# that you creating an alias for.
|
1840
1859
|
#
|
1841
1860
|
# @option params [required, String] :template_id
|
@@ -1892,12 +1911,12 @@ module Aws::QuickSight
|
|
1892
1911
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html
|
1893
1912
|
#
|
1894
1913
|
# @option params [required, String] :aws_account_id
|
1895
|
-
# The ID of the Amazon Web Services account
|
1914
|
+
# The ID of the Amazon Web Services account where you want to store the
|
1896
1915
|
# new theme.
|
1897
1916
|
#
|
1898
1917
|
# @option params [required, String] :theme_id
|
1899
1918
|
# An ID for the theme that you want to create. The theme ID is unique
|
1900
|
-
# per Region
|
1919
|
+
# per Amazon Web Services Region in each Amazon Web Services account.
|
1901
1920
|
#
|
1902
1921
|
# @option params [required, String] :name
|
1903
1922
|
# A display name for the theme.
|
@@ -1906,7 +1925,7 @@ module Aws::QuickSight
|
|
1906
1925
|
# The ID of the theme that a custom theme will inherit from. All themes
|
1907
1926
|
# inherit from one of the starting themes defined by Amazon QuickSight.
|
1908
1927
|
# For a list of the starting themes, use `ListThemes` or choose
|
1909
|
-
# **Themes** from within a QuickSight analysis.
|
1928
|
+
# **Themes** from within a Amazon QuickSight analysis.
|
1910
1929
|
#
|
1911
1930
|
# @option params [String] :version_description
|
1912
1931
|
# A description of the first version of the theme that you're creating.
|
@@ -2016,7 +2035,7 @@ module Aws::QuickSight
|
|
2016
2035
|
# Creates a theme alias for a theme.
|
2017
2036
|
#
|
2018
2037
|
# @option params [required, String] :aws_account_id
|
2019
|
-
# The ID of the Amazon Web Services account
|
2038
|
+
# The ID of the Amazon Web Services account that contains the theme for
|
2020
2039
|
# the new theme alias.
|
2021
2040
|
#
|
2022
2041
|
# @option params [required, String] :theme_id
|
@@ -2062,16 +2081,18 @@ module Aws::QuickSight
|
|
2062
2081
|
req.send_request(options)
|
2063
2082
|
end
|
2064
2083
|
|
2065
|
-
# Deletes all Amazon QuickSight customizations in this
|
2066
|
-
# specified Amazon Web Services account
|
2084
|
+
# Deletes all Amazon QuickSight customizations in this Amazon Web
|
2085
|
+
# Services Region; for the specified Amazon Web Services account and
|
2086
|
+
# Amazon QuickSight namespace.
|
2067
2087
|
#
|
2068
2088
|
# @option params [required, String] :aws_account_id
|
2069
|
-
# The ID for the Amazon Web Services account
|
2070
|
-
# QuickSight customizations from in this
|
2089
|
+
# The ID for the Amazon Web Services account that you want to delete
|
2090
|
+
# Amazon QuickSight customizations from in this Amazon Web Services
|
2091
|
+
# Region;.
|
2071
2092
|
#
|
2072
2093
|
# @option params [String] :namespace
|
2073
|
-
# The QuickSight namespace that you're deleting the
|
2074
|
-
# from.
|
2094
|
+
# The Amazon QuickSight namespace that you're deleting the
|
2095
|
+
# customizations from.
|
2075
2096
|
#
|
2076
2097
|
# @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2077
2098
|
#
|
@@ -2102,9 +2123,10 @@ module Aws::QuickSight
|
|
2102
2123
|
# Deletes an analysis from Amazon QuickSight. You can optionally include
|
2103
2124
|
# a recovery window during which you can restore the analysis. If you
|
2104
2125
|
# don't specify a recovery window value, the operation defaults to 30
|
2105
|
-
# days. QuickSight attaches a `DeletionTime` stamp to the
|
2106
|
-
# specifies the end of the recovery window. At the end of
|
2107
|
-
# window, QuickSight deletes the analysis
|
2126
|
+
# days. Amazon QuickSight attaches a `DeletionTime` stamp to the
|
2127
|
+
# response that specifies the end of the recovery window. At the end of
|
2128
|
+
# the recovery window, Amazon QuickSight deletes the analysis
|
2129
|
+
# permanently.
|
2108
2130
|
#
|
2109
2131
|
# At any time before recovery window ends, you can use the
|
2110
2132
|
# `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
|
@@ -2113,19 +2135,20 @@ module Aws::QuickSight
|
|
2113
2135
|
# make a template from it.
|
2114
2136
|
#
|
2115
2137
|
# An analysis that's scheduled for deletion isn't accessible in the
|
2116
|
-
# QuickSight console. To access it in the console, restore it.
|
2117
|
-
# an analysis doesn't delete the dashboards that you publish
|
2138
|
+
# Amazon QuickSight console. To access it in the console, restore it.
|
2139
|
+
# Deleting an analysis doesn't delete the dashboards that you publish
|
2140
|
+
# from it.
|
2118
2141
|
#
|
2119
2142
|
# @option params [required, String] :aws_account_id
|
2120
|
-
# The ID of the Amazon Web Services account
|
2143
|
+
# The ID of the Amazon Web Services account where you want to delete an
|
2121
2144
|
# analysis.
|
2122
2145
|
#
|
2123
2146
|
# @option params [required, String] :analysis_id
|
2124
2147
|
# The ID of the analysis that you're deleting.
|
2125
2148
|
#
|
2126
2149
|
# @option params [Integer] :recovery_window_in_days
|
2127
|
-
# A value that specifies the number of days that QuickSight waits
|
2128
|
-
# it deletes the analysis. You can't use this parameter with the
|
2150
|
+
# A value that specifies the number of days that Amazon QuickSight waits
|
2151
|
+
# before it deletes the analysis. You can't use this parameter with the
|
2129
2152
|
# `ForceDeleteWithoutRecovery` option in the same API call. The default
|
2130
2153
|
# value is 30.
|
2131
2154
|
#
|
@@ -2171,7 +2194,7 @@ module Aws::QuickSight
|
|
2171
2194
|
# Deletes a dashboard.
|
2172
2195
|
#
|
2173
2196
|
# @option params [required, String] :aws_account_id
|
2174
|
-
# The ID of the Amazon Web Services account
|
2197
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
2175
2198
|
# that you're deleting.
|
2176
2199
|
#
|
2177
2200
|
# @option params [required, String] :dashboard_id
|
@@ -2215,11 +2238,11 @@ module Aws::QuickSight
|
|
2215
2238
|
# Deletes a dataset.
|
2216
2239
|
#
|
2217
2240
|
# @option params [required, String] :aws_account_id
|
2218
|
-
# The Amazon Web Services account
|
2241
|
+
# The Amazon Web Services account ID.
|
2219
2242
|
#
|
2220
2243
|
# @option params [required, String] :data_set_id
|
2221
2244
|
# The ID for the dataset that you want to create. This ID is unique per
|
2222
|
-
# Region; for each Amazon Web Services account
|
2245
|
+
# Amazon Web Services Region; for each Amazon Web Services account.
|
2223
2246
|
#
|
2224
2247
|
# @return [Types::DeleteDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2225
2248
|
#
|
@@ -2255,11 +2278,11 @@ module Aws::QuickSight
|
|
2255
2278
|
# datasets that reference the deleted data source.
|
2256
2279
|
#
|
2257
2280
|
# @option params [required, String] :aws_account_id
|
2258
|
-
# The Amazon Web Services account
|
2281
|
+
# The Amazon Web Services account ID.
|
2259
2282
|
#
|
2260
2283
|
# @option params [required, String] :data_source_id
|
2261
|
-
# The ID of the data source. This ID is unique per
|
2262
|
-
# Amazon Web Services account
|
2284
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
2285
|
+
# Region; for each Amazon Web Services account.
|
2263
2286
|
#
|
2264
2287
|
# @return [Types::DeleteDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2265
2288
|
#
|
@@ -2380,8 +2403,8 @@ module Aws::QuickSight
|
|
2380
2403
|
# The name of the group that you want to delete.
|
2381
2404
|
#
|
2382
2405
|
# @option params [required, String] :aws_account_id
|
2383
|
-
# The ID for the Amazon Web Services account
|
2384
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2406
|
+
# The ID for the Amazon Web Services account that the group is in.
|
2407
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2385
2408
|
# contains your Amazon QuickSight account.
|
2386
2409
|
#
|
2387
2410
|
# @option params [required, String] :namespace
|
@@ -2425,8 +2448,8 @@ module Aws::QuickSight
|
|
2425
2448
|
# The name of the group that you want to delete the user from.
|
2426
2449
|
#
|
2427
2450
|
# @option params [required, String] :aws_account_id
|
2428
|
-
# The ID for the Amazon Web Services account
|
2429
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2451
|
+
# The ID for the Amazon Web Services account that the group is in.
|
2452
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2430
2453
|
# contains your Amazon QuickSight account.
|
2431
2454
|
#
|
2432
2455
|
# @option params [required, String] :namespace
|
@@ -2460,11 +2483,11 @@ module Aws::QuickSight
|
|
2460
2483
|
req.send_request(options)
|
2461
2484
|
end
|
2462
2485
|
|
2463
|
-
# Deletes an existing
|
2486
|
+
# Deletes an existing IAMpolicy assignment.
|
2464
2487
|
#
|
2465
2488
|
# @option params [required, String] :aws_account_id
|
2466
|
-
# The Amazon Web Services account
|
2467
|
-
#
|
2489
|
+
# The Amazon Web Services account ID where you want to delete the
|
2490
|
+
# IAMpolicy assignment.
|
2468
2491
|
#
|
2469
2492
|
# @option params [required, String] :assignment_name
|
2470
2493
|
# The name of the assignment.
|
@@ -2508,8 +2531,8 @@ module Aws::QuickSight
|
|
2508
2531
|
# asset.
|
2509
2532
|
#
|
2510
2533
|
# @option params [required, String] :aws_account_id
|
2511
|
-
# The ID for the Amazon Web Services account
|
2512
|
-
#
|
2534
|
+
# The ID for the Amazon Web Services account that you want to delete the
|
2535
|
+
# Amazon QuickSight namespace from.
|
2513
2536
|
#
|
2514
2537
|
# @option params [required, String] :namespace
|
2515
2538
|
# The namespace that you want to delete.
|
@@ -2543,7 +2566,7 @@ module Aws::QuickSight
|
|
2543
2566
|
# Deletes a template.
|
2544
2567
|
#
|
2545
2568
|
# @option params [required, String] :aws_account_id
|
2546
|
-
# The ID of the Amazon Web Services account
|
2569
|
+
# The ID of the Amazon Web Services account that contains the template
|
2547
2570
|
# that you're deleting.
|
2548
2571
|
#
|
2549
2572
|
# @option params [required, String] :template_id
|
@@ -2590,7 +2613,7 @@ module Aws::QuickSight
|
|
2590
2613
|
# the alias points to.
|
2591
2614
|
#
|
2592
2615
|
# @option params [required, String] :aws_account_id
|
2593
|
-
# The ID of the Amazon Web Services account
|
2616
|
+
# The ID of the Amazon Web Services account that contains the item to
|
2594
2617
|
# delete.
|
2595
2618
|
#
|
2596
2619
|
# @option params [required, String] :template_id
|
@@ -2638,8 +2661,8 @@ module Aws::QuickSight
|
|
2638
2661
|
# Deletes a theme.
|
2639
2662
|
#
|
2640
2663
|
# @option params [required, String] :aws_account_id
|
2641
|
-
# The ID of the Amazon Web Services account
|
2642
|
-
#
|
2664
|
+
# The ID of the Amazon Web Services account that contains the theme that
|
2665
|
+
# you're deleting.
|
2643
2666
|
#
|
2644
2667
|
# @option params [required, String] :theme_id
|
2645
2668
|
# An ID for the theme that you want to delete.
|
@@ -2686,7 +2709,7 @@ module Aws::QuickSight
|
|
2686
2709
|
# theme that the alias points to.
|
2687
2710
|
#
|
2688
2711
|
# @option params [required, String] :aws_account_id
|
2689
|
-
# The ID of the Amazon Web Services account
|
2712
|
+
# The ID of the Amazon Web Services account that contains the theme
|
2690
2713
|
# alias to delete.
|
2691
2714
|
#
|
2692
2715
|
# @option params [required, String] :theme_id
|
@@ -2737,8 +2760,8 @@ module Aws::QuickSight
|
|
2737
2760
|
# The name of the user that you want to delete.
|
2738
2761
|
#
|
2739
2762
|
# @option params [required, String] :aws_account_id
|
2740
|
-
# The ID for the Amazon Web Services account
|
2741
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2763
|
+
# The ID for the Amazon Web Services account that the user is in.
|
2764
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2742
2765
|
# contains your Amazon QuickSight account.
|
2743
2766
|
#
|
2744
2767
|
# @option params [required, String] :namespace
|
@@ -2777,8 +2800,8 @@ module Aws::QuickSight
|
|
2777
2800
|
# The principal ID of the user.
|
2778
2801
|
#
|
2779
2802
|
# @option params [required, String] :aws_account_id
|
2780
|
-
# The ID for the Amazon Web Services account
|
2781
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2803
|
+
# The ID for the Amazon Web Services account that the user is in.
|
2804
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2782
2805
|
# contains your Amazon QuickSight account.
|
2783
2806
|
#
|
2784
2807
|
# @option params [required, String] :namespace
|
@@ -2812,54 +2835,58 @@ module Aws::QuickSight
|
|
2812
2835
|
end
|
2813
2836
|
|
2814
2837
|
# Describes the customizations associated with the provided Amazon Web
|
2815
|
-
# Services account
|
2816
|
-
#
|
2817
|
-
# this API operation with the
|
2838
|
+
# Services account and Amazon Amazon QuickSight namespace in an Amazon
|
2839
|
+
# Web Services Region;. The Amazon QuickSight console evaluates which
|
2840
|
+
# customizations to apply by running this API operation with the
|
2841
|
+
# `Resolved` flag included.
|
2818
2842
|
#
|
2819
2843
|
# To determine what customizations display when you run this command, it
|
2820
2844
|
# can help to visualize the relationship of the entities involved.
|
2821
2845
|
#
|
2822
|
-
# * `Amazon Web Services account
|
2846
|
+
# * `Amazon Web Services account` - The Amazon Web Services account
|
2823
2847
|
# exists at the top of the hierarchy. It has the potential to use all
|
2824
|
-
# of the Regions; and AWS Services. When you
|
2825
|
-
#
|
2826
|
-
#
|
2827
|
-
# supported
|
2828
|
-
#
|
2829
|
-
#
|
2830
|
-
#
|
2831
|
-
# you
|
2832
|
-
#
|
2833
|
-
#
|
2834
|
-
#
|
2835
|
-
#
|
2836
|
-
#
|
2837
|
-
#
|
2838
|
-
#
|
2848
|
+
# of the Amazon Web Services Regions; and AWS Services. When you
|
2849
|
+
# subscribe to Amazon QuickSight, you choose one Amazon Web Services
|
2850
|
+
# Region; to use as your home Region. That's where your free SPICE
|
2851
|
+
# capacity is located. You can use Amazon QuickSight in any supported
|
2852
|
+
# Amazon Web Services Region;.
|
2853
|
+
#
|
2854
|
+
# * `Amazon Web Services Region;` - In each Amazon Web Services Region;
|
2855
|
+
# where you sign in to Amazon QuickSight at least once, Amazon
|
2856
|
+
# QuickSight acts as a separate instance of the same service. If you
|
2857
|
+
# have a user directory, it resides in us-east-1, which is the US East
|
2858
|
+
# (N. Virginia). Generally speaking, these users have access to Amazon
|
2859
|
+
# QuickSight in any Amazon Web Services Region;, unless they are
|
2860
|
+
# constrained to a namespace.
|
2861
|
+
#
|
2862
|
+
# To run the command in a different Amazon Web Services Region;, you
|
2863
|
+
# change your Region settings. If you're using the AWS CLI, you can
|
2864
|
+
# use one of the following options:
|
2839
2865
|
#
|
2840
2866
|
# * Use [command line options][1].
|
2841
2867
|
#
|
2842
2868
|
# * Use [named profiles][2].
|
2843
2869
|
#
|
2844
|
-
# * Run `aws configure` to change your default
|
2845
|
-
# key the same settings for your keys. For
|
2846
|
-
# [Configuring the AWS CLI][3].
|
2870
|
+
# * Run `aws configure` to change your default Amazon Web Services
|
2871
|
+
# Region;. Use Enter to key the same settings for your keys. For
|
2872
|
+
# more information, see [Configuring the AWS CLI][3].
|
2847
2873
|
#
|
2848
|
-
# * `Namespace` - A QuickSight namespace is a partition that
|
2849
|
-
# users and assets (data sources, datasets, dashboards, and
|
2850
|
-
# access assets that are in a specific namespace, users and
|
2851
|
-
# must also be part of the same namespace. People who share a
|
2874
|
+
# * `Namespace` - A Amazon QuickSight namespace is a partition that
|
2875
|
+
# contains users and assets (data sources, datasets, dashboards, and
|
2876
|
+
# so on). To access assets that are in a specific namespace, users and
|
2877
|
+
# groups must also be part of the same namespace. People who share a
|
2852
2878
|
# namespace are completely isolated from users and assets in other
|
2853
|
-
# namespaces, even if they are in the same Amazon Web Services
|
2854
|
-
#
|
2879
|
+
# namespaces, even if they are in the same Amazon Web Services account
|
2880
|
+
# and Amazon Web Services Region;.
|
2855
2881
|
#
|
2856
|
-
# * `Applied customizations` - Within an Region;, a
|
2857
|
-
# customizations can apply to an Amazon Web
|
2858
|
-
# namespace. Settings that you apply to a
|
2859
|
-
# that you apply to an Amazon Web Services
|
2860
|
-
# isolated to a single
|
2861
|
-
#
|
2862
|
-
#
|
2882
|
+
# * `Applied customizations` - Within an Amazon Web Services Region;, a
|
2883
|
+
# set of Amazon QuickSight customizations can apply to an Amazon Web
|
2884
|
+
# Services account or to a namespace. Settings that you apply to a
|
2885
|
+
# namespace override settings that you apply to an Amazon Web Services
|
2886
|
+
# account. All settings are isolated to a single Amazon Web Services
|
2887
|
+
# Region;. To apply them in other Amazon Web Services Regions;, run
|
2888
|
+
# the `CreateAccountCustomization` command in each Amazon Web Services
|
2889
|
+
# Region; where you want to apply the same customizations.
|
2863
2890
|
#
|
2864
2891
|
#
|
2865
2892
|
#
|
@@ -2868,20 +2895,20 @@ module Aws::QuickSight
|
|
2868
2895
|
# [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
|
2869
2896
|
#
|
2870
2897
|
# @option params [required, String] :aws_account_id
|
2871
|
-
# The ID for the Amazon Web Services account
|
2872
|
-
# QuickSight customizations for.
|
2898
|
+
# The ID for the Amazon Web Services account that you want to describe
|
2899
|
+
# Amazon QuickSight customizations for.
|
2873
2900
|
#
|
2874
2901
|
# @option params [String] :namespace
|
2875
|
-
# The QuickSight namespace that you want to describe
|
2876
|
-
# customizations for.
|
2902
|
+
# The Amazon QuickSight namespace that you want to describe Amazon
|
2903
|
+
# QuickSight customizations for.
|
2877
2904
|
#
|
2878
2905
|
# @option params [Boolean] :resolved
|
2879
2906
|
# The `Resolved` flag works with the other parameters to determine which
|
2880
|
-
# view of QuickSight customizations is returned. You can add this
|
2881
|
-
# to your command to use the same view that QuickSight uses
|
2882
|
-
# which customizations to apply to the console. Omit this
|
2883
|
-
# it to `no-resolved`, to reveal customizations that are
|
2884
|
-
# different levels.
|
2907
|
+
# view of Amazon QuickSight customizations is returned. You can add this
|
2908
|
+
# flag to your command to use the same view that Amazon QuickSight uses
|
2909
|
+
# to identify which customizations to apply to the console. Omit this
|
2910
|
+
# flag, or set it to `no-resolved`, to reveal customizations that are
|
2911
|
+
# configured at different levels.
|
2885
2912
|
#
|
2886
2913
|
# @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2887
2914
|
#
|
@@ -2918,11 +2945,11 @@ module Aws::QuickSight
|
|
2918
2945
|
req.send_request(options)
|
2919
2946
|
end
|
2920
2947
|
|
2921
|
-
# Describes the settings that were used when your QuickSight
|
2922
|
-
# subscription was first created in this Amazon Web Services account
|
2948
|
+
# Describes the settings that were used when your Amazon QuickSight
|
2949
|
+
# subscription was first created in this Amazon Web Services account.
|
2923
2950
|
#
|
2924
2951
|
# @option params [required, String] :aws_account_id
|
2925
|
-
# The ID for the Amazon Web Services account
|
2952
|
+
# The ID for the Amazon Web Services account that contains the settings
|
2926
2953
|
# that you want to list.
|
2927
2954
|
#
|
2928
2955
|
# @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2958,9 +2985,9 @@ module Aws::QuickSight
|
|
2958
2985
|
# Provides a summary of the metadata for an analysis.
|
2959
2986
|
#
|
2960
2987
|
# @option params [required, String] :aws_account_id
|
2961
|
-
# The ID of the Amazon Web Services account
|
2962
|
-
# You must be using the Amazon Web Services account
|
2963
|
-
#
|
2988
|
+
# The ID of the Amazon Web Services account that contains the analysis.
|
2989
|
+
# You must be using the Amazon Web Services account that the analysis is
|
2990
|
+
# in.
|
2964
2991
|
#
|
2965
2992
|
# @option params [required, String] :analysis_id
|
2966
2993
|
# The ID of the analysis that you're describing. The ID is part of the
|
@@ -3011,9 +3038,9 @@ module Aws::QuickSight
|
|
3011
3038
|
# Provides the read and write permissions for an analysis.
|
3012
3039
|
#
|
3013
3040
|
# @option params [required, String] :aws_account_id
|
3014
|
-
# The ID of the Amazon Web Services account
|
3041
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
3015
3042
|
# whose permissions you're describing. You must be using the Amazon Web
|
3016
|
-
# Services account
|
3043
|
+
# Services account that the analysis is in.
|
3017
3044
|
#
|
3018
3045
|
# @option params [required, String] :analysis_id
|
3019
3046
|
# The ID of the analysis whose permissions you're describing. The ID is
|
@@ -3057,7 +3084,7 @@ module Aws::QuickSight
|
|
3057
3084
|
# Provides a summary for a dashboard.
|
3058
3085
|
#
|
3059
3086
|
# @option params [required, String] :aws_account_id
|
3060
|
-
# The ID of the Amazon Web Services account
|
3087
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
3061
3088
|
# that you're describing.
|
3062
3089
|
#
|
3063
3090
|
# @option params [required, String] :dashboard_id
|
@@ -3123,11 +3150,11 @@ module Aws::QuickSight
|
|
3123
3150
|
# Describes read and write permissions for a dashboard.
|
3124
3151
|
#
|
3125
3152
|
# @option params [required, String] :aws_account_id
|
3126
|
-
# The ID of the Amazon Web Services account
|
3153
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
3127
3154
|
# that you're describing permissions for.
|
3128
3155
|
#
|
3129
3156
|
# @option params [required, String] :dashboard_id
|
3130
|
-
# The ID for the dashboard, also added to the
|
3157
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
3131
3158
|
#
|
3132
3159
|
# @return [Types::DescribeDashboardPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3133
3160
|
#
|
@@ -3167,11 +3194,11 @@ module Aws::QuickSight
|
|
3167
3194
|
# Describes a dataset.
|
3168
3195
|
#
|
3169
3196
|
# @option params [required, String] :aws_account_id
|
3170
|
-
# The Amazon Web Services account
|
3197
|
+
# The Amazon Web Services account ID.
|
3171
3198
|
#
|
3172
3199
|
# @option params [required, String] :data_set_id
|
3173
3200
|
# The ID for the dataset that you want to create. This ID is unique per
|
3174
|
-
# Region; for each Amazon Web Services account
|
3201
|
+
# Amazon Web Services Region; for each Amazon Web Services account.
|
3175
3202
|
#
|
3176
3203
|
# @return [Types::DescribeDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3177
3204
|
#
|
@@ -3235,6 +3262,9 @@ module Aws::QuickSight
|
|
3235
3262
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags #=> Array
|
3236
3263
|
# 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"
|
3237
3264
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_description.text #=> String
|
3265
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.column_name #=> String
|
3266
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names #=> Array
|
3267
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names[0] #=> String, one of "COLUMN_GEOGRAPHIC_ROLE", "COLUMN_DESCRIPTION"
|
3238
3268
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_operand #=> String
|
3239
3269
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_operand #=> String
|
3240
3270
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_join_key_properties.unique_key #=> Boolean
|
@@ -3242,6 +3272,7 @@ module Aws::QuickSight
|
|
3242
3272
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.type #=> String, one of "INNER", "OUTER", "LEFT", "RIGHT"
|
3243
3273
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.on_clause #=> String
|
3244
3274
|
# resp.data_set.logical_table_map["LogicalTableId"].source.physical_table_id #=> String
|
3275
|
+
# resp.data_set.logical_table_map["LogicalTableId"].source.data_set_arn #=> String
|
3245
3276
|
# resp.data_set.output_columns #=> Array
|
3246
3277
|
# resp.data_set.output_columns[0].name #=> String
|
3247
3278
|
# resp.data_set.output_columns[0].description #=> String
|
@@ -3273,6 +3304,8 @@ module Aws::QuickSight
|
|
3273
3304
|
# resp.data_set.column_level_permission_rules[0].principals[0] #=> String
|
3274
3305
|
# resp.data_set.column_level_permission_rules[0].column_names #=> Array
|
3275
3306
|
# resp.data_set.column_level_permission_rules[0].column_names[0] #=> String
|
3307
|
+
# resp.data_set.data_set_usage_configuration.disable_use_as_direct_query_source #=> Boolean
|
3308
|
+
# resp.data_set.data_set_usage_configuration.disable_use_as_imported_source #=> Boolean
|
3276
3309
|
# resp.request_id #=> String
|
3277
3310
|
# resp.status #=> Integer
|
3278
3311
|
#
|
@@ -3291,11 +3324,11 @@ module Aws::QuickSight
|
|
3291
3324
|
# `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
|
3292
3325
|
#
|
3293
3326
|
# @option params [required, String] :aws_account_id
|
3294
|
-
# The Amazon Web Services account
|
3327
|
+
# The Amazon Web Services account ID.
|
3295
3328
|
#
|
3296
3329
|
# @option params [required, String] :data_set_id
|
3297
3330
|
# The ID for the dataset that you want to create. This ID is unique per
|
3298
|
-
# Region; for each Amazon Web Services account
|
3331
|
+
# Amazon Web Services Region; for each Amazon Web Services account.
|
3299
3332
|
#
|
3300
3333
|
# @return [Types::DescribeDataSetPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3301
3334
|
#
|
@@ -3335,11 +3368,11 @@ module Aws::QuickSight
|
|
3335
3368
|
# Describes a data source.
|
3336
3369
|
#
|
3337
3370
|
# @option params [required, String] :aws_account_id
|
3338
|
-
# The Amazon Web Services account
|
3371
|
+
# The Amazon Web Services account ID.
|
3339
3372
|
#
|
3340
3373
|
# @option params [required, String] :data_source_id
|
3341
|
-
# The ID of the data source. This ID is unique per
|
3342
|
-
# Amazon Web Services account
|
3374
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
3375
|
+
# Region; for each Amazon Web Services account.
|
3343
3376
|
#
|
3344
3377
|
# @return [Types::DescribeDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3345
3378
|
#
|
@@ -3359,7 +3392,7 @@ module Aws::QuickSight
|
|
3359
3392
|
# resp.data_source.arn #=> String
|
3360
3393
|
# resp.data_source.data_source_id #=> String
|
3361
3394
|
# resp.data_source.name #=> String
|
3362
|
-
# resp.data_source.type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM"
|
3395
|
+
# resp.data_source.type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH"
|
3363
3396
|
# resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
3364
3397
|
# resp.data_source.created_time #=> Time
|
3365
3398
|
# resp.data_source.last_updated_time #=> Time
|
@@ -3410,6 +3443,7 @@ module Aws::QuickSight
|
|
3410
3443
|
# resp.data_source.data_source_parameters.teradata_parameters.database #=> String
|
3411
3444
|
# resp.data_source.data_source_parameters.twitter_parameters.query #=> String
|
3412
3445
|
# resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer
|
3446
|
+
# resp.data_source.data_source_parameters.amazon_open_search_parameters.domain #=> String
|
3413
3447
|
# resp.data_source.alternate_data_source_parameters #=> Array
|
3414
3448
|
# resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
3415
3449
|
# resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
@@ -3458,6 +3492,7 @@ module Aws::QuickSight
|
|
3458
3492
|
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.database #=> String
|
3459
3493
|
# resp.data_source.alternate_data_source_parameters[0].twitter_parameters.query #=> String
|
3460
3494
|
# resp.data_source.alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
|
3495
|
+
# resp.data_source.alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> String
|
3461
3496
|
# resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
|
3462
3497
|
# resp.data_source.ssl_properties.disable_ssl #=> Boolean
|
3463
3498
|
# resp.data_source.error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
@@ -3477,11 +3512,11 @@ module Aws::QuickSight
|
|
3477
3512
|
# Describes the resource permissions for a data source.
|
3478
3513
|
#
|
3479
3514
|
# @option params [required, String] :aws_account_id
|
3480
|
-
# The Amazon Web Services account
|
3515
|
+
# The Amazon Web Services account ID.
|
3481
3516
|
#
|
3482
3517
|
# @option params [required, String] :data_source_id
|
3483
|
-
# The ID of the data source. This ID is unique per
|
3484
|
-
# Amazon Web Services account
|
3518
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
3519
|
+
# Region; for each Amazon Web Services account.
|
3485
3520
|
#
|
3486
3521
|
# @return [Types::DescribeDataSourcePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3487
3522
|
#
|
@@ -3656,8 +3691,8 @@ module Aws::QuickSight
|
|
3656
3691
|
# The name of the group that you want to describe.
|
3657
3692
|
#
|
3658
3693
|
# @option params [required, String] :aws_account_id
|
3659
|
-
# The ID for the Amazon Web Services account
|
3660
|
-
# Currently, you use the ID for the Amazon Web Services account
|
3694
|
+
# The ID for the Amazon Web Services account that the group is in.
|
3695
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
3661
3696
|
# contains your Amazon QuickSight account.
|
3662
3697
|
#
|
3663
3698
|
# @option params [required, String] :namespace
|
@@ -3695,12 +3730,12 @@ module Aws::QuickSight
|
|
3695
3730
|
req.send_request(options)
|
3696
3731
|
end
|
3697
3732
|
|
3698
|
-
# Describes an existing
|
3733
|
+
# Describes an existing IAMpolicy assignment, as specified by the
|
3699
3734
|
# assignment name.
|
3700
3735
|
#
|
3701
3736
|
# @option params [required, String] :aws_account_id
|
3702
|
-
# The ID of the Amazon Web Services account
|
3703
|
-
#
|
3737
|
+
# The ID of the Amazon Web Services account that contains the assignment
|
3738
|
+
# that you want to describe.
|
3704
3739
|
#
|
3705
3740
|
# @option params [required, String] :assignment_name
|
3706
3741
|
# The name of the assignment, also called a rule.
|
@@ -3747,7 +3782,7 @@ module Aws::QuickSight
|
|
3747
3782
|
# Describes a SPICE ingestion.
|
3748
3783
|
#
|
3749
3784
|
# @option params [required, String] :aws_account_id
|
3750
|
-
# The Amazon Web Services account
|
3785
|
+
# The Amazon Web Services account ID.
|
3751
3786
|
#
|
3752
3787
|
# @option params [required, String] :data_set_id
|
3753
3788
|
# The ID of the dataset used in the ingestion.
|
@@ -3800,7 +3835,7 @@ module Aws::QuickSight
|
|
3800
3835
|
# Describes the current namespace.
|
3801
3836
|
#
|
3802
3837
|
# @option params [required, String] :aws_account_id
|
3803
|
-
# The ID for the Amazon Web Services account
|
3838
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
3804
3839
|
# QuickSight namespace that you want to describe.
|
3805
3840
|
#
|
3806
3841
|
# @option params [required, String] :namespace
|
@@ -3843,7 +3878,7 @@ module Aws::QuickSight
|
|
3843
3878
|
# Describes a template's metadata.
|
3844
3879
|
#
|
3845
3880
|
# @option params [required, String] :aws_account_id
|
3846
|
-
# The ID of the Amazon Web Services account
|
3881
|
+
# The ID of the Amazon Web Services account that contains the template
|
3847
3882
|
# that you're describing.
|
3848
3883
|
#
|
3849
3884
|
# @option params [required, String] :template_id
|
@@ -3920,7 +3955,7 @@ module Aws::QuickSight
|
|
3920
3955
|
# Describes the template alias for a template.
|
3921
3956
|
#
|
3922
3957
|
# @option params [required, String] :aws_account_id
|
3923
|
-
# The ID of the Amazon Web Services account
|
3958
|
+
# The ID of the Amazon Web Services account that contains the template
|
3924
3959
|
# alias that you're describing.
|
3925
3960
|
#
|
3926
3961
|
# @option params [required, String] :template_id
|
@@ -3967,7 +4002,7 @@ module Aws::QuickSight
|
|
3967
4002
|
# Describes read and write permissions on a template.
|
3968
4003
|
#
|
3969
4004
|
# @option params [required, String] :aws_account_id
|
3970
|
-
# The ID of the Amazon Web Services account
|
4005
|
+
# The ID of the Amazon Web Services account that contains the template
|
3971
4006
|
# that you're describing.
|
3972
4007
|
#
|
3973
4008
|
# @option params [required, String] :template_id
|
@@ -4011,8 +4046,8 @@ module Aws::QuickSight
|
|
4011
4046
|
# Describes a theme.
|
4012
4047
|
#
|
4013
4048
|
# @option params [required, String] :aws_account_id
|
4014
|
-
# The ID of the Amazon Web Services account
|
4015
|
-
#
|
4049
|
+
# The ID of the Amazon Web Services account that contains the theme that
|
4050
|
+
# you're describing.
|
4016
4051
|
#
|
4017
4052
|
# @option params [required, String] :theme_id
|
4018
4053
|
# The ID for the theme.
|
@@ -4100,7 +4135,7 @@ module Aws::QuickSight
|
|
4100
4135
|
# Describes the alias for a theme.
|
4101
4136
|
#
|
4102
4137
|
# @option params [required, String] :aws_account_id
|
4103
|
-
# The ID of the Amazon Web Services account
|
4138
|
+
# The ID of the Amazon Web Services account that contains the theme
|
4104
4139
|
# alias that you're describing.
|
4105
4140
|
#
|
4106
4141
|
# @option params [required, String] :theme_id
|
@@ -4143,8 +4178,8 @@ module Aws::QuickSight
|
|
4143
4178
|
# Describes the read and write permissions for a theme.
|
4144
4179
|
#
|
4145
4180
|
# @option params [required, String] :aws_account_id
|
4146
|
-
# The ID of the Amazon Web Services account
|
4147
|
-
#
|
4181
|
+
# The ID of the Amazon Web Services account that contains the theme that
|
4182
|
+
# you're describing.
|
4148
4183
|
#
|
4149
4184
|
# @option params [required, String] :theme_id
|
4150
4185
|
# The ID for the theme that you want to describe permissions for.
|
@@ -4190,8 +4225,8 @@ module Aws::QuickSight
|
|
4190
4225
|
# The name of the user that you want to describe.
|
4191
4226
|
#
|
4192
4227
|
# @option params [required, String] :aws_account_id
|
4193
|
-
# The ID for the Amazon Web Services account
|
4194
|
-
# Currently, you use the ID for the Amazon Web Services account
|
4228
|
+
# The ID for the Amazon Web Services account that the user is in.
|
4229
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
4195
4230
|
# contains your Amazon QuickSight account.
|
4196
4231
|
#
|
4197
4232
|
# @option params [required, String] :namespace
|
@@ -4434,9 +4469,9 @@ module Aws::QuickSight
|
|
4434
4469
|
end
|
4435
4470
|
|
4436
4471
|
# Generates a session URL and authorization code that you can use to
|
4437
|
-
# embed an Amazon QuickSight read-only dashboard in your web
|
4438
|
-
# code. Before you use this command, make sure that you have
|
4439
|
-
# the dashboards and permissions.
|
4472
|
+
# embed an Amazon Amazon QuickSight read-only dashboard in your web
|
4473
|
+
# server code. Before you use this command, make sure that you have
|
4474
|
+
# configured the dashboards and permissions.
|
4440
4475
|
#
|
4441
4476
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
4442
4477
|
# not from the user's browser. The following rules apply to the
|
@@ -4450,8 +4485,8 @@ module Aws::QuickSight
|
|
4450
4485
|
#
|
4451
4486
|
# * The resulting user session is valid for 10 hours.
|
4452
4487
|
#
|
4453
|
-
# For more information, see [
|
4454
|
-
# QuickSight User Guide*.
|
4488
|
+
# For more information, see [Embedding Analytics Using
|
4489
|
+
# GetDashboardEmbedUrl][1] in the *Amazon QuickSight User Guide*.
|
4455
4490
|
#
|
4456
4491
|
# For more information about the high-level steps for embedding and for
|
4457
4492
|
# an interactive demo of the ways you can customize embedding, visit the
|
@@ -4459,12 +4494,12 @@ module Aws::QuickSight
|
|
4459
4494
|
#
|
4460
4495
|
#
|
4461
4496
|
#
|
4462
|
-
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html
|
4497
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html
|
4463
4498
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
|
4464
4499
|
#
|
4465
4500
|
# @option params [required, String] :aws_account_id
|
4466
|
-
# The ID for the Amazon Web Services account
|
4467
|
-
#
|
4501
|
+
# The ID for the Amazon Web Services account that contains the dashboard
|
4502
|
+
# that you're embedding.
|
4468
4503
|
#
|
4469
4504
|
# @option params [required, String] :dashboard_id
|
4470
4505
|
# The ID for the dashboard, also added to the Identity and Access
|
@@ -4489,11 +4524,11 @@ module Aws::QuickSight
|
|
4489
4524
|
# Adds persistence of state for the user session in an embedded
|
4490
4525
|
# dashboard. Persistence applies to the sheet and the parameter
|
4491
4526
|
# settings. These are control settings that the dashboard subscriber
|
4492
|
-
# (QuickSight reader) chooses while viewing the dashboard. If
|
4493
|
-
# set to `TRUE`, the settings are the same when the subscriber
|
4494
|
-
# the same dashboard URL. The state is stored in
|
4495
|
-
# browser cookie. If this is set to FALSE, the
|
4496
|
-
# is not persisted. The default is `FALSE`.
|
4527
|
+
# (Amazon QuickSight reader) chooses while viewing the dashboard. If
|
4528
|
+
# this is set to `TRUE`, the settings are the same when the subscriber
|
4529
|
+
# reopens the same dashboard URL. The state is stored in Amazon
|
4530
|
+
# QuickSight, not in a browser cookie. If this is set to FALSE, the
|
4531
|
+
# state of the user session is not persisted. The default is `FALSE`.
|
4497
4532
|
#
|
4498
4533
|
# @option params [String] :user_arn
|
4499
4534
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
@@ -4505,23 +4540,22 @@ module Aws::QuickSight
|
|
4505
4540
|
#
|
4506
4541
|
# * Invited nonfederated users
|
4507
4542
|
#
|
4508
|
-
# *
|
4509
|
-
#
|
4510
|
-
# federation.
|
4543
|
+
# * IAMusers and IAMrole-based sessions authenticated through Federated
|
4544
|
+
# Single Sign-On using SAML, OpenID Connect, or IAMfederation.
|
4511
4545
|
#
|
4512
|
-
# Omit this parameter for users in the third group –
|
4546
|
+
# Omit this parameter for users in the third group – IAMusers and IAM
|
4513
4547
|
# role-based sessions.
|
4514
4548
|
#
|
4515
4549
|
# @option params [String] :namespace
|
4516
|
-
# The Amazon QuickSight namespace that the
|
4517
|
-
# you
|
4518
|
-
#
|
4550
|
+
# The Amazon QuickSight namespace that contains the dashboard IDs in
|
4551
|
+
# this request. If you're not using a custom namespace, set `Namespace
|
4552
|
+
# = default`.
|
4519
4553
|
#
|
4520
4554
|
# @option params [Array<String>] :additional_dashboard_ids
|
4521
4555
|
# A list of one or more dashboard IDs that you want to add to a session
|
4522
4556
|
# that includes anonymous users. The `IdentityType` parameter must be
|
4523
4557
|
# set to `ANONYMOUS` for this to work, because other identity types
|
4524
|
-
# authenticate as QuickSight or
|
4558
|
+
# authenticate as Amazon QuickSight or IAMusers. For example, if you set
|
4525
4559
|
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
4526
4560
|
# identity-type ANONYMOUS`", the session can access all three
|
4527
4561
|
# dashboards.
|
@@ -4563,28 +4597,28 @@ module Aws::QuickSight
|
|
4563
4597
|
end
|
4564
4598
|
|
4565
4599
|
# Generates a session URL and authorization code that you can use to
|
4566
|
-
# embed the Amazon QuickSight console in your web server code.
|
4567
|
-
# `GetSessionEmbedUrl` where you want to provide an authoring portal
|
4600
|
+
# embed the Amazon Amazon QuickSight console in your web server code.
|
4601
|
+
# Use `GetSessionEmbedUrl` where you want to provide an authoring portal
|
4568
4602
|
# that allows users to create data sources, datasets, analyses, and
|
4569
|
-
# dashboards. The users who access an embedded QuickSight console
|
4570
|
-
# belong to the author or admin security cohort. If you want to
|
4571
|
-
# permissions to some of these features, add a custom
|
4572
|
-
# profile to the user with the ` UpdateUser ` API operation.
|
4573
|
-
# RegisterUser ` API operation to add a new user with a custom
|
4603
|
+
# dashboards. The users who access an embedded Amazon QuickSight console
|
4604
|
+
# need belong to the author or admin security cohort. If you want to
|
4605
|
+
# restrict permissions to some of these features, add a custom
|
4606
|
+
# permissions profile to the user with the ` UpdateUser ` API operation.
|
4607
|
+
# Use ` RegisterUser ` API operation to add a new user with a custom
|
4574
4608
|
# permission profile attached. For more information, see the following
|
4575
4609
|
# sections in the *Amazon QuickSight User Guide*\:
|
4576
4610
|
#
|
4577
|
-
# * [Embedding
|
4611
|
+
# * [Embedding Analytics][1]
|
4578
4612
|
#
|
4579
4613
|
# * [Customizing Access to the Amazon QuickSight Console][2]
|
4580
4614
|
#
|
4581
4615
|
#
|
4582
4616
|
#
|
4583
|
-
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/
|
4617
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html
|
4584
4618
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
|
4585
4619
|
#
|
4586
4620
|
# @option params [required, String] :aws_account_id
|
4587
|
-
# The ID for the Amazon Web Services account
|
4621
|
+
# The ID for the Amazon Web Services account associated with your Amazon
|
4588
4622
|
# QuickSight subscription.
|
4589
4623
|
#
|
4590
4624
|
# @option params [String] :entry_point
|
@@ -4600,10 +4634,10 @@ module Aws::QuickSight
|
|
4600
4634
|
# * `/start/favorites`
|
4601
4635
|
#
|
4602
4636
|
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
4603
|
-
# key from the QuickSight console URL of the dashboard
|
4637
|
+
# key from the Amazon QuickSight console URL of the dashboard
|
4604
4638
|
#
|
4605
4639
|
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
4606
|
-
# from the QuickSight console URL of the analysis
|
4640
|
+
# from the Amazon QuickSight console URL of the analysis
|
4607
4641
|
#
|
4608
4642
|
# @option params [Integer] :session_lifetime_in_minutes
|
4609
4643
|
# How many minutes the session is valid. The session lifetime must be
|
@@ -4657,10 +4691,10 @@ module Aws::QuickSight
|
|
4657
4691
|
end
|
4658
4692
|
|
4659
4693
|
# Lists Amazon QuickSight analyses that exist in the specified Amazon
|
4660
|
-
# Web Services account
|
4694
|
+
# Web Services account.
|
4661
4695
|
#
|
4662
4696
|
# @option params [required, String] :aws_account_id
|
4663
|
-
# The ID of the Amazon Web Services account
|
4697
|
+
# The ID of the Amazon Web Services account that contains the analyses.
|
4664
4698
|
#
|
4665
4699
|
# @option params [String] :next_token
|
4666
4700
|
# A pagination token that can be used in a subsequent request.
|
@@ -4707,11 +4741,11 @@ module Aws::QuickSight
|
|
4707
4741
|
req.send_request(options)
|
4708
4742
|
end
|
4709
4743
|
|
4710
|
-
# Lists all the versions of the dashboards in the QuickSight
|
4744
|
+
# Lists all the versions of the dashboards in the Amazon QuickSight
|
4711
4745
|
# subscription.
|
4712
4746
|
#
|
4713
4747
|
# @option params [required, String] :aws_account_id
|
4714
|
-
# The ID of the Amazon Web Services account
|
4748
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
4715
4749
|
# that you're listing versions for.
|
4716
4750
|
#
|
4717
4751
|
# @option params [required, String] :dashboard_id
|
@@ -4764,11 +4798,11 @@ module Aws::QuickSight
|
|
4764
4798
|
req.send_request(options)
|
4765
4799
|
end
|
4766
4800
|
|
4767
|
-
# Lists dashboards in an Amazon Web Services account
|
4801
|
+
# Lists dashboards in an Amazon Web Services account.
|
4768
4802
|
#
|
4769
4803
|
# @option params [required, String] :aws_account_id
|
4770
|
-
# The ID of the Amazon Web Services account
|
4771
|
-
#
|
4804
|
+
# The ID of the Amazon Web Services account that contains the dashboards
|
4805
|
+
# that you're listing.
|
4772
4806
|
#
|
4773
4807
|
# @option params [String] :next_token
|
4774
4808
|
# The token for the next set of results, or null if there are no more
|
@@ -4818,13 +4852,13 @@ module Aws::QuickSight
|
|
4818
4852
|
end
|
4819
4853
|
|
4820
4854
|
# Lists all of the datasets belonging to the current Amazon Web Services
|
4821
|
-
# account
|
4855
|
+
# account in an Amazon Web Services Region;.
|
4822
4856
|
#
|
4823
4857
|
# The permissions resource is
|
4824
4858
|
# `arn:aws:quicksight:region:aws-account-id:dataset/*`.
|
4825
4859
|
#
|
4826
4860
|
# @option params [required, String] :aws_account_id
|
4827
|
-
# The Amazon Web Services account
|
4861
|
+
# The Amazon Web Services account ID.
|
4828
4862
|
#
|
4829
4863
|
# @option params [String] :next_token
|
4830
4864
|
# The token for the next set of results, or null if there are no more
|
@@ -4879,11 +4913,11 @@ module Aws::QuickSight
|
|
4879
4913
|
req.send_request(options)
|
4880
4914
|
end
|
4881
4915
|
|
4882
|
-
# Lists data sources in current Region; that belong
|
4883
|
-
# Services account
|
4916
|
+
# Lists data sources in current Amazon Web Services Region; that belong
|
4917
|
+
# to this Amazon Web Services account.
|
4884
4918
|
#
|
4885
4919
|
# @option params [required, String] :aws_account_id
|
4886
|
-
# The Amazon Web Services account
|
4920
|
+
# The Amazon Web Services account ID.
|
4887
4921
|
#
|
4888
4922
|
# @option params [String] :next_token
|
4889
4923
|
# The token for the next set of results, or null if there are no more
|
@@ -4915,7 +4949,7 @@ module Aws::QuickSight
|
|
4915
4949
|
# resp.data_sources[0].arn #=> String
|
4916
4950
|
# resp.data_sources[0].data_source_id #=> String
|
4917
4951
|
# resp.data_sources[0].name #=> String
|
4918
|
-
# resp.data_sources[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM"
|
4952
|
+
# resp.data_sources[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH"
|
4919
4953
|
# resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
4920
4954
|
# resp.data_sources[0].created_time #=> Time
|
4921
4955
|
# resp.data_sources[0].last_updated_time #=> Time
|
@@ -4966,6 +5000,7 @@ module Aws::QuickSight
|
|
4966
5000
|
# resp.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
|
4967
5001
|
# resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
|
4968
5002
|
# resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
|
5003
|
+
# resp.data_sources[0].data_source_parameters.amazon_open_search_parameters.domain #=> String
|
4969
5004
|
# resp.data_sources[0].alternate_data_source_parameters #=> Array
|
4970
5005
|
# resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
4971
5006
|
# resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
@@ -5014,6 +5049,7 @@ module Aws::QuickSight
|
|
5014
5049
|
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.database #=> String
|
5015
5050
|
# resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.query #=> String
|
5016
5051
|
# resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
|
5052
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> String
|
5017
5053
|
# resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
5018
5054
|
# resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
5019
5055
|
# resp.data_sources[0].error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
|
@@ -5141,8 +5177,8 @@ module Aws::QuickSight
|
|
5141
5177
|
# The maximum number of results to return from this request.
|
5142
5178
|
#
|
5143
5179
|
# @option params [required, String] :aws_account_id
|
5144
|
-
# The ID for the Amazon Web Services account
|
5145
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5180
|
+
# The ID for the Amazon Web Services account that the group is in.
|
5181
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5146
5182
|
# contains your Amazon QuickSight account.
|
5147
5183
|
#
|
5148
5184
|
# @option params [required, String] :namespace
|
@@ -5186,8 +5222,8 @@ module Aws::QuickSight
|
|
5186
5222
|
# Lists all user groups in Amazon QuickSight.
|
5187
5223
|
#
|
5188
5224
|
# @option params [required, String] :aws_account_id
|
5189
|
-
# The ID for the Amazon Web Services account
|
5190
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5225
|
+
# The ID for the Amazon Web Services account that the group is in.
|
5226
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5191
5227
|
# contains your Amazon QuickSight account.
|
5192
5228
|
#
|
5193
5229
|
# @option params [String] :next_token
|
@@ -5235,11 +5271,11 @@ module Aws::QuickSight
|
|
5235
5271
|
req.send_request(options)
|
5236
5272
|
end
|
5237
5273
|
|
5238
|
-
# Lists
|
5274
|
+
# Lists IAMpolicy assignments in the current Amazon QuickSight account.
|
5239
5275
|
#
|
5240
5276
|
# @option params [required, String] :aws_account_id
|
5241
|
-
# The ID of the Amazon Web Services account
|
5242
|
-
#
|
5277
|
+
# The ID of the Amazon Web Services account that contains these
|
5278
|
+
# IAMpolicy assignments.
|
5243
5279
|
#
|
5244
5280
|
# @option params [String] :assignment_status
|
5245
5281
|
# The status of the assignments.
|
@@ -5289,12 +5325,12 @@ module Aws::QuickSight
|
|
5289
5325
|
req.send_request(options)
|
5290
5326
|
end
|
5291
5327
|
|
5292
|
-
# Lists all the
|
5328
|
+
# Lists all the IAMpolicy assignments, including the Amazon Resource
|
5293
5329
|
# Names (ARNs) for the IAM policies assigned to the specified user and
|
5294
5330
|
# group or groups that the user belongs to.
|
5295
5331
|
#
|
5296
5332
|
# @option params [required, String] :aws_account_id
|
5297
|
-
# The ID of the Amazon Web Services account
|
5333
|
+
# The ID of the Amazon Web Services account that contains the
|
5298
5334
|
# assignments.
|
5299
5335
|
#
|
5300
5336
|
# @option params [required, String] :user_name
|
@@ -5355,7 +5391,7 @@ module Aws::QuickSight
|
|
5355
5391
|
# results.
|
5356
5392
|
#
|
5357
5393
|
# @option params [required, String] :aws_account_id
|
5358
|
-
# The Amazon Web Services account
|
5394
|
+
# The Amazon Web Services account ID.
|
5359
5395
|
#
|
5360
5396
|
# @option params [Integer] :max_results
|
5361
5397
|
# The maximum number of results to be returned per request.
|
@@ -5408,10 +5444,10 @@ module Aws::QuickSight
|
|
5408
5444
|
req.send_request(options)
|
5409
5445
|
end
|
5410
5446
|
|
5411
|
-
# Lists the namespaces for the specified Amazon Web Services account
|
5447
|
+
# Lists the namespaces for the specified Amazon Web Services account.
|
5412
5448
|
#
|
5413
5449
|
# @option params [required, String] :aws_account_id
|
5414
|
-
# The ID for the Amazon Web Services account
|
5450
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
5415
5451
|
# QuickSight namespaces that you want to list.
|
5416
5452
|
#
|
5417
5453
|
# @option params [String] :next_token
|
@@ -5498,7 +5534,7 @@ module Aws::QuickSight
|
|
5498
5534
|
# Lists all the aliases of a template.
|
5499
5535
|
#
|
5500
5536
|
# @option params [required, String] :aws_account_id
|
5501
|
-
# The ID of the Amazon Web Services account
|
5537
|
+
# The ID of the Amazon Web Services account that contains the template
|
5502
5538
|
# aliases that you're listing.
|
5503
5539
|
#
|
5504
5540
|
# @option params [required, String] :template_id
|
@@ -5552,7 +5588,7 @@ module Aws::QuickSight
|
|
5552
5588
|
# QuickSight account.
|
5553
5589
|
#
|
5554
5590
|
# @option params [required, String] :aws_account_id
|
5555
|
-
# The ID of the Amazon Web Services account
|
5591
|
+
# The ID of the Amazon Web Services account that contains the templates
|
5556
5592
|
# that you're listing.
|
5557
5593
|
#
|
5558
5594
|
# @option params [required, String] :template_id
|
@@ -5607,7 +5643,7 @@ module Aws::QuickSight
|
|
5607
5643
|
# Lists all the templates in the current Amazon QuickSight account.
|
5608
5644
|
#
|
5609
5645
|
# @option params [required, String] :aws_account_id
|
5610
|
-
# The ID of the Amazon Web Services account
|
5646
|
+
# The ID of the Amazon Web Services account that contains the templates
|
5611
5647
|
# that you're listing.
|
5612
5648
|
#
|
5613
5649
|
# @option params [String] :next_token
|
@@ -5659,7 +5695,7 @@ module Aws::QuickSight
|
|
5659
5695
|
# Lists all the aliases of a theme.
|
5660
5696
|
#
|
5661
5697
|
# @option params [required, String] :aws_account_id
|
5662
|
-
# The ID of the Amazon Web Services account
|
5698
|
+
# The ID of the Amazon Web Services account that contains the theme
|
5663
5699
|
# aliases that you're listing.
|
5664
5700
|
#
|
5665
5701
|
# @option params [required, String] :theme_id
|
@@ -5708,10 +5744,10 @@ module Aws::QuickSight
|
|
5708
5744
|
end
|
5709
5745
|
|
5710
5746
|
# Lists all the versions of the themes in the current Amazon Web
|
5711
|
-
# Services account
|
5747
|
+
# Services account.
|
5712
5748
|
#
|
5713
5749
|
# @option params [required, String] :aws_account_id
|
5714
|
-
# The ID of the Amazon Web Services account
|
5750
|
+
# The ID of the Amazon Web Services account that contains the themes
|
5715
5751
|
# that you're listing.
|
5716
5752
|
#
|
5717
5753
|
# @option params [required, String] :theme_id
|
@@ -5763,10 +5799,10 @@ module Aws::QuickSight
|
|
5763
5799
|
req.send_request(options)
|
5764
5800
|
end
|
5765
5801
|
|
5766
|
-
# Lists all the themes in the current Amazon Web Services account
|
5802
|
+
# Lists all the themes in the current Amazon Web Services account.
|
5767
5803
|
#
|
5768
5804
|
# @option params [required, String] :aws_account_id
|
5769
|
-
# The ID of the Amazon Web Services account
|
5805
|
+
# The ID of the Amazon Web Services account that contains the themes
|
5770
5806
|
# that you're listing.
|
5771
5807
|
#
|
5772
5808
|
# @option params [String] :next_token
|
@@ -5836,8 +5872,8 @@ module Aws::QuickSight
|
|
5836
5872
|
# memberships for.
|
5837
5873
|
#
|
5838
5874
|
# @option params [required, String] :aws_account_id
|
5839
|
-
# The Amazon Web Services account
|
5840
|
-
#
|
5875
|
+
# The Amazon Web Services account ID that the user is in. Currently, you
|
5876
|
+
# use the ID for the Amazon Web Services account that contains your
|
5841
5877
|
# Amazon QuickSight account.
|
5842
5878
|
#
|
5843
5879
|
# @option params [required, String] :namespace
|
@@ -5890,8 +5926,8 @@ module Aws::QuickSight
|
|
5890
5926
|
# account.
|
5891
5927
|
#
|
5892
5928
|
# @option params [required, String] :aws_account_id
|
5893
|
-
# The ID for the Amazon Web Services account
|
5894
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5929
|
+
# The ID for the Amazon Web Services account that the user is in.
|
5930
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5895
5931
|
# contains your Amazon QuickSight account.
|
5896
5932
|
#
|
5897
5933
|
# @option params [String] :next_token
|
@@ -5954,7 +5990,7 @@ module Aws::QuickSight
|
|
5954
5990
|
# Amazon QuickSight supports several ways of managing the identity of
|
5955
5991
|
# users. This parameter accepts two values:
|
5956
5992
|
#
|
5957
|
-
# * `IAM`\: A user whose identity maps to an existing
|
5993
|
+
# * `IAM`\: A user whose identity maps to an existing IAMuser or role.
|
5958
5994
|
#
|
5959
5995
|
# * `QUICKSIGHT`\: A user whose identity is owned and managed internally
|
5960
5996
|
# by Amazon QuickSight.
|
@@ -5979,25 +6015,25 @@ module Aws::QuickSight
|
|
5979
6015
|
# * `RESTRICTED_AUTHOR`\: This role isn't currently available for use.
|
5980
6016
|
#
|
5981
6017
|
# @option params [String] :iam_arn
|
5982
|
-
# The ARN of the
|
6018
|
+
# The ARN of the IAMuser or role that you are registering with Amazon
|
5983
6019
|
# QuickSight.
|
5984
6020
|
#
|
5985
6021
|
# @option params [String] :session_name
|
5986
6022
|
# You need to use this parameter only when you register one or more
|
5987
|
-
# users using an assumed
|
5988
|
-
#
|
5989
|
-
#
|
5990
|
-
#
|
5991
|
-
#
|
5992
|
-
#
|
6023
|
+
# users using an assumed IAMrole. You don't need to provide the session
|
6024
|
+
# name for other scenarios, for example when you are registering an
|
6025
|
+
# IAMuser or an Amazon QuickSight user. You can register multiple users
|
6026
|
+
# using the same IAMrole if each user has a different session name. For
|
6027
|
+
# more information on assuming IAMroles, see [ `assume-role` ][1] in the
|
6028
|
+
# *AWS CLI Reference.*
|
5993
6029
|
#
|
5994
6030
|
#
|
5995
6031
|
#
|
5996
6032
|
# [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
|
5997
6033
|
#
|
5998
6034
|
# @option params [required, String] :aws_account_id
|
5999
|
-
# The ID for the Amazon Web Services account
|
6000
|
-
# Currently, you use the ID for the Amazon Web Services account
|
6035
|
+
# The ID for the Amazon Web Services account that the user is in.
|
6036
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
6001
6037
|
# contains your Amazon QuickSight account.
|
6002
6038
|
#
|
6003
6039
|
# @option params [required, String] :namespace
|
@@ -6026,22 +6062,22 @@ module Aws::QuickSight
|
|
6026
6062
|
#
|
6027
6063
|
# A set of custom permissions includes any combination of these
|
6028
6064
|
# restrictions. Currently, you need to create the profile names for
|
6029
|
-
# custom permission sets by using the QuickSight console. Then,
|
6030
|
-
# the `RegisterUser` API operation to assign the named set of
|
6031
|
-
# permissions to a QuickSight user.
|
6065
|
+
# custom permission sets by using the Amazon QuickSight console. Then,
|
6066
|
+
# you use the `RegisterUser` API operation to assign the named set of
|
6067
|
+
# permissions to a Amazon QuickSight user.
|
6032
6068
|
#
|
6033
|
-
# QuickSight custom permissions are applied through
|
6069
|
+
# Amazon QuickSight custom permissions are applied through IAMpolicies.
|
6034
6070
|
# Therefore, they override the permissions typically granted by
|
6035
|
-
# assigning QuickSight users to one of the default security
|
6036
|
-
# QuickSight (admin, author, reader).
|
6071
|
+
# assigning Amazon QuickSight users to one of the default security
|
6072
|
+
# cohorts in Amazon QuickSight (admin, author, reader).
|
6037
6073
|
#
|
6038
|
-
# This feature is available only to QuickSight Enterprise edition
|
6074
|
+
# This feature is available only to Amazon QuickSight Enterprise edition
|
6039
6075
|
# subscriptions.
|
6040
6076
|
#
|
6041
6077
|
# @option params [String] :external_login_federation_provider_type
|
6042
6078
|
# The type of supported external login provider that provides identity
|
6043
|
-
# to let a user federate into Amazon QuickSight with an associated
|
6044
|
-
# Identity and Access Management
|
6079
|
+
# to let a user federate into Amazon QuickSight with an associated
|
6080
|
+
# Identity and Access Management(IAM) role. The type of supported
|
6045
6081
|
# external login provider can be one of the following.
|
6046
6082
|
#
|
6047
6083
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
@@ -6055,10 +6091,10 @@ module Aws::QuickSight
|
|
6055
6091
|
#
|
6056
6092
|
# @option params [String] :custom_federation_provider_url
|
6057
6093
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
6058
|
-
# identity to let a user federate into QuickSight with an
|
6059
|
-
# Identity and Access Management
|
6060
|
-
# be used when `ExternalLoginFederationProviderType`
|
6061
|
-
# `CUSTOM_OIDC`.
|
6094
|
+
# identity to let a user federate into Amazon QuickSight with an
|
6095
|
+
# associated Identity and Access Management(IAM) role. This parameter
|
6096
|
+
# should only be used when `ExternalLoginFederationProviderType`
|
6097
|
+
# parameter is set to `CUSTOM_OIDC`.
|
6062
6098
|
#
|
6063
6099
|
# @option params [String] :external_login_id
|
6064
6100
|
# The identity ID for a user in the external login provider.
|
@@ -6116,7 +6152,7 @@ module Aws::QuickSight
|
|
6116
6152
|
# Restores an analysis.
|
6117
6153
|
#
|
6118
6154
|
# @option params [required, String] :aws_account_id
|
6119
|
-
# The ID of the Amazon Web Services account
|
6155
|
+
# The ID of the Amazon Web Services account that contains the analysis.
|
6120
6156
|
#
|
6121
6157
|
# @option params [required, String] :analysis_id
|
6122
6158
|
# The ID of the analysis that you're restoring.
|
@@ -6159,7 +6195,7 @@ module Aws::QuickSight
|
|
6159
6195
|
# </note>
|
6160
6196
|
#
|
6161
6197
|
# @option params [required, String] :aws_account_id
|
6162
|
-
# The ID of the Amazon Web Services account
|
6198
|
+
# The ID of the Amazon Web Services account that contains the analyses
|
6163
6199
|
# that you're searching for.
|
6164
6200
|
#
|
6165
6201
|
# @option params [required, Array<Types::AnalysisSearchFilter>] :filters
|
@@ -6226,8 +6262,8 @@ module Aws::QuickSight
|
|
6226
6262
|
# </note>
|
6227
6263
|
#
|
6228
6264
|
# @option params [required, String] :aws_account_id
|
6229
|
-
# The ID of the Amazon Web Services account
|
6230
|
-
#
|
6265
|
+
# The ID of the Amazon Web Services account that contains the user whose
|
6266
|
+
# dashboards you're searching for.
|
6231
6267
|
#
|
6232
6268
|
# @option params [required, Array<Types::DashboardSearchFilter>] :filters
|
6233
6269
|
# The filters to apply to the search. Currently, you can search only by
|
@@ -6351,8 +6387,8 @@ module Aws::QuickSight
|
|
6351
6387
|
req.send_request(options)
|
6352
6388
|
end
|
6353
6389
|
|
6354
|
-
# Assigns one or more tags (key-value pairs) to the specified
|
6355
|
-
# resource.
|
6390
|
+
# Assigns one or more tags (key-value pairs) to the specified Amazon
|
6391
|
+
# QuickSight resource.
|
6356
6392
|
#
|
6357
6393
|
# Tags can help you organize and categorize your resources. You can also
|
6358
6394
|
# use them to scope user permissions, by granting a user permission to
|
@@ -6363,18 +6399,19 @@ module Aws::QuickSight
|
|
6363
6399
|
# key that is already associated with the resource, the new tag value
|
6364
6400
|
# that you specify replaces the previous value for that tag.
|
6365
6401
|
#
|
6366
|
-
# You can associate as many as 50 tags with a resource.
|
6367
|
-
# supports tagging on data set, data source, dashboard, and
|
6402
|
+
# You can associate as many as 50 tags with a resource. Amazon
|
6403
|
+
# QuickSight supports tagging on data set, data source, dashboard, and
|
6404
|
+
# template.
|
6368
6405
|
#
|
6369
|
-
# Tagging for QuickSight works in a similar way to tagging for
|
6370
|
-
# services, except for the following:
|
6406
|
+
# Tagging for Amazon QuickSight works in a similar way to tagging for
|
6407
|
+
# other AWS services, except for the following:
|
6371
6408
|
#
|
6372
|
-
# * You can't use tags to track AWS costs for QuickSight. This
|
6373
|
-
# restriction is because QuickSight costs are based on users
|
6374
|
-
# capacity, which aren't taggable resources.
|
6409
|
+
# * You can't use tags to track AWS costs for Amazon QuickSight. This
|
6410
|
+
# restriction is because Amazon QuickSight costs are based on users
|
6411
|
+
# and SPICE capacity, which aren't taggable resources.
|
6375
6412
|
#
|
6376
|
-
# * QuickSight doesn't currently support the Tag Editor for
|
6377
|
-
# Groups.
|
6413
|
+
# * Amazon QuickSight doesn't currently support the Tag Editor for
|
6414
|
+
# Resource Groups.
|
6378
6415
|
#
|
6379
6416
|
# @option params [required, String] :resource_arn
|
6380
6417
|
# The Amazon Resource Name (ARN) of the resource that you want to tag.
|
@@ -6449,25 +6486,28 @@ module Aws::QuickSight
|
|
6449
6486
|
req.send_request(options)
|
6450
6487
|
end
|
6451
6488
|
|
6452
|
-
# Updates Amazon QuickSight customizations the current
|
6453
|
-
# Currently, the only customization you can use is a
|
6489
|
+
# Updates Amazon QuickSight customizations the current Amazon Web
|
6490
|
+
# Services Region;. Currently, the only customization you can use is a
|
6491
|
+
# theme.
|
6454
6492
|
#
|
6455
|
-
# You can use customizations for your Amazon Web Services account
|
6456
|
-
#
|
6493
|
+
# You can use customizations for your Amazon Web Services account or, if
|
6494
|
+
# you specify a namespace, for a Amazon QuickSight namespace instead.
|
6457
6495
|
# Customizations that apply to a namespace override customizations that
|
6458
|
-
# apply to an Amazon Web Services account
|
6496
|
+
# apply to an Amazon Web Services account. To find out which
|
6459
6497
|
# customizations apply, use the `DescribeAccountCustomization` API
|
6460
6498
|
# operation.
|
6461
6499
|
#
|
6462
6500
|
# @option params [required, String] :aws_account_id
|
6463
|
-
# The ID for the Amazon Web Services account
|
6464
|
-
# QuickSight customizations for.
|
6501
|
+
# The ID for the Amazon Web Services account that you want to update
|
6502
|
+
# Amazon QuickSight customizations for.
|
6465
6503
|
#
|
6466
6504
|
# @option params [String] :namespace
|
6467
|
-
# The namespace that you want to update QuickSight customizations
|
6505
|
+
# The namespace that you want to update Amazon QuickSight customizations
|
6506
|
+
# for.
|
6468
6507
|
#
|
6469
6508
|
# @option params [required, Types::AccountCustomization] :account_customization
|
6470
|
-
# The QuickSight customizations you're updating in the current
|
6509
|
+
# The Amazon QuickSight customizations you're updating in the current
|
6510
|
+
# Amazon Web Services Region;.
|
6471
6511
|
#
|
6472
6512
|
# @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6473
6513
|
#
|
@@ -6507,22 +6547,22 @@ module Aws::QuickSight
|
|
6507
6547
|
end
|
6508
6548
|
|
6509
6549
|
# Updates the Amazon QuickSight settings in your Amazon Web Services
|
6510
|
-
# account
|
6550
|
+
# account.
|
6511
6551
|
#
|
6512
6552
|
# @option params [required, String] :aws_account_id
|
6513
|
-
# The ID for the Amazon Web Services account
|
6553
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
6514
6554
|
# QuickSight settings that you want to list.
|
6515
6555
|
#
|
6516
6556
|
# @option params [required, String] :default_namespace
|
6517
|
-
# The default namespace for this Amazon Web Services account
|
6518
|
-
#
|
6519
|
-
#
|
6520
|
-
#
|
6557
|
+
# The default namespace for this Amazon Web Services account. Currently,
|
6558
|
+
# the default is `default`. Identity and Access Management (IAM) users
|
6559
|
+
# that register for the first time with Amazon QuickSight provide an
|
6560
|
+
# email that becomes associated with the default namespace.
|
6521
6561
|
#
|
6522
6562
|
# @option params [String] :notification_email
|
6523
|
-
# The email address that you want QuickSight to send
|
6524
|
-
# regarding your Amazon Web Services account
|
6525
|
-
# subscription.
|
6563
|
+
# The email address that you want Amazon QuickSight to send
|
6564
|
+
# notifications to regarding your Amazon Web Services account or Amazon
|
6565
|
+
# QuickSight subscription.
|
6526
6566
|
#
|
6527
6567
|
# @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6528
6568
|
#
|
@@ -6554,7 +6594,7 @@ module Aws::QuickSight
|
|
6554
6594
|
# Updates an analysis in Amazon QuickSight
|
6555
6595
|
#
|
6556
6596
|
# @option params [required, String] :aws_account_id
|
6557
|
-
# The ID of the Amazon Web Services account
|
6597
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
6558
6598
|
# that you're updating.
|
6559
6599
|
#
|
6560
6600
|
# @option params [required, String] :analysis_id
|
@@ -6563,7 +6603,7 @@ module Aws::QuickSight
|
|
6563
6603
|
#
|
6564
6604
|
# @option params [required, String] :name
|
6565
6605
|
# A descriptive name for the analysis that you're updating. This name
|
6566
|
-
# displays for the analysis in the QuickSight console.
|
6606
|
+
# displays for the analysis in the Amazon QuickSight console.
|
6567
6607
|
#
|
6568
6608
|
# @option params [Types::Parameters] :parameters
|
6569
6609
|
# The parameter names and override values that you want to use. An
|
@@ -6577,8 +6617,8 @@ module Aws::QuickSight
|
|
6577
6617
|
#
|
6578
6618
|
# @option params [String] :theme_arn
|
6579
6619
|
# The Amazon Resource Name (ARN) for the theme to apply to the analysis
|
6580
|
-
# that you're creating. To see the theme in the QuickSight
|
6581
|
-
# make sure that you have access to it.
|
6620
|
+
# that you're creating. To see the theme in the Amazon QuickSight
|
6621
|
+
# console, make sure that you have access to it.
|
6582
6622
|
#
|
6583
6623
|
# @return [Types::UpdateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6584
6624
|
#
|
@@ -6654,9 +6694,9 @@ module Aws::QuickSight
|
|
6654
6694
|
# Updates the read and write permissions for an analysis.
|
6655
6695
|
#
|
6656
6696
|
# @option params [required, String] :aws_account_id
|
6657
|
-
# The ID of the Amazon Web Services account
|
6697
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
6658
6698
|
# whose permissions you're updating. You must be using the Amazon Web
|
6659
|
-
# Services account
|
6699
|
+
# Services account that the analysis is in.
|
6660
6700
|
#
|
6661
6701
|
# @option params [required, String] :analysis_id
|
6662
6702
|
# The ID of the analysis whose permissions you're updating. The ID is
|
@@ -6717,7 +6757,7 @@ module Aws::QuickSight
|
|
6717
6757
|
req.send_request(options)
|
6718
6758
|
end
|
6719
6759
|
|
6720
|
-
# Updates a dashboard in an Amazon Web Services account
|
6760
|
+
# Updates a dashboard in an Amazon Web Services account.
|
6721
6761
|
#
|
6722
6762
|
# <note markdown="1"> Updating a Dashboard creates a new dashboard version but does not
|
6723
6763
|
# immediately publish the new version. You can update the published
|
@@ -6727,7 +6767,7 @@ module Aws::QuickSight
|
|
6727
6767
|
# </note>
|
6728
6768
|
#
|
6729
6769
|
# @option params [required, String] :aws_account_id
|
6730
|
-
# The ID of the Amazon Web Services account
|
6770
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
6731
6771
|
# that you're updating.
|
6732
6772
|
#
|
6733
6773
|
# @option params [required, String] :dashboard_id
|
@@ -6744,8 +6784,8 @@ module Aws::QuickSight
|
|
6744
6784
|
# from an analysis, first convert the analysis to a template by using
|
6745
6785
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
6746
6786
|
# Amazon Resource Name (ARN) of the source template. The
|
6747
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
6748
|
-
# any QuickSight-supported Region;.
|
6787
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
6788
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
6749
6789
|
#
|
6750
6790
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
6751
6791
|
# replacement datasets for the placeholders listed in the original. The
|
@@ -6764,9 +6804,9 @@ module Aws::QuickSight
|
|
6764
6804
|
#
|
6765
6805
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
|
6766
6806
|
# either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
6767
|
-
# QuickSight disables the left filter pane on the published
|
6768
|
-
# which can be used for ad hoc (one-time) filtering. This
|
6769
|
-
# `ENABLED` by default.
|
6807
|
+
# Amazon QuickSight disables the left filter pane on the published
|
6808
|
+
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
6809
|
+
# option is `ENABLED` by default.
|
6770
6810
|
#
|
6771
6811
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
6772
6812
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
@@ -6781,7 +6821,7 @@ module Aws::QuickSight
|
|
6781
6821
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
6782
6822
|
# this dashboard. If you add a value for this field, it overrides the
|
6783
6823
|
# value that was originally associated with the entity. The theme ARN
|
6784
|
-
# must exist in the same Amazon Web Services account
|
6824
|
+
# must exist in the same Amazon Web Services account where you create
|
6785
6825
|
# the dashboard.
|
6786
6826
|
#
|
6787
6827
|
# @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -6872,7 +6912,7 @@ module Aws::QuickSight
|
|
6872
6912
|
# Updates read and write permissions on a dashboard.
|
6873
6913
|
#
|
6874
6914
|
# @option params [required, String] :aws_account_id
|
6875
|
-
# The ID of the Amazon Web Services account
|
6915
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
6876
6916
|
# whose permissions you're updating.
|
6877
6917
|
#
|
6878
6918
|
# @option params [required, String] :dashboard_id
|
@@ -6934,7 +6974,7 @@ module Aws::QuickSight
|
|
6934
6974
|
# Updates the published version of a dashboard.
|
6935
6975
|
#
|
6936
6976
|
# @option params [required, String] :aws_account_id
|
6937
|
-
# The ID of the Amazon Web Services account
|
6977
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
6938
6978
|
# that you're updating.
|
6939
6979
|
#
|
6940
6980
|
# @option params [required, String] :dashboard_id
|
@@ -6977,11 +7017,11 @@ module Aws::QuickSight
|
|
6977
7017
|
# Updates a dataset.
|
6978
7018
|
#
|
6979
7019
|
# @option params [required, String] :aws_account_id
|
6980
|
-
# The Amazon Web Services account
|
7020
|
+
# The Amazon Web Services account ID.
|
6981
7021
|
#
|
6982
7022
|
# @option params [required, String] :data_set_id
|
6983
7023
|
# The ID for the dataset that you want to update. This ID is unique per
|
6984
|
-
# Region; for each Amazon Web Services account
|
7024
|
+
# Amazon Web Services Region; for each Amazon Web Services account.
|
6985
7025
|
#
|
6986
7026
|
# @option params [required, String] :name
|
6987
7027
|
# The display name for the dataset.
|
@@ -6998,7 +7038,7 @@ module Aws::QuickSight
|
|
6998
7038
|
# Indicates whether you want to import the data into SPICE.
|
6999
7039
|
#
|
7000
7040
|
# @option params [Array<Types::ColumnGroup>] :column_groups
|
7001
|
-
# Groupings of columns that work together in certain QuickSight
|
7041
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
7002
7042
|
# features. Currently, only geospatial hierarchy is supported.
|
7003
7043
|
#
|
7004
7044
|
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
@@ -7016,6 +7056,10 @@ module Aws::QuickSight
|
|
7016
7056
|
# @option params [Array<Types::ColumnLevelPermissionRule>] :column_level_permission_rules
|
7017
7057
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
7018
7058
|
#
|
7059
|
+
# @option params [Types::DataSetUsageConfiguration] :data_set_usage_configuration
|
7060
|
+
# The usage configuration to apply to child datasets that reference this
|
7061
|
+
# dataset as a source.
|
7062
|
+
#
|
7019
7063
|
# @return [Types::UpdateDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7020
7064
|
#
|
7021
7065
|
# * {Types::UpdateDataSetResponse#arn #arn} => String
|
@@ -7114,6 +7158,10 @@ module Aws::QuickSight
|
|
7114
7158
|
# },
|
7115
7159
|
# ],
|
7116
7160
|
# },
|
7161
|
+
# untag_column_operation: {
|
7162
|
+
# column_name: "ColumnName", # required
|
7163
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
7164
|
+
# },
|
7117
7165
|
# },
|
7118
7166
|
# ],
|
7119
7167
|
# source: { # required
|
@@ -7130,6 +7178,7 @@ module Aws::QuickSight
|
|
7130
7178
|
# on_clause: "OnClause", # required
|
7131
7179
|
# },
|
7132
7180
|
# physical_table_id: "PhysicalTableId",
|
7181
|
+
# data_set_arn: "Arn",
|
7133
7182
|
# },
|
7134
7183
|
# },
|
7135
7184
|
# },
|
@@ -7173,6 +7222,10 @@ module Aws::QuickSight
|
|
7173
7222
|
# column_names: ["String"],
|
7174
7223
|
# },
|
7175
7224
|
# ],
|
7225
|
+
# data_set_usage_configuration: {
|
7226
|
+
# disable_use_as_direct_query_source: false,
|
7227
|
+
# disable_use_as_imported_source: false,
|
7228
|
+
# },
|
7176
7229
|
# })
|
7177
7230
|
#
|
7178
7231
|
# @example Response structure
|
@@ -7199,11 +7252,12 @@ module Aws::QuickSight
|
|
7199
7252
|
# `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
|
7200
7253
|
#
|
7201
7254
|
# @option params [required, String] :aws_account_id
|
7202
|
-
# The Amazon Web Services account
|
7255
|
+
# The Amazon Web Services account ID.
|
7203
7256
|
#
|
7204
7257
|
# @option params [required, String] :data_set_id
|
7205
7258
|
# The ID for the dataset whose permissions you want to update. This ID
|
7206
|
-
# is unique per Region; for each Amazon Web Services
|
7259
|
+
# is unique per Amazon Web Services Region; for each Amazon Web Services
|
7260
|
+
# account.
|
7207
7261
|
#
|
7208
7262
|
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
7209
7263
|
# The resource permissions that you want to grant to the dataset.
|
@@ -7256,30 +7310,30 @@ module Aws::QuickSight
|
|
7256
7310
|
# Updates a data source.
|
7257
7311
|
#
|
7258
7312
|
# @option params [required, String] :aws_account_id
|
7259
|
-
# The Amazon Web Services account
|
7313
|
+
# The Amazon Web Services account ID.
|
7260
7314
|
#
|
7261
7315
|
# @option params [required, String] :data_source_id
|
7262
|
-
# The ID of the data source. This ID is unique per
|
7263
|
-
# Amazon Web Services account
|
7316
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
7317
|
+
# Region; for each Amazon Web Services account.
|
7264
7318
|
#
|
7265
7319
|
# @option params [required, String] :name
|
7266
7320
|
# A display name for the data source.
|
7267
7321
|
#
|
7268
7322
|
# @option params [Types::DataSourceParameters] :data_source_parameters
|
7269
|
-
# The parameters that QuickSight uses to connect to your
|
7270
|
-
# source.
|
7323
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
7324
|
+
# underlying source.
|
7271
7325
|
#
|
7272
7326
|
# @option params [Types::DataSourceCredentials] :credentials
|
7273
|
-
# The credentials that QuickSight that uses to connect to your
|
7327
|
+
# The credentials that Amazon QuickSight that uses to connect to your
|
7274
7328
|
# underlying source. Currently, only credentials based on user name and
|
7275
7329
|
# password are supported.
|
7276
7330
|
#
|
7277
7331
|
# @option params [Types::VpcConnectionProperties] :vpc_connection_properties
|
7278
|
-
# Use this parameter only when you want QuickSight to use a VPC
|
7332
|
+
# Use this parameter only when you want Amazon QuickSight to use a VPC
|
7279
7333
|
# connection when connecting to your underlying source.
|
7280
7334
|
#
|
7281
7335
|
# @option params [Types::SslProperties] :ssl_properties
|
7282
|
-
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
7336
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon QuickSight
|
7283
7337
|
# connects to your underlying source.
|
7284
7338
|
#
|
7285
7339
|
# @return [Types::UpdateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -7386,6 +7440,9 @@ module Aws::QuickSight
|
|
7386
7440
|
# query: "Query", # required
|
7387
7441
|
# max_rows: 1, # required
|
7388
7442
|
# },
|
7443
|
+
# amazon_open_search_parameters: {
|
7444
|
+
# domain: "Domain", # required
|
7445
|
+
# },
|
7389
7446
|
# },
|
7390
7447
|
# credentials: {
|
7391
7448
|
# credential_pair: {
|
@@ -7482,6 +7539,9 @@ module Aws::QuickSight
|
|
7482
7539
|
# query: "Query", # required
|
7483
7540
|
# max_rows: 1, # required
|
7484
7541
|
# },
|
7542
|
+
# amazon_open_search_parameters: {
|
7543
|
+
# domain: "Domain", # required
|
7544
|
+
# },
|
7485
7545
|
# },
|
7486
7546
|
# ],
|
7487
7547
|
# },
|
@@ -7515,11 +7575,11 @@ module Aws::QuickSight
|
|
7515
7575
|
# Updates the permissions to a data source.
|
7516
7576
|
#
|
7517
7577
|
# @option params [required, String] :aws_account_id
|
7518
|
-
# The Amazon Web Services account
|
7578
|
+
# The Amazon Web Services account ID.
|
7519
7579
|
#
|
7520
7580
|
# @option params [required, String] :data_source_id
|
7521
|
-
# The ID of the data source. This ID is unique per
|
7522
|
-
# Amazon Web Services account
|
7581
|
+
# The ID of the data source. This ID is unique per Amazon Web Services
|
7582
|
+
# Region; for each Amazon Web Services account.
|
7523
7583
|
#
|
7524
7584
|
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
7525
7585
|
# A list of resource permissions that you want to grant on the data
|
@@ -7683,8 +7743,8 @@ module Aws::QuickSight
|
|
7683
7743
|
# The description for the group that you want to update.
|
7684
7744
|
#
|
7685
7745
|
# @option params [required, String] :aws_account_id
|
7686
|
-
# The ID for the Amazon Web Services account
|
7687
|
-
# Currently, you use the ID for the Amazon Web Services account
|
7746
|
+
# The ID for the Amazon Web Services account that the group is in.
|
7747
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
7688
7748
|
# contains your Amazon QuickSight account.
|
7689
7749
|
#
|
7690
7750
|
# @option params [required, String] :namespace
|
@@ -7723,17 +7783,17 @@ module Aws::QuickSight
|
|
7723
7783
|
req.send_request(options)
|
7724
7784
|
end
|
7725
7785
|
|
7726
|
-
# Updates an existing
|
7786
|
+
# Updates an existing IAMpolicy assignment. This operation updates only
|
7727
7787
|
# the optional parameter or parameters that are specified in the
|
7728
7788
|
# request. This overwrites all of the users included in `Identities`.
|
7729
7789
|
#
|
7730
7790
|
# @option params [required, String] :aws_account_id
|
7731
|
-
# The ID of the Amazon Web Services account
|
7732
|
-
#
|
7791
|
+
# The ID of the Amazon Web Services account that contains the IAMpolicy
|
7792
|
+
# assignment.
|
7733
7793
|
#
|
7734
7794
|
# @option params [required, String] :assignment_name
|
7735
7795
|
# The name of the assignment, also called a rule. This name must be
|
7736
|
-
# unique within an Amazon Web Services account
|
7796
|
+
# unique within an Amazon Web Services account.
|
7737
7797
|
#
|
7738
7798
|
# @option params [required, String] :namespace
|
7739
7799
|
# The namespace of the assignment.
|
@@ -7751,12 +7811,12 @@ module Aws::QuickSight
|
|
7751
7811
|
# when creating the data source.
|
7752
7812
|
#
|
7753
7813
|
# @option params [String] :policy_arn
|
7754
|
-
# The ARN for the
|
7755
|
-
# specified in this assignment.
|
7814
|
+
# The ARN for the IAMpolicy to apply to the Amazon QuickSight users and
|
7815
|
+
# groups specified in this assignment.
|
7756
7816
|
#
|
7757
7817
|
# @option params [Hash<String,Array>] :identities
|
7758
|
-
# The QuickSight users, groups, or both that you want to assign
|
7759
|
-
# policy to.
|
7818
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
7819
|
+
# the policy to.
|
7760
7820
|
#
|
7761
7821
|
# @return [Types::UpdateIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7762
7822
|
#
|
@@ -7806,7 +7866,7 @@ module Aws::QuickSight
|
|
7806
7866
|
# another template.
|
7807
7867
|
#
|
7808
7868
|
# @option params [required, String] :aws_account_id
|
7809
|
-
# The ID of the Amazon Web Services account
|
7869
|
+
# The ID of the Amazon Web Services account that contains the template
|
7810
7870
|
# that you're updating.
|
7811
7871
|
#
|
7812
7872
|
# @option params [required, String] :template_id
|
@@ -7819,8 +7879,8 @@ module Aws::QuickSight
|
|
7819
7879
|
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
7820
7880
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
7821
7881
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
7822
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
7823
|
-
# any QuickSight-supported Region;.
|
7882
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
7883
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
7824
7884
|
#
|
7825
7885
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
7826
7886
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
@@ -7889,7 +7949,7 @@ module Aws::QuickSight
|
|
7889
7949
|
# Updates the template alias of a template.
|
7890
7950
|
#
|
7891
7951
|
# @option params [required, String] :aws_account_id
|
7892
|
-
# The ID of the Amazon Web Services account
|
7952
|
+
# The ID of the Amazon Web Services account that contains the template
|
7893
7953
|
# alias that you're updating.
|
7894
7954
|
#
|
7895
7955
|
# @option params [required, String] :template_id
|
@@ -7940,7 +8000,7 @@ module Aws::QuickSight
|
|
7940
8000
|
# Updates the resource permissions for a template.
|
7941
8001
|
#
|
7942
8002
|
# @option params [required, String] :aws_account_id
|
7943
|
-
# The ID of the Amazon Web Services account
|
8003
|
+
# The ID of the Amazon Web Services account that contains the template.
|
7944
8004
|
#
|
7945
8005
|
# @option params [required, String] :template_id
|
7946
8006
|
# The ID for the template.
|
@@ -8001,8 +8061,8 @@ module Aws::QuickSight
|
|
8001
8061
|
# Updates a theme.
|
8002
8062
|
#
|
8003
8063
|
# @option params [required, String] :aws_account_id
|
8004
|
-
# The ID of the Amazon Web Services account
|
8005
|
-
#
|
8064
|
+
# The ID of the Amazon Web Services account that contains the theme that
|
8065
|
+
# you're updating.
|
8006
8066
|
#
|
8007
8067
|
# @option params [required, String] :theme_id
|
8008
8068
|
# The ID for the theme.
|
@@ -8104,7 +8164,7 @@ module Aws::QuickSight
|
|
8104
8164
|
# Updates an alias of a theme.
|
8105
8165
|
#
|
8106
8166
|
# @option params [required, String] :aws_account_id
|
8107
|
-
# The ID of the Amazon Web Services account
|
8167
|
+
# The ID of the Amazon Web Services account that contains the theme
|
8108
8168
|
# alias that you're updating.
|
8109
8169
|
#
|
8110
8170
|
# @option params [required, String] :theme_id
|
@@ -8193,7 +8253,7 @@ module Aws::QuickSight
|
|
8193
8253
|
# * To specify no permissions, omit the permissions list.
|
8194
8254
|
#
|
8195
8255
|
# @option params [required, String] :aws_account_id
|
8196
|
-
# The ID of the Amazon Web Services account
|
8256
|
+
# The ID of the Amazon Web Services account that contains the theme.
|
8197
8257
|
#
|
8198
8258
|
# @option params [required, String] :theme_id
|
8199
8259
|
# The ID for the theme.
|
@@ -8257,8 +8317,8 @@ module Aws::QuickSight
|
|
8257
8317
|
# The Amazon QuickSight user name that you want to update.
|
8258
8318
|
#
|
8259
8319
|
# @option params [required, String] :aws_account_id
|
8260
|
-
# The ID for the Amazon Web Services account
|
8261
|
-
# Currently, you use the ID for the Amazon Web Services account
|
8320
|
+
# The ID for the Amazon Web Services account that the user is in.
|
8321
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
8262
8322
|
# contains your Amazon QuickSight account.
|
8263
8323
|
#
|
8264
8324
|
# @option params [required, String] :namespace
|
@@ -8279,8 +8339,8 @@ module Aws::QuickSight
|
|
8279
8339
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
8280
8340
|
# QuickSight settings.
|
8281
8341
|
#
|
8282
|
-
# The name of the QuickSight role is invisible to the user except
|
8283
|
-
# the console screens dealing with permissions.
|
8342
|
+
# The name of the Amazon QuickSight role is invisible to the user except
|
8343
|
+
# for the console screens dealing with permissions.
|
8284
8344
|
#
|
8285
8345
|
# @option params [String] :custom_permissions_name
|
8286
8346
|
# (Enterprise edition only) The name of the custom permissions profile
|
@@ -8298,16 +8358,16 @@ module Aws::QuickSight
|
|
8298
8358
|
#
|
8299
8359
|
# A set of custom permissions includes any combination of these
|
8300
8360
|
# restrictions. Currently, you need to create the profile names for
|
8301
|
-
# custom permission sets by using the QuickSight console. Then,
|
8302
|
-
# the `RegisterUser` API operation to assign the named set of
|
8303
|
-
# permissions to a QuickSight user.
|
8361
|
+
# custom permission sets by using the Amazon QuickSight console. Then,
|
8362
|
+
# you use the `RegisterUser` API operation to assign the named set of
|
8363
|
+
# permissions to a Amazon QuickSight user.
|
8304
8364
|
#
|
8305
|
-
# QuickSight custom permissions are applied through
|
8365
|
+
# Amazon QuickSight custom permissions are applied through IAMpolicies.
|
8306
8366
|
# Therefore, they override the permissions typically granted by
|
8307
|
-
# assigning QuickSight users to one of the default security
|
8308
|
-
# QuickSight (admin, author, reader).
|
8367
|
+
# assigning Amazon QuickSight users to one of the default security
|
8368
|
+
# cohorts in Amazon QuickSight (admin, author, reader).
|
8309
8369
|
#
|
8310
|
-
# This feature is available only to QuickSight Enterprise edition
|
8370
|
+
# This feature is available only to Amazon QuickSight Enterprise edition
|
8311
8371
|
# subscriptions.
|
8312
8372
|
#
|
8313
8373
|
# @option params [Boolean] :unapply_custom_permissions
|
@@ -8319,9 +8379,9 @@ module Aws::QuickSight
|
|
8319
8379
|
#
|
8320
8380
|
# @option params [String] :external_login_federation_provider_type
|
8321
8381
|
# The type of supported external login provider that provides identity
|
8322
|
-
# to let a user federate into QuickSight with an associated
|
8323
|
-
# and Access Management
|
8324
|
-
# provider can be one of the following.
|
8382
|
+
# to let a user federate into Amazon QuickSight with an associated
|
8383
|
+
# Identity and Access Management(IAM) role. The type of supported
|
8384
|
+
# external login provider can be one of the following.
|
8325
8385
|
#
|
8326
8386
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
8327
8387
|
# cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
|
@@ -8338,10 +8398,10 @@ module Aws::QuickSight
|
|
8338
8398
|
#
|
8339
8399
|
# @option params [String] :custom_federation_provider_url
|
8340
8400
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
8341
|
-
# identity to let a user federate into QuickSight with an
|
8342
|
-
# Identity and Access Management
|
8343
|
-
# be used when `ExternalLoginFederationProviderType`
|
8344
|
-
# `CUSTOM_OIDC`.
|
8401
|
+
# identity to let a user federate into Amazon QuickSight with an
|
8402
|
+
# associated Identity and Access Management(IAM) role. This parameter
|
8403
|
+
# should only be used when `ExternalLoginFederationProviderType`
|
8404
|
+
# parameter is set to `CUSTOM_OIDC`.
|
8345
8405
|
#
|
8346
8406
|
# @option params [String] :external_login_id
|
8347
8407
|
# The identity ID for a user in the external login provider.
|
@@ -8405,7 +8465,7 @@ module Aws::QuickSight
|
|
8405
8465
|
params: params,
|
8406
8466
|
config: config)
|
8407
8467
|
context[:gem_name] = 'aws-sdk-quicksight'
|
8408
|
-
context[:gem_version] = '1.
|
8468
|
+
context[:gem_version] = '1.54.0'
|
8409
8469
|
Seahorse::Client::Request.new(handlers, context)
|
8410
8470
|
end
|
8411
8471
|
|