aws-sdk-quicksight 1.54.0 → 1.58.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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 Amazon QuickSight namespace in a specific Amazon
37
- # Web Services Region;.
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 IAMpolicy assignment.
102
+ # A name for the IAM policy assignment.
97
103
  # @return [String]
98
104
  #
99
105
  # @!attribute [rw] policy_arn
@@ -130,7 +136,7 @@ module Aws::QuickSight
130
136
  include Aws::Structure
131
137
  end
132
138
 
133
- # The parameters for Elasticsearch.
139
+ # The parameters for OpenSearch.
134
140
  #
135
141
  # @note When making an API call, you may pass AmazonElasticsearchParameters
136
142
  # data as a hash:
@@ -140,7 +146,7 @@ module Aws::QuickSight
140
146
  # }
141
147
  #
142
148
  # @!attribute [rw] domain
143
- # The Elasticsearch domain.
149
+ # The OpenSearch domain.
144
150
  # @return [String]
145
151
  #
146
152
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AmazonElasticsearchParameters AWS API Documentation
@@ -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 an Amazon QuickSight dashboard.
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, an Amazon QuickSight
431
- # dashboard.
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
@@ -609,7 +618,7 @@ module Aws::QuickSight
609
618
  #
610
619
  # {
611
620
  # aws_account_id: "AwsAccountId", # required
612
- # data_set_id: "string", # required
621
+ # data_set_id: "String", # required
613
622
  # ingestion_id: "IngestionId", # required
614
623
  # }
615
624
  #
@@ -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
  # {
@@ -931,8 +941,8 @@ module Aws::QuickSight
931
941
  #
932
942
  # @!attribute [rw] account_customization
933
943
  # The Amazon QuickSight customizations you're adding in the current
934
- # Amazon Web Services Region;. You can add these to an Amazon Web
935
- # Services account and a Amazon QuickSight namespace.
944
+ # Amazon Web Services Region. You can add these to an Amazon Web
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:
@@ -975,7 +985,7 @@ module Aws::QuickSight
975
985
  #
976
986
  # @!attribute [rw] account_customization
977
987
  # The Amazon QuickSight customizations you're adding in the current
978
- # Amazon Web Services Region;.
988
+ # Amazon Web Services Region.
979
989
  # @return [Types::AccountCustomization]
980
990
  #
981
991
  # @!attribute [rw] request_id
@@ -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 IAMpolicy.
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
- # IAMaction information for each principal ARN.
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,10 +1295,10 @@ 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 the
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
- # any Amazon QuickSight-supported Amazon Web Services Region;.
1301
+ # any Amazon QuickSight-supported Amazon Web Services Region.
1292
1302
  #
1293
1303
  # Use the `DataSetReferences` entity within `SourceTemplate` to list
1294
1304
  # the replacement datasets for the placeholders listed in the
@@ -1563,7 +1573,7 @@ module Aws::QuickSight
1563
1573
  #
1564
1574
  # @!attribute [rw] data_set_id
1565
1575
  # An ID for the dataset that you want to create. This ID is unique per
1566
- # Amazon Web Services Region; for each Amazon Web Services account.
1576
+ # Amazon Web Services Region for each Amazon Web Services account.
1567
1577
  # @return [String]
1568
1578
  #
1569
1579
  # @!attribute [rw] name
@@ -1650,8 +1660,7 @@ module Aws::QuickSight
1650
1660
  #
1651
1661
  # @!attribute [rw] data_set_id
1652
1662
  # The ID for the dataset that you want to create. This ID is unique
1653
- # per Amazon Web Services Region; for each Amazon Web Services
1654
- # account.
1663
+ # per Amazon Web Services Region for each Amazon Web Services account.
1655
1664
  # @return [String]
1656
1665
  #
1657
1666
  # @!attribute [rw] ingestion_arn
@@ -1692,7 +1701,7 @@ module Aws::QuickSight
1692
1701
  # aws_account_id: "AwsAccountId", # required
1693
1702
  # data_source_id: "ResourceId", # required
1694
1703
  # name: "ResourceName", # required
1695
- # 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
1696
1705
  # data_source_parameters: {
1697
1706
  # amazon_elasticsearch_parameters: {
1698
1707
  # domain: "Domain", # required
@@ -1786,6 +1795,10 @@ module Aws::QuickSight
1786
1795
  # amazon_open_search_parameters: {
1787
1796
  # domain: "Domain", # required
1788
1797
  # },
1798
+ # exasol_parameters: {
1799
+ # host: "Host", # required
1800
+ # port: 1, # required
1801
+ # },
1789
1802
  # },
1790
1803
  # credentials: {
1791
1804
  # credential_pair: {
@@ -1885,6 +1898,10 @@ module Aws::QuickSight
1885
1898
  # amazon_open_search_parameters: {
1886
1899
  # domain: "Domain", # required
1887
1900
  # },
1901
+ # exasol_parameters: {
1902
+ # host: "Host", # required
1903
+ # port: 1, # required
1904
+ # },
1888
1905
  # },
1889
1906
  # ],
1890
1907
  # },
@@ -1916,7 +1933,7 @@ module Aws::QuickSight
1916
1933
  #
1917
1934
  # @!attribute [rw] data_source_id
1918
1935
  # An ID for the data source. This ID is unique per Amazon Web Services
1919
- # Region; for each Amazon Web Services account.
1936
+ # Region for each Amazon Web Services account.
1920
1937
  # @return [String]
1921
1938
  #
1922
1939
  # @!attribute [rw] name
@@ -1927,7 +1944,7 @@ module Aws::QuickSight
1927
1944
  # The type of the data source. To return a list of all data sources,
1928
1945
  # use `ListDataSources`.
1929
1946
  #
1930
- # Use `AMAZON_ELASTICSEARCH` for Amazon Elasticsearch Service.
1947
+ # Use `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service.
1931
1948
  # @return [String]
1932
1949
  #
1933
1950
  # @!attribute [rw] data_source_parameters
@@ -1983,7 +2000,7 @@ module Aws::QuickSight
1983
2000
  #
1984
2001
  # @!attribute [rw] data_source_id
1985
2002
  # The ID of the data source. This ID is unique per Amazon Web Services
1986
- # Region; for each Amazon Web Services account.
2003
+ # Region for each Amazon Web Services account.
1987
2004
  # @return [String]
1988
2005
  #
1989
2006
  # @!attribute [rw] creation_status
@@ -2021,11 +2038,11 @@ module Aws::QuickSight
2021
2038
  # }
2022
2039
  #
2023
2040
  # @!attribute [rw] aws_account_id
2024
- # The AWS Account ID.
2041
+ # The ID for the Amazon Web Services account that contains the folder.
2025
2042
  # @return [String]
2026
2043
  #
2027
2044
  # @!attribute [rw] folder_id
2028
- # The folder ID.
2045
+ # The ID of the folder.
2029
2046
  # @return [String]
2030
2047
  #
2031
2048
  # @!attribute [rw] member_id
@@ -2049,8 +2066,7 @@ module Aws::QuickSight
2049
2066
  end
2050
2067
 
2051
2068
  # @!attribute [rw] status
2052
- # The status of the folder membership. If succeeded, the status is
2053
- # `SC_OK (200)`.
2069
+ # The HTTP status of the request.
2054
2070
  # @return [Integer]
2055
2071
  #
2056
2072
  # @!attribute [rw] folder_member
@@ -2058,7 +2074,7 @@ module Aws::QuickSight
2058
2074
  # @return [Types::FolderMember]
2059
2075
  #
2060
2076
  # @!attribute [rw] request_id
2061
- # The request ID.
2077
+ # The Amazon Web Services request ID for this operation.
2062
2078
  # @return [String]
2063
2079
  #
2064
2080
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderMembershipResponse AWS API Documentation
@@ -2095,11 +2111,12 @@ module Aws::QuickSight
2095
2111
  # }
2096
2112
  #
2097
2113
  # @!attribute [rw] aws_account_id
2098
- # The AWS Account ID.
2114
+ # The ID for the Amazon Web Services account where you want to create
2115
+ # the folder.
2099
2116
  # @return [String]
2100
2117
  #
2101
2118
  # @!attribute [rw] folder_id
2102
- # The folder ID.
2119
+ # The ID of the folder.
2103
2120
  # @return [String]
2104
2121
  #
2105
2122
  # @!attribute [rw] name
@@ -2143,8 +2160,7 @@ module Aws::QuickSight
2143
2160
  end
2144
2161
 
2145
2162
  # @!attribute [rw] status
2146
- # The status of the newly created folder. If succeeded, the status is
2147
- # `SC_OK (200)`.
2163
+ # The HTTP status of the request.
2148
2164
  # @return [Integer]
2149
2165
  #
2150
2166
  # @!attribute [rw] arn
@@ -2312,7 +2328,7 @@ module Aws::QuickSight
2312
2328
  #
2313
2329
  # @!attribute [rw] aws_account_id
2314
2330
  # The ID of the Amazon Web Services account where you want to assign
2315
- # an IAMpolicy to Amazon QuickSight users or groups.
2331
+ # an IAM policy to Amazon QuickSight users or groups.
2316
2332
  # @return [String]
2317
2333
  #
2318
2334
  # @!attribute [rw] assignment_name
@@ -2334,7 +2350,7 @@ module Aws::QuickSight
2334
2350
  # @return [String]
2335
2351
  #
