aws-sdk-quicksight 1.51.0 → 1.55.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 +545 -410
- data/lib/aws-sdk-quicksight/client_api.rb +103 -21
- data/lib/aws-sdk-quicksight/types.rb +737 -471
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +5 -5
@@ -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.
|
@@ -349,7 +349,7 @@ module Aws::QuickSight
|
|
349
349
|
#
|
350
350
|
# resp = client.cancel_ingestion({
|
351
351
|
# aws_account_id: "AwsAccountId", # required
|
352
|
-
# data_set_id: "
|
352
|
+
# data_set_id: "String", # required
|
353
353
|
# ingestion_id: "IngestionId", # required
|
354
354
|
# })
|
355
355
|
#
|
@@ -370,16 +370,17 @@ module Aws::QuickSight
|
|
370
370
|
end
|
371
371
|
|
372
372
|
# Creates Amazon QuickSight customizations the current Amazon Web
|
373
|
-
# Services Region
|
373
|
+
# Services Region. Currently, you can add a custom default theme by
|
374
374
|
# using the `CreateAccountCustomization` or `UpdateAccountCustomization`
|
375
|
-
# API operation. To further customize QuickSight by removing
|
376
|
-
# sample assets and videos for all new users, see
|
377
|
-
# QuickSight][1] in the *Amazon QuickSight User
|
375
|
+
# API operation. To further customize Amazon QuickSight by removing
|
376
|
+
# Amazon QuickSight sample assets and videos for all new users, see
|
377
|
+
# [Customizing Amazon QuickSight][1] in the *Amazon QuickSight User
|
378
|
+
# Guide.*
|
378
379
|
#
|
379
|
-
# You can create customizations for your Amazon Web Services account
|
380
|
-
#
|
380
|
+
# You can create customizations for your Amazon Web Services account or,
|
381
|
+
# if you specify a namespace, for a Amazon QuickSight namespace instead.
|
381
382
|
# Customizations that apply to a namespace always override
|
382
|
-
# customizations that apply to an Amazon Web Services account
|
383
|
+
# customizations that apply to an Amazon Web Services account. To find
|
383
384
|
# out which customizations apply, use the `DescribeAccountCustomization`
|
384
385
|
# API operation.
|
385
386
|
#
|
@@ -397,16 +398,17 @@ module Aws::QuickSight
|
|
397
398
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html
|
398
399
|
#
|
399
400
|
# @option params [required, String] :aws_account_id
|
400
|
-
# The ID for the Amazon Web Services account
|
401
|
-
# QuickSight for.
|
401
|
+
# The ID for the Amazon Web Services account that you want to customize
|
402
|
+
# Amazon QuickSight for.
|
402
403
|
#
|
403
404
|
# @option params [String] :namespace
|
404
|
-
# The QuickSight namespace that you want to add customizations
|
405
|
+
# The Amazon QuickSight namespace that you want to add customizations
|
406
|
+
# to.
|
405
407
|
#
|
406
408
|
# @option params [required, Types::AccountCustomization] :account_customization
|
407
|
-
# The QuickSight customizations you're adding in the current
|
408
|
-
# Services Region
|
409
|
-
# and a QuickSight namespace.
|
409
|
+
# The Amazon QuickSight customizations you're adding in the current
|
410
|
+
# Amazon Web Services Region. You can add these to an Amazon Web
|
411
|
+
# Services account and a Amazon QuickSight namespace.
|
410
412
|
#
|
411
413
|
# For example, you can add a default theme by setting
|
412
414
|
# `AccountCustomization` to the midnight theme: `"AccountCustomization":
|
@@ -465,7 +467,7 @@ module Aws::QuickSight
|
|
465
467
|
# Creates an analysis in Amazon QuickSight.
|
466
468
|
#
|
467
469
|
# @option params [required, String] :aws_account_id
|
468
|
-
# The ID of the Amazon Web Services account
|
470
|
+
# The ID of the Amazon Web Services account where you are creating an
|
469
471
|
# analysis.
|
470
472
|
#
|
471
473
|
# @option params [required, String] :analysis_id
|
@@ -474,7 +476,7 @@ module Aws::QuickSight
|
|
474
476
|
#
|
475
477
|
# @option params [required, String] :name
|
476
478
|
# A descriptive name for the analysis that you're creating. This name
|
477
|
-
# displays for the analysis in the QuickSight console.
|
479
|
+
# displays for the analysis in the Amazon QuickSight console.
|
478
480
|
#
|
479
481
|
# @option params [Types::Parameters] :parameters
|
480
482
|
# The parameter names and override values that you want to use. An
|
@@ -497,8 +499,8 @@ module Aws::QuickSight
|
|
497
499
|
#
|
498
500
|
# @option params [String] :theme_arn
|
499
501
|
# The ARN for the theme to apply to the analysis that you're creating.
|
500
|
-
# To see the theme in the QuickSight console, make sure that you
|
501
|
-
# access to it.
|
502
|
+
# To see the theme in the Amazon QuickSight console, make sure that you
|
503
|
+
# have access to it.
|
502
504
|
#
|
503
505
|
# @option params [Array<Types::Tag>] :tags
|
504
506
|
# Contains a map of the key-value pairs for the resource tag or tags
|
@@ -590,19 +592,19 @@ module Aws::QuickSight
|
|
590
592
|
# Creates a dashboard from a template. To first create a template, see
|
591
593
|
# the ` CreateTemplate ` API operation.
|
592
594
|
#
|
593
|
-
# A dashboard is an entity in QuickSight that identifies
|
594
|
-
# reports, created from analyses. You can share
|
595
|
-
# With the right permissions, you can create
|
596
|
-
# from them. If you have the correct
|
597
|
-
# dashboard from a template that exists in
|
598
|
-
# Services account
|
595
|
+
# A dashboard is an entity in Amazon QuickSight that identifies Amazon
|
596
|
+
# QuickSight reports, created from analyses. You can share Amazon
|
597
|
+
# QuickSight dashboards. With the right permissions, you can create
|
598
|
+
# scheduled email reports from them. If you have the correct
|
599
|
+
# permissions, you can create a dashboard from a template that exists in
|
600
|
+
# a different Amazon Web Services account.
|
599
601
|
#
|
600
602
|
# @option params [required, String] :aws_account_id
|
601
|
-
# The ID of the Amazon Web Services account
|
602
|
-
#
|
603
|
+
# The ID of the Amazon Web Services account where you want to create the
|
604
|
+
# dashboard.
|
603
605
|
#
|
604
606
|
# @option params [required, String] :dashboard_id
|
605
|
-
# The ID for the dashboard, also added to the
|
607
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
606
608
|
#
|
607
609
|
# @option params [required, String] :name
|
608
610
|
# The display name of the dashboard.
|
@@ -614,8 +616,8 @@ module Aws::QuickSight
|
|
614
616
|
#
|
615
617
|
# @option params [Array<Types::ResourcePermission>] :permissions
|
616
618
|
# A structure that contains the permissions of the dashboard. You can
|
617
|
-
# use this structure for granting permissions by providing a list of
|
618
|
-
#
|
619
|
+
# use this structure for granting permissions by providing a list of
|
620
|
+
# IAMaction information for each principal ARN.
|
619
621
|
#
|
620
622
|
# To specify no permissions, omit the permissions list.
|
621
623
|
#
|
@@ -627,8 +629,8 @@ module Aws::QuickSight
|
|
627
629
|
# from an analysis, first convert the analysis to a template by using
|
628
630
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
629
631
|
# Amazon Resource Name (ARN) of the source template. The
|
630
|
-
# `SourceTemplate`ARN can contain any Amazon Web Services account
|
631
|
-
# any QuickSight-supported Amazon Web Services Region
|
632
|
+
# `SourceTemplate`ARN can contain any Amazon Web Services account and
|
633
|
+
# any Amazon QuickSight-supported Amazon Web Services Region.
|
632
634
|
#
|
633
635
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
634
636
|
# replacement datasets for the placeholders listed in the original. The
|
@@ -646,9 +648,9 @@ module Aws::QuickSight
|
|
646
648
|
#
|
647
649
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
|
648
650
|
# either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
649
|
-
# QuickSight disables the left filter pane on the published
|
650
|
-
# which can be used for ad hoc (one-time) filtering. This
|
651
|
-
# `ENABLED` by default.
|
651
|
+
# Amazon QuickSight disables the left filter pane on the published
|
652
|
+
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
653
|
+
# option is `ENABLED` by default.
|
652
654
|
#
|
653
655
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
654
656
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
@@ -663,7 +665,7 @@ module Aws::QuickSight
|
|
663
665
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
664
666
|
# this dashboard. If you add a value for this field, it overrides the
|
665
667
|
# value that is used in the source entity. The theme ARN must exist in
|
666
|
-
# the same Amazon Web Services account
|
668
|
+
# the same Amazon Web Services account where you create the dashboard.
|
667
669
|
#
|
668
670
|
# @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
669
671
|
#
|
@@ -765,11 +767,11 @@ module Aws::QuickSight
|
|
765
767
|
# Creates a dataset.
|
766
768
|
#
|
767
769
|
# @option params [required, String] :aws_account_id
|
768
|
-
# The Amazon Web Services account
|
770
|
+
# The Amazon Web Services account ID.
|
769
771
|
#
|
770
772
|
# @option params [required, String] :data_set_id
|
771
773
|
# An ID for the dataset that you want to create. This ID is unique per
|
772
|
-
# Amazon Web Services Region
|
774
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
773
775
|
#
|
774
776
|
# @option params [required, String] :name
|
775
777
|
# The display name for the dataset.
|
@@ -786,7 +788,7 @@ module Aws::QuickSight
|
|
786
788
|
# Indicates whether you want to import the data into SPICE.
|
787
789
|
#
|
788
790
|
# @option params [Array<Types::ColumnGroup>] :column_groups
|
789
|
-
# Groupings of columns that work together in certain QuickSight
|
791
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
790
792
|
# features. Currently, only geospatial hierarchy is supported.
|
791
793
|
#
|
792
794
|
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
@@ -812,6 +814,10 @@ module Aws::QuickSight
|
|
812
814
|
# Contains a map of the key-value pairs for the resource tag or tags
|
813
815
|
# assigned to the dataset.
|
814
816
|
#
|
817
|
+
# @option params [Types::DataSetUsageConfiguration] :data_set_usage_configuration
|
818
|
+
# The usage configuration to apply to child datasets that reference this
|
819
|
+
# dataset as a source.
|
820
|
+
#
|
815
821
|
# @return [Types::CreateDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
816
822
|
#
|
817
823
|
# * {Types::CreateDataSetResponse#arn #arn} => String
|
@@ -910,6 +916,10 @@ module Aws::QuickSight
|
|
910
916
|
# },
|
911
917
|
# ],
|
912
918
|
# },
|
919
|
+
# untag_column_operation: {
|
920
|
+
# column_name: "ColumnName", # required
|
921
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
922
|
+
# },
|
913
923
|
# },
|
914
924
|
# ],
|
915
925
|
# source: { # required
|
@@ -926,6 +936,7 @@ module Aws::QuickSight
|
|
926
936
|
# on_clause: "OnClause", # required
|
927
937
|
# },
|
928
938
|
# physical_table_id: "PhysicalTableId",
|
939
|
+
# data_set_arn: "Arn",
|
929
940
|
# },
|
930
941
|
# },
|
931
942
|
# },
|
@@ -981,6 +992,10 @@ module Aws::QuickSight
|
|
981
992
|
# value: "TagValue", # required
|
982
993
|
# },
|
983
994
|
# ],
|
995
|
+
# data_set_usage_configuration: {
|
996
|
+
# disable_use_as_direct_query_source: false,
|
997
|
+
# disable_use_as_imported_source: false,
|
998
|
+
# },
|
984
999
|
# })
|
985
1000
|
#
|
986
1001
|
# @example Response structure
|
@@ -1004,42 +1019,39 @@ module Aws::QuickSight
|
|
1004
1019
|
# Creates a data source.
|
1005
1020
|
#
|
1006
1021
|
# @option params [required, String] :aws_account_id
|
1007
|
-
# The Amazon Web Services account
|
1022
|
+
# The Amazon Web Services account ID.
|
1008
1023
|
#
|
1009
1024
|
# @option params [required, String] :data_source_id
|
1010
1025
|
# An ID for the data source. This ID is unique per Amazon Web Services
|
1011
|
-
# Region
|
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 OpenSearch 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,10 @@ 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.
|
1634
|
+
#
|
1635
|
+
# @option params [String] :ingestion_type
|
1636
|
+
# The type of ingestion that you want to create.
|
1616
1637
|
#
|
1617
1638
|
# @return [Types::CreateIngestionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1618
1639
|
#
|
@@ -1625,9 +1646,10 @@ module Aws::QuickSight
|
|
1625
1646
|
# @example Request syntax with placeholder values
|
1626
1647
|
#
|
1627
1648
|
# resp = client.create_ingestion({
|
1628
|
-
# data_set_id: "
|
1649
|
+
# data_set_id: "String", # required
|
1629
1650
|
# ingestion_id: "IngestionId", # required
|
1630
1651
|
# aws_account_id: "AwsAccountId", # required
|
1652
|
+
# ingestion_type: "INCREMENTAL_REFRESH", # accepts INCREMENTAL_REFRESH, FULL_REFRESH
|
1631
1653
|
# })
|
1632
1654
|
#
|
1633
1655
|
# @example Response structure
|
@@ -1650,19 +1672,19 @@ module Aws::QuickSight
|
|
1650
1672
|
# (Enterprise edition only) Creates a new namespace for you to use with
|
1651
1673
|
# Amazon QuickSight.
|
1652
1674
|
#
|
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.
|
1675
|
+
# A namespace allows you to isolate the Amazon QuickSight users and
|
1676
|
+
# groups that are registered for that namespace. Users that access the
|
1677
|
+
# namespace can share assets only with other users or groups in the same
|
1678
|
+
# namespace. They can't see users and groups in other namespaces. You
|
1679
|
+
# can create a namespace after your Amazon Web Services account is
|
1680
|
+
# subscribed to Amazon QuickSight. The namespace must be unique within
|
1681
|
+
# the Amazon Web Services account. By default, there is a limit of 100
|
1682
|
+
# namespaces per Amazon Web Services account. To increase your limit,
|
1683
|
+
# create a ticket with Amazon Web Services Support.
|
1662
1684
|
#
|
1663
1685
|
# @option params [required, String] :aws_account_id
|
1664
|
-
# The ID for the Amazon Web Services account
|
1665
|
-
#
|
1686
|
+
# The ID for the Amazon Web Services account that you want to create the
|
1687
|
+
# Amazon QuickSight namespace in.
|
1666
1688
|
#
|
1667
1689
|
# @option params [required, String] :namespace
|
1668
1690
|
# The name that you want to use to describe the new namespace.
|
@@ -1721,23 +1743,23 @@ module Aws::QuickSight
|
|
1721
1743
|
# Creates a template from an existing Amazon QuickSight analysis or
|
1722
1744
|
# template. You can use the resulting template to create a dashboard.
|
1723
1745
|
#
|
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
|
1746
|
+
# A *template* is an entity in Amazon QuickSight that encapsulates the
|
1747
|
+
# metadata required to create an analysis and that you can use to create
|
1748
|
+
# s dashboard. A template adds a layer of abstraction by using
|
1727
1749
|
# placeholders to replace the dataset associated with the analysis. You
|
1728
1750
|
# can use templates to create dashboards by replacing dataset
|
1729
1751
|
# placeholders with datasets that follow the same schema that was used
|
1730
1752
|
# to create the source analysis and template.
|
1731
1753
|
#
|
1732
1754
|
# @option params [required, String] :aws_account_id
|
1733
|
-
# The ID for the Amazon Web Services account
|
1734
|
-
#
|
1735
|
-
#
|
1755
|
+
# The ID for the Amazon Web Services account that the group is in. You
|
1756
|
+
# use the ID for the Amazon Web Services account that contains your
|
1757
|
+
# Amazon QuickSight account.
|
1736
1758
|
#
|
1737
1759
|
# @option params [required, String] :template_id
|
1738
1760
|
# An ID for the template that you want to create. This template is
|
1739
1761
|
# unique per Amazon Web Services Region; in each Amazon Web Services
|
1740
|
-
# account
|
1762
|
+
# account.
|
1741
1763
|
#
|
1742
1764
|
# @option params [String] :name
|
1743
1765
|
# A display name for the template.
|
@@ -1752,8 +1774,8 @@ module Aws::QuickSight
|
|
1752
1774
|
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
1753
1775
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
1754
1776
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
1755
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
1756
|
-
# any QuickSight-supported Amazon Web Services Region
|
1777
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
1778
|
+
# any Amazon QuickSight-supported Amazon Web Services Region.
|
1757
1779
|
#
|
1758
1780
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
1759
1781
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
@@ -1836,7 +1858,7 @@ module Aws::QuickSight
|
|
1836
1858
|
# Creates a template alias for a template.
|
1837
1859
|
#
|
1838
1860
|
# @option params [required, String] :aws_account_id
|
1839
|
-
# The ID of the Amazon Web Services account
|
1861
|
+
# The ID of the Amazon Web Services account that contains the template
|
1840
1862
|
# that you creating an alias for.
|
1841
1863
|
#
|
1842
1864
|
# @option params [required, String] :template_id
|
@@ -1893,12 +1915,12 @@ module Aws::QuickSight
|
|
1893
1915
|
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html
|
1894
1916
|
#
|
1895
1917
|
# @option params [required, String] :aws_account_id
|
1896
|
-
# The ID of the Amazon Web Services account
|
1918
|
+
# The ID of the Amazon Web Services account where you want to store the
|
1897
1919
|
# new theme.
|
1898
1920
|
#
|
1899
1921
|
# @option params [required, String] :theme_id
|
1900
1922
|
# An ID for the theme that you want to create. The theme ID is unique
|
1901
|
-
# per Amazon Web Services Region
|
1923
|
+
# per Amazon Web Services Region in each Amazon Web Services account.
|
1902
1924
|
#
|
1903
1925
|
# @option params [required, String] :name
|
1904
1926
|
# A display name for the theme.
|
@@ -1907,7 +1929,7 @@ module Aws::QuickSight
|
|
1907
1929
|
# The ID of the theme that a custom theme will inherit from. All themes
|
1908
1930
|
# inherit from one of the starting themes defined by Amazon QuickSight.
|
1909
1931
|
# For a list of the starting themes, use `ListThemes` or choose
|
1910
|
-
# **Themes** from within a QuickSight analysis.
|
1932
|
+
# **Themes** from within a Amazon QuickSight analysis.
|
1911
1933
|
#
|
1912
1934
|
# @option params [String] :version_description
|
1913
1935
|
# A description of the first version of the theme that you're creating.
|
@@ -2017,7 +2039,7 @@ module Aws::QuickSight
|
|
2017
2039
|
# Creates a theme alias for a theme.
|
2018
2040
|
#
|
2019
2041
|
# @option params [required, String] :aws_account_id
|
2020
|
-
# The ID of the Amazon Web Services account
|
2042
|
+
# The ID of the Amazon Web Services account that contains the theme for
|
2021
2043
|
# the new theme alias.
|
2022
2044
|
#
|
2023
2045
|
# @option params [required, String] :theme_id
|
@@ -2064,16 +2086,17 @@ module Aws::QuickSight
|
|
2064
2086
|
end
|
2065
2087
|
|
2066
2088
|
# Deletes all Amazon QuickSight customizations in this Amazon Web
|
2067
|
-
# Services Region
|
2068
|
-
# QuickSight namespace.
|
2089
|
+
# Services Region for the specified Amazon Web Services account and
|
2090
|
+
# Amazon QuickSight namespace.
|
2069
2091
|
#
|
2070
2092
|
# @option params [required, String] :aws_account_id
|
2071
|
-
# The ID for the Amazon Web Services account
|
2072
|
-
# QuickSight customizations from in this Amazon Web Services
|
2093
|
+
# The ID for the Amazon Web Services account that you want to delete
|
2094
|
+
# Amazon QuickSight customizations from in this Amazon Web Services
|
2095
|
+
# Region.
|
2073
2096
|
#
|
2074
2097
|
# @option params [String] :namespace
|
2075
|
-
# The QuickSight namespace that you're deleting the
|
2076
|
-
# from.
|
2098
|
+
# The Amazon QuickSight namespace that you're deleting the
|
2099
|
+
# customizations from.
|
2077
2100
|
#
|
2078
2101
|
# @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2079
2102
|
#
|
@@ -2104,9 +2127,10 @@ module Aws::QuickSight
|
|
2104
2127
|
# Deletes an analysis from Amazon QuickSight. You can optionally include
|
2105
2128
|
# a recovery window during which you can restore the analysis. If you
|
2106
2129
|
# don't specify a recovery window value, the operation defaults to 30
|
2107
|
-
# days. QuickSight attaches a `DeletionTime` stamp to the
|
2108
|
-
# specifies the end of the recovery window. At the end of
|
2109
|
-
# window, QuickSight deletes the analysis
|
2130
|
+
# days. Amazon QuickSight attaches a `DeletionTime` stamp to the
|
2131
|
+
# response that specifies the end of the recovery window. At the end of
|
2132
|
+
# the recovery window, Amazon QuickSight deletes the analysis
|
2133
|
+
# permanently.
|
2110
2134
|
#
|
2111
2135
|
# At any time before recovery window ends, you can use the
|
2112
2136
|
# `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
|
@@ -2115,19 +2139,20 @@ module Aws::QuickSight
|
|
2115
2139
|
# make a template from it.
|
2116
2140
|
#
|
2117
2141
|
# An analysis that's scheduled for deletion isn't accessible in the
|
2118
|
-
# QuickSight console. To access it in the console, restore it.
|
2119
|
-
# an analysis doesn't delete the dashboards that you publish
|
2142
|
+
# Amazon QuickSight console. To access it in the console, restore it.
|
2143
|
+
# Deleting an analysis doesn't delete the dashboards that you publish
|
2144
|
+
# from it.
|
2120
2145
|
#
|
2121
2146
|
# @option params [required, String] :aws_account_id
|
2122
|
-
# The ID of the Amazon Web Services account
|
2147
|
+
# The ID of the Amazon Web Services account where you want to delete an
|
2123
2148
|
# analysis.
|
2124
2149
|
#
|
2125
2150
|
# @option params [required, String] :analysis_id
|
2126
2151
|
# The ID of the analysis that you're deleting.
|
2127
2152
|
#
|
2128
2153
|
# @option params [Integer] :recovery_window_in_days
|
2129
|
-
# A value that specifies the number of days that QuickSight waits
|
2130
|
-
# it deletes the analysis. You can't use this parameter with the
|
2154
|
+
# A value that specifies the number of days that Amazon QuickSight waits
|
2155
|
+
# before it deletes the analysis. You can't use this parameter with the
|
2131
2156
|
# `ForceDeleteWithoutRecovery` option in the same API call. The default
|
2132
2157
|
# value is 30.
|
2133
2158
|
#
|
@@ -2173,7 +2198,7 @@ module Aws::QuickSight
|
|
2173
2198
|
# Deletes a dashboard.
|
2174
2199
|
#
|
2175
2200
|
# @option params [required, String] :aws_account_id
|
2176
|
-
# The ID of the Amazon Web Services account
|
2201
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
2177
2202
|
# that you're deleting.
|
2178
2203
|
#
|
2179
2204
|
# @option params [required, String] :dashboard_id
|
@@ -2217,11 +2242,11 @@ module Aws::QuickSight
|
|
2217
2242
|
# Deletes a dataset.
|
2218
2243
|
#
|
2219
2244
|
# @option params [required, String] :aws_account_id
|
2220
|
-
# The Amazon Web Services account
|
2245
|
+
# The Amazon Web Services account ID.
|
2221
2246
|
#
|
2222
2247
|
# @option params [required, String] :data_set_id
|
2223
2248
|
# The ID for the dataset that you want to create. This ID is unique per
|
2224
|
-
# Amazon Web Services Region
|
2249
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
2225
2250
|
#
|
2226
2251
|
# @return [Types::DeleteDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2227
2252
|
#
|
@@ -2257,11 +2282,11 @@ module Aws::QuickSight
|
|
2257
2282
|
# datasets that reference the deleted data source.
|
2258
2283
|
#
|
2259
2284
|
# @option params [required, String] :aws_account_id
|
2260
|
-
# The Amazon Web Services account
|
2285
|
+
# The Amazon Web Services account ID.
|
2261
2286
|
#
|
2262
2287
|
# @option params [required, String] :data_source_id
|
2263
2288
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
2264
|
-
# Region
|
2289
|
+
# Region for each Amazon Web Services account.
|
2265
2290
|
#
|
2266
2291
|
# @return [Types::DeleteDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2267
2292
|
#
|
@@ -2382,8 +2407,8 @@ module Aws::QuickSight
|
|
2382
2407
|
# The name of the group that you want to delete.
|
2383
2408
|
#
|
2384
2409
|
# @option params [required, String] :aws_account_id
|
2385
|
-
# The ID for the Amazon Web Services account
|
2386
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2410
|
+
# The ID for the Amazon Web Services account that the group is in.
|
2411
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2387
2412
|
# contains your Amazon QuickSight account.
|
2388
2413
|
#
|
2389
2414
|
# @option params [required, String] :namespace
|
@@ -2427,8 +2452,8 @@ module Aws::QuickSight
|
|
2427
2452
|
# The name of the group that you want to delete the user from.
|
2428
2453
|
#
|
2429
2454
|
# @option params [required, String] :aws_account_id
|
2430
|
-
# The ID for the Amazon Web Services account
|
2431
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2455
|
+
# The ID for the Amazon Web Services account that the group is in.
|
2456
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2432
2457
|
# contains your Amazon QuickSight account.
|
2433
2458
|
#
|
2434
2459
|
# @option params [required, String] :namespace
|
@@ -2462,11 +2487,11 @@ module Aws::QuickSight
|
|
2462
2487
|
req.send_request(options)
|
2463
2488
|
end
|
2464
2489
|
|
2465
|
-
# Deletes an existing
|
2490
|
+
# Deletes an existing IAMpolicy assignment.
|
2466
2491
|
#
|
2467
2492
|
# @option params [required, String] :aws_account_id
|
2468
|
-
# The Amazon Web Services account
|
2469
|
-
#
|
2493
|
+
# The Amazon Web Services account ID where you want to delete the
|
2494
|
+
# IAMpolicy assignment.
|
2470
2495
|
#
|
2471
2496
|
# @option params [required, String] :assignment_name
|
2472
2497
|
# The name of the assignment.
|
@@ -2510,8 +2535,8 @@ module Aws::QuickSight
|
|
2510
2535
|
# asset.
|
2511
2536
|
#
|
2512
2537
|
# @option params [required, String] :aws_account_id
|
2513
|
-
# The ID for the Amazon Web Services account
|
2514
|
-
#
|
2538
|
+
# The ID for the Amazon Web Services account that you want to delete the
|
2539
|
+
# Amazon QuickSight namespace from.
|
2515
2540
|
#
|
2516
2541
|
# @option params [required, String] :namespace
|
2517
2542
|
# The namespace that you want to delete.
|
@@ -2545,7 +2570,7 @@ module Aws::QuickSight
|
|
2545
2570
|
# Deletes a template.
|
2546
2571
|
#
|
2547
2572
|
# @option params [required, String] :aws_account_id
|
2548
|
-
# The ID of the Amazon Web Services account
|
2573
|
+
# The ID of the Amazon Web Services account that contains the template
|
2549
2574
|
# that you're deleting.
|
2550
2575
|
#
|
2551
2576
|
# @option params [required, String] :template_id
|
@@ -2592,7 +2617,7 @@ module Aws::QuickSight
|
|
2592
2617
|
# the alias points to.
|
2593
2618
|
#
|
2594
2619
|
# @option params [required, String] :aws_account_id
|
2595
|
-
# The ID of the Amazon Web Services account
|
2620
|
+
# The ID of the Amazon Web Services account that contains the item to
|
2596
2621
|
# delete.
|
2597
2622
|
#
|
2598
2623
|
# @option params [required, String] :template_id
|
@@ -2640,8 +2665,8 @@ module Aws::QuickSight
|
|
2640
2665
|
# Deletes a theme.
|
2641
2666
|
#
|
2642
2667
|
# @option params [required, String] :aws_account_id
|
2643
|
-
# The ID of the Amazon Web Services account
|
2644
|
-
#
|
2668
|
+
# The ID of the Amazon Web Services account that contains the theme that
|
2669
|
+
# you're deleting.
|
2645
2670
|
#
|
2646
2671
|
# @option params [required, String] :theme_id
|
2647
2672
|
# An ID for the theme that you want to delete.
|
@@ -2688,7 +2713,7 @@ module Aws::QuickSight
|
|
2688
2713
|
# theme that the alias points to.
|
2689
2714
|
#
|
2690
2715
|
# @option params [required, String] :aws_account_id
|
2691
|
-
# The ID of the Amazon Web Services account
|
2716
|
+
# The ID of the Amazon Web Services account that contains the theme
|
2692
2717
|
# alias to delete.
|
2693
2718
|
#
|
2694
2719
|
# @option params [required, String] :theme_id
|
@@ -2739,8 +2764,8 @@ module Aws::QuickSight
|
|
2739
2764
|
# The name of the user that you want to delete.
|
2740
2765
|
#
|
2741
2766
|
# @option params [required, String] :aws_account_id
|
2742
|
-
# The ID for the Amazon Web Services account
|
2743
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2767
|
+
# The ID for the Amazon Web Services account that the user is in.
|
2768
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2744
2769
|
# contains your Amazon QuickSight account.
|
2745
2770
|
#
|
2746
2771
|
# @option params [required, String] :namespace
|
@@ -2779,8 +2804,8 @@ module Aws::QuickSight
|
|
2779
2804
|
# The principal ID of the user.
|
2780
2805
|
#
|
2781
2806
|
# @option params [required, String] :aws_account_id
|
2782
|
-
# The ID for the Amazon Web Services account
|
2783
|
-
# Currently, you use the ID for the Amazon Web Services account
|
2807
|
+
# The ID for the Amazon Web Services account that the user is in.
|
2808
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
2784
2809
|
# contains your Amazon QuickSight account.
|
2785
2810
|
#
|
2786
2811
|
# @option params [required, String] :namespace
|
@@ -2814,31 +2839,31 @@ module Aws::QuickSight
|
|
2814
2839
|
end
|
2815
2840
|
|
2816
2841
|
# Describes the customizations associated with the provided Amazon Web
|
2817
|
-
# Services account
|
2818
|
-
# Services Region
|
2842
|
+
# Services account and Amazon Amazon QuickSight namespace in an Amazon
|
2843
|
+
# Web Services Region. The Amazon QuickSight console evaluates which
|
2819
2844
|
# customizations to apply by running this API operation with the
|
2820
2845
|
# `Resolved` flag included.
|
2821
2846
|
#
|
2822
2847
|
# To determine what customizations display when you run this command, it
|
2823
2848
|
# can help to visualize the relationship of the entities involved.
|
2824
2849
|
#
|
2825
|
-
# * `Amazon Web Services account
|
2850
|
+
# * `Amazon Web Services account` - The Amazon Web Services account
|
2826
2851
|
# exists at the top of the hierarchy. It has the potential to use all
|
2827
|
-
# of the Amazon Web Services Regions
|
2828
|
-
# subscribe to QuickSight, you choose one Amazon Web Services
|
2829
|
-
# to use as your home Region. That's where your free SPICE
|
2830
|
-
# is located. You can use QuickSight in any supported
|
2831
|
-
# Services Region
|
2832
|
-
#
|
2833
|
-
# * `Amazon Web Services Region
|
2834
|
-
# where you sign in to QuickSight at least once,
|
2835
|
-
# separate instance of the same service. If you
|
2836
|
-
# it resides in us-east-1, which is the US East
|
2837
|
-
# Generally speaking, these users have access to
|
2838
|
-
# Amazon Web Services Region
|
2839
|
-
# namespace.
|
2840
|
-
#
|
2841
|
-
# To run the command in a different Amazon Web Services Region
|
2852
|
+
# of the Amazon Web Services Regions and AWS Services. When you
|
2853
|
+
# subscribe to Amazon QuickSight, you choose one Amazon Web Services
|
2854
|
+
# Region to use as your home Region. That's where your free SPICE
|
2855
|
+
# capacity is located. You can use Amazon QuickSight in any supported
|
2856
|
+
# Amazon Web Services Region.
|
2857
|
+
#
|
2858
|
+
# * `Amazon Web Services Region` - In each Amazon Web Services Region
|
2859
|
+
# where you sign in to Amazon QuickSight at least once, Amazon
|
2860
|
+
# QuickSight acts as a separate instance of the same service. If you
|
2861
|
+
# have a user directory, it resides in us-east-1, which is the US East
|
2862
|
+
# (N. Virginia). Generally speaking, these users have access to Amazon
|
2863
|
+
# QuickSight in any Amazon Web Services Region, unless they are
|
2864
|
+
# constrained to a namespace.
|
2865
|
+
#
|
2866
|
+
# To run the command in a different Amazon Web Services Region, you
|
2842
2867
|
# change your Region settings. If you're using the AWS CLI, you can
|
2843
2868
|
# use one of the following options:
|
2844
2869
|
#
|
@@ -2847,25 +2872,25 @@ module Aws::QuickSight
|
|
2847
2872
|
# * Use [named profiles][2].
|
2848
2873
|
#
|
2849
2874
|
# * Run `aws configure` to change your default Amazon Web Services
|
2850
|
-
# Region
|
2851
|
-
#
|
2875
|
+
# Region. Use Enter to key the same settings for your keys. For more
|
2876
|
+
# information, see [Configuring the AWS CLI][3].
|
2852
2877
|
#
|
2853
|
-
# * `Namespace` - A QuickSight namespace is a partition that
|
2854
|
-
# users and assets (data sources, datasets, dashboards, and
|
2855
|
-
# access assets that are in a specific namespace, users and
|
2856
|
-
# must also be part of the same namespace. People who share a
|
2878
|
+
# * `Namespace` - A Amazon QuickSight namespace is a partition that
|
2879
|
+
# contains users and assets (data sources, datasets, dashboards, and
|
2880
|
+
# so on). To access assets that are in a specific namespace, users and
|
2881
|
+
# groups must also be part of the same namespace. People who share a
|
2857
2882
|
# namespace are completely isolated from users and assets in other
|
2858
|
-
# namespaces, even if they are in the same Amazon Web Services
|
2859
|
-
#
|
2860
|
-
#
|
2861
|
-
# * `Applied customizations` - Within an Amazon Web Services Region
|
2862
|
-
# set of QuickSight customizations can apply to an Amazon Web
|
2863
|
-
# account
|
2864
|
-
# override settings that you apply to an Amazon Web Services
|
2865
|
-
# All settings are isolated to a single Amazon Web Services
|
2866
|
-
# To apply them in other Amazon Web Services Regions
|
2883
|
+
# namespaces, even if they are in the same Amazon Web Services account
|
2884
|
+
# and Amazon Web Services Region.
|
2885
|
+
#
|
2886
|
+
# * `Applied customizations` - Within an Amazon Web Services Region, a
|
2887
|
+
# set of Amazon QuickSight customizations can apply to an Amazon Web
|
2888
|
+
# Services account or to a namespace. Settings that you apply to a
|
2889
|
+
# namespace override settings that you apply to an Amazon Web Services
|
2890
|
+
# account. All settings are isolated to a single Amazon Web Services
|
2891
|
+
# Region. To apply them in other Amazon Web Services Regions, run the
|
2867
2892
|
# `CreateAccountCustomization` command in each Amazon Web Services
|
2868
|
-
# Region
|
2893
|
+
# Region where you want to apply the same customizations.
|
2869
2894
|
#
|
2870
2895
|
#
|
2871
2896
|
#
|
@@ -2874,20 +2899,20 @@ module Aws::QuickSight
|
|
2874
2899
|
# [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
|
2875
2900
|
#
|
2876
2901
|
# @option params [required, String] :aws_account_id
|
2877
|
-
# The ID for the Amazon Web Services account
|
2878
|
-
# QuickSight customizations for.
|
2902
|
+
# The ID for the Amazon Web Services account that you want to describe
|
2903
|
+
# Amazon QuickSight customizations for.
|
2879
2904
|
#
|
2880
2905
|
# @option params [String] :namespace
|
2881
|
-
# The QuickSight namespace that you want to describe
|
2882
|
-
# customizations for.
|
2906
|
+
# The Amazon QuickSight namespace that you want to describe Amazon
|
2907
|
+
# QuickSight customizations for.
|
2883
2908
|
#
|
2884
2909
|
# @option params [Boolean] :resolved
|
2885
2910
|
# The `Resolved` flag works with the other parameters to determine which
|
2886
|
-
# view of QuickSight customizations is returned. You can add this
|
2887
|
-
# to your command to use the same view that QuickSight uses
|
2888
|
-
# which customizations to apply to the console. Omit this
|
2889
|
-
# it to `no-resolved`, to reveal customizations that are
|
2890
|
-
# different levels.
|
2911
|
+
# view of Amazon QuickSight customizations is returned. You can add this
|
2912
|
+
# flag to your command to use the same view that Amazon QuickSight uses
|
2913
|
+
# to identify which customizations to apply to the console. Omit this
|
2914
|
+
# flag, or set it to `no-resolved`, to reveal customizations that are
|
2915
|
+
# configured at different levels.
|
2891
2916
|
#
|
2892
2917
|
# @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2893
2918
|
#
|
@@ -2924,11 +2949,11 @@ module Aws::QuickSight
|
|
2924
2949
|
req.send_request(options)
|
2925
2950
|
end
|
2926
2951
|
|
2927
|
-
# Describes the settings that were used when your QuickSight
|
2928
|
-
# subscription was first created in this Amazon Web Services account
|
2952
|
+
# Describes the settings that were used when your Amazon QuickSight
|
2953
|
+
# subscription was first created in this Amazon Web Services account.
|
2929
2954
|
#
|
2930
2955
|
# @option params [required, String] :aws_account_id
|
2931
|
-
# The ID for the Amazon Web Services account
|
2956
|
+
# The ID for the Amazon Web Services account that contains the settings
|
2932
2957
|
# that you want to list.
|
2933
2958
|
#
|
2934
2959
|
# @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -2964,9 +2989,9 @@ module Aws::QuickSight
|
|
2964
2989
|
# Provides a summary of the metadata for an analysis.
|
2965
2990
|
#
|
2966
2991
|
# @option params [required, String] :aws_account_id
|
2967
|
-
# The ID of the Amazon Web Services account
|
2968
|
-
# You must be using the Amazon Web Services account
|
2969
|
-
#
|
2992
|
+
# The ID of the Amazon Web Services account that contains the analysis.
|
2993
|
+
# You must be using the Amazon Web Services account that the analysis is
|
2994
|
+
# in.
|
2970
2995
|
#
|
2971
2996
|
# @option params [required, String] :analysis_id
|
2972
2997
|
# The ID of the analysis that you're describing. The ID is part of the
|
@@ -3017,9 +3042,9 @@ module Aws::QuickSight
|
|
3017
3042
|
# Provides the read and write permissions for an analysis.
|
3018
3043
|
#
|
3019
3044
|
# @option params [required, String] :aws_account_id
|
3020
|
-
# The ID of the Amazon Web Services account
|
3045
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
3021
3046
|
# whose permissions you're describing. You must be using the Amazon Web
|
3022
|
-
# Services account
|
3047
|
+
# Services account that the analysis is in.
|
3023
3048
|
#
|
3024
3049
|
# @option params [required, String] :analysis_id
|
3025
3050
|
# The ID of the analysis whose permissions you're describing. The ID is
|
@@ -3063,7 +3088,7 @@ module Aws::QuickSight
|
|
3063
3088
|
# Provides a summary for a dashboard.
|
3064
3089
|
#
|
3065
3090
|
# @option params [required, String] :aws_account_id
|
3066
|
-
# The ID of the Amazon Web Services account
|
3091
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
3067
3092
|
# that you're describing.
|
3068
3093
|
#
|
3069
3094
|
# @option params [required, String] :dashboard_id
|
@@ -3129,11 +3154,11 @@ module Aws::QuickSight
|
|
3129
3154
|
# Describes read and write permissions for a dashboard.
|
3130
3155
|
#
|
3131
3156
|
# @option params [required, String] :aws_account_id
|
3132
|
-
# The ID of the Amazon Web Services account
|
3157
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
3133
3158
|
# that you're describing permissions for.
|
3134
3159
|
#
|
3135
3160
|
# @option params [required, String] :dashboard_id
|
3136
|
-
# The ID for the dashboard, also added to the
|
3161
|
+
# The ID for the dashboard, also added to the IAMpolicy.
|
3137
3162
|
#
|
3138
3163
|
# @return [Types::DescribeDashboardPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3139
3164
|
#
|
@@ -3173,11 +3198,11 @@ module Aws::QuickSight
|
|
3173
3198
|
# Describes a dataset.
|
3174
3199
|
#
|
3175
3200
|
# @option params [required, String] :aws_account_id
|
3176
|
-
# The Amazon Web Services account
|
3201
|
+
# The Amazon Web Services account ID.
|
3177
3202
|
#
|
3178
3203
|
# @option params [required, String] :data_set_id
|
3179
3204
|
# The ID for the dataset that you want to create. This ID is unique per
|
3180
|
-
# Amazon Web Services Region
|
3205
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
3181
3206
|
#
|
3182
3207
|
# @return [Types::DescribeDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3183
3208
|
#
|
@@ -3241,6 +3266,9 @@ module Aws::QuickSight
|
|
3241
3266
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags #=> Array
|
3242
3267
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_geographic_role #=> String, one of "COUNTRY", "STATE", "COUNTY", "CITY", "POSTCODE", "LONGITUDE", "LATITUDE"
|
3243
3268
|
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].tag_column_operation.tags[0].column_description.text #=> String
|
3269
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.column_name #=> String
|
3270
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names #=> Array
|
3271
|
+
# resp.data_set.logical_table_map["LogicalTableId"].data_transforms[0].untag_column_operation.tag_names[0] #=> String, one of "COLUMN_GEOGRAPHIC_ROLE", "COLUMN_DESCRIPTION"
|
3244
3272
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_operand #=> String
|
3245
3273
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.right_operand #=> String
|
3246
3274
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.left_join_key_properties.unique_key #=> Boolean
|
@@ -3248,6 +3276,7 @@ module Aws::QuickSight
|
|
3248
3276
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.type #=> String, one of "INNER", "OUTER", "LEFT", "RIGHT"
|
3249
3277
|
# resp.data_set.logical_table_map["LogicalTableId"].source.join_instruction.on_clause #=> String
|
3250
3278
|
# resp.data_set.logical_table_map["LogicalTableId"].source.physical_table_id #=> String
|
3279
|
+
# resp.data_set.logical_table_map["LogicalTableId"].source.data_set_arn #=> String
|
3251
3280
|
# resp.data_set.output_columns #=> Array
|
3252
3281
|
# resp.data_set.output_columns[0].name #=> String
|
3253
3282
|
# resp.data_set.output_columns[0].description #=> String
|
@@ -3279,6 +3308,8 @@ module Aws::QuickSight
|
|
3279
3308
|
# resp.data_set.column_level_permission_rules[0].principals[0] #=> String
|
3280
3309
|
# resp.data_set.column_level_permission_rules[0].column_names #=> Array
|
3281
3310
|
# resp.data_set.column_level_permission_rules[0].column_names[0] #=> String
|
3311
|
+
# resp.data_set.data_set_usage_configuration.disable_use_as_direct_query_source #=> Boolean
|
3312
|
+
# resp.data_set.data_set_usage_configuration.disable_use_as_imported_source #=> Boolean
|
3282
3313
|
# resp.request_id #=> String
|
3283
3314
|
# resp.status #=> Integer
|
3284
3315
|
#
|
@@ -3297,11 +3328,11 @@ module Aws::QuickSight
|
|
3297
3328
|
# `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
|
3298
3329
|
#
|
3299
3330
|
# @option params [required, String] :aws_account_id
|
3300
|
-
# The Amazon Web Services account
|
3331
|
+
# The Amazon Web Services account ID.
|
3301
3332
|
#
|
3302
3333
|
# @option params [required, String] :data_set_id
|
3303
3334
|
# The ID for the dataset that you want to create. This ID is unique per
|
3304
|
-
# Amazon Web Services Region
|
3335
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
3305
3336
|
#
|
3306
3337
|
# @return [Types::DescribeDataSetPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3307
3338
|
#
|
@@ -3341,11 +3372,11 @@ module Aws::QuickSight
|
|
3341
3372
|
# Describes a data source.
|
3342
3373
|
#
|
3343
3374
|
# @option params [required, String] :aws_account_id
|
3344
|
-
# The Amazon Web Services account
|
3375
|
+
# The Amazon Web Services account ID.
|
3345
3376
|
#
|
3346
3377
|
# @option params [required, String] :data_source_id
|
3347
3378
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
3348
|
-
# Region
|
3379
|
+
# Region for each Amazon Web Services account.
|
3349
3380
|
#
|
3350
3381
|
# @return [Types::DescribeDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3351
3382
|
#
|
@@ -3365,7 +3396,7 @@ module Aws::QuickSight
|
|
3365
3396
|
# resp.data_source.arn #=> String
|
3366
3397
|
# resp.data_source.data_source_id #=> String
|
3367
3398
|
# resp.data_source.name #=> String
|
3368
|
-
# 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"
|
3399
|
+
# 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"
|
3369
3400
|
# resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
3370
3401
|
# resp.data_source.created_time #=> Time
|
3371
3402
|
# resp.data_source.last_updated_time #=> Time
|
@@ -3416,6 +3447,7 @@ module Aws::QuickSight
|
|
3416
3447
|
# resp.data_source.data_source_parameters.teradata_parameters.database #=> String
|
3417
3448
|
# resp.data_source.data_source_parameters.twitter_parameters.query #=> String
|
3418
3449
|
# resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer
|
3450
|
+
# resp.data_source.data_source_parameters.amazon_open_search_parameters.domain #=> String
|
3419
3451
|
# resp.data_source.alternate_data_source_parameters #=> Array
|
3420
3452
|
# resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
3421
3453
|
# resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
@@ -3464,6 +3496,7 @@ module Aws::QuickSight
|
|
3464
3496
|
# resp.data_source.alternate_data_source_parameters[0].teradata_parameters.database #=> String
|
3465
3497
|
# resp.data_source.alternate_data_source_parameters[0].twitter_parameters.query #=> String
|
3466
3498
|
# resp.data_source.alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
|
3499
|
+
# resp.data_source.alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> String
|
3467
3500
|
# resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
|
3468
3501
|
# resp.data_source.ssl_properties.disable_ssl #=> Boolean
|
3469
3502
|
# 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"
|
@@ -3483,11 +3516,11 @@ module Aws::QuickSight
|
|
3483
3516
|
# Describes the resource permissions for a data source.
|
3484
3517
|
#
|
3485
3518
|
# @option params [required, String] :aws_account_id
|
3486
|
-
# The Amazon Web Services account
|
3519
|
+
# The Amazon Web Services account ID.
|
3487
3520
|
#
|
3488
3521
|
# @option params [required, String] :data_source_id
|
3489
3522
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
3490
|
-
# Region
|
3523
|
+
# Region for each Amazon Web Services account.
|
3491
3524
|
#
|
3492
3525
|
# @return [Types::DescribeDataSourcePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3493
3526
|
#
|
@@ -3662,8 +3695,8 @@ module Aws::QuickSight
|
|
3662
3695
|
# The name of the group that you want to describe.
|
3663
3696
|
#
|
3664
3697
|
# @option params [required, String] :aws_account_id
|
3665
|
-
# The ID for the Amazon Web Services account
|
3666
|
-
# Currently, you use the ID for the Amazon Web Services account
|
3698
|
+
# The ID for the Amazon Web Services account that the group is in.
|
3699
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
3667
3700
|
# contains your Amazon QuickSight account.
|
3668
3701
|
#
|
3669
3702
|
# @option params [required, String] :namespace
|
@@ -3701,12 +3734,12 @@ module Aws::QuickSight
|
|
3701
3734
|
req.send_request(options)
|
3702
3735
|
end
|
3703
3736
|
|
3704
|
-
# Describes an existing
|
3737
|
+
# Describes an existing IAMpolicy assignment, as specified by the
|
3705
3738
|
# assignment name.
|
3706
3739
|
#
|
3707
3740
|
# @option params [required, String] :aws_account_id
|
3708
|
-
# The ID of the Amazon Web Services account
|
3709
|
-
#
|
3741
|
+
# The ID of the Amazon Web Services account that contains the assignment
|
3742
|
+
# that you want to describe.
|
3710
3743
|
#
|
3711
3744
|
# @option params [required, String] :assignment_name
|
3712
3745
|
# The name of the assignment, also called a rule.
|
@@ -3753,7 +3786,7 @@ module Aws::QuickSight
|
|
3753
3786
|
# Describes a SPICE ingestion.
|
3754
3787
|
#
|
3755
3788
|
# @option params [required, String] :aws_account_id
|
3756
|
-
# The Amazon Web Services account
|
3789
|
+
# The Amazon Web Services account ID.
|
3757
3790
|
#
|
3758
3791
|
# @option params [required, String] :data_set_id
|
3759
3792
|
# The ID of the dataset used in the ingestion.
|
@@ -3771,7 +3804,7 @@ module Aws::QuickSight
|
|
3771
3804
|
#
|
3772
3805
|
# resp = client.describe_ingestion({
|
3773
3806
|
# aws_account_id: "AwsAccountId", # required
|
3774
|
-
# data_set_id: "
|
3807
|
+
# data_set_id: "String", # required
|
3775
3808
|
# ingestion_id: "IngestionId", # required
|
3776
3809
|
# })
|
3777
3810
|
#
|
@@ -3780,10 +3813,11 @@ module Aws::QuickSight
|
|
3780
3813
|
# resp.ingestion.arn #=> String
|
3781
3814
|
# resp.ingestion.ingestion_id #=> String
|
3782
3815
|
# resp.ingestion.ingestion_status #=> String, one of "INITIALIZED", "QUEUED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
|
3783
|
-
# resp.ingestion.error_info.type #=> String, one of "FAILURE_TO_ASSUME_ROLE", "INGESTION_SUPERSEDED", "INGESTION_CANCELED", "DATA_SET_DELETED", "DATA_SET_NOT_SPICE", "S3_UPLOADED_FILE_DELETED", "S3_MANIFEST_ERROR", "DATA_TOLERANCE_EXCEPTION", "SPICE_TABLE_NOT_FOUND", "DATA_SET_SIZE_LIMIT_EXCEEDED", "ROW_SIZE_LIMIT_EXCEEDED", "ACCOUNT_CAPACITY_LIMIT_EXCEEDED", "CUSTOMER_ERROR", "DATA_SOURCE_NOT_FOUND", "IAM_ROLE_NOT_AVAILABLE", "CONNECTION_FAILURE", "SQL_TABLE_NOT_FOUND", "PERMISSION_DENIED", "SSL_CERTIFICATE_VALIDATION_FAILURE", "OAUTH_TOKEN_FAILURE", "SOURCE_API_LIMIT_EXCEEDED_FAILURE", "PASSWORD_AUTHENTICATION_FAILURE", "SQL_SCHEMA_MISMATCH_ERROR", "INVALID_DATE_FORMAT", "INVALID_DATAPREP_SYNTAX", "SOURCE_RESOURCE_LIMIT_EXCEEDED", "SQL_INVALID_PARAMETER_VALUE", "QUERY_TIMEOUT", "SQL_NUMERIC_OVERFLOW", "UNRESOLVABLE_HOST", "UNROUTABLE_HOST", "SQL_EXCEPTION", "S3_FILE_INACCESSIBLE", "IOT_FILE_NOT_FOUND", "IOT_DATA_SET_FILE_EMPTY", "INVALID_DATA_SOURCE_CONFIG", "DATA_SOURCE_AUTH_FAILED", "DATA_SOURCE_CONNECTION_FAILED", "FAILURE_TO_PROCESS_JSON_FILE", "INTERNAL_SERVICE_ERROR"
|
3816
|
+
# resp.ingestion.error_info.type #=> String, one of "FAILURE_TO_ASSUME_ROLE", "INGESTION_SUPERSEDED", "INGESTION_CANCELED", "DATA_SET_DELETED", "DATA_SET_NOT_SPICE", "S3_UPLOADED_FILE_DELETED", "S3_MANIFEST_ERROR", "DATA_TOLERANCE_EXCEPTION", "SPICE_TABLE_NOT_FOUND", "DATA_SET_SIZE_LIMIT_EXCEEDED", "ROW_SIZE_LIMIT_EXCEEDED", "ACCOUNT_CAPACITY_LIMIT_EXCEEDED", "CUSTOMER_ERROR", "DATA_SOURCE_NOT_FOUND", "IAM_ROLE_NOT_AVAILABLE", "CONNECTION_FAILURE", "SQL_TABLE_NOT_FOUND", "PERMISSION_DENIED", "SSL_CERTIFICATE_VALIDATION_FAILURE", "OAUTH_TOKEN_FAILURE", "SOURCE_API_LIMIT_EXCEEDED_FAILURE", "PASSWORD_AUTHENTICATION_FAILURE", "SQL_SCHEMA_MISMATCH_ERROR", "INVALID_DATE_FORMAT", "INVALID_DATAPREP_SYNTAX", "SOURCE_RESOURCE_LIMIT_EXCEEDED", "SQL_INVALID_PARAMETER_VALUE", "QUERY_TIMEOUT", "SQL_NUMERIC_OVERFLOW", "UNRESOLVABLE_HOST", "UNROUTABLE_HOST", "SQL_EXCEPTION", "S3_FILE_INACCESSIBLE", "IOT_FILE_NOT_FOUND", "IOT_DATA_SET_FILE_EMPTY", "INVALID_DATA_SOURCE_CONFIG", "DATA_SOURCE_AUTH_FAILED", "DATA_SOURCE_CONNECTION_FAILED", "FAILURE_TO_PROCESS_JSON_FILE", "INTERNAL_SERVICE_ERROR", "REFRESH_SUPPRESSED_BY_EDIT", "PERMISSION_NOT_FOUND", "ELASTICSEARCH_CURSOR_NOT_ENABLED", "CURSOR_NOT_ENABLED"
|
3784
3817
|
# resp.ingestion.error_info.message #=> String
|
3785
3818
|
# resp.ingestion.row_info.rows_ingested #=> Integer
|
3786
3819
|
# resp.ingestion.row_info.rows_dropped #=> Integer
|
3820
|
+
# resp.ingestion.row_info.total_rows_in_dataset #=> Integer
|
3787
3821
|
# resp.ingestion.queue_info.waiting_on_ingestion #=> String
|
3788
3822
|
# resp.ingestion.queue_info.queued_ingestion #=> String
|
3789
3823
|
# resp.ingestion.created_time #=> Time
|
@@ -3803,10 +3837,47 @@ module Aws::QuickSight
|
|
3803
3837
|
req.send_request(options)
|
3804
3838
|
end
|
3805
3839
|
|
3840
|
+
# Provides a summary and status of IP Rules.
|
3841
|
+
#
|
3842
|
+
# @option params [required, String] :aws_account_id
|
3843
|
+
# Your AWS account ID.
|
3844
|
+
#
|
3845
|
+
# @return [Types::DescribeIpRestrictionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3846
|
+
#
|
3847
|
+
# * {Types::DescribeIpRestrictionResponse#aws_account_id #aws_account_id} => String
|
3848
|
+
# * {Types::DescribeIpRestrictionResponse#ip_restriction_rule_map #ip_restriction_rule_map} => Hash<String,String>
|
3849
|
+
# * {Types::DescribeIpRestrictionResponse#enabled #enabled} => Boolean
|
3850
|
+
# * {Types::DescribeIpRestrictionResponse#request_id #request_id} => String
|
3851
|
+
# * {Types::DescribeIpRestrictionResponse#status #status} => Integer
|
3852
|
+
#
|
3853
|
+
# @example Request syntax with placeholder values
|
3854
|
+
#
|
3855
|
+
# resp = client.describe_ip_restriction({
|
3856
|
+
# aws_account_id: "AwsAccountId", # required
|
3857
|
+
# })
|
3858
|
+
#
|
3859
|
+
# @example Response structure
|
3860
|
+
#
|
3861
|
+
# resp.aws_account_id #=> String
|
3862
|
+
# resp.ip_restriction_rule_map #=> Hash
|
3863
|
+
# resp.ip_restriction_rule_map["CIDR"] #=> String
|
3864
|
+
# resp.enabled #=> Boolean
|
3865
|
+
# resp.request_id #=> String
|
3866
|
+
# resp.status #=> Integer
|
3867
|
+
#
|
3868
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIpRestriction AWS API Documentation
|
3869
|
+
#
|
3870
|
+
# @overload describe_ip_restriction(params = {})
|
3871
|
+
# @param [Hash] params ({})
|
3872
|
+
def describe_ip_restriction(params = {}, options = {})
|
3873
|
+
req = build_request(:describe_ip_restriction, params)
|
3874
|
+
req.send_request(options)
|
3875
|
+
end
|
3876
|
+
|
3806
3877
|
# Describes the current namespace.
|
3807
3878
|
#
|
3808
3879
|
# @option params [required, String] :aws_account_id
|
3809
|
-
# The ID for the Amazon Web Services account
|
3880
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
3810
3881
|
# QuickSight namespace that you want to describe.
|
3811
3882
|
#
|
3812
3883
|
# @option params [required, String] :namespace
|
@@ -3849,7 +3920,7 @@ module Aws::QuickSight
|
|
3849
3920
|
# Describes a template's metadata.
|
3850
3921
|
#
|
3851
3922
|
# @option params [required, String] :aws_account_id
|
3852
|
-
# The ID of the Amazon Web Services account
|
3923
|
+
# The ID of the Amazon Web Services account that contains the template
|
3853
3924
|
# that you're describing.
|
3854
3925
|
#
|
3855
3926
|
# @option params [required, String] :template_id
|
@@ -3926,7 +3997,7 @@ module Aws::QuickSight
|
|
3926
3997
|
# Describes the template alias for a template.
|
3927
3998
|
#
|
3928
3999
|
# @option params [required, String] :aws_account_id
|
3929
|
-
# The ID of the Amazon Web Services account
|
4000
|
+
# The ID of the Amazon Web Services account that contains the template
|
3930
4001
|
# alias that you're describing.
|
3931
4002
|
#
|
3932
4003
|
# @option params [required, String] :template_id
|
@@ -3973,7 +4044,7 @@ module Aws::QuickSight
|
|
3973
4044
|
# Describes read and write permissions on a template.
|
3974
4045
|
#
|
3975
4046
|
# @option params [required, String] :aws_account_id
|
3976
|
-
# The ID of the Amazon Web Services account
|
4047
|
+
# The ID of the Amazon Web Services account that contains the template
|
3977
4048
|
# that you're describing.
|
3978
4049
|
#
|
3979
4050
|
# @option params [required, String] :template_id
|
@@ -4017,8 +4088,8 @@ module Aws::QuickSight
|
|
4017
4088
|
# Describes a theme.
|
4018
4089
|
#
|
4019
4090
|
# @option params [required, String] :aws_account_id
|
4020
|
-
# The ID of the Amazon Web Services account
|
4021
|
-
#
|
4091
|
+
# The ID of the Amazon Web Services account that contains the theme that
|
4092
|
+
# you're describing.
|
4022
4093
|
#
|
4023
4094
|
# @option params [required, String] :theme_id
|
4024
4095
|
# The ID for the theme.
|
@@ -4106,7 +4177,7 @@ module Aws::QuickSight
|
|
4106
4177
|
# Describes the alias for a theme.
|
4107
4178
|
#
|
4108
4179
|
# @option params [required, String] :aws_account_id
|
4109
|
-
# The ID of the Amazon Web Services account
|
4180
|
+
# The ID of the Amazon Web Services account that contains the theme
|
4110
4181
|
# alias that you're describing.
|
4111
4182
|
#
|
4112
4183
|
# @option params [required, String] :theme_id
|
@@ -4149,8 +4220,8 @@ module Aws::QuickSight
|
|
4149
4220
|
# Describes the read and write permissions for a theme.
|
4150
4221
|
#
|
4151
4222
|
# @option params [required, String] :aws_account_id
|
4152
|
-
# The ID of the Amazon Web Services account
|
4153
|
-
#
|
4223
|
+
# The ID of the Amazon Web Services account that contains the theme that
|
4224
|
+
# you're describing.
|
4154
4225
|
#
|
4155
4226
|
# @option params [required, String] :theme_id
|
4156
4227
|
# The ID for the theme that you want to describe permissions for.
|
@@ -4196,8 +4267,8 @@ module Aws::QuickSight
|
|
4196
4267
|
# The name of the user that you want to describe.
|
4197
4268
|
#
|
4198
4269
|
# @option params [required, String] :aws_account_id
|
4199
|
-
# The ID for the Amazon Web Services account
|
4200
|
-
# Currently, you use the ID for the Amazon Web Services account
|
4270
|
+
# The ID for the Amazon Web Services account that the user is in.
|
4271
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
4201
4272
|
# contains your Amazon QuickSight account.
|
4202
4273
|
#
|
4203
4274
|
# @option params [required, String] :namespace
|
@@ -4440,9 +4511,9 @@ module Aws::QuickSight
|
|
4440
4511
|
end
|
4441
4512
|
|
4442
4513
|
# Generates a session URL and authorization code that you can use to
|
4443
|
-
# embed an Amazon QuickSight read-only dashboard in your web
|
4444
|
-
# code. Before you use this command, make sure that you have
|
4445
|
-
# the dashboards and permissions.
|
4514
|
+
# embed an Amazon Amazon QuickSight read-only dashboard in your web
|
4515
|
+
# server code. Before you use this command, make sure that you have
|
4516
|
+
# configured the dashboards and permissions.
|
4446
4517
|
#
|
4447
4518
|
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
4448
4519
|
# not from the user's browser. The following rules apply to the
|
@@ -4469,8 +4540,8 @@ module Aws::QuickSight
|
|
4469
4540
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
|
4470
4541
|
#
|
4471
4542
|
# @option params [required, String] :aws_account_id
|
4472
|
-
# The ID for the Amazon Web Services account
|
4473
|
-
#
|
4543
|
+
# The ID for the Amazon Web Services account that contains the dashboard
|
4544
|
+
# that you're embedding.
|
4474
4545
|
#
|
4475
4546
|
# @option params [required, String] :dashboard_id
|
4476
4547
|
# The ID for the dashboard, also added to the Identity and Access
|
@@ -4495,11 +4566,11 @@ module Aws::QuickSight
|
|
4495
4566
|
# Adds persistence of state for the user session in an embedded
|
4496
4567
|
# dashboard. Persistence applies to the sheet and the parameter
|
4497
4568
|
# settings. These are control settings that the dashboard subscriber
|
4498
|
-
# (QuickSight reader) chooses while viewing the dashboard. If
|
4499
|
-
# set to `TRUE`, the settings are the same when the subscriber
|
4500
|
-
# the same dashboard URL. The state is stored in
|
4501
|
-
# browser cookie. If this is set to FALSE, the
|
4502
|
-
# is not persisted. The default is `FALSE`.
|
4569
|
+
# (Amazon QuickSight reader) chooses while viewing the dashboard. If
|
4570
|
+
# this is set to `TRUE`, the settings are the same when the subscriber
|
4571
|
+
# reopens the same dashboard URL. The state is stored in Amazon
|
4572
|
+
# QuickSight, not in a browser cookie. If this is set to FALSE, the
|
4573
|
+
# state of the user session is not persisted. The default is `FALSE`.
|
4503
4574
|
#
|
4504
4575
|
# @option params [String] :user_arn
|
4505
4576
|
# The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
|
@@ -4511,23 +4582,22 @@ module Aws::QuickSight
|
|
4511
4582
|
#
|
4512
4583
|
# * Invited nonfederated users
|
4513
4584
|
#
|
4514
|
-
# *
|
4515
|
-
#
|
4516
|
-
# federation.
|
4585
|
+
# * IAMusers and IAMrole-based sessions authenticated through Federated
|
4586
|
+
# Single Sign-On using SAML, OpenID Connect, or IAMfederation.
|
4517
4587
|
#
|
4518
|
-
# Omit this parameter for users in the third group –
|
4588
|
+
# Omit this parameter for users in the third group – IAMusers and IAM
|
4519
4589
|
# role-based sessions.
|
4520
4590
|
#
|
4521
4591
|
# @option params [String] :namespace
|
4522
|
-
# The Amazon QuickSight namespace that the
|
4523
|
-
# you
|
4524
|
-
#
|
4592
|
+
# The Amazon QuickSight namespace that contains the dashboard IDs in
|
4593
|
+
# this request. If you're not using a custom namespace, set `Namespace
|
4594
|
+
# = default`.
|
4525
4595
|
#
|
4526
4596
|
# @option params [Array<String>] :additional_dashboard_ids
|
4527
4597
|
# A list of one or more dashboard IDs that you want to add to a session
|
4528
4598
|
# that includes anonymous users. The `IdentityType` parameter must be
|
4529
4599
|
# set to `ANONYMOUS` for this to work, because other identity types
|
4530
|
-
# authenticate as QuickSight or
|
4600
|
+
# authenticate as Amazon QuickSight or IAMusers. For example, if you set
|
4531
4601
|
# "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
|
4532
4602
|
# identity-type ANONYMOUS`", the session can access all three
|
4533
4603
|
# dashboards.
|
@@ -4569,29 +4639,28 @@ module Aws::QuickSight
|
|
4569
4639
|
end
|
4570
4640
|
|
4571
4641
|
# Generates a session URL and authorization code that you can use to
|
4572
|
-
# embed the Amazon QuickSight console in your web server code.
|
4573
|
-
# `GetSessionEmbedUrl` where you want to provide an authoring portal
|
4642
|
+
# embed the Amazon Amazon QuickSight console in your web server code.
|
4643
|
+
# Use `GetSessionEmbedUrl` where you want to provide an authoring portal
|
4574
4644
|
# that allows users to create data sources, datasets, analyses, and
|
4575
|
-
# dashboards. The users who access an embedded QuickSight console
|
4576
|
-
# belong to the author or admin security cohort. If you want to
|
4577
|
-
# permissions to some of these features, add a custom
|
4578
|
-
# profile to the user with the ` UpdateUser ` API operation.
|
4579
|
-
# RegisterUser ` API operation to add a new user with a custom
|
4645
|
+
# dashboards. The users who access an embedded Amazon QuickSight console
|
4646
|
+
# need belong to the author or admin security cohort. If you want to
|
4647
|
+
# restrict permissions to some of these features, add a custom
|
4648
|
+
# permissions profile to the user with the ` UpdateUser ` API operation.
|
4649
|
+
# Use ` RegisterUser ` API operation to add a new user with a custom
|
4580
4650
|
# permission profile attached. For more information, see the following
|
4581
4651
|
# sections in the *Amazon QuickSight User Guide*\:
|
4582
4652
|
#
|
4583
|
-
# * [Embedding
|
4584
|
-
# GetSessionEmbedUrl][1]
|
4653
|
+
# * [Embedding Analytics][1]
|
4585
4654
|
#
|
4586
4655
|
# * [Customizing Access to the Amazon QuickSight Console][2]
|
4587
4656
|
#
|
4588
4657
|
#
|
4589
4658
|
#
|
4590
|
-
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics
|
4659
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html
|
4591
4660
|
# [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
|
4592
4661
|
#
|
4593
4662
|
# @option params [required, String] :aws_account_id
|
4594
|
-
# The ID for the Amazon Web Services account
|
4663
|
+
# The ID for the Amazon Web Services account associated with your Amazon
|
4595
4664
|
# QuickSight subscription.
|
4596
4665
|
#
|
4597
4666
|
# @option params [String] :entry_point
|
@@ -4607,10 +4676,10 @@ module Aws::QuickSight
|
|
4607
4676
|
# * `/start/favorites`
|
4608
4677
|
#
|
4609
4678
|
# * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
|
4610
|
-
# key from the QuickSight console URL of the dashboard
|
4679
|
+
# key from the Amazon QuickSight console URL of the dashboard
|
4611
4680
|
#
|
4612
4681
|
# * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
|
4613
|
-
# from the QuickSight console URL of the analysis
|
4682
|
+
# from the Amazon QuickSight console URL of the analysis
|
4614
4683
|
#
|
4615
4684
|
# @option params [Integer] :session_lifetime_in_minutes
|
4616
4685
|
# How many minutes the session is valid. The session lifetime must be
|
@@ -4664,10 +4733,10 @@ module Aws::QuickSight
|
|
4664
4733
|
end
|
4665
4734
|
|
4666
4735
|
# Lists Amazon QuickSight analyses that exist in the specified Amazon
|
4667
|
-
# Web Services account
|
4736
|
+
# Web Services account.
|
4668
4737
|
#
|
4669
4738
|
# @option params [required, String] :aws_account_id
|
4670
|
-
# The ID of the Amazon Web Services account
|
4739
|
+
# The ID of the Amazon Web Services account that contains the analyses.
|
4671
4740
|
#
|
4672
4741
|
# @option params [String] :next_token
|
4673
4742
|
# A pagination token that can be used in a subsequent request.
|
@@ -4714,11 +4783,11 @@ module Aws::QuickSight
|
|
4714
4783
|
req.send_request(options)
|
4715
4784
|
end
|
4716
4785
|
|
4717
|
-
# Lists all the versions of the dashboards in the QuickSight
|
4786
|
+
# Lists all the versions of the dashboards in the Amazon QuickSight
|
4718
4787
|
# subscription.
|
4719
4788
|
#
|
4720
4789
|
# @option params [required, String] :aws_account_id
|
4721
|
-
# The ID of the Amazon Web Services account
|
4790
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
4722
4791
|
# that you're listing versions for.
|
4723
4792
|
#
|
4724
4793
|
# @option params [required, String] :dashboard_id
|
@@ -4771,11 +4840,11 @@ module Aws::QuickSight
|
|
4771
4840
|
req.send_request(options)
|
4772
4841
|
end
|
4773
4842
|
|
4774
|
-
# Lists dashboards in an Amazon Web Services account
|
4843
|
+
# Lists dashboards in an Amazon Web Services account.
|
4775
4844
|
#
|
4776
4845
|
# @option params [required, String] :aws_account_id
|
4777
|
-
# The ID of the Amazon Web Services account
|
4778
|
-
#
|
4846
|
+
# The ID of the Amazon Web Services account that contains the dashboards
|
4847
|
+
# that you're listing.
|
4779
4848
|
#
|
4780
4849
|
# @option params [String] :next_token
|
4781
4850
|
# The token for the next set of results, or null if there are no more
|
@@ -4825,13 +4894,13 @@ module Aws::QuickSight
|
|
4825
4894
|
end
|
4826
4895
|
|
4827
4896
|
# Lists all of the datasets belonging to the current Amazon Web Services
|
4828
|
-
# account
|
4897
|
+
# account in an Amazon Web Services Region.
|
4829
4898
|
#
|
4830
4899
|
# The permissions resource is
|
4831
4900
|
# `arn:aws:quicksight:region:aws-account-id:dataset/*`.
|
4832
4901
|
#
|
4833
4902
|
# @option params [required, String] :aws_account_id
|
4834
|
-
# The Amazon Web Services account
|
4903
|
+
# The Amazon Web Services account ID.
|
4835
4904
|
#
|
4836
4905
|
# @option params [String] :next_token
|
4837
4906
|
# The token for the next set of results, or null if there are no more
|
@@ -4886,11 +4955,11 @@ module Aws::QuickSight
|
|
4886
4955
|
req.send_request(options)
|
4887
4956
|
end
|
4888
4957
|
|
4889
|
-
# Lists data sources in current Amazon Web Services Region
|
4890
|
-
# to this Amazon Web Services account
|
4958
|
+
# Lists data sources in current Amazon Web Services Region that belong
|
4959
|
+
# to this Amazon Web Services account.
|
4891
4960
|
#
|
4892
4961
|
# @option params [required, String] :aws_account_id
|
4893
|
-
# The Amazon Web Services account
|
4962
|
+
# The Amazon Web Services account ID.
|
4894
4963
|
#
|
4895
4964
|
# @option params [String] :next_token
|
4896
4965
|
# The token for the next set of results, or null if there are no more
|
@@ -4922,7 +4991,7 @@ module Aws::QuickSight
|
|
4922
4991
|
# resp.data_sources[0].arn #=> String
|
4923
4992
|
# resp.data_sources[0].data_source_id #=> String
|
4924
4993
|
# resp.data_sources[0].name #=> String
|
4925
|
-
# 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"
|
4994
|
+
# 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"
|
4926
4995
|
# resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
|
4927
4996
|
# resp.data_sources[0].created_time #=> Time
|
4928
4997
|
# resp.data_sources[0].last_updated_time #=> Time
|
@@ -4973,6 +5042,7 @@ module Aws::QuickSight
|
|
4973
5042
|
# resp.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
|
4974
5043
|
# resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
|
4975
5044
|
# resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
|
5045
|
+
# resp.data_sources[0].data_source_parameters.amazon_open_search_parameters.domain #=> String
|
4976
5046
|
# resp.data_sources[0].alternate_data_source_parameters #=> Array
|
4977
5047
|
# resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
|
4978
5048
|
# resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
|
@@ -5021,6 +5091,7 @@ module Aws::QuickSight
|
|
5021
5091
|
# resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.database #=> String
|
5022
5092
|
# resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.query #=> String
|
5023
5093
|
# resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
|
5094
|
+
# resp.data_sources[0].alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> String
|
5024
5095
|
# resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
|
5025
5096
|
# resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
|
5026
5097
|
# 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"
|
@@ -5148,8 +5219,8 @@ module Aws::QuickSight
|
|
5148
5219
|
# The maximum number of results to return from this request.
|
5149
5220
|
#
|
5150
5221
|
# @option params [required, String] :aws_account_id
|
5151
|
-
# The ID for the Amazon Web Services account
|
5152
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5222
|
+
# The ID for the Amazon Web Services account that the group is in.
|
5223
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5153
5224
|
# contains your Amazon QuickSight account.
|
5154
5225
|
#
|
5155
5226
|
# @option params [required, String] :namespace
|
@@ -5193,8 +5264,8 @@ module Aws::QuickSight
|
|
5193
5264
|
# Lists all user groups in Amazon QuickSight.
|
5194
5265
|
#
|
5195
5266
|
# @option params [required, String] :aws_account_id
|
5196
|
-
# The ID for the Amazon Web Services account
|
5197
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5267
|
+
# The ID for the Amazon Web Services account that the group is in.
|
5268
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5198
5269
|
# contains your Amazon QuickSight account.
|
5199
5270
|
#
|
5200
5271
|
# @option params [String] :next_token
|
@@ -5242,11 +5313,11 @@ module Aws::QuickSight
|
|
5242
5313
|
req.send_request(options)
|
5243
5314
|
end
|
5244
5315
|
|
5245
|
-
# Lists
|
5316
|
+
# Lists IAMpolicy assignments in the current Amazon QuickSight account.
|
5246
5317
|
#
|
5247
5318
|
# @option params [required, String] :aws_account_id
|
5248
|
-
# The ID of the Amazon Web Services account
|
5249
|
-
#
|
5319
|
+
# The ID of the Amazon Web Services account that contains these
|
5320
|
+
# IAMpolicy assignments.
|
5250
5321
|
#
|
5251
5322
|
# @option params [String] :assignment_status
|
5252
5323
|
# The status of the assignments.
|
@@ -5296,12 +5367,12 @@ module Aws::QuickSight
|
|
5296
5367
|
req.send_request(options)
|
5297
5368
|
end
|
5298
5369
|
|
5299
|
-
# Lists all the
|
5370
|
+
# Lists all the IAMpolicy assignments, including the Amazon Resource
|
5300
5371
|
# Names (ARNs) for the IAM policies assigned to the specified user and
|
5301
5372
|
# group or groups that the user belongs to.
|
5302
5373
|
#
|
5303
5374
|
# @option params [required, String] :aws_account_id
|
5304
|
-
# The ID of the Amazon Web Services account
|
5375
|
+
# The ID of the Amazon Web Services account that contains the
|
5305
5376
|
# assignments.
|
5306
5377
|
#
|
5307
5378
|
# @option params [required, String] :user_name
|
@@ -5362,7 +5433,7 @@ module Aws::QuickSight
|
|
5362
5433
|
# results.
|
5363
5434
|
#
|
5364
5435
|
# @option params [required, String] :aws_account_id
|
5365
|
-
# The Amazon Web Services account
|
5436
|
+
# The Amazon Web Services account ID.
|
5366
5437
|
#
|
5367
5438
|
# @option params [Integer] :max_results
|
5368
5439
|
# The maximum number of results to be returned per request.
|
@@ -5379,8 +5450,8 @@ module Aws::QuickSight
|
|
5379
5450
|
# @example Request syntax with placeholder values
|
5380
5451
|
#
|
5381
5452
|
# resp = client.list_ingestions({
|
5382
|
-
# data_set_id: "
|
5383
|
-
# next_token: "
|
5453
|
+
# data_set_id: "String", # required
|
5454
|
+
# next_token: "String",
|
5384
5455
|
# aws_account_id: "AwsAccountId", # required
|
5385
5456
|
# max_results: 1,
|
5386
5457
|
# })
|
@@ -5391,10 +5462,11 @@ module Aws::QuickSight
|
|
5391
5462
|
# resp.ingestions[0].arn #=> String
|
5392
5463
|
# resp.ingestions[0].ingestion_id #=> String
|
5393
5464
|
# resp.ingestions[0].ingestion_status #=> String, one of "INITIALIZED", "QUEUED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
|
5394
|
-
# resp.ingestions[0].error_info.type #=> String, one of "FAILURE_TO_ASSUME_ROLE", "INGESTION_SUPERSEDED", "INGESTION_CANCELED", "DATA_SET_DELETED", "DATA_SET_NOT_SPICE", "S3_UPLOADED_FILE_DELETED", "S3_MANIFEST_ERROR", "DATA_TOLERANCE_EXCEPTION", "SPICE_TABLE_NOT_FOUND", "DATA_SET_SIZE_LIMIT_EXCEEDED", "ROW_SIZE_LIMIT_EXCEEDED", "ACCOUNT_CAPACITY_LIMIT_EXCEEDED", "CUSTOMER_ERROR", "DATA_SOURCE_NOT_FOUND", "IAM_ROLE_NOT_AVAILABLE", "CONNECTION_FAILURE", "SQL_TABLE_NOT_FOUND", "PERMISSION_DENIED", "SSL_CERTIFICATE_VALIDATION_FAILURE", "OAUTH_TOKEN_FAILURE", "SOURCE_API_LIMIT_EXCEEDED_FAILURE", "PASSWORD_AUTHENTICATION_FAILURE", "SQL_SCHEMA_MISMATCH_ERROR", "INVALID_DATE_FORMAT", "INVALID_DATAPREP_SYNTAX", "SOURCE_RESOURCE_LIMIT_EXCEEDED", "SQL_INVALID_PARAMETER_VALUE", "QUERY_TIMEOUT", "SQL_NUMERIC_OVERFLOW", "UNRESOLVABLE_HOST", "UNROUTABLE_HOST", "SQL_EXCEPTION", "S3_FILE_INACCESSIBLE", "IOT_FILE_NOT_FOUND", "IOT_DATA_SET_FILE_EMPTY", "INVALID_DATA_SOURCE_CONFIG", "DATA_SOURCE_AUTH_FAILED", "DATA_SOURCE_CONNECTION_FAILED", "FAILURE_TO_PROCESS_JSON_FILE", "INTERNAL_SERVICE_ERROR"
|
5465
|
+
# resp.ingestions[0].error_info.type #=> String, one of "FAILURE_TO_ASSUME_ROLE", "INGESTION_SUPERSEDED", "INGESTION_CANCELED", "DATA_SET_DELETED", "DATA_SET_NOT_SPICE", "S3_UPLOADED_FILE_DELETED", "S3_MANIFEST_ERROR", "DATA_TOLERANCE_EXCEPTION", "SPICE_TABLE_NOT_FOUND", "DATA_SET_SIZE_LIMIT_EXCEEDED", "ROW_SIZE_LIMIT_EXCEEDED", "ACCOUNT_CAPACITY_LIMIT_EXCEEDED", "CUSTOMER_ERROR", "DATA_SOURCE_NOT_FOUND", "IAM_ROLE_NOT_AVAILABLE", "CONNECTION_FAILURE", "SQL_TABLE_NOT_FOUND", "PERMISSION_DENIED", "SSL_CERTIFICATE_VALIDATION_FAILURE", "OAUTH_TOKEN_FAILURE", "SOURCE_API_LIMIT_EXCEEDED_FAILURE", "PASSWORD_AUTHENTICATION_FAILURE", "SQL_SCHEMA_MISMATCH_ERROR", "INVALID_DATE_FORMAT", "INVALID_DATAPREP_SYNTAX", "SOURCE_RESOURCE_LIMIT_EXCEEDED", "SQL_INVALID_PARAMETER_VALUE", "QUERY_TIMEOUT", "SQL_NUMERIC_OVERFLOW", "UNRESOLVABLE_HOST", "UNROUTABLE_HOST", "SQL_EXCEPTION", "S3_FILE_INACCESSIBLE", "IOT_FILE_NOT_FOUND", "IOT_DATA_SET_FILE_EMPTY", "INVALID_DATA_SOURCE_CONFIG", "DATA_SOURCE_AUTH_FAILED", "DATA_SOURCE_CONNECTION_FAILED", "FAILURE_TO_PROCESS_JSON_FILE", "INTERNAL_SERVICE_ERROR", "REFRESH_SUPPRESSED_BY_EDIT", "PERMISSION_NOT_FOUND", "ELASTICSEARCH_CURSOR_NOT_ENABLED", "CURSOR_NOT_ENABLED"
|
5395
5466
|
# resp.ingestions[0].error_info.message #=> String
|
5396
5467
|
# resp.ingestions[0].row_info.rows_ingested #=> Integer
|
5397
5468
|
# resp.ingestions[0].row_info.rows_dropped #=> Integer
|
5469
|
+
# resp.ingestions[0].row_info.total_rows_in_dataset #=> Integer
|
5398
5470
|
# resp.ingestions[0].queue_info.waiting_on_ingestion #=> String
|
5399
5471
|
# resp.ingestions[0].queue_info.queued_ingestion #=> String
|
5400
5472
|
# resp.ingestions[0].created_time #=> Time
|
@@ -5415,10 +5487,10 @@ module Aws::QuickSight
|
|
5415
5487
|
req.send_request(options)
|
5416
5488
|
end
|
5417
5489
|
|
5418
|
-
# Lists the namespaces for the specified Amazon Web Services account
|
5490
|
+
# Lists the namespaces for the specified Amazon Web Services account.
|
5419
5491
|
#
|
5420
5492
|
# @option params [required, String] :aws_account_id
|
5421
|
-
# The ID for the Amazon Web Services account
|
5493
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
5422
5494
|
# QuickSight namespaces that you want to list.
|
5423
5495
|
#
|
5424
5496
|
# @option params [String] :next_token
|
@@ -5505,7 +5577,7 @@ module Aws::QuickSight
|
|
5505
5577
|
# Lists all the aliases of a template.
|
5506
5578
|
#
|
5507
5579
|
# @option params [required, String] :aws_account_id
|
5508
|
-
# The ID of the Amazon Web Services account
|
5580
|
+
# The ID of the Amazon Web Services account that contains the template
|
5509
5581
|
# aliases that you're listing.
|
5510
5582
|
#
|
5511
5583
|
# @option params [required, String] :template_id
|
@@ -5559,7 +5631,7 @@ module Aws::QuickSight
|
|
5559
5631
|
# QuickSight account.
|
5560
5632
|
#
|
5561
5633
|
# @option params [required, String] :aws_account_id
|
5562
|
-
# The ID of the Amazon Web Services account
|
5634
|
+
# The ID of the Amazon Web Services account that contains the templates
|
5563
5635
|
# that you're listing.
|
5564
5636
|
#
|
5565
5637
|
# @option params [required, String] :template_id
|
@@ -5614,7 +5686,7 @@ module Aws::QuickSight
|
|
5614
5686
|
# Lists all the templates in the current Amazon QuickSight account.
|
5615
5687
|
#
|
5616
5688
|
# @option params [required, String] :aws_account_id
|
5617
|
-
# The ID of the Amazon Web Services account
|
5689
|
+
# The ID of the Amazon Web Services account that contains the templates
|
5618
5690
|
# that you're listing.
|
5619
5691
|
#
|
5620
5692
|
# @option params [String] :next_token
|
@@ -5666,7 +5738,7 @@ module Aws::QuickSight
|
|
5666
5738
|
# Lists all the aliases of a theme.
|
5667
5739
|
#
|
5668
5740
|
# @option params [required, String] :aws_account_id
|
5669
|
-
# The ID of the Amazon Web Services account
|
5741
|
+
# The ID of the Amazon Web Services account that contains the theme
|
5670
5742
|
# aliases that you're listing.
|
5671
5743
|
#
|
5672
5744
|
# @option params [required, String] :theme_id
|
@@ -5715,10 +5787,10 @@ module Aws::QuickSight
|
|
5715
5787
|
end
|
5716
5788
|
|
5717
5789
|
# Lists all the versions of the themes in the current Amazon Web
|
5718
|
-
# Services account
|
5790
|
+
# Services account.
|
5719
5791
|
#
|
5720
5792
|
# @option params [required, String] :aws_account_id
|
5721
|
-
# The ID of the Amazon Web Services account
|
5793
|
+
# The ID of the Amazon Web Services account that contains the themes
|
5722
5794
|
# that you're listing.
|
5723
5795
|
#
|
5724
5796
|
# @option params [required, String] :theme_id
|
@@ -5770,10 +5842,10 @@ module Aws::QuickSight
|
|
5770
5842
|
req.send_request(options)
|
5771
5843
|
end
|
5772
5844
|
|
5773
|
-
# Lists all the themes in the current Amazon Web Services account
|
5845
|
+
# Lists all the themes in the current Amazon Web Services account.
|
5774
5846
|
#
|
5775
5847
|
# @option params [required, String] :aws_account_id
|
5776
|
-
# The ID of the Amazon Web Services account
|
5848
|
+
# The ID of the Amazon Web Services account that contains the themes
|
5777
5849
|
# that you're listing.
|
5778
5850
|
#
|
5779
5851
|
# @option params [String] :next_token
|
@@ -5843,8 +5915,8 @@ module Aws::QuickSight
|
|
5843
5915
|
# memberships for.
|
5844
5916
|
#
|
5845
5917
|
# @option params [required, String] :aws_account_id
|
5846
|
-
# The Amazon Web Services account
|
5847
|
-
#
|
5918
|
+
# The Amazon Web Services account ID that the user is in. Currently, you
|
5919
|
+
# use the ID for the Amazon Web Services account that contains your
|
5848
5920
|
# Amazon QuickSight account.
|
5849
5921
|
#
|
5850
5922
|
# @option params [required, String] :namespace
|
@@ -5897,8 +5969,8 @@ module Aws::QuickSight
|
|
5897
5969
|
# account.
|
5898
5970
|
#
|
5899
5971
|
# @option params [required, String] :aws_account_id
|
5900
|
-
# The ID for the Amazon Web Services account
|
5901
|
-
# Currently, you use the ID for the Amazon Web Services account
|
5972
|
+
# The ID for the Amazon Web Services account that the user is in.
|
5973
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
5902
5974
|
# contains your Amazon QuickSight account.
|
5903
5975
|
#
|
5904
5976
|
# @option params [String] :next_token
|
@@ -5961,7 +6033,7 @@ module Aws::QuickSight
|
|
5961
6033
|
# Amazon QuickSight supports several ways of managing the identity of
|
5962
6034
|
# users. This parameter accepts two values:
|
5963
6035
|
#
|
5964
|
-
# * `IAM`\: A user whose identity maps to an existing
|
6036
|
+
# * `IAM`\: A user whose identity maps to an existing IAMuser or role.
|
5965
6037
|
#
|
5966
6038
|
# * `QUICKSIGHT`\: A user whose identity is owned and managed internally
|
5967
6039
|
# by Amazon QuickSight.
|
@@ -5986,25 +6058,25 @@ module Aws::QuickSight
|
|
5986
6058
|
# * `RESTRICTED_AUTHOR`\: This role isn't currently available for use.
|
5987
6059
|
#
|
5988
6060
|
# @option params [String] :iam_arn
|
5989
|
-
# The ARN of the
|
6061
|
+
# The ARN of the IAMuser or role that you are registering with Amazon
|
5990
6062
|
# QuickSight.
|
5991
6063
|
#
|
5992
6064
|
# @option params [String] :session_name
|
5993
6065
|
# You need to use this parameter only when you register one or more
|
5994
|
-
# users using an assumed
|
5995
|
-
#
|
5996
|
-
#
|
5997
|
-
#
|
5998
|
-
#
|
5999
|
-
#
|
6066
|
+
# users using an assumed IAMrole. You don't need to provide the session
|
6067
|
+
# name for other scenarios, for example when you are registering an
|
6068
|
+
# IAMuser or an Amazon QuickSight user. You can register multiple users
|
6069
|
+
# using the same IAMrole if each user has a different session name. For
|
6070
|
+
# more information on assuming IAMroles, see [ `assume-role` ][1] in the
|
6071
|
+
# *AWS CLI Reference.*
|
6000
6072
|
#
|
6001
6073
|
#
|
6002
6074
|
#
|
6003
6075
|
# [1]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
|
6004
6076
|
#
|
6005
6077
|
# @option params [required, String] :aws_account_id
|
6006
|
-
# The ID for the Amazon Web Services account
|
6007
|
-
# Currently, you use the ID for the Amazon Web Services account
|
6078
|
+
# The ID for the Amazon Web Services account that the user is in.
|
6079
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
6008
6080
|
# contains your Amazon QuickSight account.
|
6009
6081
|
#
|
6010
6082
|
# @option params [required, String] :namespace
|
@@ -6033,22 +6105,22 @@ module Aws::QuickSight
|
|
6033
6105
|
#
|
6034
6106
|
# A set of custom permissions includes any combination of these
|
6035
6107
|
# restrictions. Currently, you need to create the profile names for
|
6036
|
-
# custom permission sets by using the QuickSight console. Then,
|
6037
|
-
# the `RegisterUser` API operation to assign the named set of
|
6038
|
-
# permissions to a QuickSight user.
|
6108
|
+
# custom permission sets by using the Amazon QuickSight console. Then,
|
6109
|
+
# you use the `RegisterUser` API operation to assign the named set of
|
6110
|
+
# permissions to a Amazon QuickSight user.
|
6039
6111
|
#
|
6040
|
-
# QuickSight custom permissions are applied through
|
6112
|
+
# Amazon QuickSight custom permissions are applied through IAMpolicies.
|
6041
6113
|
# Therefore, they override the permissions typically granted by
|
6042
|
-
# assigning QuickSight users to one of the default security
|
6043
|
-
# QuickSight (admin, author, reader).
|
6114
|
+
# assigning Amazon QuickSight users to one of the default security
|
6115
|
+
# cohorts in Amazon QuickSight (admin, author, reader).
|
6044
6116
|
#
|
6045
|
-
# This feature is available only to QuickSight Enterprise edition
|
6117
|
+
# This feature is available only to Amazon QuickSight Enterprise edition
|
6046
6118
|
# subscriptions.
|
6047
6119
|
#
|
6048
6120
|
# @option params [String] :external_login_federation_provider_type
|
6049
6121
|
# The type of supported external login provider that provides identity
|
6050
|
-
# to let a user federate into Amazon QuickSight with an associated
|
6051
|
-
# Identity and Access Management
|
6122
|
+
# to let a user federate into Amazon QuickSight with an associated
|
6123
|
+
# Identity and Access Management(IAM) role. The type of supported
|
6052
6124
|
# external login provider can be one of the following.
|
6053
6125
|
#
|
6054
6126
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
@@ -6062,10 +6134,10 @@ module Aws::QuickSight
|
|
6062
6134
|
#
|
6063
6135
|
# @option params [String] :custom_federation_provider_url
|
6064
6136
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
6065
|
-
# identity to let a user federate into QuickSight with an
|
6066
|
-
# Identity and Access Management
|
6067
|
-
# be used when `ExternalLoginFederationProviderType`
|
6068
|
-
# `CUSTOM_OIDC`.
|
6137
|
+
# identity to let a user federate into Amazon QuickSight with an
|
6138
|
+
# associated Identity and Access Management(IAM) role. This parameter
|
6139
|
+
# should only be used when `ExternalLoginFederationProviderType`
|
6140
|
+
# parameter is set to `CUSTOM_OIDC`.
|
6069
6141
|
#
|
6070
6142
|
# @option params [String] :external_login_id
|
6071
6143
|
# The identity ID for a user in the external login provider.
|
@@ -6123,7 +6195,7 @@ module Aws::QuickSight
|
|
6123
6195
|
# Restores an analysis.
|
6124
6196
|
#
|
6125
6197
|
# @option params [required, String] :aws_account_id
|
6126
|
-
# The ID of the Amazon Web Services account
|
6198
|
+
# The ID of the Amazon Web Services account that contains the analysis.
|
6127
6199
|
#
|
6128
6200
|
# @option params [required, String] :analysis_id
|
6129
6201
|
# The ID of the analysis that you're restoring.
|
@@ -6166,7 +6238,7 @@ module Aws::QuickSight
|
|
6166
6238
|
# </note>
|
6167
6239
|
#
|
6168
6240
|
# @option params [required, String] :aws_account_id
|
6169
|
-
# The ID of the Amazon Web Services account
|
6241
|
+
# The ID of the Amazon Web Services account that contains the analyses
|
6170
6242
|
# that you're searching for.
|
6171
6243
|
#
|
6172
6244
|
# @option params [required, Array<Types::AnalysisSearchFilter>] :filters
|
@@ -6233,8 +6305,8 @@ module Aws::QuickSight
|
|
6233
6305
|
# </note>
|
6234
6306
|
#
|
6235
6307
|
# @option params [required, String] :aws_account_id
|
6236
|
-
# The ID of the Amazon Web Services account
|
6237
|
-
#
|
6308
|
+
# The ID of the Amazon Web Services account that contains the user whose
|
6309
|
+
# dashboards you're searching for.
|
6238
6310
|
#
|
6239
6311
|
# @option params [required, Array<Types::DashboardSearchFilter>] :filters
|
6240
6312
|
# The filters to apply to the search. Currently, you can search only by
|
@@ -6358,8 +6430,8 @@ module Aws::QuickSight
|
|
6358
6430
|
req.send_request(options)
|
6359
6431
|
end
|
6360
6432
|
|
6361
|
-
# Assigns one or more tags (key-value pairs) to the specified
|
6362
|
-
# resource.
|
6433
|
+
# Assigns one or more tags (key-value pairs) to the specified Amazon
|
6434
|
+
# QuickSight resource.
|
6363
6435
|
#
|
6364
6436
|
# Tags can help you organize and categorize your resources. You can also
|
6365
6437
|
# use them to scope user permissions, by granting a user permission to
|
@@ -6370,18 +6442,19 @@ module Aws::QuickSight
|
|
6370
6442
|
# key that is already associated with the resource, the new tag value
|
6371
6443
|
# that you specify replaces the previous value for that tag.
|
6372
6444
|
#
|
6373
|
-
# You can associate as many as 50 tags with a resource.
|
6374
|
-
# supports tagging on data set, data source, dashboard, and
|
6445
|
+
# You can associate as many as 50 tags with a resource. Amazon
|
6446
|
+
# QuickSight supports tagging on data set, data source, dashboard, and
|
6447
|
+
# template.
|
6375
6448
|
#
|
6376
|
-
# Tagging for QuickSight works in a similar way to tagging for
|
6377
|
-
# services, except for the following:
|
6449
|
+
# Tagging for Amazon QuickSight works in a similar way to tagging for
|
6450
|
+
# other AWS services, except for the following:
|
6378
6451
|
#
|
6379
|
-
# * You can't use tags to track AWS costs for QuickSight. This
|
6380
|
-
# restriction is because QuickSight costs are based on users
|
6381
|
-
# capacity, which aren't taggable resources.
|
6452
|
+
# * You can't use tags to track AWS costs for Amazon QuickSight. This
|
6453
|
+
# restriction is because Amazon QuickSight costs are based on users
|
6454
|
+
# and SPICE capacity, which aren't taggable resources.
|
6382
6455
|
#
|
6383
|
-
# * QuickSight doesn't currently support the Tag Editor for
|
6384
|
-
# Groups.
|
6456
|
+
# * Amazon QuickSight doesn't currently support the Tag Editor for
|
6457
|
+
# Resource Groups.
|
6385
6458
|
#
|
6386
6459
|
# @option params [required, String] :resource_arn
|
6387
6460
|
# The Amazon Resource Name (ARN) of the resource that you want to tag.
|
@@ -6457,26 +6530,27 @@ module Aws::QuickSight
|
|
6457
6530
|
end
|
6458
6531
|
|
6459
6532
|
# Updates Amazon QuickSight customizations the current Amazon Web
|
6460
|
-
# Services Region
|
6533
|
+
# Services Region. Currently, the only customization you can use is a
|
6461
6534
|
# theme.
|
6462
6535
|
#
|
6463
|
-
# You can use customizations for your Amazon Web Services account
|
6464
|
-
#
|
6536
|
+
# You can use customizations for your Amazon Web Services account or, if
|
6537
|
+
# you specify a namespace, for a Amazon QuickSight namespace instead.
|
6465
6538
|
# Customizations that apply to a namespace override customizations that
|
6466
|
-
# apply to an Amazon Web Services account
|
6539
|
+
# apply to an Amazon Web Services account. To find out which
|
6467
6540
|
# customizations apply, use the `DescribeAccountCustomization` API
|
6468
6541
|
# operation.
|
6469
6542
|
#
|
6470
6543
|
# @option params [required, String] :aws_account_id
|
6471
|
-
# The ID for the Amazon Web Services account
|
6472
|
-
# QuickSight customizations for.
|
6544
|
+
# The ID for the Amazon Web Services account that you want to update
|
6545
|
+
# Amazon QuickSight customizations for.
|
6473
6546
|
#
|
6474
6547
|
# @option params [String] :namespace
|
6475
|
-
# The namespace that you want to update QuickSight customizations
|
6548
|
+
# The namespace that you want to update Amazon QuickSight customizations
|
6549
|
+
# for.
|
6476
6550
|
#
|
6477
6551
|
# @option params [required, Types::AccountCustomization] :account_customization
|
6478
|
-
# The QuickSight customizations you're updating in the current
|
6479
|
-
# Web Services Region
|
6552
|
+
# The Amazon QuickSight customizations you're updating in the current
|
6553
|
+
# Amazon Web Services Region.
|
6480
6554
|
#
|
6481
6555
|
# @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6482
6556
|
#
|
@@ -6516,22 +6590,22 @@ module Aws::QuickSight
|
|
6516
6590
|
end
|
6517
6591
|
|
6518
6592
|
# Updates the Amazon QuickSight settings in your Amazon Web Services
|
6519
|
-
# account
|
6593
|
+
# account.
|
6520
6594
|
#
|
6521
6595
|
# @option params [required, String] :aws_account_id
|
6522
|
-
# The ID for the Amazon Web Services account
|
6596
|
+
# The ID for the Amazon Web Services account that contains the Amazon
|
6523
6597
|
# QuickSight settings that you want to list.
|
6524
6598
|
#
|
6525
6599
|
# @option params [required, String] :default_namespace
|
6526
|
-
# The default namespace for this Amazon Web Services account
|
6527
|
-
#
|
6528
|
-
#
|
6529
|
-
#
|
6600
|
+
# The default namespace for this Amazon Web Services account. Currently,
|
6601
|
+
# the default is `default`. Identity and Access Management (IAM) users
|
6602
|
+
# that register for the first time with Amazon QuickSight provide an
|
6603
|
+
# email that becomes associated with the default namespace.
|
6530
6604
|
#
|
6531
6605
|
# @option params [String] :notification_email
|
6532
|
-
# The email address that you want QuickSight to send
|
6533
|
-
# regarding your Amazon Web Services account
|
6534
|
-
# subscription.
|
6606
|
+
# The email address that you want Amazon QuickSight to send
|
6607
|
+
# notifications to regarding your Amazon Web Services account or Amazon
|
6608
|
+
# QuickSight subscription.
|
6535
6609
|
#
|
6536
6610
|
# @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6537
6611
|
#
|
@@ -6563,7 +6637,7 @@ module Aws::QuickSight
|
|
6563
6637
|
# Updates an analysis in Amazon QuickSight
|
6564
6638
|
#
|
6565
6639
|
# @option params [required, String] :aws_account_id
|
6566
|
-
# The ID of the Amazon Web Services account
|
6640
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
6567
6641
|
# that you're updating.
|
6568
6642
|
#
|
6569
6643
|
# @option params [required, String] :analysis_id
|
@@ -6572,7 +6646,7 @@ module Aws::QuickSight
|
|
6572
6646
|
#
|
6573
6647
|
# @option params [required, String] :name
|
6574
6648
|
# A descriptive name for the analysis that you're updating. This name
|
6575
|
-
# displays for the analysis in the QuickSight console.
|
6649
|
+
# displays for the analysis in the Amazon QuickSight console.
|
6576
6650
|
#
|
6577
6651
|
# @option params [Types::Parameters] :parameters
|
6578
6652
|
# The parameter names and override values that you want to use. An
|
@@ -6586,8 +6660,8 @@ module Aws::QuickSight
|
|
6586
6660
|
#
|
6587
6661
|
# @option params [String] :theme_arn
|
6588
6662
|
# The Amazon Resource Name (ARN) for the theme to apply to the analysis
|
6589
|
-
# that you're creating. To see the theme in the QuickSight
|
6590
|
-
# make sure that you have access to it.
|
6663
|
+
# that you're creating. To see the theme in the Amazon QuickSight
|
6664
|
+
# console, make sure that you have access to it.
|
6591
6665
|
#
|
6592
6666
|
# @return [Types::UpdateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6593
6667
|
#
|
@@ -6663,9 +6737,9 @@ module Aws::QuickSight
|
|
6663
6737
|
# Updates the read and write permissions for an analysis.
|
6664
6738
|
#
|
6665
6739
|
# @option params [required, String] :aws_account_id
|
6666
|
-
# The ID of the Amazon Web Services account
|
6740
|
+
# The ID of the Amazon Web Services account that contains the analysis
|
6667
6741
|
# whose permissions you're updating. You must be using the Amazon Web
|
6668
|
-
# Services account
|
6742
|
+
# Services account that the analysis is in.
|
6669
6743
|
#
|
6670
6744
|
# @option params [required, String] :analysis_id
|
6671
6745
|
# The ID of the analysis whose permissions you're updating. The ID is
|
@@ -6726,7 +6800,7 @@ module Aws::QuickSight
|
|
6726
6800
|
req.send_request(options)
|
6727
6801
|
end
|
6728
6802
|
|
6729
|
-
# Updates a dashboard in an Amazon Web Services account
|
6803
|
+
# Updates a dashboard in an Amazon Web Services account.
|
6730
6804
|
#
|
6731
6805
|
# <note markdown="1"> Updating a Dashboard creates a new dashboard version but does not
|
6732
6806
|
# immediately publish the new version. You can update the published
|
@@ -6736,7 +6810,7 @@ module Aws::QuickSight
|
|
6736
6810
|
# </note>
|
6737
6811
|
#
|
6738
6812
|
# @option params [required, String] :aws_account_id
|
6739
|
-
# The ID of the Amazon Web Services account
|
6813
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
6740
6814
|
# that you're updating.
|
6741
6815
|
#
|
6742
6816
|
# @option params [required, String] :dashboard_id
|
@@ -6753,8 +6827,8 @@ module Aws::QuickSight
|
|
6753
6827
|
# from an analysis, first convert the analysis to a template by using
|
6754
6828
|
# the CreateTemplate API operation. For `SourceTemplate`, specify the
|
6755
6829
|
# Amazon Resource Name (ARN) of the source template. The
|
6756
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
6757
|
-
# any QuickSight-supported Amazon Web Services Region
|
6830
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
6831
|
+
# any Amazon QuickSight-supported Amazon Web Services Region.
|
6758
6832
|
#
|
6759
6833
|
# Use the `DataSetReferences` entity within `SourceTemplate` to list the
|
6760
6834
|
# replacement datasets for the placeholders listed in the original. The
|
@@ -6773,9 +6847,9 @@ module Aws::QuickSight
|
|
6773
6847
|
#
|
6774
6848
|
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
|
6775
6849
|
# either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
6776
|
-
# QuickSight disables the left filter pane on the published
|
6777
|
-
# which can be used for ad hoc (one-time) filtering. This
|
6778
|
-
# `ENABLED` by default.
|
6850
|
+
# Amazon QuickSight disables the left filter pane on the published
|
6851
|
+
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
6852
|
+
# option is `ENABLED` by default.
|
6779
6853
|
#
|
6780
6854
|
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
6781
6855
|
# either `ENABLED` or `DISABLED`. The visual option to export data to
|
@@ -6790,7 +6864,7 @@ module Aws::QuickSight
|
|
6790
6864
|
# The Amazon Resource Name (ARN) of the theme that is being used for
|
6791
6865
|
# this dashboard. If you add a value for this field, it overrides the
|
6792
6866
|
# value that was originally associated with the entity. The theme ARN
|
6793
|
-
# must exist in the same Amazon Web Services account
|
6867
|
+
# must exist in the same Amazon Web Services account where you create
|
6794
6868
|
# the dashboard.
|
6795
6869
|
#
|
6796
6870
|
# @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -6881,7 +6955,7 @@ module Aws::QuickSight
|
|
6881
6955
|
# Updates read and write permissions on a dashboard.
|
6882
6956
|
#
|
6883
6957
|
# @option params [required, String] :aws_account_id
|
6884
|
-
# The ID of the Amazon Web Services account
|
6958
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
6885
6959
|
# whose permissions you're updating.
|
6886
6960
|
#
|
6887
6961
|
# @option params [required, String] :dashboard_id
|
@@ -6943,7 +7017,7 @@ module Aws::QuickSight
|
|
6943
7017
|
# Updates the published version of a dashboard.
|
6944
7018
|
#
|
6945
7019
|
# @option params [required, String] :aws_account_id
|
6946
|
-
# The ID of the Amazon Web Services account
|
7020
|
+
# The ID of the Amazon Web Services account that contains the dashboard
|
6947
7021
|
# that you're updating.
|
6948
7022
|
#
|
6949
7023
|
# @option params [required, String] :dashboard_id
|
@@ -6986,11 +7060,11 @@ module Aws::QuickSight
|
|
6986
7060
|
# Updates a dataset.
|
6987
7061
|
#
|
6988
7062
|
# @option params [required, String] :aws_account_id
|
6989
|
-
# The Amazon Web Services account
|
7063
|
+
# The Amazon Web Services account ID.
|
6990
7064
|
#
|
6991
7065
|
# @option params [required, String] :data_set_id
|
6992
7066
|
# The ID for the dataset that you want to update. This ID is unique per
|
6993
|
-
# Amazon Web Services Region
|
7067
|
+
# Amazon Web Services Region for each Amazon Web Services account.
|
6994
7068
|
#
|
6995
7069
|
# @option params [required, String] :name
|
6996
7070
|
# The display name for the dataset.
|
@@ -7007,7 +7081,7 @@ module Aws::QuickSight
|
|
7007
7081
|
# Indicates whether you want to import the data into SPICE.
|
7008
7082
|
#
|
7009
7083
|
# @option params [Array<Types::ColumnGroup>] :column_groups
|
7010
|
-
# Groupings of columns that work together in certain QuickSight
|
7084
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
7011
7085
|
# features. Currently, only geospatial hierarchy is supported.
|
7012
7086
|
#
|
7013
7087
|
# @option params [Hash<String,Types::FieldFolder>] :field_folders
|
@@ -7025,6 +7099,10 @@ module Aws::QuickSight
|
|
7025
7099
|
# @option params [Array<Types::ColumnLevelPermissionRule>] :column_level_permission_rules
|
7026
7100
|
# A set of one or more definitions of a ` ColumnLevelPermissionRule `.
|
7027
7101
|
#
|
7102
|
+
# @option params [Types::DataSetUsageConfiguration] :data_set_usage_configuration
|
7103
|
+
# The usage configuration to apply to child datasets that reference this
|
7104
|
+
# dataset as a source.
|
7105
|
+
#
|
7028
7106
|
# @return [Types::UpdateDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7029
7107
|
#
|
7030
7108
|
# * {Types::UpdateDataSetResponse#arn #arn} => String
|
@@ -7123,6 +7201,10 @@ module Aws::QuickSight
|
|
7123
7201
|
# },
|
7124
7202
|
# ],
|
7125
7203
|
# },
|
7204
|
+
# untag_column_operation: {
|
7205
|
+
# column_name: "ColumnName", # required
|
7206
|
+
# tag_names: ["COLUMN_GEOGRAPHIC_ROLE"], # required, accepts COLUMN_GEOGRAPHIC_ROLE, COLUMN_DESCRIPTION
|
7207
|
+
# },
|
7126
7208
|
# },
|
7127
7209
|
# ],
|
7128
7210
|
# source: { # required
|
@@ -7139,6 +7221,7 @@ module Aws::QuickSight
|
|
7139
7221
|
# on_clause: "OnClause", # required
|
7140
7222
|
# },
|
7141
7223
|
# physical_table_id: "PhysicalTableId",
|
7224
|
+
# data_set_arn: "Arn",
|
7142
7225
|
# },
|
7143
7226
|
# },
|
7144
7227
|
# },
|
@@ -7182,6 +7265,10 @@ module Aws::QuickSight
|
|
7182
7265
|
# column_names: ["String"],
|
7183
7266
|
# },
|
7184
7267
|
# ],
|
7268
|
+
# data_set_usage_configuration: {
|
7269
|
+
# disable_use_as_direct_query_source: false,
|
7270
|
+
# disable_use_as_imported_source: false,
|
7271
|
+
# },
|
7185
7272
|
# })
|
7186
7273
|
#
|
7187
7274
|
# @example Response structure
|
@@ -7208,12 +7295,12 @@ module Aws::QuickSight
|
|
7208
7295
|
# `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
|
7209
7296
|
#
|
7210
7297
|
# @option params [required, String] :aws_account_id
|
7211
|
-
# The Amazon Web Services account
|
7298
|
+
# The Amazon Web Services account ID.
|
7212
7299
|
#
|
7213
7300
|
# @option params [required, String] :data_set_id
|
7214
7301
|
# The ID for the dataset whose permissions you want to update. This ID
|
7215
|
-
# is unique per Amazon Web Services Region
|
7216
|
-
# account
|
7302
|
+
# is unique per Amazon Web Services Region for each Amazon Web Services
|
7303
|
+
# account.
|
7217
7304
|
#
|
7218
7305
|
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
7219
7306
|
# The resource permissions that you want to grant to the dataset.
|
@@ -7266,30 +7353,30 @@ module Aws::QuickSight
|
|
7266
7353
|
# Updates a data source.
|
7267
7354
|
#
|
7268
7355
|
# @option params [required, String] :aws_account_id
|
7269
|
-
# The Amazon Web Services account
|
7356
|
+
# The Amazon Web Services account ID.
|
7270
7357
|
#
|
7271
7358
|
# @option params [required, String] :data_source_id
|
7272
7359
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
7273
|
-
# Region
|
7360
|
+
# Region for each Amazon Web Services account.
|
7274
7361
|
#
|
7275
7362
|
# @option params [required, String] :name
|
7276
7363
|
# A display name for the data source.
|
7277
7364
|
#
|
7278
7365
|
# @option params [Types::DataSourceParameters] :data_source_parameters
|
7279
|
-
# The parameters that QuickSight uses to connect to your
|
7280
|
-
# source.
|
7366
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
7367
|
+
# underlying source.
|
7281
7368
|
#
|
7282
7369
|
# @option params [Types::DataSourceCredentials] :credentials
|
7283
|
-
# The credentials that QuickSight that uses to connect to your
|
7370
|
+
# The credentials that Amazon QuickSight that uses to connect to your
|
7284
7371
|
# underlying source. Currently, only credentials based on user name and
|
7285
7372
|
# password are supported.
|
7286
7373
|
#
|
7287
7374
|
# @option params [Types::VpcConnectionProperties] :vpc_connection_properties
|
7288
|
-
# Use this parameter only when you want QuickSight to use a VPC
|
7375
|
+
# Use this parameter only when you want Amazon QuickSight to use a VPC
|
7289
7376
|
# connection when connecting to your underlying source.
|
7290
7377
|
#
|
7291
7378
|
# @option params [Types::SslProperties] :ssl_properties
|
7292
|
-
# Secure Socket Layer (SSL) properties that apply when QuickSight
|
7379
|
+
# Secure Socket Layer (SSL) properties that apply when Amazon QuickSight
|
7293
7380
|
# connects to your underlying source.
|
7294
7381
|
#
|
7295
7382
|
# @return [Types::UpdateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -7396,6 +7483,9 @@ module Aws::QuickSight
|
|
7396
7483
|
# query: "Query", # required
|
7397
7484
|
# max_rows: 1, # required
|
7398
7485
|
# },
|
7486
|
+
# amazon_open_search_parameters: {
|
7487
|
+
# domain: "Domain", # required
|
7488
|
+
# },
|
7399
7489
|
# },
|
7400
7490
|
# credentials: {
|
7401
7491
|
# credential_pair: {
|
@@ -7492,6 +7582,9 @@ module Aws::QuickSight
|
|
7492
7582
|
# query: "Query", # required
|
7493
7583
|
# max_rows: 1, # required
|
7494
7584
|
# },
|
7585
|
+
# amazon_open_search_parameters: {
|
7586
|
+
# domain: "Domain", # required
|
7587
|
+
# },
|
7495
7588
|
# },
|
7496
7589
|
# ],
|
7497
7590
|
# },
|
@@ -7525,11 +7618,11 @@ module Aws::QuickSight
|
|
7525
7618
|
# Updates the permissions to a data source.
|
7526
7619
|
#
|
7527
7620
|
# @option params [required, String] :aws_account_id
|
7528
|
-
# The Amazon Web Services account
|
7621
|
+
# The Amazon Web Services account ID.
|
7529
7622
|
#
|
7530
7623
|
# @option params [required, String] :data_source_id
|
7531
7624
|
# The ID of the data source. This ID is unique per Amazon Web Services
|
7532
|
-
# Region
|
7625
|
+
# Region for each Amazon Web Services account.
|
7533
7626
|
#
|
7534
7627
|
# @option params [Array<Types::ResourcePermission>] :grant_permissions
|
7535
7628
|
# A list of resource permissions that you want to grant on the data
|
@@ -7693,8 +7786,8 @@ module Aws::QuickSight
|
|
7693
7786
|
# The description for the group that you want to update.
|
7694
7787
|
#
|
7695
7788
|
# @option params [required, String] :aws_account_id
|
7696
|
-
# The ID for the Amazon Web Services account
|
7697
|
-
# Currently, you use the ID for the Amazon Web Services account
|
7789
|
+
# The ID for the Amazon Web Services account that the group is in.
|
7790
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
7698
7791
|
# contains your Amazon QuickSight account.
|
7699
7792
|
#
|
7700
7793
|
# @option params [required, String] :namespace
|
@@ -7733,17 +7826,17 @@ module Aws::QuickSight
|
|
7733
7826
|
req.send_request(options)
|
7734
7827
|
end
|
7735
7828
|
|
7736
|
-
# Updates an existing
|
7829
|
+
# Updates an existing IAMpolicy assignment. This operation updates only
|
7737
7830
|
# the optional parameter or parameters that are specified in the
|
7738
7831
|
# request. This overwrites all of the users included in `Identities`.
|
7739
7832
|
#
|
7740
7833
|
# @option params [required, String] :aws_account_id
|
7741
|
-
# The ID of the Amazon Web Services account
|
7742
|
-
#
|
7834
|
+
# The ID of the Amazon Web Services account that contains the IAMpolicy
|
7835
|
+
# assignment.
|
7743
7836
|
#
|
7744
7837
|
# @option params [required, String] :assignment_name
|
7745
7838
|
# The name of the assignment, also called a rule. This name must be
|
7746
|
-
# unique within an Amazon Web Services account
|
7839
|
+
# unique within an Amazon Web Services account.
|
7747
7840
|
#
|
7748
7841
|
# @option params [required, String] :namespace
|
7749
7842
|
# The namespace of the assignment.
|
@@ -7761,12 +7854,12 @@ module Aws::QuickSight
|
|
7761
7854
|
# when creating the data source.
|
7762
7855
|
#
|
7763
7856
|
# @option params [String] :policy_arn
|
7764
|
-
# The ARN for the
|
7765
|
-
# specified in this assignment.
|
7857
|
+
# The ARN for the IAMpolicy to apply to the Amazon QuickSight users and
|
7858
|
+
# groups specified in this assignment.
|
7766
7859
|
#
|
7767
7860
|
# @option params [Hash<String,Array>] :identities
|
7768
|
-
# The QuickSight users, groups, or both that you want to assign
|
7769
|
-
# policy to.
|
7861
|
+
# The Amazon QuickSight users, groups, or both that you want to assign
|
7862
|
+
# the policy to.
|
7770
7863
|
#
|
7771
7864
|
# @return [Types::UpdateIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7772
7865
|
#
|
@@ -7812,11 +7905,53 @@ module Aws::QuickSight
|
|
7812
7905
|
req.send_request(options)
|
7813
7906
|
end
|
7814
7907
|
|
7908
|
+
# Updates content and status of IP Rules.
|
7909
|
+
#
|
7910
|
+
# @option params [required, String] :aws_account_id
|
7911
|
+
# Your AWS account ID.
|
7912
|
+
#
|
7913
|
+
# @option params [Hash<String,String>] :ip_restriction_rule_map
|
7914
|
+
# Describes updated IP rules.
|
7915
|
+
#
|
7916
|
+
# @option params [Boolean] :enabled
|
7917
|
+
# Whether or not IP rules are enabled.
|
7918
|
+
#
|
7919
|
+
# @return [Types::UpdateIpRestrictionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7920
|
+
#
|
7921
|
+
# * {Types::UpdateIpRestrictionResponse#aws_account_id #aws_account_id} => String
|
7922
|
+
# * {Types::UpdateIpRestrictionResponse#request_id #request_id} => String
|
7923
|
+
# * {Types::UpdateIpRestrictionResponse#status #status} => Integer
|
7924
|
+
#
|
7925
|
+
# @example Request syntax with placeholder values
|
7926
|
+
#
|
7927
|
+
# resp = client.update_ip_restriction({
|
7928
|
+
# aws_account_id: "AwsAccountId", # required
|
7929
|
+
# ip_restriction_rule_map: {
|
7930
|
+
# "CIDR" => "IpRestrictionRuleDescription",
|
7931
|
+
# },
|
7932
|
+
# enabled: false,
|
7933
|
+
# })
|
7934
|
+
#
|
7935
|
+
# @example Response structure
|
7936
|
+
#
|
7937
|
+
# resp.aws_account_id #=> String
|
7938
|
+
# resp.request_id #=> String
|
7939
|
+
# resp.status #=> Integer
|
7940
|
+
#
|
7941
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIpRestriction AWS API Documentation
|
7942
|
+
#
|
7943
|
+
# @overload update_ip_restriction(params = {})
|
7944
|
+
# @param [Hash] params ({})
|
7945
|
+
def update_ip_restriction(params = {}, options = {})
|
7946
|
+
req = build_request(:update_ip_restriction, params)
|
7947
|
+
req.send_request(options)
|
7948
|
+
end
|
7949
|
+
|
7815
7950
|
# Updates a template from an existing Amazon QuickSight analysis or
|
7816
7951
|
# another template.
|
7817
7952
|
#
|
7818
7953
|
# @option params [required, String] :aws_account_id
|
7819
|
-
# The ID of the Amazon Web Services account
|
7954
|
+
# The ID of the Amazon Web Services account that contains the template
|
7820
7955
|
# that you're updating.
|
7821
7956
|
#
|
7822
7957
|
# @option params [required, String] :template_id
|
@@ -7829,8 +7964,8 @@ module Aws::QuickSight
|
|
7829
7964
|
# for an analysis. Both of these require an Amazon Resource Name (ARN).
|
7830
7965
|
# For `SourceTemplate`, specify the ARN of the source template. For
|
7831
7966
|
# `SourceAnalysis`, specify the ARN of the source analysis. The
|
7832
|
-
# `SourceTemplate` ARN can contain any Amazon Web Services account
|
7833
|
-
# any QuickSight-supported Amazon Web Services Region;.
|
7967
|
+
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
7968
|
+
# any Amazon QuickSight-supported Amazon Web Services Region;.
|
7834
7969
|
#
|
7835
7970
|
# Use the `DataSetReferences` entity within `SourceTemplate` or
|
7836
7971
|
# `SourceAnalysis` to list the replacement datasets for the placeholders
|
@@ -7899,7 +8034,7 @@ module Aws::QuickSight
|
|
7899
8034
|
# Updates the template alias of a template.
|
7900
8035
|
#
|
7901
8036
|
# @option params [required, String] :aws_account_id
|
7902
|
-
# The ID of the Amazon Web Services account
|
8037
|
+
# The ID of the Amazon Web Services account that contains the template
|
7903
8038
|
# alias that you're updating.
|
7904
8039
|
#
|
7905
8040
|
# @option params [required, String] :template_id
|
@@ -7950,7 +8085,7 @@ module Aws::QuickSight
|
|
7950
8085
|
# Updates the resource permissions for a template.
|
7951
8086
|
#
|
7952
8087
|
# @option params [required, String] :aws_account_id
|
7953
|
-
# The ID of the Amazon Web Services account
|
8088
|
+
# The ID of the Amazon Web Services account that contains the template.
|
7954
8089
|
#
|
7955
8090
|
# @option params [required, String] :template_id
|
7956
8091
|
# The ID for the template.
|
@@ -8011,8 +8146,8 @@ module Aws::QuickSight
|
|
8011
8146
|
# Updates a theme.
|
8012
8147
|
#
|
8013
8148
|
# @option params [required, String] :aws_account_id
|
8014
|
-
# The ID of the Amazon Web Services account
|
8015
|
-
#
|
8149
|
+
# The ID of the Amazon Web Services account that contains the theme that
|
8150
|
+
# you're updating.
|
8016
8151
|
#
|
8017
8152
|
# @option params [required, String] :theme_id
|
8018
8153
|
# The ID for the theme.
|
@@ -8114,7 +8249,7 @@ module Aws::QuickSight
|
|
8114
8249
|
# Updates an alias of a theme.
|
8115
8250
|
#
|
8116
8251
|
# @option params [required, String] :aws_account_id
|
8117
|
-
# The ID of the Amazon Web Services account
|
8252
|
+
# The ID of the Amazon Web Services account that contains the theme
|
8118
8253
|
# alias that you're updating.
|
8119
8254
|
#
|
8120
8255
|
# @option params [required, String] :theme_id
|
@@ -8203,7 +8338,7 @@ module Aws::QuickSight
|
|
8203
8338
|
# * To specify no permissions, omit the permissions list.
|
8204
8339
|
#
|
8205
8340
|
# @option params [required, String] :aws_account_id
|
8206
|
-
# The ID of the Amazon Web Services account
|
8341
|
+
# The ID of the Amazon Web Services account that contains the theme.
|
8207
8342
|
#
|
8208
8343
|
# @option params [required, String] :theme_id
|
8209
8344
|
# The ID for the theme.
|
@@ -8267,8 +8402,8 @@ module Aws::QuickSight
|
|
8267
8402
|
# The Amazon QuickSight user name that you want to update.
|
8268
8403
|
#
|
8269
8404
|
# @option params [required, String] :aws_account_id
|
8270
|
-
# The ID for the Amazon Web Services account
|
8271
|
-
# Currently, you use the ID for the Amazon Web Services account
|
8405
|
+
# The ID for the Amazon Web Services account that the user is in.
|
8406
|
+
# Currently, you use the ID for the Amazon Web Services account that
|
8272
8407
|
# contains your Amazon QuickSight account.
|
8273
8408
|
#
|
8274
8409
|
# @option params [required, String] :namespace
|
@@ -8289,8 +8424,8 @@ module Aws::QuickSight
|
|
8289
8424
|
# * `ADMIN`\: A user who is an author, who can also manage Amazon
|
8290
8425
|
# QuickSight settings.
|
8291
8426
|
#
|
8292
|
-
# The name of the QuickSight role is invisible to the user except
|
8293
|
-
# the console screens dealing with permissions.
|
8427
|
+
# The name of the Amazon QuickSight role is invisible to the user except
|
8428
|
+
# for the console screens dealing with permissions.
|
8294
8429
|
#
|
8295
8430
|
# @option params [String] :custom_permissions_name
|
8296
8431
|
# (Enterprise edition only) The name of the custom permissions profile
|
@@ -8308,16 +8443,16 @@ module Aws::QuickSight
|
|
8308
8443
|
#
|
8309
8444
|
# A set of custom permissions includes any combination of these
|
8310
8445
|
# restrictions. Currently, you need to create the profile names for
|
8311
|
-
# custom permission sets by using the QuickSight console. Then,
|
8312
|
-
# the `RegisterUser` API operation to assign the named set of
|
8313
|
-
# permissions to a QuickSight user.
|
8446
|
+
# custom permission sets by using the Amazon QuickSight console. Then,
|
8447
|
+
# you use the `RegisterUser` API operation to assign the named set of
|
8448
|
+
# permissions to a Amazon QuickSight user.
|
8314
8449
|
#
|
8315
|
-
# QuickSight custom permissions are applied through
|
8450
|
+
# Amazon QuickSight custom permissions are applied through IAMpolicies.
|
8316
8451
|
# Therefore, they override the permissions typically granted by
|
8317
|
-
# assigning QuickSight users to one of the default security
|
8318
|
-
# QuickSight (admin, author, reader).
|
8452
|
+
# assigning Amazon QuickSight users to one of the default security
|
8453
|
+
# cohorts in Amazon QuickSight (admin, author, reader).
|
8319
8454
|
#
|
8320
|
-
# This feature is available only to QuickSight Enterprise edition
|
8455
|
+
# This feature is available only to Amazon QuickSight Enterprise edition
|
8321
8456
|
# subscriptions.
|
8322
8457
|
#
|
8323
8458
|
# @option params [Boolean] :unapply_custom_permissions
|
@@ -8329,9 +8464,9 @@ module Aws::QuickSight
|
|
8329
8464
|
#
|
8330
8465
|
# @option params [String] :external_login_federation_provider_type
|
8331
8466
|
# The type of supported external login provider that provides identity
|
8332
|
-
# to let a user federate into QuickSight with an associated
|
8333
|
-
# and Access Management
|
8334
|
-
# provider can be one of the following.
|
8467
|
+
# to let a user federate into Amazon QuickSight with an associated
|
8468
|
+
# Identity and Access Management(IAM) role. The type of supported
|
8469
|
+
# external login provider can be one of the following.
|
8335
8470
|
#
|
8336
8471
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
8337
8472
|
# cognito-identity.amazonaws.com. When choosing the `COGNITO` provider
|
@@ -8348,10 +8483,10 @@ module Aws::QuickSight
|
|
8348
8483
|
#
|
8349
8484
|
# @option params [String] :custom_federation_provider_url
|
8350
8485
|
# The URL of the custom OpenID Connect (OIDC) provider that provides
|
8351
|
-
# identity to let a user federate into QuickSight with an
|
8352
|
-
# Identity and Access Management
|
8353
|
-
# be used when `ExternalLoginFederationProviderType`
|
8354
|
-
# `CUSTOM_OIDC`.
|
8486
|
+
# identity to let a user federate into Amazon QuickSight with an
|
8487
|
+
# associated Identity and Access Management(IAM) role. This parameter
|
8488
|
+
# should only be used when `ExternalLoginFederationProviderType`
|
8489
|
+
# parameter is set to `CUSTOM_OIDC`.
|
8355
8490
|
#
|
8356
8491
|
# @option params [String] :external_login_id
|
8357
8492
|
# The identity ID for a user in the external login provider.
|
@@ -8415,7 +8550,7 @@ module Aws::QuickSight
|
|
8415
8550
|
params: params,
|
8416
8551
|
config: config)
|
8417
8552
|
context[:gem_name] = 'aws-sdk-quicksight'
|
8418
|
-
context[:gem_version] = '1.
|
8553
|
+
context[:gem_version] = '1.55.0'
|
8419
8554
|
Seahorse::Client::Request.new(handlers, context)
|
8420
8555
|
end
|
8421
8556
|
|