aws-sdk-quicksight 1.57.0 → 1.58.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-quicksight/client.rb +162 -98
- data/lib/aws-sdk-quicksight/client_api.rb +21 -0
- data/lib/aws-sdk-quicksight/types.rb +333 -198
- data/lib/aws-sdk-quicksight.rb +1 -1
- metadata +2 -2
@@ -33,24 +33,30 @@ module Aws::QuickSight
|
|
33
33
|
end
|
34
34
|
|
35
35
|
# The Amazon QuickSight customizations associated with your Amazon Web
|
36
|
-
# Services account or a
|
37
|
-
#
|
36
|
+
# Services account or a QuickSight namespace in a specific Amazon Web
|
37
|
+
# Services Region.
|
38
38
|
#
|
39
39
|
# @note When making an API call, you may pass AccountCustomization
|
40
40
|
# data as a hash:
|
41
41
|
#
|
42
42
|
# {
|
43
43
|
# default_theme: "Arn",
|
44
|
+
# default_email_customization_template: "Arn",
|
44
45
|
# }
|
45
46
|
#
|
46
47
|
# @!attribute [rw] default_theme
|
47
48
|
# The default theme for this Amazon QuickSight subscription.
|
48
49
|
# @return [String]
|
49
50
|
#
|
51
|
+
# @!attribute [rw] default_email_customization_template
|
52
|
+
# The default email customization template.
|
53
|
+
# @return [String]
|
54
|
+
#
|
50
55
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountCustomization AWS API Documentation
|
51
56
|
#
|
52
57
|
class AccountCustomization < Struct.new(
|
53
|
-
:default_theme
|
58
|
+
:default_theme,
|
59
|
+
:default_email_customization_template)
|
54
60
|
SENSITIVE = []
|
55
61
|
include Aws::Structure
|
56
62
|
end
|
@@ -93,7 +99,7 @@ module Aws::QuickSight
|
|
93
99
|
# The active Identity and Access Management (IAM) policy assignment.
|
94
100
|
#
|
95
101
|
# @!attribute [rw] assignment_name
|
96
|
-
# A name for the
|
102
|
+
# A name for the IAM policy assignment.
|
97
103
|
# @return [String]
|
98
104
|
#
|
99
105
|
# @!attribute [rw] policy_arn
|
@@ -151,6 +157,8 @@ module Aws::QuickSight
|
|
151
157
|
include Aws::Structure
|
152
158
|
end
|
153
159
|
|
160
|
+
# The parameters for OpenSearch.
|
161
|
+
#
|
154
162
|
# @note When making an API call, you may pass AmazonOpenSearchParameters
|
155
163
|
# data as a hash:
|
156
164
|
#
|
@@ -159,6 +167,7 @@ module Aws::QuickSight
|
|
159
167
|
# }
|
160
168
|
#
|
161
169
|
# @!attribute [rw] domain
|
170
|
+
# The OpenSearch domain.
|
162
171
|
# @return [String]
|
163
172
|
#
|
164
173
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonOpenSearchParameters AWS API Documentation
|
@@ -415,7 +424,7 @@ module Aws::QuickSight
|
|
415
424
|
end
|
416
425
|
|
417
426
|
# The type of experience you want to embed. For anonymous users, you can
|
418
|
-
# embed
|
427
|
+
# embed Amazon QuickSight dashboards.
|
419
428
|
#
|
420
429
|
# @note When making an API call, you may pass AnonymousUserEmbeddingExperienceConfiguration
|
421
430
|
# data as a hash:
|
@@ -427,8 +436,8 @@ module Aws::QuickSight
|
|
427
436
|
# }
|
428
437
|
#
|
429
438
|
# @!attribute [rw] dashboard
|
430
|
-
# The type of embedding experience. In this case,
|
431
|
-
#
|
439
|
+
# The type of embedding experience. In this case, Amazon QuickSight
|
440
|
+
# dashboards.
|
432
441
|
# @return [Types::AnonymousUserDashboardEmbeddingConfiguration]
|
433
442
|
#
|
434
443
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnonymousUserEmbeddingExperienceConfiguration AWS API Documentation
|
@@ -835,7 +844,7 @@ module Aws::QuickSight
|
|
835
844
|
include Aws::Structure
|
836
845
|
end
|
837
846
|
|
838
|
-
# A tag for a column in a TagColumnOperation structure. This is a
|
847
|
+
# A tag for a column in a ` TagColumnOperation ` structure. This is a
|
839
848
|
# variant type structure. For this structure to be valid, only one of
|
840
849
|
# the attributes can be non-null.
|
841
850
|
#
|
@@ -910,6 +919,7 @@ module Aws::QuickSight
|
|
910
919
|
# namespace: "Namespace",
|
911
920
|
# account_customization: { # required
|
912
921
|
# default_theme: "Arn",
|
922
|
+
# default_email_customization_template: "Arn",
|
913
923
|
# },
|
914
924
|
# tags: [
|
915
925
|
# {
|
@@ -932,7 +942,7 @@ module Aws::QuickSight
|
|
932
942
|
# @!attribute [rw] account_customization
|
933
943
|
# The Amazon QuickSight customizations you're adding in the current
|
934
944
|
# Amazon Web Services Region. You can add these to an Amazon Web
|
935
|
-
# Services account and a
|
945
|
+
# Services account and a QuickSight namespace.
|
936
946
|
#
|
937
947
|
# For example, you can add a default theme by setting
|
938
948
|
# `AccountCustomization` to the midnight theme:
|
@@ -1258,7 +1268,7 @@ module Aws::QuickSight
|
|
1258
1268
|
# @return [String]
|
1259
1269
|
#
|
1260
1270
|
# @!attribute [rw] dashboard_id
|
1261
|
-
# The ID for the dashboard, also added to the
|
1271
|
+
# The ID for the dashboard, also added to the IAM policy.
|
1262
1272
|
# @return [String]
|
1263
1273
|
#
|
1264
1274
|
# @!attribute [rw] name
|
@@ -1274,7 +1284,7 @@ module Aws::QuickSight
|
|
1274
1284
|
# @!attribute [rw] permissions
|
1275
1285
|
# A structure that contains the permissions of the dashboard. You can
|
1276
1286
|
# use this structure for granting permissions by providing a list of
|
1277
|
-
#
|
1287
|
+
# IAM action information for each principal ARN.
|
1278
1288
|
#
|
1279
1289
|
# To specify no permissions, omit the permissions list.
|
1280
1290
|
# @return [Array<Types::ResourcePermission>]
|
@@ -1285,8 +1295,8 @@ module Aws::QuickSight
|
|
1285
1295
|
# using as source. You can only create a dashboard from a template, so
|
1286
1296
|
# you use a `SourceTemplate` entity. If you need to create a dashboard
|
1287
1297
|
# from an analysis, first convert the analysis to a template by using
|
1288
|
-
# the CreateTemplate API operation. For `SourceTemplate`, specify
|
1289
|
-
# Amazon Resource Name (ARN) of the source template. The
|
1298
|
+
# the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
|
1299
|
+
# the Amazon Resource Name (ARN) of the source template. The
|
1290
1300
|
# `SourceTemplate`ARN can contain any Amazon Web Services account and
|
1291
1301
|
# any Amazon QuickSight-supported Amazon Web Services Region.
|
1292
1302
|
#
|
@@ -1691,7 +1701,7 @@ module Aws::QuickSight
|
|
1691
1701
|
# aws_account_id: "AwsAccountId", # required
|
1692
1702
|
# data_source_id: "ResourceId", # required
|
1693
1703
|
# name: "ResourceName", # required
|
1694
|
-
# 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
|
1704
|
+
# 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, EXASOL
|
1695
1705
|
# data_source_parameters: {
|
1696
1706
|
# amazon_elasticsearch_parameters: {
|
1697
1707
|
# domain: "Domain", # required
|
@@ -1785,6 +1795,10 @@ module Aws::QuickSight
|
|
1785
1795
|
# amazon_open_search_parameters: {
|
1786
1796
|
# domain: "Domain", # required
|
1787
1797
|
# },
|
1798
|
+
# exasol_parameters: {
|
1799
|
+
# host: "Host", # required
|
1800
|
+
# port: 1, # required
|
1801
|
+
# },
|
1788
1802
|
# },
|
1789
1803
|
# credentials: {
|
1790
1804
|
# credential_pair: {
|
@@ -1884,6 +1898,10 @@ module Aws::QuickSight
|
|
1884
1898
|
# amazon_open_search_parameters: {
|
1885
1899
|
# domain: "Domain", # required
|
1886
1900
|
# },
|
1901
|
+
# exasol_parameters: {
|
1902
|
+
# host: "Host", # required
|
1903
|
+
# port: 1, # required
|
1904
|
+
# },
|
1887
1905
|
# },
|
1888
1906
|
# ],
|
1889
1907
|
# },
|
@@ -2020,11 +2038,11 @@ module Aws::QuickSight
|
|
2020
2038
|
# }
|
2021
2039
|
#
|
2022
2040
|
# @!attribute [rw] aws_account_id
|
2023
|
-
# The
|
2041
|
+
# The ID for the Amazon Web Services account that contains the folder.
|
2024
2042
|
# @return [String]
|
2025
2043
|
#
|
2026
2044
|
# @!attribute [rw] folder_id
|
2027
|
-
# The folder
|
2045
|
+
# The ID of the folder.
|
2028
2046
|
# @return [String]
|
2029
2047
|
#
|
2030
2048
|
# @!attribute [rw] member_id
|
@@ -2048,8 +2066,7 @@ module Aws::QuickSight
|
|
2048
2066
|
end
|
2049
2067
|
|
2050
2068
|
# @!attribute [rw] status
|
2051
|
-
# The status of the
|
2052
|
-
# `SC_OK (200)`.
|
2069
|
+
# The HTTP status of the request.
|
2053
2070
|
# @return [Integer]
|
2054
2071
|
#
|
2055
2072
|
# @!attribute [rw] folder_member
|
@@ -2057,7 +2074,7 @@ module Aws::QuickSight
|
|
2057
2074
|
# @return [Types::FolderMember]
|
2058
2075
|
#
|
2059
2076
|
# @!attribute [rw] request_id
|
2060
|
-
# The request ID.
|
2077
|
+
# The Amazon Web Services request ID for this operation.
|
2061
2078
|
# @return [String]
|
2062
2079
|
#
|
2063
2080
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderMembershipResponse AWS API Documentation
|
@@ -2094,11 +2111,12 @@ module Aws::QuickSight
|
|
2094
2111
|
# }
|
2095
2112
|
#
|
2096
2113
|
# @!attribute [rw] aws_account_id
|
2097
|
-
# The
|
2114
|
+
# The ID for the Amazon Web Services account where you want to create
|
2115
|
+
# the folder.
|
2098
2116
|
# @return [String]
|
2099
2117
|
#
|
2100
2118
|
# @!attribute [rw] folder_id
|
2101
|
-
# The folder
|
2119
|
+
# The ID of the folder.
|
2102
2120
|
# @return [String]
|
2103
2121
|
#
|
2104
2122
|
# @!attribute [rw] name
|
@@ -2142,8 +2160,7 @@ module Aws::QuickSight
|
|
2142
2160
|
end
|
2143
2161
|
|
2144
2162
|
# @!attribute [rw] status
|
2145
|
-
# The status of the
|
2146
|
-
# `SC_OK (200)`.
|
2163
|
+
# The HTTP status of the request.
|
2147
2164
|
# @return [Integer]
|
2148
2165
|
#
|
2149
2166
|
# @!attribute [rw] arn
|
@@ -2311,7 +2328,7 @@ module Aws::QuickSight
|
|
2311
2328
|
#
|
2312
2329
|
# @!attribute [rw] aws_account_id
|
2313
2330
|
# The ID of the Amazon Web Services account where you want to assign
|
2314
|
-
# an
|
2331
|
+
# an IAM policy to Amazon QuickSight users or groups.
|
2315
2332
|
# @return [String]
|
2316
2333
|
#
|
2317
2334
|
# @!attribute [rw] assignment_name
|
@@ -2333,7 +2350,7 @@ module Aws::QuickSight
|
|
2333
2350
|
# @return [String]
|
2334
2351
|
#
|
2335
2352
|
# @!attribute [rw] policy_arn
|
2336
|
-
# The ARN for the
|
2353
|
+
# The ARN for the IAM policy to apply to the Amazon QuickSight users
|
2337
2354
|
# and groups specified in this assignment.
|
2338
2355
|
# @return [String]
|
2339
2356
|
#
|
@@ -2382,12 +2399,12 @@ module Aws::QuickSight
|
|
2382
2399
|
# @return [String]
|
2383
2400
|
#
|
2384
2401
|
# @!attribute [rw] policy_arn
|
2385
|
-
# The ARN for the
|
2402
|
+
# The ARN for the IAM policy that is applied to the Amazon QuickSight
|
2386
2403
|
# users and groups specified in this assignment.
|
2387
2404
|
# @return [String]
|
2388
2405
|
#
|
2389
2406
|
# @!attribute [rw] identities
|
2390
|
-
# The Amazon QuickSight users, groups, or both that the
|
2407
|
+
# The Amazon QuickSight users, groups, or both that the IAM policy is
|
2391
2408
|
# assigned to.
|
2392
2409
|
# @return [Hash<String,Array<String>>]
|
2393
2410
|
#
|
@@ -2918,7 +2935,7 @@ module Aws::QuickSight
|
|
2918
2935
|
# The ID of the theme that a custom theme will inherit from. All
|
2919
2936
|
# themes inherit from one of the starting themes defined by Amazon
|
2920
2937
|
# QuickSight. For a list of the starting themes, use `ListThemes` or
|
2921
|
-
# choose **Themes** from within
|
2938
|
+
# choose **Themes** from within an analysis.
|
2922
2939
|
# @return [String]
|
2923
2940
|
#
|
2924
2941
|
# @!attribute [rw] version_description
|
@@ -3097,6 +3114,10 @@ module Aws::QuickSight
|
|
3097
3114
|
# amazon_open_search_parameters: {
|
3098
3115
|
# domain: "Domain", # required
|
3099
3116
|
# },
|
3117
|
+
# exasol_parameters: {
|
3118
|
+
# host: "Host", # required
|
3119
|
+
# port: 1, # required
|
3120
|
+
# },
|
3100
3121
|
# },
|
3101
3122
|
# ],
|
3102
3123
|
# }
|
@@ -3997,6 +4018,10 @@ module Aws::QuickSight
|
|
3997
4018
|
# amazon_open_search_parameters: {
|
3998
4019
|
# domain: "Domain", # required
|
3999
4020
|
# },
|
4021
|
+
# exasol_parameters: {
|
4022
|
+
# host: "Host", # required
|
4023
|
+
# port: 1, # required
|
4024
|
+
# },
|
4000
4025
|
# },
|
4001
4026
|
# ],
|
4002
4027
|
# },
|
@@ -4004,7 +4029,7 @@ module Aws::QuickSight
|
|
4004
4029
|
# }
|
4005
4030
|
#
|
4006
4031
|
# @!attribute [rw] credential_pair
|
4007
|
-
# Credential pair. For more information, see CredentialPair
|
4032
|
+
# Credential pair. For more information, see ` CredentialPair `.
|
4008
4033
|
# @return [Types::CredentialPair]
|
4009
4034
|
#
|
4010
4035
|
# @!attribute [rw] copy_source_arn
|
@@ -4142,6 +4167,10 @@ module Aws::QuickSight
|
|
4142
4167
|
# amazon_open_search_parameters: {
|
4143
4168
|
# domain: "Domain", # required
|
4144
4169
|
# },
|
4170
|
+
# exasol_parameters: {
|
4171
|
+
# host: "Host", # required
|
4172
|
+
# port: 1, # required
|
4173
|
+
# },
|
4145
4174
|
# }
|
4146
4175
|
#
|
4147
4176
|
# @!attribute [rw] amazon_elasticsearch_parameters
|
@@ -4225,8 +4254,13 @@ module Aws::QuickSight
|
|
4225
4254
|
# @return [Types::TwitterParameters]
|
4226
4255
|
#
|
4227
4256
|
# @!attribute [rw] amazon_open_search_parameters
|
4257
|
+
# The parameters for OpenSearch.
|
4228
4258
|
# @return [Types::AmazonOpenSearchParameters]
|
4229
4259
|
#
|
4260
|
+
# @!attribute [rw] exasol_parameters
|
4261
|
+
# The parameters for Exasol.
|
4262
|
+
# @return [Types::ExasolParameters]
|
4263
|
+
#
|
4230
4264
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceParameters AWS API Documentation
|
4231
4265
|
#
|
4232
4266
|
class DataSourceParameters < Struct.new(
|
@@ -4250,7 +4284,8 @@ module Aws::QuickSight
|
|
4250
4284
|
:sql_server_parameters,
|
4251
4285
|
:teradata_parameters,
|
4252
4286
|
:twitter_parameters,
|
4253
|
-
:amazon_open_search_parameters
|
4287
|
+
:amazon_open_search_parameters,
|
4288
|
+
:exasol_parameters)
|
4254
4289
|
SENSITIVE = []
|
4255
4290
|
include Aws::Structure
|
4256
4291
|
end
|
@@ -4610,7 +4645,7 @@ module Aws::QuickSight
|
|
4610
4645
|
# }
|
4611
4646
|
#
|
4612
4647
|
# @!attribute [rw] aws_account_id
|
4613
|
-
# The
|
4648
|
+
# The ID for the Amazon Web Services account that contains the folder.
|
4614
4649
|
# @return [String]
|
4615
4650
|
#
|
4616
4651
|
# @!attribute [rw] folder_id
|
@@ -4639,12 +4674,11 @@ module Aws::QuickSight
|
|
4639
4674
|
end
|
4640
4675
|
|
4641
4676
|
# @!attribute [rw] status
|
4642
|
-
# The status of
|
4643
|
-
# (200)`.
|
4677
|
+
# The HTTP status of the request.
|
4644
4678
|
# @return [Integer]
|
4645
4679
|
#
|
4646
4680
|
# @!attribute [rw] request_id
|
4647
|
-
# The request ID.
|
4681
|
+
# The Amazon Web Services request ID for this operation.
|
4648
4682
|
# @return [String]
|
4649
4683
|
#
|
4650
4684
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderMembershipResponse AWS API Documentation
|
@@ -4665,11 +4699,11 @@ module Aws::QuickSight
|
|
4665
4699
|
# }
|
4666
4700
|
#
|
4667
4701
|
# @!attribute [rw] aws_account_id
|
4668
|
-
# The
|
4702
|
+
# The ID for the Amazon Web Services account that contains the folder.
|
4669
4703
|
# @return [String]
|
4670
4704
|
#
|
4671
4705
|
# @!attribute [rw] folder_id
|
4672
|
-
# The folder
|
4706
|
+
# The ID of the folder.
|
4673
4707
|
# @return [String]
|
4674
4708
|
#
|
4675
4709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderRequest AWS API Documentation
|
@@ -4682,8 +4716,7 @@ module Aws::QuickSight
|
|
4682
4716
|
end
|
4683
4717
|
|
4684
4718
|
# @!attribute [rw] status
|
4685
|
-
# The status of
|
4686
|
-
# `SC_OK (200)`.
|
4719
|
+
# The HTTP status of the request.
|
4687
4720
|
# @return [Integer]
|
4688
4721
|
#
|
4689
4722
|
# @!attribute [rw] arn
|
@@ -4691,11 +4724,11 @@ module Aws::QuickSight
|
|
4691
4724
|
# @return [String]
|
4692
4725
|
#
|
4693
4726
|
# @!attribute [rw] folder_id
|
4694
|
-
# The folder
|
4727
|
+
# The ID of the folder.
|
4695
4728
|
# @return [String]
|
4696
4729
|
#
|
4697
4730
|
# @!attribute [rw] request_id
|
4698
|
-
# The request ID.
|
4731
|
+
# The Amazon Web Services request ID for this operation.
|
4699
4732
|
# @return [String]
|
4700
4733
|
#
|
4701
4734
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderResponse AWS API Documentation
|
@@ -4826,8 +4859,8 @@ module Aws::QuickSight
|
|
4826
4859
|
# }
|
4827
4860
|
#
|
4828
4861
|
# @!attribute [rw] aws_account_id
|
4829
|
-
# The Amazon Web Services account ID where you want to delete the
|
4830
|
-
#
|
4862
|
+
# The Amazon Web Services account ID where you want to delete the IAM
|
4863
|
+
# policy assignment.
|
4831
4864
|
# @return [String]
|
4832
4865
|
#
|
4833
4866
|
# @!attribute [rw] assignment_name
|
@@ -5369,13 +5402,13 @@ module Aws::QuickSight
|
|
5369
5402
|
# The Amazon QuickSight settings for this Amazon Web Services account.
|
5370
5403
|
# This information includes the edition of Amazon Amazon QuickSight
|
5371
5404
|
# that you subscribed to (Standard or Enterprise) and the notification
|
5372
|
-
# email for the Amazon QuickSight subscription. In the
|
5373
|
-
#
|
5374
|
-
#
|
5375
|
-
#
|
5376
|
-
#
|
5377
|
-
#
|
5378
|
-
#
|
5405
|
+
# email for the Amazon QuickSight subscription. In the QuickSight
|
5406
|
+
# console, the Amazon QuickSight subscription is sometimes referred to
|
5407
|
+
# as a QuickSight "account" even though it's technically not an
|
5408
|
+
# account by itself. Instead, it's a subscription to the Amazon
|
5409
|
+
# QuickSight service for your Amazon Web Services account. The edition
|
5410
|
+
# that you subscribe to applies to Amazon QuickSight in every Amazon
|
5411
|
+
# Web Services Region where you use it.
|
5379
5412
|
# @return [Types::AccountSettings]
|
5380
5413
|
#
|
5381
5414
|
# @!attribute [rw] request_id
|
@@ -5523,7 +5556,7 @@ module Aws::QuickSight
|
|
5523
5556
|
# @return [String]
|
5524
5557
|
#
|
5525
5558
|
# @!attribute [rw] dashboard_id
|
5526
|
-
# The ID for the dashboard, also added to the
|
5559
|
+
# The ID for the dashboard, also added to the IAM policy.
|
5527
5560
|
# @return [String]
|
5528
5561
|
#
|
5529
5562
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissionsRequest AWS API Documentation
|
@@ -5555,6 +5588,18 @@ module Aws::QuickSight
|
|
5555
5588
|
# The Amazon Web Services request ID for this operation.
|
5556
5589
|
# @return [String]
|
5557
5590
|
#
|
5591
|
+
# @!attribute [rw] link_sharing_configuration
|
5592
|
+
# A structure that contains the configuration of a shareable link that
|
5593
|
+
# grants access to the dashboard. Your users can use the link to view
|
5594
|
+
# and interact with the dashboard, if the dashboard has been shared
|
5595
|
+
# with them. For more information about sharing dashboards, see
|
5596
|
+
# [Sharing Dashboards][1].
|
5597
|
+
#
|
5598
|
+
#
|
5599
|
+
#
|
5600
|
+
# [1]: https://docs.aws.amazon.com/quicksight/latest/user/sharing-a-dashboard.html
|
5601
|
+
# @return [Types::LinkSharingConfiguration]
|
5602
|
+
#
|
5558
5603
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissionsResponse AWS API Documentation
|
5559
5604
|
#
|
5560
5605
|
class DescribeDashboardPermissionsResponse < Struct.new(
|
@@ -5562,7 +5607,8 @@ module Aws::QuickSight
|
|
5562
5607
|
:dashboard_arn,
|
5563
5608
|
:permissions,
|
5564
5609
|
:status,
|
5565
|
-
:request_id
|
5610
|
+
:request_id,
|
5611
|
+
:link_sharing_configuration)
|
5566
5612
|
SENSITIVE = []
|
5567
5613
|
include Aws::Structure
|
5568
5614
|
end
|
@@ -5851,11 +5897,11 @@ module Aws::QuickSight
|
|
5851
5897
|
# }
|
5852
5898
|
#
|
5853
5899
|
# @!attribute [rw] aws_account_id
|
5854
|
-
# The
|
5900
|
+
# The ID for the Amazon Web Services account that contains the folder.
|
5855
5901
|
# @return [String]
|
5856
5902
|
#
|
5857
5903
|
# @!attribute [rw] folder_id
|
5858
|
-
# The folder
|
5904
|
+
# The ID of the folder.
|
5859
5905
|
# @return [String]
|
5860
5906
|
#
|
5861
5907
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderPermissionsRequest AWS API Documentation
|
@@ -5868,11 +5914,11 @@ module Aws::QuickSight
|
|
5868
5914
|
end
|
5869
5915
|
|
5870
5916
|
# @!attribute [rw] status
|
5871
|
-
# The status
|
5917
|
+
# The HTTP status of the request.
|
5872
5918
|
# @return [Integer]
|
5873
5919
|
#
|
5874
5920
|
# @!attribute [rw] folder_id
|
5875
|
-
# The folder
|
5921
|
+
# The ID of the folder.
|
5876
5922
|
# @return [String]
|
5877
5923
|
#
|
5878
5924
|
# @!attribute [rw] arn
|
@@ -5884,7 +5930,7 @@ module Aws::QuickSight
|
|
5884
5930
|
# @return [Array<Types::ResourcePermission>]
|
5885
5931
|
#
|
5886
5932
|
# @!attribute [rw] request_id
|
5887
|
-
# The request ID.
|
5933
|
+
# The Amazon Web Services request ID for this operation.
|
5888
5934
|
# @return [String]
|
5889
5935
|
#
|
5890
5936
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderPermissionsResponse AWS API Documentation
|
@@ -5908,11 +5954,11 @@ module Aws::QuickSight
|
|
5908
5954
|
# }
|
5909
5955
|
#
|
5910
5956
|
# @!attribute [rw] aws_account_id
|
5911
|
-
# The
|
5957
|
+
# The ID for the Amazon Web Services account that contains the folder.
|
5912
5958
|
# @return [String]
|
5913
5959
|
#
|
5914
5960
|
# @!attribute [rw] folder_id
|
5915
|
-
# The folder
|
5961
|
+
# The ID of the folder.
|
5916
5962
|
# @return [String]
|
5917
5963
|
#
|
5918
5964
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderRequest AWS API Documentation
|
@@ -5933,11 +5979,11 @@ module Aws::QuickSight
|
|
5933
5979
|
# }
|
5934
5980
|
#
|
5935
5981
|
# @!attribute [rw] aws_account_id
|
5936
|
-
# The
|
5982
|
+
# The ID for the Amazon Web Services account that contains the folder.
|
5937
5983
|
# @return [String]
|
5938
5984
|
#
|
5939
5985
|
# @!attribute [rw] folder_id
|
5940
|
-
# The folder
|
5986
|
+
# The ID of the folder.
|
5941
5987
|
# @return [String]
|
5942
5988
|
#
|
5943
5989
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResolvedPermissionsRequest AWS API Documentation
|
@@ -5950,23 +5996,23 @@ module Aws::QuickSight
|
|
5950
5996
|
end
|
5951
5997
|
|
5952
5998
|
# @!attribute [rw] status
|
5953
|
-
# The status
|
5999
|
+
# The HTTP status of the request.
|
5954
6000
|
# @return [Integer]
|
5955
6001
|
#
|
5956
6002
|
# @!attribute [rw] folder_id
|
5957
|
-
# The folder
|
6003
|
+
# The ID of the folder.
|
5958
6004
|
# @return [String]
|
5959
6005
|
#
|
5960
6006
|
# @!attribute [rw] arn
|
5961
|
-
# The Amazon Resource Name (ARN).
|
6007
|
+
# The Amazon Resource Name (ARN) of the folder.
|
5962
6008
|
# @return [String]
|
5963
6009
|
#
|
5964
6010
|
# @!attribute [rw] permissions
|
5965
|
-
# Information about the permissions
|
6011
|
+
# Information about the permissions for the folder.
|
5966
6012
|
# @return [Array<Types::ResourcePermission>]
|
5967
6013
|
#
|
5968
6014
|
# @!attribute [rw] request_id
|
5969
|
-
# The request ID.
|
6015
|
+
# The Amazon Web Services request ID for this operation.
|
5970
6016
|
# @return [String]
|
5971
6017
|
#
|
5972
6018
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResolvedPermissionsResponse AWS API Documentation
|
@@ -5982,7 +6028,7 @@ module Aws::QuickSight
|
|
5982
6028
|
end
|
5983
6029
|
|
5984
6030
|
# @!attribute [rw] status
|
5985
|
-
# The status
|
6031
|
+
# The HTTP status of the request.
|
5986
6032
|
# @return [Integer]
|
5987
6033
|
#
|
5988
6034
|
# @!attribute [rw] folder
|
@@ -5990,7 +6036,7 @@ module Aws::QuickSight
|
|
5990
6036
|
# @return [Types::Folder]
|
5991
6037
|
#
|
5992
6038
|
# @!attribute [rw] request_id
|
5993
|
-
# The request ID.
|
6039
|
+
# The Amazon Web Services request ID for this operation.
|
5994
6040
|
# @return [String]
|
5995
6041
|
#
|
5996
6042
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResponse AWS API Documentation
|
@@ -6091,7 +6137,7 @@ module Aws::QuickSight
|
|
6091
6137
|
end
|
6092
6138
|
|
6093
6139
|
# @!attribute [rw] iam_policy_assignment
|
6094
|
-
# Information describing the
|
6140
|
+
# Information describing the IAM policy assignment.
|
6095
6141
|
# @return [Types::IAMPolicyAssignment]
|
6096
6142
|
#
|
6097
6143
|
# @!attribute [rw] request_id
|
@@ -6173,7 +6219,8 @@ module Aws::QuickSight
|
|
6173
6219
|
# }
|
6174
6220
|
#
|
6175
6221
|
# @!attribute [rw] aws_account_id
|
6176
|
-
#
|
6222
|
+
# The ID of the Amazon Web Services account that contains the IP
|
6223
|
+
# rules.
|
6177
6224
|
# @return [String]
|
6178
6225
|
#
|
6179
6226
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIpRestrictionRequest AWS API Documentation
|
@@ -6185,24 +6232,24 @@ module Aws::QuickSight
|
|
6185
6232
|
end
|
6186
6233
|
|
6187
6234
|
# @!attribute [rw] aws_account_id
|
6188
|
-
#
|
6235
|
+
# The ID of the Amazon Web Services account that contains the IP
|
6236
|
+
# rules.
|
6189
6237
|
# @return [String]
|
6190
6238
|
#
|
6191
6239
|
# @!attribute [rw] ip_restriction_rule_map
|
6192
|
-
#
|
6240
|
+
# A map that describes the IP rules with CIDR range and description.
|
6193
6241
|
# @return [Hash<String,String>]
|
6194
6242
|
#
|
6195
6243
|
# @!attribute [rw] enabled
|
6196
|
-
#
|
6244
|
+
# A value that specifies whether IP rules are turned on.
|
6197
6245
|
# @return [Boolean]
|
6198
6246
|
#
|
6199
6247
|
# @!attribute [rw] request_id
|
6200
|
-
# The ID
|
6248
|
+
# The Amazon Web Services request ID for this operation.
|
6201
6249
|
# @return [String]
|
6202
6250
|
#
|
6203
6251
|
# @!attribute [rw] status
|
6204
|
-
# The status of
|
6205
|
-
# a 200 status code.
|
6252
|
+
# The HTTP status of the request.
|
6206
6253
|
# @return [Integer]
|
6207
6254
|
#
|
6208
6255
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIpRestrictionResponse AWS API Documentation
|
@@ -6724,6 +6771,33 @@ module Aws::QuickSight
|
|
6724
6771
|
include Aws::Structure
|
6725
6772
|
end
|
6726
6773
|
|
6774
|
+
# The required parameters for connecting to an Exasol data source.
|
6775
|
+
#
|
6776
|
+
# @note When making an API call, you may pass ExasolParameters
|
6777
|
+
# data as a hash:
|
6778
|
+
#
|
6779
|
+
# {
|
6780
|
+
# host: "Host", # required
|
6781
|
+
# port: 1, # required
|
6782
|
+
# }
|
6783
|
+
#
|
6784
|
+
# @!attribute [rw] host
|
6785
|
+
# The hostname or IP address of the Exasol data source.
|
6786
|
+
# @return [String]
|
6787
|
+
#
|
6788
|
+
# @!attribute [rw] port
|
6789
|
+
# The port for the Exasol data source.
|
6790
|
+
# @return [Integer]
|
6791
|
+
#
|
6792
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ExasolParameters AWS API Documentation
|
6793
|
+
#
|
6794
|
+
class ExasolParameters < Struct.new(
|
6795
|
+
:host,
|
6796
|
+
:port)
|
6797
|
+
SENSITIVE = []
|
6798
|
+
include Aws::Structure
|
6799
|
+
end
|
6800
|
+
|
6727
6801
|
# Export to .csv option.
|
6728
6802
|
#
|
6729
6803
|
# @note When making an API call, you may pass ExportToCSVOption
|
@@ -6795,14 +6869,14 @@ module Aws::QuickSight
|
|
6795
6869
|
include Aws::Structure
|
6796
6870
|
end
|
6797
6871
|
|
6798
|
-
# A folder.
|
6872
|
+
# A folder in Amazon QuickSight.
|
6799
6873
|
#
|
6800
6874
|
# @!attribute [rw] folder_id
|
6801
|
-
# The folder
|
6875
|
+
# The ID of the folder.
|
6802
6876
|
# @return [String]
|
6803
6877
|
#
|
6804
6878
|
# @!attribute [rw] arn
|
6805
|
-
# The
|
6879
|
+
# The Amazon Resource Name (ARN) for the folder.
|
6806
6880
|
# @return [String]
|
6807
6881
|
#
|
6808
6882
|
# @!attribute [rw] name
|
@@ -6810,11 +6884,11 @@ module Aws::QuickSight
|
|
6810
6884
|
# @return [String]
|
6811
6885
|
#
|
6812
6886
|
# @!attribute [rw] folder_type
|
6813
|
-
# The type of
|
6887
|
+
# The type of folder it is.
|
6814
6888
|
# @return [String]
|
6815
6889
|
#
|
6816
6890
|
# @!attribute [rw] folder_path
|
6817
|
-
# An array of ancestor
|
6891
|
+
# An array of ancestor ARN strings for the folder.
|
6818
6892
|
# @return [Array<String>]
|
6819
6893
|
#
|
6820
6894
|
# @!attribute [rw] created_time
|
@@ -6839,14 +6913,15 @@ module Aws::QuickSight
|
|
6839
6913
|
include Aws::Structure
|
6840
6914
|
end
|
6841
6915
|
|
6842
|
-
# An asset in a folder, such as a dashboard, analysis,
|
6916
|
+
# An asset in a Amazon QuickSight folder, such as a dashboard, analysis,
|
6917
|
+
# or dataset.
|
6843
6918
|
#
|
6844
6919
|
# @!attribute [rw] member_id
|
6845
|
-
# The ID of the
|
6920
|
+
# The ID of an asset in the folder.
|
6846
6921
|
# @return [String]
|
6847
6922
|
#
|
6848
6923
|
# @!attribute [rw] member_type
|
6849
|
-
# The type of
|
6924
|
+
# The type of asset that it is.
|
6850
6925
|
# @return [String]
|
6851
6926
|
#
|
6852
6927
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FolderMember AWS API Documentation
|
@@ -6858,7 +6933,7 @@ module Aws::QuickSight
|
|
6858
6933
|
include Aws::Structure
|
6859
6934
|
end
|
6860
6935
|
|
6861
|
-
#
|
6936
|
+
# A filter to use to search a Amazon QuickSight folder.
|
6862
6937
|
#
|
6863
6938
|
# @note When making an API call, you may pass FolderSearchFilter
|
6864
6939
|
# data as a hash:
|
@@ -6870,12 +6945,12 @@ module Aws::QuickSight
|
|
6870
6945
|
# }
|
6871
6946
|
#
|
6872
6947
|
# @!attribute [rw] operator
|
6873
|
-
# The comparison operator that you want to use
|
6948
|
+
# The comparison operator that you want to use in the filter. For
|
6874
6949
|
# example, `"Operator": "StringEquals"`.
|
6875
6950
|
# @return [String]
|
6876
6951
|
#
|
6877
6952
|
# @!attribute [rw] name
|
6878
|
-
# The name of
|
6953
|
+
# The name of a value that you want to use in the filter. For example,
|
6879
6954
|
# `"Name": "PARENT_FOLDER_ARN"`.
|
6880
6955
|
# @return [String]
|
6881
6956
|
#
|
@@ -6895,14 +6970,14 @@ module Aws::QuickSight
|
|
6895
6970
|
include Aws::Structure
|
6896
6971
|
end
|
6897
6972
|
|
6898
|
-
# A summary of
|
6973
|
+
# A summary of information about an existing Amazon QuickSight folder.
|
6899
6974
|
#
|
6900
6975
|
# @!attribute [rw] arn
|
6901
|
-
# The Amazon Resource Name (ARN).
|
6976
|
+
# The Amazon Resource Name (ARN) of the folder.
|
6902
6977
|
# @return [String]
|
6903
6978
|
#
|
6904
6979
|
# @!attribute [rw] folder_id
|
6905
|
-
# The folder
|
6980
|
+
# The ID of the folder.
|
6906
6981
|
# @return [String]
|
6907
6982
|
#
|
6908
6983
|
# @!attribute [rw] name
|
@@ -7069,8 +7144,8 @@ module Aws::QuickSight
|
|
7069
7144
|
#
|
7070
7145
|
# @!attribute [rw] experience_configuration
|
7071
7146
|
# The experience you are embedding. For registered users, you can
|
7072
|
-
# embed Amazon QuickSight dashboards
|
7073
|
-
# console
|
7147
|
+
# embed Amazon QuickSight dashboards or the entire Amazon QuickSight
|
7148
|
+
# console.
|
7074
7149
|
# @return [Types::RegisteredUserEmbeddingExperienceConfiguration]
|
7075
7150
|
#
|
7076
7151
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUserRequest AWS API Documentation
|
@@ -7085,8 +7160,7 @@ module Aws::QuickSight
|
|
7085
7160
|
end
|
7086
7161
|
|
7087
7162
|
# @!attribute [rw] embed_url
|
7088
|
-
# The embed URL for the Amazon QuickSight dashboard
|
7089
|
-
# search bar.
|
7163
|
+
# The embed URL for the Amazon QuickSight dashboard or console.
|
7090
7164
|
# @return [String]
|
7091
7165
|
#
|
7092
7166
|
# @!attribute [rw] status
|
@@ -7206,11 +7280,11 @@ module Aws::QuickSight
|
|
7206
7280
|
#
|
7207
7281
|
# * Invited nonfederated users
|
7208
7282
|
#
|
7209
|
-
# *
|
7210
|
-
# Federated Single Sign-On using SAML, OpenID Connect, or
|
7211
|
-
#
|
7283
|
+
# * IAM users and IAM role-based sessions authenticated through
|
7284
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
7285
|
+
# federation.
|
7212
7286
|
#
|
7213
|
-
# Omit this parameter for users in the third group –
|
7287
|
+
# Omit this parameter for users in the third group – IAM users and IAM
|
7214
7288
|
# role-based sessions.
|
7215
7289
|
# @return [String]
|
7216
7290
|
#
|
@@ -7224,10 +7298,10 @@ module Aws::QuickSight
|
|
7224
7298
|
# A list of one or more dashboard IDs that you want to add to a
|
7225
7299
|
# session that includes anonymous users. The `IdentityType` parameter
|
7226
7300
|
# must be set to `ANONYMOUS` for this to work, because other identity
|
7227
|
-
# types authenticate as Amazon QuickSight or
|
7228
|
-
# you set "`--dashboard-id dash_id1 --dashboard-id dash_id2
|
7229
|
-
# identity-type ANONYMOUS`", the session can access all
|
7230
|
-
# dashboards.
|
7301
|
+
# types authenticate as Amazon QuickSight or IAM users. For example,
|
7302
|
+
# if you set "`--dashboard-id dash_id1 --dashboard-id dash_id2
|
7303
|
+
# dash_id3 identity-type ANONYMOUS`", the session can access all
|
7304
|
+
# three dashboards.
|
7231
7305
|
# @return [Array<String>]
|
7232
7306
|
#
|
7233
7307
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
|
@@ -7456,7 +7530,7 @@ module Aws::QuickSight
|
|
7456
7530
|
# @return [String]
|
7457
7531
|
#
|
7458
7532
|
# @!attribute [rw] policy_arn
|
7459
|
-
# The Amazon Resource Name (ARN) for the
|
7533
|
+
# The Amazon Resource Name (ARN) for the IAM policy.
|
7460
7534
|
# @return [String]
|
7461
7535
|
#
|
7462
7536
|
# @!attribute [rw] identities
|
@@ -7480,7 +7554,7 @@ module Aws::QuickSight
|
|
7480
7554
|
include Aws::Structure
|
7481
7555
|
end
|
7482
7556
|
|
7483
|
-
#
|
7557
|
+
# IAM policy assignment summary.
|
7484
7558
|
#
|
7485
7559
|
# @!attribute [rw] assignment_name
|
7486
7560
|
# Assignment name.
|
@@ -7813,6 +7887,21 @@ module Aws::QuickSight
|
|
7813
7887
|
include Aws::Structure
|
7814
7888
|
end
|
7815
7889
|
|
7890
|
+
# A structure that contains the configuration of a shareable link to the
|
7891
|
+
# dashboard.
|
7892
|
+
#
|
7893
|
+
# @!attribute [rw] permissions
|
7894
|
+
# A structure that contains the permissions of a shareable link.
|
7895
|
+
# @return [Array<Types::ResourcePermission>]
|
7896
|
+
#
|
7897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/LinkSharingConfiguration AWS API Documentation
|
7898
|
+
#
|
7899
|
+
class LinkSharingConfiguration < Struct.new(
|
7900
|
+
:permissions)
|
7901
|
+
SENSITIVE = []
|
7902
|
+
include Aws::Structure
|
7903
|
+
end
|
7904
|
+
|
7816
7905
|
# @note When making an API call, you may pass ListAnalysesRequest
|
7817
7906
|
# data as a hash:
|
7818
7907
|
#
|
@@ -8134,11 +8223,11 @@ module Aws::QuickSight
|
|
8134
8223
|
# }
|
8135
8224
|
#
|
8136
8225
|
# @!attribute [rw] aws_account_id
|
8137
|
-
# The
|
8226
|
+
# The ID for the Amazon Web Services account that contains the folder.
|
8138
8227
|
# @return [String]
|
8139
8228
|
#
|
8140
8229
|
# @!attribute [rw] folder_id
|
8141
|
-
# The folder
|
8230
|
+
# The ID of the folder.
|
8142
8231
|
# @return [String]
|
8143
8232
|
#
|
8144
8233
|
# @!attribute [rw] next_token
|
@@ -8162,7 +8251,7 @@ module Aws::QuickSight
|
|
8162
8251
|
end
|
8163
8252
|
|
8164
8253
|
# @!attribute [rw] status
|
8165
|
-
# The status
|
8254
|
+
# The HTTP status of the request.
|
8166
8255
|
# @return [Integer]
|
8167
8256
|
#
|
8168
8257
|
# @!attribute [rw] folder_member_list
|
@@ -8176,7 +8265,7 @@ module Aws::QuickSight
|
|
8176
8265
|
# @return [String]
|
8177
8266
|
#
|
8178
8267
|
# @!attribute [rw] request_id
|
8179
|
-
# The request ID.
|
8268
|
+
# The Amazon Web Services request ID for this operation.
|
8180
8269
|
# @return [String]
|
8181
8270
|
#
|
8182
8271
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolderMembersResponse AWS API Documentation
|
@@ -8200,7 +8289,7 @@ module Aws::QuickSight
|
|
8200
8289
|
# }
|
8201
8290
|
#
|
8202
8291
|
# @!attribute [rw] aws_account_id
|
8203
|
-
# The
|
8292
|
+
# The ID for the Amazon Web Services account that contains the folder.
|
8204
8293
|
# @return [String]
|
8205
8294
|
#
|
8206
8295
|
# @!attribute [rw] next_token
|
@@ -8223,12 +8312,13 @@ module Aws::QuickSight
|
|
8223
8312
|
end
|
8224
8313
|
|
8225
8314
|
# @!attribute [rw] status
|
8226
|
-
# The status
|
8315
|
+
# The HTTP status of the request.
|
8227
8316
|
# @return [Integer]
|
8228
8317
|
#
|
8229
8318
|
# @!attribute [rw] folder_summary_list
|
8230
|
-
# A structure that contains all of the folders in
|
8231
|
-
# This structure provides basic information about
|
8319
|
+
# A structure that contains all of the folders in the Amazon Web
|
8320
|
+
# Services account. This structure provides basic information about
|
8321
|
+
# the folders.
|
8232
8322
|
# @return [Array<Types::FolderSummary>]
|
8233
8323
|
#
|
8234
8324
|
# @!attribute [rw] next_token
|
@@ -8237,7 +8327,7 @@ module Aws::QuickSight
|
|
8237
8327
|
# @return [String]
|
8238
8328
|
#
|
8239
8329
|
# @!attribute [rw] request_id
|
8240
|
-
# The request ID.
|
8330
|
+
# The Amazon Web Services request ID for this operation.
|
8241
8331
|
# @return [String]
|
8242
8332
|
#
|
8243
8333
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFoldersResponse AWS API Documentation
|
@@ -8474,8 +8564,8 @@ module Aws::QuickSight
|
|
8474
8564
|
# }
|
8475
8565
|
#
|
8476
8566
|
# @!attribute [rw] aws_account_id
|
8477
|
-
# The ID of the Amazon Web Services account that contains these
|
8478
|
-
#
|
8567
|
+
# The ID of the Amazon Web Services account that contains these IAM
|
8568
|
+
# policy assignments.
|
8479
8569
|
# @return [String]
|
8480
8570
|
#
|
8481
8571
|
# @!attribute [rw] assignment_status
|
@@ -8508,7 +8598,7 @@ module Aws::QuickSight
|
|
8508
8598
|
end
|
8509
8599
|
|
8510
8600
|
# @!attribute [rw] iam_policy_assignments
|
8511
|
-
# Information describing the
|
8601
|
+
# Information describing the IAM policy assignments.
|
8512
8602
|
# @return [Array<Types::IAMPolicyAssignmentSummary>]
|
8513
8603
|
#
|
8514
8604
|
# @!attribute [rw] next_token
|
@@ -9473,7 +9563,7 @@ module Aws::QuickSight
|
|
9473
9563
|
include Aws::Structure
|
9474
9564
|
end
|
9475
9565
|
|
9476
|
-
# An object that consists of
|
9566
|
+
# An object that consists of a member Amazon Resource Name (ARN) and a
|
9477
9567
|
# member ID.
|
9478
9568
|
#
|
9479
9569
|
# @!attribute [rw] member_id
|
@@ -10012,7 +10102,8 @@ module Aws::QuickSight
|
|
10012
10102
|
# Amazon QuickSight supports several ways of managing the identity of
|
10013
10103
|
# users. This parameter accepts two values:
|
10014
10104
|
#
|
10015
|
-
# * `IAM`\: A user whose identity maps to an existing
|
10105
|
+
# * `IAM`\: A user whose identity maps to an existing IAM user or
|
10106
|
+
# role.
|
10016
10107
|
#
|
10017
10108
|
# * `QUICKSIGHT`\: A user whose identity is owned and managed
|
10018
10109
|
# internally by Amazon QuickSight.
|
@@ -10042,18 +10133,18 @@ module Aws::QuickSight
|
|
10042
10133
|
# @return [String]
|
10043
10134
|
#
|
10044
10135
|
# @!attribute [rw] iam_arn
|
10045
|
-
# The ARN of the
|
10136
|
+
# The ARN of the IAM user or role that you are registering with Amazon
|
10046
10137
|
# QuickSight.
|
10047
10138
|
# @return [String]
|
10048
10139
|
#
|
10049
10140
|
# @!attribute [rw] session_name
|
10050
10141
|
# You need to use this parameter only when you register one or more
|
10051
|
-
# users using an assumed
|
10142
|
+
# users using an assumed IAM role. You don't need to provide the
|
10052
10143
|
# session name for other scenarios, for example when you are
|
10053
|
-
# registering an
|
10054
|
-
# register multiple users using the same
|
10055
|
-
# different session name. For more information on assuming
|
10056
|
-
# see [ `assume-role` ][1] in the *
|
10144
|
+
# registering an IAM user or an Amazon QuickSight user. You can
|
10145
|
+
# register multiple users using the same IAM role if each user has a
|
10146
|
+
# different session name. For more information on assuming IAM roles,
|
10147
|
+
# see [ `assume-role` ][1] in the *CLI Reference.*
|
10057
10148
|
#
|
10058
10149
|
#
|
10059
10150
|
#
|
@@ -10096,12 +10187,12 @@ module Aws::QuickSight
|
|
10096
10187
|
# restrictions. Currently, you need to create the profile names for
|
10097
10188
|
# custom permission sets by using the Amazon QuickSight console. Then,
|
10098
10189
|
# you use the `RegisterUser` API operation to assign the named set of
|
10099
|
-
# permissions to a
|
10190
|
+
# permissions to a QuickSight user.
|
10100
10191
|
#
|
10101
|
-
# Amazon QuickSight custom permissions are applied through
|
10102
|
-
#
|
10103
|
-
#
|
10104
|
-
#
|
10192
|
+
# Amazon QuickSight custom permissions are applied through IAM
|
10193
|
+
# policies. Therefore, they override the permissions typically granted
|
10194
|
+
# by assigning Amazon QuickSight users to one of the default security
|
10195
|
+
# cohorts in Amazon QuickSight (admin, author, reader).
|
10105
10196
|
#
|
10106
10197
|
# This feature is available only to Amazon QuickSight Enterprise
|
10107
10198
|
# edition subscriptions.
|
@@ -10212,12 +10303,12 @@ module Aws::QuickSight
|
|
10212
10303
|
end
|
10213
10304
|
|
10214
10305
|
# The type of experience you want to embed. For registered users, you
|
10215
|
-
# can embed
|
10306
|
+
# can embed Amazon QuickSight dashboards or the Amazon QuickSight
|
10216
10307
|
# console.
|
10217
10308
|
#
|
10218
10309
|
# <note markdown="1"> Exactly one of the experience configurations is required. You can
|
10219
10310
|
# choose `Dashboard` or `QuickSightConsole`. You cannot choose more than
|
10220
|
-
# one experience
|
10311
|
+
# one experience configuration.
|
10221
10312
|
#
|
10222
10313
|
# </note>
|
10223
10314
|
#
|
@@ -10242,22 +10333,22 @@ module Aws::QuickSight
|
|
10242
10333
|
# @return [Types::RegisteredUserDashboardEmbeddingConfiguration]
|
10243
10334
|
#
|
10244
10335
|
# @!attribute [rw] quick_sight_console
|
10245
|
-
# The configuration details for providing
|
10246
|
-
# embedding experience. This can be used along with custom
|
10247
|
-
# to restrict access to certain features. For more
|
10248
|
-
# [Customizing Access to the Amazon QuickSight
|
10249
|
-
# *Amazon QuickSight User Guide*.
|
10250
|
-
#
|
10251
|
-
# Use `GenerateEmbedUrlForRegisteredUser` where you want to provide
|
10252
|
-
# authoring portal that allows users to create data sources,
|
10253
|
-
# analyses, and dashboards. The users who accesses an
|
10254
|
-
# QuickSight console needs to belong to the author or
|
10255
|
-
# cohort. If you want to restrict permissions to some
|
10256
|
-
# features, add a custom permissions profile to the user with
|
10257
|
-
# UpdateUser ` API operation. Use ` RegisterUser ` API
|
10258
|
-
# add a new user with a custom permission profile
|
10259
|
-
# information, see the following sections in the
|
10260
|
-
# User Guide*\:
|
10336
|
+
# The configuration details for providing each Amazon QuickSight
|
10337
|
+
# console embedding experience. This can be used along with custom
|
10338
|
+
# permissions to restrict access to certain features. For more
|
10339
|
+
# information, see [Customizing Access to the Amazon QuickSight
|
10340
|
+
# Console][1] in the *Amazon QuickSight User Guide*.
|
10341
|
+
#
|
10342
|
+
# Use ` GenerateEmbedUrlForRegisteredUser ` where you want to provide
|
10343
|
+
# an authoring portal that allows users to create data sources,
|
10344
|
+
# datasets, analyses, and dashboards. The users who accesses an
|
10345
|
+
# embedded Amazon QuickSight console needs to belong to the author or
|
10346
|
+
# admin security cohort. If you want to restrict permissions to some
|
10347
|
+
# of these features, add a custom permissions profile to the user with
|
10348
|
+
# the ` UpdateUser ` API operation. Use the ` RegisterUser ` API
|
10349
|
+
# operation to add a new user with a custom permission profile
|
10350
|
+
# attached. For more information, see the following sections in the
|
10351
|
+
# *Amazon QuickSight User Guide*\:
|
10261
10352
|
#
|
10262
10353
|
# * [Embedding the Full Functionality of the Amazon QuickSight Console
|
10263
10354
|
# for Authenticated Users][2]
|
@@ -10509,14 +10600,14 @@ module Aws::QuickSight
|
|
10509
10600
|
# associated with an analysis, dashboard, template, or theme. (This
|
10510
10601
|
# is common.)
|
10511
10602
|
#
|
10512
|
-
# * The ARN of an Amazon Web Services account root: This is an
|
10513
|
-
# rather than a
|
10603
|
+
# * The ARN of an Amazon Web Services account root: This is an IAM ARN
|
10604
|
+
# rather than a QuickSight ARN. Use this option only to share
|
10514
10605
|
# resources (templates) across Amazon Web Services accounts. (This
|
10515
10606
|
# is less common.)
|
10516
10607
|
# @return [String]
|
10517
10608
|
#
|
10518
10609
|
# @!attribute [rw] actions
|
10519
|
-
# The
|
10610
|
+
# The IAM action to grant or revoke permissions on.
|
10520
10611
|
# @return [Array<String>]
|
10521
10612
|
#
|
10522
10613
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourcePermission AWS API Documentation
|
@@ -11014,7 +11105,7 @@ module Aws::QuickSight
|
|
11014
11105
|
# }
|
11015
11106
|
#
|
11016
11107
|
# @!attribute [rw] aws_account_id
|
11017
|
-
# The
|
11108
|
+
# The ID for the Amazon Web Services account that contains the folder.
|
11018
11109
|
# @return [String]
|
11019
11110
|
#
|
11020
11111
|
# @!attribute [rw] filters
|
@@ -11045,12 +11136,13 @@ module Aws::QuickSight
|
|
11045
11136
|
end
|
11046
11137
|
|
11047
11138
|
# @!attribute [rw] status
|
11048
|
-
# The status
|
11139
|
+
# The HTTP status of the request.
|
11049
11140
|
# @return [Integer]
|
11050
11141
|
#
|
11051
11142
|
# @!attribute [rw] folder_summary_list
|
11052
|
-
# A structure that contains all of the folders in
|
11053
|
-
# This structure provides basic information about
|
11143
|
+
# A structure that contains all of the folders in the Amazon Web
|
11144
|
+
# Services account. This structure provides basic information about
|
11145
|
+
# the folders.
|
11054
11146
|
# @return [Array<Types::FolderSummary>]
|
11055
11147
|
#
|
11056
11148
|
# @!attribute [rw] next_token
|
@@ -11059,7 +11151,7 @@ module Aws::QuickSight
|
|
11059
11151
|
# @return [String]
|
11060
11152
|
#
|
11061
11153
|
# @!attribute [rw] request_id
|
11062
|
-
# The request ID.
|
11154
|
+
# The Amazon Web Services request ID for this operation.
|
11063
11155
|
# @return [String]
|
11064
11156
|
#
|
11065
11157
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchFoldersResponse AWS API Documentation
|
@@ -12444,12 +12536,12 @@ module Aws::QuickSight
|
|
12444
12536
|
# This error indicates that you are calling an embedding operation in
|
12445
12537
|
# Amazon QuickSight without the required pricing plan on your Amazon Web
|
12446
12538
|
# Services account. Before you can use embedding for anonymous users, a
|
12447
|
-
#
|
12448
|
-
#
|
12449
|
-
# page.
|
12539
|
+
# QuickSight administrator needs to add capacity pricing to Amazon
|
12540
|
+
# QuickSight. You can do this on the **Manage Amazon QuickSight** page.
|
12450
12541
|
#
|
12451
|
-
# After capacity pricing is added, you can use the
|
12452
|
-
# API operation with the `--identity-type
|
12542
|
+
# After capacity pricing is added, you can use the `
|
12543
|
+
# GetDashboardEmbedUrl ` API operation with the `--identity-type
|
12544
|
+
# ANONYMOUS` option.
|
12453
12545
|
#
|
12454
12546
|
# @!attribute [rw] message
|
12455
12547
|
# @return [String]
|
@@ -12568,6 +12660,7 @@ module Aws::QuickSight
|
|
12568
12660
|
# namespace: "Namespace",
|
12569
12661
|
# account_customization: { # required
|
12570
12662
|
# default_theme: "Arn",
|
12663
|
+
# default_email_customization_template: "Arn",
|
12571
12664
|
# },
|
12572
12665
|
# }
|
12573
12666
|
#
|
@@ -12919,6 +13012,18 @@ module Aws::QuickSight
|
|
12919
13012
|
# actions: ["String"], # required
|
12920
13013
|
# },
|
12921
13014
|
# ],
|
13015
|
+
# grant_link_permissions: [
|
13016
|
+
# {
|
13017
|
+
# principal: "Principal", # required
|
13018
|
+
# actions: ["String"], # required
|
13019
|
+
# },
|
13020
|
+
# ],
|
13021
|
+
# revoke_link_permissions: [
|
13022
|
+
# {
|
13023
|
+
# principal: "Principal", # required
|
13024
|
+
# actions: ["String"], # required
|
13025
|
+
# },
|
13026
|
+
# ],
|
12922
13027
|
# }
|
12923
13028
|
#
|
12924
13029
|
# @!attribute [rw] aws_account_id
|
@@ -12938,13 +13043,23 @@ module Aws::QuickSight
|
|
12938
13043
|
# The permissions that you want to revoke from this resource.
|
12939
13044
|
# @return [Array<Types::ResourcePermission>]
|
12940
13045
|
#
|
13046
|
+
# @!attribute [rw] grant_link_permissions
|
13047
|
+
# Grants link permissions to all users in a defined namespace.
|
13048
|
+
# @return [Array<Types::ResourcePermission>]
|
13049
|
+
#
|
13050
|
+
# @!attribute [rw] revoke_link_permissions
|
13051
|
+
# Revokes link permissions from all users in a defined namespace.
|
13052
|
+
# @return [Array<Types::ResourcePermission>]
|
13053
|
+
#
|
12941
13054
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardPermissionsRequest AWS API Documentation
|
12942
13055
|
#
|
12943
13056
|
class UpdateDashboardPermissionsRequest < Struct.new(
|
12944
13057
|
:aws_account_id,
|
12945
13058
|
:dashboard_id,
|
12946
13059
|
:grant_permissions,
|
12947
|
-
:revoke_permissions
|
13060
|
+
:revoke_permissions,
|
13061
|
+
:grant_link_permissions,
|
13062
|
+
:revoke_link_permissions)
|
12948
13063
|
SENSITIVE = []
|
12949
13064
|
include Aws::Structure
|
12950
13065
|
end
|
@@ -12969,6 +13084,11 @@ module Aws::QuickSight
|
|
12969
13084
|
# The HTTP status of the request.
|
12970
13085
|
# @return [Integer]
|
12971
13086
|
#
|
13087
|
+
# @!attribute [rw] link_sharing_configuration
|
13088
|
+
# Updates the permissions of a shared link to an Amazon QuickSight
|
13089
|
+
# dashboard.
|
13090
|
+
# @return [Types::LinkSharingConfiguration]
|
13091
|
+
#
|
12972
13092
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardPermissionsResponse AWS API Documentation
|
12973
13093
|
#
|
12974
13094
|
class UpdateDashboardPermissionsResponse < Struct.new(
|
@@ -12976,7 +13096,8 @@ module Aws::QuickSight
|
|
12976
13096
|
:dashboard_id,
|
12977
13097
|
:permissions,
|
12978
13098
|
:request_id,
|
12979
|
-
:status
|
13099
|
+
:status,
|
13100
|
+
:link_sharing_configuration)
|
12980
13101
|
SENSITIVE = []
|
12981
13102
|
include Aws::Structure
|
12982
13103
|
end
|
@@ -13118,8 +13239,8 @@ module Aws::QuickSight
|
|
13118
13239
|
# using as source. You can only update a dashboard from a template, so
|
13119
13240
|
# you use a `SourceTemplate` entity. If you need to update a dashboard
|
13120
13241
|
# from an analysis, first convert the analysis to a template by using
|
13121
|
-
# the CreateTemplate API operation. For `SourceTemplate`, specify
|
13122
|
-
# Amazon Resource Name (ARN) of the source template. The
|
13242
|
+
# the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
|
13243
|
+
# the Amazon Resource Name (ARN) of the source template. The
|
13123
13244
|
# `SourceTemplate` ARN can contain any Amazon Web Services account and
|
13124
13245
|
# any Amazon QuickSight-supported Amazon Web Services Region.
|
13125
13246
|
#
|
@@ -13749,6 +13870,10 @@ module Aws::QuickSight
|
|
13749
13870
|
# amazon_open_search_parameters: {
|
13750
13871
|
# domain: "Domain", # required
|
13751
13872
|
# },
|
13873
|
+
# exasol_parameters: {
|
13874
|
+
# host: "Host", # required
|
13875
|
+
# port: 1, # required
|
13876
|
+
# },
|
13752
13877
|
# },
|
13753
13878
|
# credentials: {
|
13754
13879
|
# credential_pair: {
|
@@ -13848,6 +13973,10 @@ module Aws::QuickSight
|
|
13848
13973
|
# amazon_open_search_parameters: {
|
13849
13974
|
# domain: "Domain", # required
|
13850
13975
|
# },
|
13976
|
+
# exasol_parameters: {
|
13977
|
+
# host: "Host", # required
|
13978
|
+
# port: 1, # required
|
13979
|
+
# },
|
13851
13980
|
# },
|
13852
13981
|
# ],
|
13853
13982
|
# },
|
@@ -13963,11 +14092,12 @@ module Aws::QuickSight
|
|
13963
14092
|
# }
|
13964
14093
|
#
|
13965
14094
|
# @!attribute [rw] aws_account_id
|
13966
|
-
# The
|
14095
|
+
# The ID for the Amazon Web Services account that contains the folder
|
14096
|
+
# to update.
|
13967
14097
|
# @return [String]
|
13968
14098
|
#
|
13969
14099
|
# @!attribute [rw] folder_id
|
13970
|
-
# The folder
|
14100
|
+
# The ID of the folder.
|
13971
14101
|
# @return [String]
|
13972
14102
|
#
|
13973
14103
|
# @!attribute [rw] grant_permissions
|
@@ -13990,23 +14120,23 @@ module Aws::QuickSight
|
|
13990
14120
|
end
|
13991
14121
|
|
13992
14122
|
# @!attribute [rw] status
|
13993
|
-
# The status
|
14123
|
+
# The HTTP status of the request.
|
13994
14124
|
# @return [Integer]
|
13995
14125
|
#
|
13996
14126
|
# @!attribute [rw] arn
|
13997
|
-
# The Amazon Resource Name (ARN).
|
14127
|
+
# The Amazon Resource Name (ARN) of the folder.
|
13998
14128
|
# @return [String]
|
13999
14129
|
#
|
14000
14130
|
# @!attribute [rw] folder_id
|
14001
|
-
# The folder
|
14131
|
+
# The ID of the folder.
|
14002
14132
|
# @return [String]
|
14003
14133
|
#
|
14004
14134
|
# @!attribute [rw] permissions
|
14005
|
-
# Information about the permissions
|
14135
|
+
# Information about the permissions for the folder.
|
14006
14136
|
# @return [Array<Types::ResourcePermission>]
|
14007
14137
|
#
|
14008
14138
|
# @!attribute [rw] request_id
|
14009
|
-
# The request ID.
|
14139
|
+
# The Amazon Web Services request ID for this operation.
|
14010
14140
|
# @return [String]
|
14011
14141
|
#
|
14012
14142
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderPermissionsResponse AWS API Documentation
|
@@ -14031,11 +14161,12 @@ module Aws::QuickSight
|
|
14031
14161
|
# }
|
14032
14162
|
#
|
14033
14163
|
# @!attribute [rw] aws_account_id
|
14034
|
-
# The
|
14164
|
+
# The ID for the Amazon Web Services account that contains the folder
|
14165
|
+
# to update.
|
14035
14166
|
# @return [String]
|
14036
14167
|
#
|
14037
14168
|
# @!attribute [rw] folder_id
|
14038
|
-
# The folder
|
14169
|
+
# The ID of the folder.
|
14039
14170
|
# @return [String]
|
14040
14171
|
#
|
14041
14172
|
# @!attribute [rw] name
|
@@ -14053,19 +14184,19 @@ module Aws::QuickSight
|
|
14053
14184
|
end
|
14054
14185
|
|
14055
14186
|
# @!attribute [rw] status
|
14056
|
-
# The status
|
14187
|
+
# The HTTP status of the request.
|
14057
14188
|
# @return [Integer]
|
14058
14189
|
#
|
14059
14190
|
# @!attribute [rw] arn
|
14060
|
-
# The Amazon Resource Name (ARN).
|
14191
|
+
# The Amazon Resource Name (ARN) of the folder.
|
14061
14192
|
# @return [String]
|
14062
14193
|
#
|
14063
14194
|
# @!attribute [rw] folder_id
|
14064
|
-
# The folder
|
14195
|
+
# The ID of the folder.
|
14065
14196
|
# @return [String]
|
14066
14197
|
#
|
14067
14198
|
# @!attribute [rw] request_id
|
14068
|
-
# The request ID.
|
14199
|
+
# The Amazon Web Services request ID for this operation.
|
14069
14200
|
# @return [String]
|
14070
14201
|
#
|
14071
14202
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderResponse AWS API Documentation
|
@@ -14155,8 +14286,8 @@ module Aws::QuickSight
|
|
14155
14286
|
# }
|
14156
14287
|
#
|
14157
14288
|
# @!attribute [rw] aws_account_id
|
14158
|
-
# The ID of the Amazon Web Services account that contains the
|
14159
|
-
#
|
14289
|
+
# The ID of the Amazon Web Services account that contains the IAM
|
14290
|
+
# policy assignment.
|
14160
14291
|
# @return [String]
|
14161
14292
|
#
|
14162
14293
|
# @!attribute [rw] assignment_name
|
@@ -14182,7 +14313,7 @@ module Aws::QuickSight
|
|
14182
14313
|
# @return [String]
|
14183
14314
|
#
|
14184
14315
|
# @!attribute [rw] policy_arn
|
14185
|
-
# The ARN for the
|
14316
|
+
# The ARN for the IAM policy to apply to the Amazon QuickSight users
|
14186
14317
|
# and groups specified in this assignment.
|
14187
14318
|
# @return [String]
|
14188
14319
|
#
|
@@ -14213,12 +14344,12 @@ module Aws::QuickSight
|
|
14213
14344
|
# @return [String]
|
14214
14345
|
#
|
14215
14346
|
# @!attribute [rw] policy_arn
|
14216
|
-
# The ARN for the
|
14217
|
-
# groups specified in this assignment.
|
14347
|
+
# The ARN for the IAM policy applied to the Amazon QuickSight users
|
14348
|
+
# and groups specified in this assignment.
|
14218
14349
|
# @return [String]
|
14219
14350
|
#
|
14220
14351
|
# @!attribute [rw] identities
|
14221
|
-
# The Amazon QuickSight users, groups, or both that the
|
14352
|
+
# The Amazon QuickSight users, groups, or both that the IAM policy is
|
14222
14353
|
# assigned to.
|
14223
14354
|
# @return [Hash<String,Array<String>>]
|
14224
14355
|
#
|
@@ -14269,15 +14400,17 @@ module Aws::QuickSight
|
|
14269
14400
|
# }
|
14270
14401
|
#
|
14271
14402
|
# @!attribute [rw] aws_account_id
|
14272
|
-
#
|
14403
|
+
# The ID of the Amazon Web Services account that contains the IP
|
14404
|
+
# rules.
|
14273
14405
|
# @return [String]
|
14274
14406
|
#
|
14275
14407
|
# @!attribute [rw] ip_restriction_rule_map
|
14276
|
-
#
|
14408
|
+
# A map that describes the updated IP rules with CIDR ranges and
|
14409
|
+
# descriptions.
|
14277
14410
|
# @return [Hash<String,String>]
|
14278
14411
|
#
|
14279
14412
|
# @!attribute [rw] enabled
|
14280
|
-
#
|
14413
|
+
# A value that specifies whether IP rules are turned on.
|
14281
14414
|
# @return [Boolean]
|
14282
14415
|
#
|
14283
14416
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIpRestrictionRequest AWS API Documentation
|
@@ -14291,16 +14424,16 @@ module Aws::QuickSight
|
|
14291
14424
|
end
|
14292
14425
|
|
14293
14426
|
# @!attribute [rw] aws_account_id
|
14294
|
-
#
|
14427
|
+
# The ID of the Amazon Web Services account that contains the IP
|
14428
|
+
# rules.
|
14295
14429
|
# @return [String]
|
14296
14430
|
#
|
14297
14431
|
# @!attribute [rw] request_id
|
14298
|
-
# The ID
|
14432
|
+
# The Amazon Web Services request ID for this operation.
|
14299
14433
|
# @return [String]
|
14300
14434
|
#
|
14301
14435
|
# @!attribute [rw] status
|
14302
|
-
# The status of the
|
14303
|
-
# 200 code.
|
14436
|
+
# The HTTP status of the request.
|
14304
14437
|
# @return [Integer]
|
14305
14438
|
#
|
14306
14439
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIpRestrictionResponse AWS API Documentation
|
@@ -14906,12 +15039,12 @@ module Aws::QuickSight
|
|
14906
15039
|
# restrictions. Currently, you need to create the profile names for
|
14907
15040
|
# custom permission sets by using the Amazon QuickSight console. Then,
|
14908
15041
|
# you use the `RegisterUser` API operation to assign the named set of
|
14909
|
-
# permissions to a
|
15042
|
+
# permissions to a QuickSight user.
|
14910
15043
|
#
|
14911
|
-
# Amazon QuickSight custom permissions are applied through
|
14912
|
-
#
|
14913
|
-
#
|
14914
|
-
#
|
15044
|
+
# Amazon QuickSight custom permissions are applied through IAM
|
15045
|
+
# policies. Therefore, they override the permissions typically granted
|
15046
|
+
# by assigning Amazon QuickSight users to one of the default security
|
15047
|
+
# cohorts in Amazon QuickSight (admin, author, reader).
|
14915
15048
|
#
|
14916
15049
|
# This feature is available only to Amazon QuickSight Enterprise
|
14917
15050
|
# edition subscriptions.
|
@@ -14942,8 +15075,8 @@ module Aws::QuickSight
|
|
14942
15075
|
# parameter to provide the custom OIDC provider URL.
|
14943
15076
|
#
|
14944
15077
|
# * `NONE`\: This clears all the previously saved external login
|
14945
|
-
# information for a user. Use ` DescribeUser ` API to
|
14946
|
-
# external login information.
|
15078
|
+
# information for a user. Use the ` DescribeUser ` API operation to
|
15079
|
+
# check the external login information.
|
14947
15080
|
# @return [String]
|
14948
15081
|
#
|
14949
15082
|
# @!attribute [rw] custom_federation_provider_url
|
@@ -15050,7 +15183,9 @@ module Aws::QuickSight
|
|
15050
15183
|
# @return [String]
|
15051
15184
|
#
|
15052
15185
|
# @!attribute [rw] user_name
|
15053
|
-
# The user's user name.
|
15186
|
+
# The user's user name. In the output, the value for `UserName` is
|
15187
|
+
# `N/A` when the value for `IdentityType` is `IAM` and the
|
15188
|
+
# corresponding IAM user is deleted.
|
15054
15189
|
# @return [String]
|
15055
15190
|
#
|
15056
15191
|
# @!attribute [rw] email
|
@@ -15097,7 +15232,7 @@ module Aws::QuickSight
|
|
15097
15232
|
# @!attribute [rw] external_login_federation_provider_type
|
15098
15233
|
# The type of supported external login provider that provides identity
|
15099
15234
|
# to let the user federate into Amazon QuickSight with an associated
|
15100
|
-
#
|
15235
|
+
# IAM role. The type can be one of the following.
|
15101
15236
|
#
|
15102
15237
|
# * `COGNITO`\: Amazon Cognito. The provider URL is
|
15103
15238
|
# cognito-identity.amazonaws.com.
|