2336
2352
  # @!attribute [rw] policy_arn
2337
- # The ARN for the IAMpolicy to apply to the Amazon QuickSight users
2353
+ # The ARN for the IAM policy to apply to the Amazon QuickSight users
2338
2354
  # and groups specified in this assignment.
2339
2355
  # @return [String]
2340
2356
  #
@@ -2383,12 +2399,12 @@ module Aws::QuickSight
2383
2399
  # @return [String]
2384
2400
  #
2385
2401
  # @!attribute [rw] policy_arn
2386
- # The ARN for the IAMpolicy that is applied to the Amazon QuickSight
2402
+ # The ARN for the IAM policy that is applied to the Amazon QuickSight
2387
2403
  # users and groups specified in this assignment.
2388
2404
  # @return [String]
2389
2405
  #
2390
2406
  # @!attribute [rw] identities
2391
- # The Amazon QuickSight users, groups, or both that the IAMpolicy is
2407
+ # The Amazon QuickSight users, groups, or both that the IAM policy is
2392
2408
  # assigned to.
2393
2409
  # @return [Hash<String,Array<String>>]
2394
2410
  #
@@ -2418,9 +2434,10 @@ module Aws::QuickSight
2418
2434
  # data as a hash:
2419
2435
  #
2420
2436
  # {
2421
- # data_set_id: "string", # required
2437
+ # data_set_id: "String", # required
2422
2438
  # ingestion_id: "IngestionId", # required
2423
2439
  # aws_account_id: "AwsAccountId", # required
2440
+ # ingestion_type: "INCREMENTAL_REFRESH", # accepts INCREMENTAL_REFRESH, FULL_REFRESH
2424
2441
  # }
2425
2442
  #
2426
2443
  # @!attribute [rw] data_set_id
@@ -2435,12 +2452,17 @@ module Aws::QuickSight
2435
2452
  # The Amazon Web Services account ID.
2436
2453
  # @return [String]
2437
2454
  #
2455
+ # @!attribute [rw] ingestion_type
2456
+ # The type of ingestion that you want to create.
2457
+ # @return [String]
2458
+ #
2438
2459
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateIngestionRequest AWS API Documentation
2439
2460
  #
2440
2461
  class CreateIngestionRequest < Struct.new(
2441
2462
  :data_set_id,
2442
2463
  :ingestion_id,
2443
- :aws_account_id)
2464
+ :aws_account_id,
2465
+ :ingestion_type)
2444
2466
  SENSITIVE = []
2445
2467
  include Aws::Structure
2446
2468
  end
@@ -2697,7 +2719,7 @@ module Aws::QuickSight
2697
2719
  # (ARN). For `SourceTemplate`, specify the ARN of the source template.
2698
2720
  # For `SourceAnalysis`, specify the ARN of the source analysis. The
2699
2721
  # `SourceTemplate` ARN can contain any Amazon Web Services account and
2700
- # any Amazon QuickSight-supported Amazon Web Services Region;.
2722
+ # any Amazon QuickSight-supported Amazon Web Services Region.
2701
2723
  #
2702
2724
  # Use the `DataSetReferences` entity within `SourceTemplate` or
2703
2725
  # `SourceAnalysis` to list the replacement datasets for the
@@ -2913,7 +2935,7 @@ module Aws::QuickSight
2913
2935
  # The ID of the theme that a custom theme will inherit from. All
2914
2936
  # themes inherit from one of the starting themes defined by Amazon
2915
2937
  # QuickSight. For a list of the starting themes, use `ListThemes` or
2916
- # choose **Themes** from within a Amazon QuickSight analysis.
2938
+ # choose **Themes** from within an analysis.
2917
2939
  # @return [String]
2918
2940
  #
2919
2941
  # @!attribute [rw] version_description
@@ -3092,6 +3114,10 @@ module Aws::QuickSight
3092
3114
  # amazon_open_search_parameters: {
3093
3115
  # domain: "Domain", # required
3094
3116
  # },
3117
+ # exasol_parameters: {
3118
+ # host: "Host", # required
3119
+ # port: 1, # required
3120
+ # },
3095
3121
  # },
3096
3122
  # ],
3097
3123
  # }
@@ -3809,7 +3835,7 @@ module Aws::QuickSight
3809
3835
  #
3810
3836
  # @!attribute [rw] data_source_id
3811
3837
  # The ID of the data source. This ID is unique per Amazon Web Services
3812
- # Region; for each Amazon Web Services account.
3838
+ # Region for each Amazon Web Services account.
3813
3839
  # @return [String]
3814
3840
  #
3815
3841
  # @!attribute [rw] name
@@ -3992,6 +4018,10 @@ module Aws::QuickSight
3992
4018
  # amazon_open_search_parameters: {
3993
4019
  # domain: "Domain", # required
3994
4020
  # },
4021
+ # exasol_parameters: {
4022
+ # host: "Host", # required
4023
+ # port: 1, # required
4024
+ # },
3995
4025
  # },
3996
4026
  # ],
3997
4027
  # },
@@ -3999,7 +4029,7 @@ module Aws::QuickSight
3999
4029
  # }
4000
4030
  #
4001
4031
  # @!attribute [rw] credential_pair
4002
- # Credential pair. For more information, see CredentialPair.
4032
+ # Credential pair. For more information, see ` CredentialPair `.
4003
4033
  # @return [Types::CredentialPair]
4004
4034
  #
4005
4035
  # @!attribute [rw] copy_source_arn
@@ -4137,10 +4167,14 @@ module Aws::QuickSight
4137
4167
  # amazon_open_search_parameters: {
4138
4168
  # domain: "Domain", # required
4139
4169
  # },
4170
+ # exasol_parameters: {
4171
+ # host: "Host", # required
4172
+ # port: 1, # required
4173
+ # },
4140
4174
  # }
4141
4175
  #
4142
4176
  # @!attribute [rw] amazon_elasticsearch_parameters
4143
- # The parameters for Elasticsearch.
4177
+ # The parameters for OpenSearch.
4144
4178
  # @return [Types::AmazonElasticsearchParameters]
4145
4179
  #
4146
4180
  # @!attribute [rw] athena_parameters
@@ -4220,8 +4254,13 @@ module Aws::QuickSight
4220
4254
  # @return [Types::TwitterParameters]
4221
4255
  #
4222
4256
  # @!attribute [rw] amazon_open_search_parameters
4257
+ # The parameters for OpenSearch.
4223
4258
  # @return [Types::AmazonOpenSearchParameters]
4224
4259
  #
4260
+ # @!attribute [rw] exasol_parameters
4261
+ # The parameters for Exasol.
4262
+ # @return [Types::ExasolParameters]
4263
+ #
4225
4264
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceParameters AWS API Documentation
4226
4265
  #
4227
4266
  class DataSourceParameters < Struct.new(
@@ -4245,7 +4284,8 @@ module Aws::QuickSight
4245
4284
  :sql_server_parameters,
4246
4285
  :teradata_parameters,
4247
4286
  :twitter_parameters,
4248
- :amazon_open_search_parameters)
4287
+ :amazon_open_search_parameters,
4288
+ :exasol_parameters)
4249
4289
  SENSITIVE = []
4250
4290
  include Aws::Structure
4251
4291
  end
@@ -4315,7 +4355,7 @@ module Aws::QuickSight
4315
4355
  # @!attribute [rw] aws_account_id
4316
4356
  # The ID for the Amazon Web Services account that you want to delete
4317
4357
  # Amazon QuickSight customizations from in this Amazon Web Services
4318
- # Region;.
4358
+ # Region.
4319
4359
  # @return [String]
4320
4360
  #
4321
4361
  # @!attribute [rw] namespace
@@ -4500,8 +4540,7 @@ module Aws::QuickSight
4500
4540
  #
4501
4541
  # @!attribute [rw] data_set_id
4502
4542
  # The ID for the dataset that you want to create. This ID is unique
4503
- # per Amazon Web Services Region; for each Amazon Web Services
4504
- # account.
4543
+ # per Amazon Web Services Region for each Amazon Web Services account.
4505
4544
  # @return [String]
4506
4545
  #
4507
4546
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSetRequest AWS API Documentation
@@ -4519,8 +4558,7 @@ module Aws::QuickSight
4519
4558
  #
4520
4559
  # @!attribute [rw] data_set_id
4521
4560
  # The ID for the dataset that you want to create. This ID is unique
4522
- # per Amazon Web Services Region; for each Amazon Web Services
4523
- # account.
4561
+ # per Amazon Web Services Region for each Amazon Web Services account.
4524
4562
  # @return [String]
4525
4563
  #
4526
4564
  # @!attribute [rw] request_id
@@ -4556,7 +4594,7 @@ module Aws::QuickSight
4556
4594
  #
4557
4595
  # @!attribute [rw] data_source_id
4558
4596
  # The ID of the data source. This ID is unique per Amazon Web Services
4559
- # Region; for each Amazon Web Services account.
4597
+ # Region for each Amazon Web Services account.
4560
4598
  # @return [String]
4561
4599
  #
4562
4600
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDataSourceRequest AWS API Documentation
@@ -4574,7 +4612,7 @@ module Aws::QuickSight
4574
4612
  #
4575
4613
  # @!attribute [rw] data_source_id
4576
4614
  # The ID of the data source. This ID is unique per Amazon Web Services
4577
- # Region; for each Amazon Web Services account.
4615
+ # Region for each Amazon Web Services account.
4578
4616
  # @return [String]
4579
4617
  #
4580
4618
  # @!attribute [rw] request_id
@@ -4607,7 +4645,7 @@ module Aws::QuickSight
4607
4645
  # }
4608
4646
  #
4609
4647
  # @!attribute [rw] aws_account_id
4610
- # The AWS Account ID.
4648
+ # The ID for the Amazon Web Services account that contains the folder.
4611
4649
  # @return [String]
4612
4650
  #
4613
4651
  # @!attribute [rw] folder_id
@@ -4636,12 +4674,11 @@ module Aws::QuickSight
4636
4674
  end
4637
4675
 
4638
4676
  # @!attribute [rw] status
4639
- # The status of deleting the asset. If succeeded, the status is `SC_OK
4640
- # (200)`.
4677
+ # The HTTP status of the request.
4641
4678
  # @return [Integer]
4642
4679
  #
4643
4680
  # @!attribute [rw] request_id
4644
- # The request ID.
4681
+ # The Amazon Web Services request ID for this operation.
4645
4682
  # @return [String]
4646
4683
  #
4647
4684
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderMembershipResponse AWS API Documentation
@@ -4662,11 +4699,11 @@ module Aws::QuickSight
4662
4699
  # }
4663
4700
  #
4664
4701
  # @!attribute [rw] aws_account_id
4665
- # The AWS Account ID for the folder.
4702
+ # The ID for the Amazon Web Services account that contains the folder.
4666
4703
  # @return [String]
4667
4704
  #
4668
4705
  # @!attribute [rw] folder_id
4669
- # The folder ID.
4706
+ # The ID of the folder.
4670
4707
  # @return [String]
4671
4708
  #
4672
4709
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderRequest AWS API Documentation
@@ -4679,8 +4716,7 @@ module Aws::QuickSight
4679
4716
  end
4680
4717
 
4681
4718
  # @!attribute [rw] status
4682
- # The status of deleting the folder. If succeeded, the status is
4683
- # `SC_OK (200)`.
4719
+ # The HTTP status of the request.
4684
4720
  # @return [Integer]
4685
4721
  #
4686
4722
  # @!attribute [rw] arn
@@ -4688,11 +4724,11 @@ module Aws::QuickSight
4688
4724
  # @return [String]
4689
4725
  #
4690
4726
  # @!attribute [rw] folder_id
4691
- # The folder ID.
4727
+ # The ID of the folder.
4692
4728
  # @return [String]
4693
4729
  #
4694
4730
  # @!attribute [rw] request_id
4695
- # The request ID.
4731
+ # The Amazon Web Services request ID for this operation.
4696
4732
  # @return [String]
4697
4733
  #
4698
4734
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderResponse AWS API Documentation
@@ -4823,8 +4859,8 @@ module Aws::QuickSight
4823
4859
  # }
4824
4860
  #
4825
4861
  # @!attribute [rw] aws_account_id
4826
- # The Amazon Web Services account ID where you want to delete the
4827
- # IAMpolicy assignment.
4862
+ # The Amazon Web Services account ID where you want to delete the IAM
4863
+ # policy assignment.
4828
4864
  # @return [String]
4829
4865
  #
4830
4866
  # @!attribute [rw] assignment_name
@@ -5318,7 +5354,7 @@ module Aws::QuickSight
5318
5354
  #
5319
5355
  # @!attribute [rw] account_customization
5320
5356
  # The Amazon QuickSight customizations that exist in the current
5321
- # Amazon Web Services Region;.
5357
+ # Amazon Web Services Region.
5322
5358
  # @return [Types::AccountCustomization]
5323
5359
  #
5324
5360
  # @!attribute [rw] request_id
@@ -5366,13 +5402,13 @@ module Aws::QuickSight
5366
5402
  # The Amazon QuickSight settings for this Amazon Web Services account.
5367
5403
  # This information includes the edition of Amazon Amazon QuickSight
5368
5404
  # that you subscribed to (Standard or Enterprise) and the notification
5369
- # email for the Amazon QuickSight subscription. In the Amazon
5370
- # QuickSight console, the Amazon QuickSight subscription is sometimes
5371
- # referred to as a Amazon QuickSight "account" even though it's
5372
- # technically not an account by itself. Instead, it's a subscription
5373
- # to the Amazon QuickSight service for your Amazon Web Services
5374
- # account. The edition that you subscribe to applies to Amazon
5375
- # QuickSight in every Amazon Web Services Region; where you use it.
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.
5376
5412
  # @return [Types::AccountSettings]
5377
5413
  #
5378
5414
  # @!attribute [rw] request_id
@@ -5520,7 +5556,7 @@ module Aws::QuickSight
5520
5556
  # @return [String]
5521
5557
  #
5522
5558
  # @!attribute [rw] dashboard_id
5523
- # The ID for the dashboard, also added to the IAMpolicy.
5559
+ # The ID for the dashboard, also added to the IAM policy.
5524
5560
  # @return [String]
5525
5561
  #
5526
5562
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissionsRequest AWS API Documentation
@@ -5552,6 +5588,18 @@ module Aws::QuickSight
5552
5588
  # The Amazon Web Services request ID for this operation.
5553
5589
  # @return [String]
5554
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
+ #
5555
5603
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissionsResponse AWS API Documentation
5556
5604
  #
5557
5605
  class DescribeDashboardPermissionsResponse < Struct.new(
@@ -5559,7 +5607,8 @@ module Aws::QuickSight
5559
5607
  :dashboard_arn,
5560
5608
  :permissions,
5561
5609
  :status,
5562
- :request_id)
5610
+ :request_id,
5611
+ :link_sharing_configuration)
5563
5612
  SENSITIVE = []
5564
5613
  include Aws::Structure
5565
5614
  end
@@ -5639,8 +5688,7 @@ module Aws::QuickSight
5639
5688
  #
5640
5689
  # @!attribute [rw] data_set_id
5641
5690
  # The ID for the dataset that you want to create. This ID is unique
5642
- # per Amazon Web Services Region; for each Amazon Web Services
5643
- # account.
5691
+ # per Amazon Web Services Region for each Amazon Web Services account.
5644
5692
  # @return [String]
5645
5693
  #
5646
5694
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetPermissionsRequest AWS API Documentation
@@ -5658,8 +5706,7 @@ module Aws::QuickSight
5658
5706
  #
5659
5707
  # @!attribute [rw] data_set_id
5660
5708
  # The ID for the dataset that you want to create. This ID is unique
5661
- # per Amazon Web Services Region; for each Amazon Web Services
5662
- # account.
5709
+ # per Amazon Web Services Region for each Amazon Web Services account.
5663
5710
  # @return [String]
5664
5711
  #
5665
5712
  # @!attribute [rw] permissions
@@ -5700,8 +5747,7 @@ module Aws::QuickSight
5700
5747
  #
5701
5748
  # @!attribute [rw] data_set_id
5702
5749
  # The ID for the dataset that you want to create. This ID is unique
5703
- # per Amazon Web Services Region; for each Amazon Web Services
5704
- # account.
5750
+ # per Amazon Web Services Region for each Amazon Web Services account.
5705
5751
  # @return [String]
5706
5752
  #
5707
5753
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSetRequest AWS API Documentation
@@ -5749,7 +5795,7 @@ module Aws::QuickSight
5749
5795
  #
5750
5796
  # @!attribute [rw] data_source_id
5751
5797
  # The ID of the data source. This ID is unique per Amazon Web Services
5752
- # Region; for each Amazon Web Services account.
5798
+ # Region for each Amazon Web Services account.
5753
5799
  # @return [String]
5754
5800
  #
5755
5801
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourcePermissionsRequest AWS API Documentation
@@ -5767,7 +5813,7 @@ module Aws::QuickSight
5767
5813
  #
5768
5814
  # @!attribute [rw] data_source_id
5769
5815
  # The ID of the data source. This ID is unique per Amazon Web Services
5770
- # Region; for each Amazon Web Services account.
5816
+ # Region for each Amazon Web Services account.
5771
5817
  # @return [String]
5772
5818
  #
5773
5819
  # @!attribute [rw] permissions
@@ -5808,7 +5854,7 @@ module Aws::QuickSight
5808
5854
  #
5809
5855
  # @!attribute [rw] data_source_id
5810
5856
  # The ID of the data source. This ID is unique per Amazon Web Services
5811
- # Region; for each Amazon Web Services account.
5857
+ # Region for each Amazon Web Services account.
5812
5858
  # @return [String]
5813
5859
  #
5814
5860
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDataSourceRequest AWS API Documentation
@@ -5851,11 +5897,11 @@ module Aws::QuickSight
5851
5897
  # }
5852
5898
  #
5853
5899
  # @!attribute [rw] aws_account_id
5854
- # The AWS Account ID.
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 ID.
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. If succeeded, the status is `SC_OK`.
5917
+ # The HTTP status of the request.
5872
5918
  # @return [Integer]
5873
5919
  #
5874
5920
  # @!attribute [rw] folder_id
5875
- # The folder ID.
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 AWS account ID.
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 ID.
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 AWS account ID.
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 ID.
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. If succeeded, the status is `SC_OK`
5999
+ # The HTTP status of the request.
5954
6000
  # @return [Integer]
5955
6001
  #
5956
6002
  # @!attribute [rw] folder_id
5957
- # The folder ID.
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 on the dashboard.
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. If succeeded, the status is `SC_OK (200)`.
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 IAMpolicy assignment.
6140
+ # Information describing the IAM policy assignment.
6095
6141
  # @return [Types::IAMPolicyAssignment]
6096
6142
  #
6097
6143
  # @!attribute [rw] request_id
@@ -6117,7 +6163,7 @@ module Aws::QuickSight
6117
6163
  #
6118
6164
  # {
6119
6165
  # aws_account_id: "AwsAccountId", # required
6120
- # data_set_id: "string", # required
6166
+ # data_set_id: "String", # required
6121
6167
  # ingestion_id: "IngestionId", # required
6122
6168
  # }
6123
6169
  #
@@ -6165,6 +6211,59 @@ module Aws::QuickSight
6165
6211
  include Aws::Structure
6166
6212
  end
6167
6213
 
6214
+ # @note When making an API call, you may pass DescribeIpRestrictionRequest
6215
+ # data as a hash:
6216
+ #
6217
+ # {
6218
+ # aws_account_id: "AwsAccountId", # required
6219
+ # }
6220
+ #
6221
+ # @!attribute [rw] aws_account_id
6222
+ # The ID of the Amazon Web Services account that contains the IP
6223
+ # rules.
6224
+ # @return [String]
6225
+ #
6226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIpRestrictionRequest AWS API Documentation
6227
+ #
6228
+ class DescribeIpRestrictionRequest < Struct.new(
6229
+ :aws_account_id)
6230
+ SENSITIVE = []
6231
+ include Aws::Structure
6232
+ end
6233
+
6234
+ # @!attribute [rw] aws_account_id
6235
+ # The ID of the Amazon Web Services account that contains the IP
6236
+ # rules.
6237
+ # @return [String]
6238
+ #
6239
+ # @!attribute [rw] ip_restriction_rule_map
6240
+ # A map that describes the IP rules with CIDR range and description.
6241
+ # @return [Hash<String,String>]
6242
+ #
6243
+ # @!attribute [rw] enabled
6244
+ # A value that specifies whether IP rules are turned on.
6245
+ # @return [Boolean]
6246
+ #
6247
+ # @!attribute [rw] request_id
6248
+ # The Amazon Web Services request ID for this operation.
6249
+ # @return [String]
6250
+ #
6251
+ # @!attribute [rw] status
6252
+ # The HTTP status of the request.
6253
+ # @return [Integer]
6254
+ #
6255
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIpRestrictionResponse AWS API Documentation
6256
+ #
6257
+ class DescribeIpRestrictionResponse < Struct.new(
6258
+ :aws_account_id,
6259
+ :ip_restriction_rule_map,
6260
+ :enabled,
6261
+ :request_id,
6262
+ :status)
6263
+ SENSITIVE = []
6264
+ include Aws::Structure
6265
+ end
6266
+
6168
6267
  # @note When making an API call, you may pass DescribeNamespaceRequest
6169
6268
  # data as a hash:
6170
6269
  #
@@ -6194,7 +6293,7 @@ module Aws::QuickSight
6194
6293
  # @!attribute [rw] namespace
6195
6294
  # The information about the namespace that you're describing. The
6196
6295
  # response includes the namespace ARN, name, Amazon Web Services
6197
- # Region;, creation status, and identity store. `DescribeNamespace`
6296
+ # Region, creation status, and identity store. `DescribeNamespace`
6198
6297
  # also works for namespaces that are in the process of being created.
6199
6298
  # For incomplete namespaces, this API operation lists the namespace
6200
6299
  # error types and messages associated with the creation process.
@@ -6672,6 +6771,33 @@ module Aws::QuickSight
6672
6771
  include Aws::Structure
6673
6772
  end
6674
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
+
6675
6801
  # Export to .csv option.
6676
6802
  #
6677
6803
  # @note When making an API call, you may pass ExportToCSVOption
@@ -6743,14 +6869,14 @@ module Aws::QuickSight
6743
6869
  include Aws::Structure
6744
6870
  end
6745
6871
 
6746
- # A folder.
6872
+ # A folder in Amazon QuickSight.
6747
6873
  #
6748
6874
  # @!attribute [rw] folder_id
6749
- # The folder ID.
6875
+ # The ID of the folder.
6750
6876
  # @return [String]
6751
6877
  #
6752
6878
  # @!attribute [rw] arn
6753
- # The folder Amazon Resource Name (ARN).
6879
+ # The Amazon Resource Name (ARN) for the folder.
6754
6880
  # @return [String]
6755
6881
  #
6756
6882
  # @!attribute [rw] name
@@ -6758,11 +6884,11 @@ module Aws::QuickSight
6758
6884
  # @return [String]
6759
6885
  #
6760
6886
  # @!attribute [rw] folder_type
6761
- # The type of the folder.
6887
+ # The type of folder it is.
6762
6888
  # @return [String]
6763
6889
  #
6764
6890
  # @!attribute [rw] folder_path
6765
- # An array of ancestor folder ARN strings.
6891
+ # An array of ancestor ARN strings for the folder.
6766
6892
  # @return [Array<String>]
6767
6893
  #
6768
6894
  # @!attribute [rw] created_time
@@ -6787,14 +6913,15 @@ module Aws::QuickSight
6787
6913
  include Aws::Structure
6788
6914
  end
6789
6915
 
6790
- # An asset in a folder, such as a dashboard, analysis, or dataset.
6916
+ # An asset in a Amazon QuickSight folder, such as a dashboard, analysis,
6917
+ # or dataset.
6791
6918
  #
6792
6919
  # @!attribute [rw] member_id
6793
- # The ID of the asset.
6920
+ # The ID of an asset in the folder.
6794
6921
  # @return [String]
6795
6922
  #
6796
6923
  # @!attribute [rw] member_type
6797
- # The type of the asset.
6924
+ # The type of asset that it is.
6798
6925
  # @return [String]
6799
6926
  #
6800
6927
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FolderMember AWS API Documentation
@@ -6806,7 +6933,7 @@ module Aws::QuickSight
6806
6933
  include Aws::Structure
6807
6934
  end
6808
6935
 
6809
- # Searches a folder by a filter.
6936
+ # A filter to use to search a Amazon QuickSight folder.
6810
6937
  #
6811
6938
  # @note When making an API call, you may pass FolderSearchFilter
6812
6939
  # data as a hash:
@@ -6818,12 +6945,12 @@ module Aws::QuickSight
6818
6945
  # }
6819
6946
  #
6820
6947
  # @!attribute [rw] operator
6821
- # The comparison operator that you want to use as a filter. For
6948
+ # The comparison operator that you want to use in the filter. For
6822
6949
  # example, `"Operator": "StringEquals"`.
6823
6950
  # @return [String]
6824
6951
  #
6825
6952
  # @!attribute [rw] name
6826
- # The name of the value that you want to use as a filter. For example,
6953
+ # The name of a value that you want to use in the filter. For example,
6827
6954
  # `"Name": "PARENT_FOLDER_ARN"`.
6828
6955
  # @return [String]
6829
6956
  #
@@ -6843,14 +6970,14 @@ module Aws::QuickSight
6843
6970
  include Aws::Structure
6844
6971
  end
6845
6972
 
6846
- # A summary of the folder.
6973
+ # A summary of information about an existing Amazon QuickSight folder.
6847
6974
  #
6848
6975
  # @!attribute [rw] arn
6849
- # The Amazon Resource Name (ARN).
6976
+ # The Amazon Resource Name (ARN) of the folder.
6850
6977
  # @return [String]
6851
6978
  #
6852
6979
  # @!attribute [rw] folder_id
6853
- # The folder ID.
6980
+ # The ID of the folder.
6854
6981
  # @return [String]
6855
6982
  #
6856
6983
  # @!attribute [rw] name
@@ -6995,6 +7122,9 @@ module Aws::QuickSight
6995
7122
  # quick_sight_console: {
6996
7123
  # initial_path: "EntryPath",
6997
7124
  # },
7125
+ # q_search_bar: {
7126
+ # initial_topic_id: "RestrictiveResourceId",
7127
+ # },
6998
7128
  # },
6999
7129
  # }
7000
7130
  #
@@ -7150,11 +7280,11 @@ module Aws::QuickSight
7150
7280
  #
7151
7281
  # * Invited nonfederated users
7152
7282
  #
7153
- # * IAMusers and IAMrole-based sessions authenticated through
7154
- # Federated Single Sign-On using SAML, OpenID Connect, or
7155
- # IAMfederation.
7283
+ # * IAM users and IAM role-based sessions authenticated through
7284
+ # Federated Single Sign-On using SAML, OpenID Connect, or IAM
7285
+ # federation.
7156
7286
  #
7157
- # Omit this parameter for users in the third group – IAMusers and IAM
7287
+ # Omit this parameter for users in the third group – IAM users and IAM
7158
7288
  # role-based sessions.
7159
7289
  # @return [String]
7160
7290
  #
@@ -7168,10 +7298,10 @@ module Aws::QuickSight
7168
7298
  # A list of one or more dashboard IDs that you want to add to a
7169
7299
  # session that includes anonymous users. The `IdentityType` parameter
7170
7300
  # must be set to `ANONYMOUS` for this to work, because other identity
7171
- # types authenticate as Amazon QuickSight or IAMusers. For example, if
7172
- # you set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
7173
- # identity-type ANONYMOUS`", the session can access all three
7174
- # 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.
7175
7305
  # @return [Array<String>]
7176
7306
  #
7177
7307
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
@@ -7400,7 +7530,7 @@ module Aws::QuickSight
7400
7530
  # @return [String]
7401
7531
  #
7402
7532
  # @!attribute [rw] policy_arn
7403
- # The Amazon Resource Name (ARN) for the IAMpolicy.
7533
+ # The Amazon Resource Name (ARN) for the IAM policy.
7404
7534
  # @return [String]
7405
7535
  #
7406
7536
  # @!attribute [rw] identities
@@ -7424,7 +7554,7 @@ module Aws::QuickSight
7424
7554
  include Aws::Structure
7425
7555
  end
7426
7556
 
7427
- # IAMpolicy assignment summary.
7557
+ # IAM policy assignment summary.
7428
7558
  #
7429
7559
  # @!attribute [rw] assignment_name
7430
7560
  # Assignment name.
@@ -7757,6 +7887,21 @@ module Aws::QuickSight
7757
7887
  include Aws::Structure
7758
7888
  end
7759
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
+
7760
7905
  # @note When making an API call, you may pass ListAnalysesRequest
7761
7906
  # data as a hash:
7762
7907
  #
@@ -8078,11 +8223,11 @@ module Aws::QuickSight
8078
8223
  # }
8079
8224
  #
8080
8225
  # @!attribute [rw] aws_account_id
8081
- # The AWS account ID.
8226
+ # The ID for the Amazon Web Services account that contains the folder.
8082
8227
  # @return [String]
8083
8228
  #
8084
8229
  # @!attribute [rw] folder_id
8085
- # The folder ID.
8230
+ # The ID of the folder.
8086
8231
  # @return [String]
8087
8232
  #
8088
8233
  # @!attribute [rw] next_token
@@ -8106,7 +8251,7 @@ module Aws::QuickSight
8106
8251
  end
8107
8252
 
8108
8253
  # @!attribute [rw] status
8109
- # The status. If succeeded, the status is `SC_OK`
8254
+ # The HTTP status of the request.
8110
8255
  # @return [Integer]
8111
8256
  #
8112
8257
  # @!attribute [rw] folder_member_list
@@ -8120,7 +8265,7 @@ module Aws::QuickSight
8120
8265
  # @return [String]
8121
8266
  #
8122
8267
  # @!attribute [rw] request_id
8123
- # The request ID.
8268
+ # The Amazon Web Services request ID for this operation.
8124
8269
  # @return [String]
8125
8270
  #
8126
8271
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolderMembersResponse AWS API Documentation
@@ -8144,7 +8289,7 @@ module Aws::QuickSight
8144
8289
  # }
8145
8290
  #
8146
8291
  # @!attribute [rw] aws_account_id
8147
- # The AWS account ID.
8292
+ # The ID for the Amazon Web Services account that contains the folder.
8148
8293
  # @return [String]
8149
8294
  #
8150
8295
  # @!attribute [rw] next_token
@@ -8167,12 +8312,13 @@ module Aws::QuickSight
8167
8312
  end
8168
8313
 
8169
8314
  # @!attribute [rw] status
8170
- # The status. If succeeded, the status is `SC_OK`
8315
+ # The HTTP status of the request.
8171
8316
  # @return [Integer]
8172
8317
  #
8173
8318
  # @!attribute [rw] folder_summary_list
8174
- # A structure that contains all of the folders in your AWS account.
8175
- # This structure provides basic information about the folders.
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.
8176
8322
  # @return [Array<Types::FolderSummary>]
8177
8323
  #
8178
8324
  # @!attribute [rw] next_token
@@ -8181,7 +8327,7 @@ module Aws::QuickSight
8181
8327
  # @return [String]
8182
8328
  #
8183
8329
  # @!attribute [rw] request_id
8184
- # The request ID.
8330
+ # The Amazon Web Services request ID for this operation.
8185
8331
  # @return [String]
8186
8332
  #
8187
8333
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFoldersResponse AWS API Documentation
@@ -8418,8 +8564,8 @@ module Aws::QuickSight
8418
8564
  # }
8419
8565
  #
8420
8566
  # @!attribute [rw] aws_account_id
8421
- # The ID of the Amazon Web Services account that contains these
8422
- # IAMpolicy assignments.
8567
+ # The ID of the Amazon Web Services account that contains these IAM
8568
+ # policy assignments.
8423
8569
  # @return [String]
8424
8570
  #
8425
8571
  # @!attribute [rw] assignment_status
@@ -8452,7 +8598,7 @@ module Aws::QuickSight
8452
8598
  end
8453
8599
 
8454
8600
  # @!attribute [rw] iam_policy_assignments
8455
- # Information describing the IAMpolicy assignments.
8601
+ # Information describing the IAM policy assignments.
8456
8602
  # @return [Array<Types::IAMPolicyAssignmentSummary>]
8457
8603
  #
8458
8604
  # @!attribute [rw] next_token
@@ -8483,8 +8629,8 @@ module Aws::QuickSight
8483
8629
  # data as a hash:
8484
8630
  #
8485
8631
  # {
8486
- # data_set_id: "string", # required
8487
- # next_token: "string",
8632
+ # data_set_id: "String", # required
8633
+ # next_token: "String",
8488
8634
  # aws_account_id: "AwsAccountId", # required
8489
8635
  # max_results: 1,
8490
8636
  # }
@@ -8580,7 +8726,7 @@ module Aws::QuickSight
8580
8726
  # @!attribute [rw] namespaces
8581
8727
  # The information about the namespaces in this Amazon Web Services
8582
8728
  # account. The response includes the namespace ARN, name, Amazon Web
8583
- # Services Region;, notification email address, creation status, and
8729
+ # Services Region, notification email address, creation status, and
8584
8730
  # identity store.
8585
8731
  # @return [Array<Types::NamespaceInfoV2>]
8586
8732
  #
@@ -9417,7 +9563,7 @@ module Aws::QuickSight
9417
9563
  include Aws::Structure
9418
9564
  end
9419
9565
 
9420
- # An object that consists of the member Amazon Resource Name (ARN) and
9566
+ # An object that consists of a member Amazon Resource Name (ARN) and a
9421
9567
  # member ID.
9422
9568
  #
9423
9569
  # @!attribute [rw] member_id
@@ -9500,7 +9646,7 @@ module Aws::QuickSight
9500
9646
  # @return [String]
9501
9647
  #
9502
9648
  # @!attribute [rw] capacity_region
9503
- # The namespace Amazon Web Services Region;.
9649
+ # The namespace Amazon Web Services Region.
9504
9650
  # @return [String]
9505
9651
  #
9506
9652
  # @!attribute [rw] creation_status
@@ -9956,7 +10102,8 @@ module Aws::QuickSight
9956
10102
  # Amazon QuickSight supports several ways of managing the identity of
9957
10103
  # users. This parameter accepts two values:
9958
10104
  #
9959
- # * `IAM`\: A user whose identity maps to an existing IAMuser or role.
10105
+ # * `IAM`\: A user whose identity maps to an existing IAM user or
10106
+ # role.
9960
10107
  #
9961
10108
  # * `QUICKSIGHT`\: A user whose identity is owned and managed
9962
10109
  # internally by Amazon QuickSight.
@@ -9986,18 +10133,18 @@ module Aws::QuickSight
9986
10133
  # @return [String]
9987
10134
  #
9988
10135
  # @!attribute [rw] iam_arn
9989
- # The ARN of the IAMuser or role that you are registering with Amazon
10136
+ # The ARN of the IAM user or role that you are registering with Amazon
9990
10137
  # QuickSight.
9991
10138
  # @return [String]
9992
10139
  #
9993
10140
  # @!attribute [rw] session_name
9994
10141
  # You need to use this parameter only when you register one or more
9995
- # users using an assumed IAMrole. You don't need to provide the
10142
+ # users using an assumed IAM role. You don't need to provide the
9996
10143
  # session name for other scenarios, for example when you are
9997
- # registering an IAMuser or an Amazon QuickSight user. You can
9998
- # register multiple users using the same IAMrole if each user has a
9999
- # different session name. For more information on assuming IAMroles,
10000
- # see [ `assume-role` ][1] in the *AWS CLI Reference.*
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.*
10001
10148
  #
10002
10149
  #
10003
10150
  #
@@ -10040,12 +10187,12 @@ module Aws::QuickSight
10040
10187
  # restrictions. Currently, you need to create the profile names for
10041
10188
  # custom permission sets by using the Amazon QuickSight console. Then,
10042
10189
  # you use the `RegisterUser` API operation to assign the named set of
10043
- # permissions to a Amazon QuickSight user.
10190
+ # permissions to a QuickSight user.
10044
10191
  #
10045
- # Amazon QuickSight custom permissions are applied through
10046
- # IAMpolicies. Therefore, they override the permissions typically
10047
- # granted by assigning Amazon QuickSight users to one of the default
10048
- # security cohorts in Amazon QuickSight (admin, author, reader).
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).
10049
10196
  #
10050
10197
  # This feature is available only to Amazon QuickSight Enterprise
10051
10198
  # edition subscriptions.
@@ -10156,12 +10303,12 @@ module Aws::QuickSight
10156
10303
  end
10157
10304
 
10158
10305
  # The type of experience you want to embed. For registered users, you
10159
- # can embed an Amazon QuickSight dashboard or the Amazon QuickSight
10306
+ # can embed Amazon QuickSight dashboards or the Amazon QuickSight
10160
10307
  # console.
10161
10308
  #
10162
10309
  # <note markdown="1"> Exactly one of the experience configurations is required. You can
10163
10310
  # choose `Dashboard` or `QuickSightConsole`. You cannot choose more than
10164
- # one experience configuraton.
10311
+ # one experience configuration.
10165
10312
  #
10166
10313
  # </note>
10167
10314
  #
@@ -10175,6 +10322,9 @@ module Aws::QuickSight
10175
10322
  # quick_sight_console: {
10176
10323
  # initial_path: "EntryPath",
10177
10324
  # },
10325
+ # q_search_bar: {
10326
+ # initial_topic_id: "RestrictiveResourceId",
10327
+ # },
10178
10328
  # }
10179
10329
  #
10180
10330
  # @!attribute [rw] dashboard
@@ -10183,22 +10333,22 @@ module Aws::QuickSight
10183
10333
  # @return [Types::RegisteredUserDashboardEmbeddingConfiguration]
10184
10334
  #
10185
10335
  # @!attribute [rw] quick_sight_console
10186
- # The configuration details for providing an Amazon QuickSight console
10187
- # embedding experience. This can be used along with custom permissions
10188
- # to restrict access to certain features. For more information, see
10189
- # [Customizing Access to the Amazon QuickSight Console][1] in the
10190
- # *Amazon QuickSight User Guide*.
10191
- #
10192
- # Use `GenerateEmbedUrlForRegisteredUser` where you want to provide an
10193
- # authoring portal that allows users to create data sources, datasets,
10194
- # analyses, and dashboards. The users who accesses an embedded Amazon
10195
- # QuickSight console needs to belong to the author or admin security
10196
- # cohort. If you want to restrict permissions to some of these
10197
- # features, add a custom permissions profile to the user with the `
10198
- # UpdateUser ` API operation. Use ` RegisterUser ` API operation to
10199
- # add a new user with a custom permission profile attached. For more
10200
- # information, see the following sections in the *Amazon QuickSight
10201
- # 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*\:
10202
10352
  #
10203
10353
  # * [Embedding the Full Functionality of the Amazon QuickSight Console
10204
10354
  # for Authenticated Users][2]
@@ -10216,11 +10366,52 @@ module Aws::QuickSight
10216
10366
  # [3]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html
10217
10367
  # @return [Types::RegisteredUserQuickSightConsoleEmbeddingConfiguration]
10218
10368
  #
10369
+ # @!attribute [rw] q_search_bar
10370
+ # The configuration details for embedding the Q search bar.
10371
+ #
10372
+ # For more information about embedding the Q search bar, see
10373
+ # [Embedding Overview][1].
10374
+ #
10375
+ #
10376
+ #
10377
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html
10378
+ # @return [Types::RegisteredUserQSearchBarEmbeddingConfiguration]
10379
+ #
10219
10380
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserEmbeddingExperienceConfiguration AWS API Documentation
10220
10381
  #
10221
10382
  class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
10222
10383
  :dashboard,
10223
- :quick_sight_console)
10384
+ :quick_sight_console,
10385
+ :q_search_bar)
10386
+ SENSITIVE = []
10387
+ include Aws::Structure
10388
+ end
10389
+
10390
+ # Information about the Q search bar embedding experience.
10391
+ #
10392
+ # @note When making an API call, you may pass RegisteredUserQSearchBarEmbeddingConfiguration
10393
+ # data as a hash:
10394
+ #
10395
+ # {
10396
+ # initial_topic_id: "RestrictiveResourceId",
10397
+ # }
10398
+ #
10399
+ # @!attribute [rw] initial_topic_id
10400
+ # The ID of the Q topic that you want to make the starting topic in
10401
+ # the Q search bar. You can find a topic ID by navigating to the
10402
+ # Topics pane in the Amazon QuickSight application and opening a
10403
+ # topic. The ID is in the URL for the topic that you open.
10404
+ #
10405
+ # If you don't specify an initial topic, a list of all shared topics
10406
+ # is shown in the Q bar for your readers. When you select an initial
10407
+ # topic, you can specify whether or not readers are allowed to select
10408
+ # other topics from the available ones in the list.
10409
+ # @return [String]
10410
+ #
10411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisteredUserQSearchBarEmbeddingConfiguration AWS API Documentation
10412
+ #
10413
+ class RegisteredUserQSearchBarEmbeddingConfiguration < Struct.new(
10414
+ :initial_topic_id)
10224
10415
  SENSITIVE = []
10225
10416
  include Aws::Structure
10226
10417
  end
@@ -10409,14 +10600,14 @@ module Aws::QuickSight
10409
10600
  # associated with an analysis, dashboard, template, or theme. (This
10410
10601
  # is common.)
10411
10602
  #
10412
- # * The ARN of an Amazon Web Services account root: This is an IAMARN
10413
- # rather than a Amazon QuickSight ARN. Use this option only to share
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
10414
10605
  # resources (templates) across Amazon Web Services accounts. (This
10415
10606
  # is less common.)
10416
10607
  # @return [String]
10417
10608
  #
10418
10609
  # @!attribute [rw] actions
10419
- # The IAMaction to grant or revoke permissions on.
10610
+ # The IAM action to grant or revoke permissions on.
10420
10611
  # @return [Array<String>]
10421
10612
  #
10422
10613
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourcePermission AWS API Documentation
@@ -10515,11 +10706,16 @@ module Aws::QuickSight
10515
10706
  # The number of rows that were not ingested.
10516
10707
  # @return [Integer]
10517
10708
  #
10709
+ # @!attribute [rw] total_rows_in_dataset
10710
+ # The total number of rows in the dataset.
10711
+ # @return [Integer]
10712
+ #
10518
10713
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowInfo AWS API Documentation
10519
10714
  #
10520
10715
  class RowInfo < Struct.new(
10521
10716
  :rows_ingested,
10522
- :rows_dropped)
10717
+ :rows_dropped,
10718
+ :total_rows_in_dataset)
10523
10719
  SENSITIVE = []
10524
10720
  include Aws::Structure
10525
10721
  end
@@ -10909,7 +11105,7 @@ module Aws::QuickSight
10909
11105
  # }
10910
11106
  #
10911
11107
  # @!attribute [rw] aws_account_id
10912
- # The AWS account ID.
11108
+ # The ID for the Amazon Web Services account that contains the folder.
10913
11109
  # @return [String]
10914
11110
  #
10915
11111
  # @!attribute [rw] filters
@@ -10940,12 +11136,13 @@ module Aws::QuickSight
10940
11136
  end
10941
11137
 
10942
11138
  # @!attribute [rw] status
10943
- # The status. If succeeded, the status is `SC_OK`.
11139
+ # The HTTP status of the request.
10944
11140
  # @return [Integer]
10945
11141
  #
10946
11142
  # @!attribute [rw] folder_summary_list
10947
- # A structure that contains all of the folders in your AWS account.
10948
- # This structure provides basic information about the folders.
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.
10949
11146
  # @return [Array<Types::FolderSummary>]
10950
11147
  #
10951
11148
  # @!attribute [rw] next_token
@@ -10954,7 +11151,7 @@ module Aws::QuickSight
10954
11151
  # @return [String]
10955
11152
  #
10956
11153
  # @!attribute [rw] request_id
10957
- # The request ID.
11154
+ # The Amazon Web Services request ID for this operation.
10958
11155
  # @return [String]
10959
11156
  #
10960
11157
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchFoldersResponse AWS API Documentation
@@ -11402,7 +11599,7 @@ module Aws::QuickSight
11402
11599
  #
11403
11600
  # @!attribute [rw] template_id
11404
11601
  # The ID for the template. This is unique per Amazon Web Services
11405
- # Region; for each Amazon Web Services account.
11602
+ # Region for each Amazon Web Services account.
11406
11603
  # @return [String]
11407
11604
  #
11408
11605
  # @!attribute [rw] last_updated_time
@@ -11569,7 +11766,7 @@ module Aws::QuickSight
11569
11766
  #
11570
11767
  # @!attribute [rw] template_id
11571
11768
  # The ID of the template. This ID is unique per Amazon Web Services
11572
- # Region; for each Amazon Web Services account.
11769
+ # Region for each Amazon Web Services account.
11573
11770
  # @return [String]
11574
11771
  #
11575
11772
  # @!attribute [rw] name
@@ -11897,7 +12094,7 @@ module Aws::QuickSight
11897
12094
  #
11898
12095
  # @!attribute [rw] theme_id
11899
12096
  # The ID of the theme. This ID is unique per Amazon Web Services
11900
- # Region; for each Amazon Web Services account.
12097
+ # Region for each Amazon Web Services account.
11901
12098
  # @return [String]
11902
12099
  #
11903
12100
  # @!attribute [rw] latest_version_number
@@ -12339,12 +12536,12 @@ module Aws::QuickSight
12339
12536
  # This error indicates that you are calling an embedding operation in
12340
12537
  # Amazon QuickSight without the required pricing plan on your Amazon Web
12341
12538
  # Services account. Before you can use embedding for anonymous users, a
12342
- # Amazon QuickSight administrator needs to add capacity pricing to
12343
- # Amazon QuickSight. You can do this on the **Manage Amazon QuickSight**
12344
- # page.
12539
+ # QuickSight administrator needs to add capacity pricing to Amazon
12540
+ # QuickSight. You can do this on the **Manage Amazon QuickSight** page.
12345
12541
  #
12346
- # After capacity pricing is added, you can use the GetDashboardEmbedUrl
12347
- # API operation with the `--identity-type ANONYMOUS` option.
12542
+ # After capacity pricing is added, you can use the `
12543
+ # GetDashboardEmbedUrl ` API operation with the `--identity-type
12544
+ # ANONYMOUS` option.
12348
12545
  #
12349
12546
  # @!attribute [rw] message
12350
12547
  # @return [String]
@@ -12463,6 +12660,7 @@ module Aws::QuickSight
12463
12660
  # namespace: "Namespace",
12464
12661
  # account_customization: { # required
12465
12662
  # default_theme: "Arn",
12663
+ # default_email_customization_template: "Arn",
12466
12664
  # },
12467
12665
  # }
12468
12666
  #
@@ -12478,7 +12676,7 @@ module Aws::QuickSight
12478
12676
  #
12479
12677
  # @!attribute [rw] account_customization
12480
12678
  # The Amazon QuickSight customizations you're updating in the current
12481
- # Amazon Web Services Region;.
12679
+ # Amazon Web Services Region.
12482
12680
  # @return [Types::AccountCustomization]
12483
12681
  #
12484
12682
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
@@ -12508,7 +12706,7 @@ module Aws::QuickSight
12508
12706
  #
12509
12707
  # @!attribute [rw] account_customization
12510
12708
  # The Amazon QuickSight customizations you're updating in the current
12511
- # Amazon Web Services Region;.
12709
+ # Amazon Web Services Region.
12512
12710
  # @return [Types::AccountCustomization]
12513
12711
  #
12514
12712
  # @!attribute [rw] request_id
@@ -12814,6 +13012,18 @@ module Aws::QuickSight
12814
13012
  # actions: ["String"], # required
12815
13013
  # },
12816
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
+ # ],
12817
13027
  # }
12818
13028
  #
12819
13029
  # @!attribute [rw] aws_account_id
@@ -12833,13 +13043,23 @@ module Aws::QuickSight
12833
13043
  # The permissions that you want to revoke from this resource.
12834
13044
  # @return [Array<Types::ResourcePermission>]
12835
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
+ #
12836
13054
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardPermissionsRequest AWS API Documentation
12837
13055
  #
12838
13056
  class UpdateDashboardPermissionsRequest < Struct.new(
12839
13057
  :aws_account_id,
12840
13058
  :dashboard_id,
12841
13059
  :grant_permissions,
12842
- :revoke_permissions)
13060
+ :revoke_permissions,
13061
+ :grant_link_permissions,
13062
+ :revoke_link_permissions)
12843
13063
  SENSITIVE = []
12844
13064
  include Aws::Structure
12845
13065
  end
@@ -12864,6 +13084,11 @@ module Aws::QuickSight
12864
13084
  # The HTTP status of the request.
12865
13085
  # @return [Integer]
12866
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
+ #
12867
13092
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardPermissionsResponse AWS API Documentation
12868
13093
  #
12869
13094
  class UpdateDashboardPermissionsResponse < Struct.new(
@@ -12871,7 +13096,8 @@ module Aws::QuickSight
12871
13096
  :dashboard_id,
12872
13097
  :permissions,
12873
13098
  :request_id,
12874
- :status)
13099
+ :status,
13100
+ :link_sharing_configuration)
12875
13101
  SENSITIVE = []
12876
13102
  include Aws::Structure
12877
13103
  end
@@ -13013,10 +13239,10 @@ module Aws::QuickSight
13013
13239
  # using as source. You can only update a dashboard from a template, so
13014
13240
  # you use a `SourceTemplate` entity. If you need to update a dashboard
13015
13241
  # from an analysis, first convert the analysis to a template by using
13016
- # the CreateTemplate API operation. For `SourceTemplate`, specify the
13017
- # 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
13018
13244
  # `SourceTemplate` ARN can contain any Amazon Web Services account and
13019
- # any Amazon QuickSight-supported Amazon Web Services Region;.
13245
+ # any Amazon QuickSight-supported Amazon Web Services Region.
13020
13246
  #
13021
13247
  # Use the `DataSetReferences` entity within `SourceTemplate` to list
13022
13248
  # the replacement datasets for the placeholders listed in the
@@ -13138,7 +13364,7 @@ module Aws::QuickSight
13138
13364
  #
13139
13365
  # @!attribute [rw] data_set_id
13140
13366
  # The ID for the dataset whose permissions you want to update. This ID
13141
- # is unique per Amazon Web Services Region; for each Amazon Web
13367
+ # is unique per Amazon Web Services Region for each Amazon Web
13142
13368
  # Services account.
13143
13369
  # @return [String]
13144
13370
  #
@@ -13167,7 +13393,7 @@ module Aws::QuickSight
13167
13393
  #
13168
13394
  # @!attribute [rw] data_set_id
13169
13395
  # The ID for the dataset whose permissions you want to update. This ID
13170
- # is unique per Amazon Web Services Region; for each Amazon Web
13396
+ # is unique per Amazon Web Services Region for each Amazon Web
13171
13397
  # Services account.
13172
13398
  # @return [String]
13173
13399
  #
@@ -13356,8 +13582,7 @@ module Aws::QuickSight
13356
13582
  #
13357
13583
  # @!attribute [rw] data_set_id
13358
13584
  # The ID for the dataset that you want to update. This ID is unique
13359
- # per Amazon Web Services Region; for each Amazon Web Services
13360
- # account.
13585
+ # per Amazon Web Services Region for each Amazon Web Services account.
13361
13586
  # @return [String]
13362
13587
  #
13363
13588
  # @!attribute [rw] name
@@ -13433,8 +13658,7 @@ module Aws::QuickSight
13433
13658
  #
13434
13659
  # @!attribute [rw] data_set_id
13435
13660
  # The ID for the dataset that you want to create. This ID is unique
13436
- # per Amazon Web Services Region; for each Amazon Web Services
13437
- # account.
13661
+ # per Amazon Web Services Region for each Amazon Web Services account.
13438
13662
  # @return [String]
13439
13663
  #
13440
13664
  # @!attribute [rw] ingestion_arn
@@ -13494,7 +13718,7 @@ module Aws::QuickSight
13494
13718
  #
13495
13719
  # @!attribute [rw] data_source_id
13496
13720
  # The ID of the data source. This ID is unique per Amazon Web Services
13497
- # Region; for each Amazon Web Services account.
13721
+ # Region for each Amazon Web Services account.
13498
13722
  # @return [String]
13499
13723
  #
13500
13724
  # @!attribute [rw] grant_permissions
@@ -13524,7 +13748,7 @@ module Aws::QuickSight
13524
13748
  #
13525
13749
  # @!attribute [rw] data_source_id
13526
13750
  # The ID of the data source. This ID is unique per Amazon Web Services
13527
- # Region; for each Amazon Web Services account.
13751
+ # Region for each Amazon Web Services account.
13528
13752
  # @return [String]
13529
13753
  #
13530
13754
  # @!attribute [rw] request_id
@@ -13646,6 +13870,10 @@ module Aws::QuickSight
13646
13870
  # amazon_open_search_parameters: {
13647
13871
  # domain: "Domain", # required
13648
13872
  # },
13873
+ # exasol_parameters: {
13874
+ # host: "Host", # required
13875
+ # port: 1, # required
13876
+ # },
13649
13877
  # },
13650
13878
  # credentials: {
13651
13879
  # credential_pair: {
@@ -13745,6 +13973,10 @@ module Aws::QuickSight
13745
13973
  # amazon_open_search_parameters: {
13746
13974
  # domain: "Domain", # required
13747
13975
  # },
13976
+ # exasol_parameters: {
13977
+ # host: "Host", # required
13978
+ # port: 1, # required
13979
+ # },
13748
13980
  # },
13749
13981
  # ],
13750
13982
  # },
@@ -13764,7 +13996,7 @@ module Aws::QuickSight
13764
13996
  #
13765
13997
  # @!attribute [rw] data_source_id
13766
13998
  # The ID of the data source. This ID is unique per Amazon Web Services
13767
- # Region; for each Amazon Web Services account.
13999
+ # Region for each Amazon Web Services account.
13768
14000
  # @return [String]
13769
14001
  #
13770
14002
  # @!attribute [rw] name
@@ -13812,7 +14044,7 @@ module Aws::QuickSight
13812
14044
  #
13813
14045
  # @!attribute [rw] data_source_id
13814
14046
  # The ID of the data source. This ID is unique per Amazon Web Services
13815
- # Region; for each Amazon Web Services account.
14047
+ # Region for each Amazon Web Services account.
13816
14048
  # @return [String]
13817
14049
  #
13818
14050
  # @!attribute [rw] update_status
@@ -13860,11 +14092,12 @@ module Aws::QuickSight
13860
14092
  # }
13861
14093
  #
13862
14094
  # @!attribute [rw] aws_account_id
13863
- # The AWS account ID.
14095
+ # The ID for the Amazon Web Services account that contains the folder
14096
+ # to update.
13864
14097
  # @return [String]
13865
14098
  #
13866
14099
  # @!attribute [rw] folder_id
13867
- # The folder ID.
14100
+ # The ID of the folder.
13868
14101
  # @return [String]
13869
14102
  #
13870
14103
  # @!attribute [rw] grant_permissions
@@ -13887,23 +14120,23 @@ module Aws::QuickSight
13887
14120
  end
13888
14121
 
13889
14122
  # @!attribute [rw] status
13890
- # The status. If succeeded, the status is `SC_OK`.
14123
+ # The HTTP status of the request.
13891
14124
  # @return [Integer]
13892
14125
  #
13893
14126
  # @!attribute [rw] arn
13894
- # The Amazon Resource Name (ARN).
14127
+ # The Amazon Resource Name (ARN) of the folder.
13895
14128
  # @return [String]
13896
14129
  #
13897
14130
  # @!attribute [rw] folder_id
13898
- # The folder ID.
14131
+ # The ID of the folder.
13899
14132
  # @return [String]
13900
14133
  #
13901
14134
  # @!attribute [rw] permissions
13902
- # Information about the permissions on the dashboard.
14135
+ # Information about the permissions for the folder.
13903
14136
  # @return [Array<Types::ResourcePermission>]
13904
14137
  #
13905
14138
  # @!attribute [rw] request_id
13906
- # The request ID.
14139
+ # The Amazon Web Services request ID for this operation.
13907
14140
  # @return [String]
13908
14141
  #
13909
14142
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderPermissionsResponse AWS API Documentation
@@ -13928,11 +14161,12 @@ module Aws::QuickSight
13928
14161
  # }
13929
14162
  #
13930
14163
  # @!attribute [rw] aws_account_id
13931
- # The AWS account ID.
14164
+ # The ID for the Amazon Web Services account that contains the folder
14165
+ # to update.
13932
14166
  # @return [String]
13933
14167
  #
13934
14168
  # @!attribute [rw] folder_id
13935
- # The folder ID.
14169
+ # The ID of the folder.
13936
14170
  # @return [String]
13937
14171
  #
13938
14172
  # @!attribute [rw] name
@@ -13950,19 +14184,19 @@ module Aws::QuickSight
13950
14184
  end
13951
14185
 
13952
14186
  # @!attribute [rw] status
13953
- # The status. If succeeded, the status is `SC_OK`.
14187
+ # The HTTP status of the request.
13954
14188
  # @return [Integer]
13955
14189
  #
13956
14190
  # @!attribute [rw] arn
13957
- # The Amazon Resource Name (ARN).
14191
+ # The Amazon Resource Name (ARN) of the folder.
13958
14192
  # @return [String]
13959
14193
  #
13960
14194
  # @!attribute [rw] folder_id
13961
- # The folder ID.
14195
+ # The ID of the folder.
13962
14196
  # @return [String]
13963
14197
  #
13964
14198
  # @!attribute [rw] request_id
13965
- # The request ID.
14199
+ # The Amazon Web Services request ID for this operation.
13966
14200
  # @return [String]
13967
14201
  #
13968
14202
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderResponse AWS API Documentation
@@ -14052,8 +14286,8 @@ module Aws::QuickSight
14052
14286
  # }
14053
14287
  #
14054
14288
  # @!attribute [rw] aws_account_id
14055
- # The ID of the Amazon Web Services account that contains the
14056
- # IAMpolicy assignment.
14289
+ # The ID of the Amazon Web Services account that contains the IAM
14290
+ # policy assignment.
14057
14291
  # @return [String]
14058
14292
  #
14059
14293
  # @!attribute [rw] assignment_name
@@ -14079,7 +14313,7 @@ module Aws::QuickSight
14079
14313
  # @return [String]
14080
14314
  #
14081
14315
  # @!attribute [rw] policy_arn
14082
- # The ARN for the IAMpolicy to apply to the Amazon QuickSight users
14316
+ # The ARN for the IAM policy to apply to the Amazon QuickSight users
14083
14317
  # and groups specified in this assignment.
14084
14318
  # @return [String]
14085
14319
  #
@@ -14110,12 +14344,12 @@ module Aws::QuickSight
14110
14344
  # @return [String]
14111
14345
  #
14112
14346
  # @!attribute [rw] policy_arn
14113
- # The ARN for the IAMpolicy applied to the Amazon QuickSight users and
14114
- # 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.
14115
14349
  # @return [String]
14116
14350
  #
14117
14351
  # @!attribute [rw] identities
14118
- # The Amazon QuickSight users, groups, or both that the IAMpolicy is
14352
+ # The Amazon QuickSight users, groups, or both that the IAM policy is
14119
14353
  # assigned to.
14120
14354
  # @return [Hash<String,Array<String>>]
14121
14355
  #
@@ -14154,6 +14388,64 @@ module Aws::QuickSight
14154
14388
  include Aws::Structure
14155
14389
  end
14156
14390
 
14391
+ # @note When making an API call, you may pass UpdateIpRestrictionRequest
14392
+ # data as a hash:
14393
+ #
14394
+ # {
14395
+ # aws_account_id: "AwsAccountId", # required
14396
+ # ip_restriction_rule_map: {
14397
+ # "CIDR" => "IpRestrictionRuleDescription",
14398
+ # },
14399
+ # enabled: false,
14400
+ # }
14401
+ #
14402
+ # @!attribute [rw] aws_account_id
14403
+ # The ID of the Amazon Web Services account that contains the IP
14404
+ # rules.
14405
+ # @return [String]
14406
+ #
14407
+ # @!attribute [rw] ip_restriction_rule_map
14408
+ # A map that describes the updated IP rules with CIDR ranges and
14409
+ # descriptions.
14410
+ # @return [Hash<String,String>]
14411
+ #
14412
+ # @!attribute [rw] enabled
14413
+ # A value that specifies whether IP rules are turned on.
14414
+ # @return [Boolean]
14415
+ #
14416
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIpRestrictionRequest AWS API Documentation
14417
+ #
14418
+ class UpdateIpRestrictionRequest < Struct.new(
14419
+ :aws_account_id,
14420
+ :ip_restriction_rule_map,
14421
+ :enabled)
14422
+ SENSITIVE = []
14423
+ include Aws::Structure
14424
+ end
14425
+
14426
+ # @!attribute [rw] aws_account_id
14427
+ # The ID of the Amazon Web Services account that contains the IP
14428
+ # rules.
14429
+ # @return [String]
14430
+ #
14431
+ # @!attribute [rw] request_id
14432
+ # The Amazon Web Services request ID for this operation.
14433
+ # @return [String]
14434
+ #
14435
+ # @!attribute [rw] status
14436
+ # The HTTP status of the request.
14437
+ # @return [Integer]
14438
+ #
14439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIpRestrictionResponse AWS API Documentation
14440
+ #
14441
+ class UpdateIpRestrictionResponse < Struct.new(
14442
+ :aws_account_id,
14443
+ :request_id,
14444
+ :status)
14445
+ SENSITIVE = []
14446
+ include Aws::Structure
14447
+ end
14448
+
14157
14449
  # @note When making an API call, you may pass UpdateTemplateAliasRequest
14158
14450
  # data as a hash:
14159
14451
  #
@@ -14747,12 +15039,12 @@ module Aws::QuickSight
14747
15039
  # restrictions. Currently, you need to create the profile names for
14748
15040
  # custom permission sets by using the Amazon QuickSight console. Then,
14749
15041
  # you use the `RegisterUser` API operation to assign the named set of
14750
- # permissions to a Amazon QuickSight user.
15042
+ # permissions to a QuickSight user.
14751
15043
  #
14752
- # Amazon QuickSight custom permissions are applied through
14753
- # IAMpolicies. Therefore, they override the permissions typically
14754
- # granted by assigning Amazon QuickSight users to one of the default
14755
- # security cohorts in Amazon QuickSight (admin, author, reader).
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).
14756
15048
  #
14757
15049
  # This feature is available only to Amazon QuickSight Enterprise
14758
15050
  # edition subscriptions.
@@ -14783,8 +15075,8 @@ module Aws::QuickSight
14783
15075
  # parameter to provide the custom OIDC provider URL.
14784
15076
  #
14785
15077
  # * `NONE`\: This clears all the previously saved external login
14786
- # information for a user. Use ` DescribeUser ` API to check the
14787
- # external login information.
15078
+ # information for a user. Use the ` DescribeUser ` API operation to
15079
+ # check the external login information.
14788
15080
  # @return [String]
14789
15081
  #
14790
15082
  # @!attribute [rw] custom_federation_provider_url
@@ -14891,7 +15183,9 @@ module Aws::QuickSight
14891
15183
  # @return [String]
14892
15184
  #
14893
15185
  # @!attribute [rw] user_name
14894
- # 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.
14895
15189
  # @return [String]
14896
15190
  #
14897
15191
  # @!attribute [rw] email
@@ -14938,7 +15232,7 @@ module Aws::QuickSight
14938
15232
  # @!attribute [rw] external_login_federation_provider_type
14939
15233
  # The type of supported external login provider that provides identity
14940
15234
  # to let the user federate into Amazon QuickSight with an associated
14941
- # IAMrole. The type can be one of the following.
15235
+ # IAM role. The type can be one of the following.
14942
15236
  #
14943
15237
  # * `COGNITO`\: Amazon Cognito. The provider URL is
14944
15238
  # cognito-identity.amazonaws.com.