aws-sdk-quicksight 1.55.0 → 1.59.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -119,7 +119,9 @@ module Aws::QuickSight
119
119
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
120
  # are very aggressive. Construct and pass an instance of
121
121
  # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
- # enable retries and extended timeouts.
122
+ # enable retries and extended timeouts. Instance profile credential
123
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
124
+ # to true.
123
125
  #
124
126
  # @option options [required, String] :region
125
127
  # The AWS region to connect to. The configured `:region` is
@@ -275,6 +277,15 @@ module Aws::QuickSight
275
277
  # ** Please note ** When response stubbing is enabled, no HTTP
276
278
  # requests are made, and retries are disabled.
277
279
  #
280
+ # @option options [Boolean] :use_dualstack_endpoint
281
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
282
+ # will be used if available.
283
+ #
284
+ # @option options [Boolean] :use_fips_endpoint
285
+ # When set to `true`, fips compatible endpoints will be used if available.
286
+ # When a `fips` region is used, the region is normalized and this config
287
+ # is set to `true`.
288
+ #
278
289
  # @option options [Boolean] :validate_params (true)
279
290
  # When `true`, request parameters are validated before
280
291
  # sending the request.
@@ -378,7 +389,7 @@ module Aws::QuickSight
378
389
  # Guide.*
379
390
  #
380
391
  # You can create customizations for your Amazon Web Services account or,
381
- # if you specify a namespace, for a Amazon QuickSight namespace instead.
392
+ # if you specify a namespace, for a QuickSight namespace instead.
382
393
  # Customizations that apply to a namespace always override
383
394
  # customizations that apply to an Amazon Web Services account. To find
384
395
  # out which customizations apply, use the `DescribeAccountCustomization`
@@ -408,7 +419,7 @@ module Aws::QuickSight
408
419
  # @option params [required, Types::AccountCustomization] :account_customization
409
420
  # The Amazon QuickSight customizations you're adding in the current
410
421
  # Amazon Web Services Region. You can add these to an Amazon Web
411
- # Services account and a Amazon QuickSight namespace.
422
+ # Services account and a QuickSight namespace.
412
423
  #
413
424
  # For example, you can add a default theme by setting
414
425
  # `AccountCustomization` to the midnight theme: `"AccountCustomization":
@@ -437,6 +448,7 @@ module Aws::QuickSight
437
448
  # namespace: "Namespace",
438
449
  # account_customization: { # required
439
450
  # default_theme: "Arn",
451
+ # default_email_customization_template: "Arn",
440
452
  # },
441
453
  # tags: [
442
454
  # {
@@ -452,6 +464,7 @@ module Aws::QuickSight
452
464
  # resp.aws_account_id #=> String
453
465
  # resp.namespace #=> String
454
466
  # resp.account_customization.default_theme #=> String
467
+ # resp.account_customization.default_email_customization_template #=> String
455
468
  # resp.request_id #=> String
456
469
  # resp.status #=> Integer
457
470
  #
@@ -604,7 +617,7 @@ module Aws::QuickSight
604
617
  # dashboard.
605
618
  #
606
619
  # @option params [required, String] :dashboard_id
607
- # The ID for the dashboard, also added to the IAMpolicy.
620
+ # The ID for the dashboard, also added to the IAM policy.
608
621
  #
609
622
  # @option params [required, String] :name
610
623
  # The display name of the dashboard.
@@ -616,8 +629,8 @@ module Aws::QuickSight
616
629
  #
617
630
  # @option params [Array<Types::ResourcePermission>] :permissions
618
631
  # A structure that contains the permissions of the dashboard. You can
619
- # use this structure for granting permissions by providing a list of
620
- # IAMaction information for each principal ARN.
632
+ # use this structure for granting permissions by providing a list of IAM
633
+ # action information for each principal ARN.
621
634
  #
622
635
  # To specify no permissions, omit the permissions list.
623
636
  #
@@ -627,8 +640,8 @@ module Aws::QuickSight
627
640
  # using as source. You can only create a dashboard from a template, so
628
641
  # you use a `SourceTemplate` entity. If you need to create a dashboard
629
642
  # from an analysis, first convert the analysis to a template by using
630
- # the CreateTemplate API operation. For `SourceTemplate`, specify the
631
- # Amazon Resource Name (ARN) of the source template. The
643
+ # the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
644
+ # the Amazon Resource Name (ARN) of the source template. The
632
645
  # `SourceTemplate`ARN can contain any Amazon Web Services account and
633
646
  # any Amazon QuickSight-supported Amazon Web Services Region.
634
647
  #
@@ -1072,7 +1085,7 @@ module Aws::QuickSight
1072
1085
  # aws_account_id: "AwsAccountId", # required
1073
1086
  # data_source_id: "ResourceId", # required
1074
1087
  # name: "ResourceName", # required
1075
- # type: "ADOBE_ANALYTICS", # required, accepts ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM, AMAZON_OPENSEARCH
1088
+ # 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
1076
1089
  # data_source_parameters: {
1077
1090
  # amazon_elasticsearch_parameters: {
1078
1091
  # domain: "Domain", # required
@@ -1166,6 +1179,10 @@ module Aws::QuickSight
1166
1179
  # amazon_open_search_parameters: {
1167
1180
  # domain: "Domain", # required
1168
1181
  # },
1182
+ # exasol_parameters: {
1183
+ # host: "Host", # required
1184
+ # port: 1, # required
1185
+ # },
1169
1186
  # },
1170
1187
  # credentials: {
1171
1188
  # credential_pair: {
@@ -1265,6 +1282,10 @@ module Aws::QuickSight
1265
1282
  # amazon_open_search_parameters: {
1266
1283
  # domain: "Domain", # required
1267
1284
  # },
1285
+ # exasol_parameters: {
1286
+ # host: "Host", # required
1287
+ # port: 1, # required
1288
+ # },
1268
1289
  # },
1269
1290
  # ],
1270
1291
  # },
@@ -1310,10 +1331,11 @@ module Aws::QuickSight
1310
1331
  # Creates an empty shared folder.
1311
1332
  #
1312
1333
  # @option params [required, String] :aws_account_id
1313
- # The AWS Account ID.
1334
+ # The ID for the Amazon Web Services account where you want to create
1335
+ # the folder.
1314
1336
  #
1315
1337
  # @option params [required, String] :folder_id
1316
- # The folder ID.
1338
+ # The ID of the folder.
1317
1339
  #
1318
1340
  # @option params [String] :name
1319
1341
  # The name of the folder.
@@ -1385,10 +1407,10 @@ module Aws::QuickSight
1385
1407
  # folder.
1386
1408
  #
1387
1409
  # @option params [required, String] :aws_account_id
1388
- # The AWS Account ID.
1410
+ # The ID for the Amazon Web Services account that contains the folder.
1389
1411
  #
1390
1412
  # @option params [required, String] :folder_id
1391
- # The folder ID.
1413
+ # The ID of the folder.
1392
1414
  #
1393
1415
  # @option params [required, String] :member_id
1394
1416
  # The ID of the asset (the dashboard, analysis, or dataset).
@@ -1530,7 +1552,7 @@ module Aws::QuickSight
1530
1552
  req.send_request(options)
1531
1553
  end
1532
1554
 
1533
- # Creates an assignment with one specified IAMpolicy, identified by its
1555
+ # Creates an assignment with one specified IAM policy, identified by its
1534
1556
  # Amazon Resource Name (ARN). This policy assignment is attached to the
1535
1557
  # specified groups or users of Amazon QuickSight. Assignment names are
1536
1558
  # unique per Amazon Web Services account. To avoid overwriting rules in
@@ -1538,7 +1560,7 @@ module Aws::QuickSight
1538
1560
  #
1539
1561
  # @option params [required, String] :aws_account_id
1540
1562
  # The ID of the Amazon Web Services account where you want to assign an
1541
- # IAMpolicy to Amazon QuickSight users or groups.
1563
+ # IAM policy to Amazon QuickSight users or groups.
1542
1564
  #
1543
1565
  # @option params [required, String] :assignment_name
1544
1566
  # The name of the assignment, also called a rule. It must be unique
@@ -1557,7 +1579,7 @@ module Aws::QuickSight
1557
1579
  # when creating the data source.
1558
1580
  #
1559
1581
  # @option params [String] :policy_arn
1560
- # The ARN for the IAMpolicy to apply to the Amazon QuickSight users and
1582
+ # The ARN for the IAM policy to apply to the Amazon QuickSight users and
1561
1583
  # groups specified in this assignment.
1562
1584
  #
1563
1585
  # @option params [Hash<String,Array>] :identities
@@ -1929,7 +1951,7 @@ module Aws::QuickSight
1929
1951
  # The ID of the theme that a custom theme will inherit from. All themes
1930
1952
  # inherit from one of the starting themes defined by Amazon QuickSight.
1931
1953
  # For a list of the starting themes, use `ListThemes` or choose
1932
- # **Themes** from within a Amazon QuickSight analysis.
1954
+ # **Themes** from within an analysis.
1933
1955
  #
1934
1956
  # @option params [String] :version_description
1935
1957
  # A description of the first version of the theme that you're creating.
@@ -2321,10 +2343,10 @@ module Aws::QuickSight
2321
2343
  # Deletes an empty folder.
2322
2344
  #
2323
2345
  # @option params [required, String] :aws_account_id
2324
- # The AWS Account ID for the folder.
2346
+ # The ID for the Amazon Web Services account that contains the folder.
2325
2347
  #
2326
2348
  # @option params [required, String] :folder_id
2327
- # The folder ID.
2349
+ # The ID of the folder.
2328
2350
  #
2329
2351
  # @return [Types::DeleteFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2330
2352
  #
@@ -2360,7 +2382,7 @@ module Aws::QuickSight
2360
2382
  # folder.
2361
2383
  #
2362
2384
  # @option params [required, String] :aws_account_id
2363
- # The AWS Account ID.
2385
+ # The ID for the Amazon Web Services account that contains the folder.
2364
2386
  #
2365
2387
  # @option params [required, String] :folder_id
2366
2388
  # The Folder ID.
@@ -2487,11 +2509,11 @@ module Aws::QuickSight
2487
2509
  req.send_request(options)
2488
2510
  end
2489
2511
 
2490
- # Deletes an existing IAMpolicy assignment.
2512
+ # Deletes an existing IAM policy assignment.
2491
2513
  #
2492
2514
  # @option params [required, String] :aws_account_id
2493
- # The Amazon Web Services account ID where you want to delete the
2494
- # IAMpolicy assignment.
2515
+ # The Amazon Web Services account ID where you want to delete the IAM
2516
+ # policy assignment.
2495
2517
  #
2496
2518
  # @option params [required, String] :assignment_name
2497
2519
  # The name of the assignment.
@@ -2849,11 +2871,11 @@ module Aws::QuickSight
2849
2871
  #
2850
2872
  # * `Amazon Web Services account` - The Amazon Web Services account
2851
2873
  # exists at the top of the hierarchy. It has the potential to use all
2852
- # of the Amazon Web Services Regions and AWS Services. When you
2853
- # subscribe to Amazon QuickSight, you choose one Amazon Web Services
2854
- # Region to use as your home Region. That's where your free SPICE
2855
- # capacity is located. You can use Amazon QuickSight in any supported
2856
- # Amazon Web Services Region.
2874
+ # of the Amazon Web Services Regions and Amazon Web Services Services.
2875
+ # When you subscribe to Amazon QuickSight, you choose one Amazon Web
2876
+ # Services Region to use as your home Region. That's where your free
2877
+ # SPICE capacity is located. You can use Amazon QuickSight in any
2878
+ # supported Amazon Web Services Region.
2857
2879
  #
2858
2880
  # * `Amazon Web Services Region` - In each Amazon Web Services Region
2859
2881
  # where you sign in to Amazon QuickSight at least once, Amazon
@@ -2864,8 +2886,8 @@ module Aws::QuickSight
2864
2886
  # constrained to a namespace.
2865
2887
  #
2866
2888
  # To run the command in a different Amazon Web Services Region, you
2867
- # change your Region settings. If you're using the AWS CLI, you can
2868
- # use one of the following options:
2889
+ # change your Region settings. If you're using the CLI, you can use
2890
+ # one of the following options:
2869
2891
  #
2870
2892
  # * Use [command line options][1].
2871
2893
  #
@@ -2873,12 +2895,12 @@ module Aws::QuickSight
2873
2895
  #
2874
2896
  # * Run `aws configure` to change your default Amazon Web Services
2875
2897
  # Region. Use Enter to key the same settings for your keys. For more
2876
- # information, see [Configuring the AWS CLI][3].
2898
+ # information, see [Configuring the CLI][3].
2877
2899
  #
2878
- # * `Namespace` - A Amazon QuickSight namespace is a partition that
2879
- # contains users and assets (data sources, datasets, dashboards, and
2880
- # so on). To access assets that are in a specific namespace, users and
2881
- # groups must also be part of the same namespace. People who share a
2900
+ # * `Namespace` - A QuickSight namespace is a partition that contains
2901
+ # users and assets (data sources, datasets, dashboards, and so on). To
2902
+ # access assets that are in a specific namespace, users and groups
2903
+ # must also be part of the same namespace. People who share a
2882
2904
  # namespace are completely isolated from users and assets in other
2883
2905
  # namespaces, even if they are in the same Amazon Web Services account
2884
2906
  # and Amazon Web Services Region.
@@ -2937,6 +2959,7 @@ module Aws::QuickSight
2937
2959
  # resp.aws_account_id #=> String
2938
2960
  # resp.namespace #=> String
2939
2961
  # resp.account_customization.default_theme #=> String
2962
+ # resp.account_customization.default_email_customization_template #=> String
2940
2963
  # resp.request_id #=> String
2941
2964
  # resp.status #=> Integer
2942
2965
  #
@@ -3158,7 +3181,7 @@ module Aws::QuickSight
3158
3181
  # that you're describing permissions for.
3159
3182
  #
3160
3183
  # @option params [required, String] :dashboard_id
3161
- # The ID for the dashboard, also added to the IAMpolicy.
3184
+ # The ID for the dashboard, also added to the IAM policy.
3162
3185
  #
3163
3186
  # @return [Types::DescribeDashboardPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3164
3187
  #
@@ -3167,6 +3190,7 @@ module Aws::QuickSight
3167
3190
  # * {Types::DescribeDashboardPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
3168
3191
  # * {Types::DescribeDashboardPermissionsResponse#status #status} => Integer
3169
3192
  # * {Types::DescribeDashboardPermissionsResponse#request_id #request_id} => String
3193
+ # * {Types::DescribeDashboardPermissionsResponse#link_sharing_configuration #link_sharing_configuration} => Types::LinkSharingConfiguration
3170
3194
  #
3171
3195
  # @example Request syntax with placeholder values
3172
3196
  #
@@ -3185,6 +3209,10 @@ module Aws::QuickSight
3185
3209
  # resp.permissions[0].actions[0] #=> String
3186
3210
  # resp.status #=> Integer
3187
3211
  # resp.request_id #=> String
3212
+ # resp.link_sharing_configuration.permissions #=> Array
3213
+ # resp.link_sharing_configuration.permissions[0].principal #=> String
3214
+ # resp.link_sharing_configuration.permissions[0].actions #=> Array
3215
+ # resp.link_sharing_configuration.permissions[0].actions[0] #=> String
3188
3216
  #
3189
3217
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissions AWS API Documentation
3190
3218
  #
@@ -3396,7 +3424,7 @@ module Aws::QuickSight
3396
3424
  # resp.data_source.arn #=> String
3397
3425
  # resp.data_source.data_source_id #=> String
3398
3426
  # resp.data_source.name #=> String
3399
- # resp.data_source.type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH"
3427
+ # resp.data_source.type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL"
3400
3428
  # resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3401
3429
  # resp.data_source.created_time #=> Time
3402
3430
  # resp.data_source.last_updated_time #=> Time
@@ -3448,6 +3476,8 @@ module Aws::QuickSight
3448
3476
  # resp.data_source.data_source_parameters.twitter_parameters.query #=> String
3449
3477
  # resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer
3450
3478
  # resp.data_source.data_source_parameters.amazon_open_search_parameters.domain #=> String
3479
+ # resp.data_source.data_source_parameters.exasol_parameters.host #=> String
3480
+ # resp.data_source.data_source_parameters.exasol_parameters.port #=> Integer
3451
3481
  # resp.data_source.alternate_data_source_parameters #=> Array
3452
3482
  # resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
3453
3483
  # resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
@@ -3497,6 +3527,8 @@ module Aws::QuickSight
3497
3527
  # resp.data_source.alternate_data_source_parameters[0].twitter_parameters.query #=> String
3498
3528
  # resp.data_source.alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
3499
3529
  # resp.data_source.alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> String
3530
+ # resp.data_source.alternate_data_source_parameters[0].exasol_parameters.host #=> String
3531
+ # resp.data_source.alternate_data_source_parameters[0].exasol_parameters.port #=> Integer
3500
3532
  # resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
3501
3533
  # resp.data_source.ssl_properties.disable_ssl #=> Boolean
3502
3534
  # resp.data_source.error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
@@ -3560,10 +3592,10 @@ module Aws::QuickSight
3560
3592
  # Describes a folder.
3561
3593
  #
3562
3594
  # @option params [required, String] :aws_account_id
3563
- # The AWS account ID.
3595
+ # The ID for the Amazon Web Services account that contains the folder.
3564
3596
  #
3565
3597
  # @option params [required, String] :folder_id
3566
- # The folder ID.
3598
+ # The ID of the folder.
3567
3599
  #
3568
3600
  # @return [Types::DescribeFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3569
3601
  #
@@ -3603,10 +3635,10 @@ module Aws::QuickSight
3603
3635
  # Describes permissions for a folder.
3604
3636
  #
3605
3637
  # @option params [required, String] :aws_account_id
3606
- # The AWS Account ID.
3638
+ # The ID for the Amazon Web Services account that contains the folder.
3607
3639
  #
3608
3640
  # @option params [required, String] :folder_id
3609
- # The folder ID.
3641
+ # The ID of the folder.
3610
3642
  #
3611
3643
  # @return [Types::DescribeFolderPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3612
3644
  #
@@ -3648,10 +3680,10 @@ module Aws::QuickSight
3648
3680
  # ancestor folders.
3649
3681
  #
3650
3682
  # @option params [required, String] :aws_account_id
3651
- # The AWS account ID.
3683
+ # The ID for the Amazon Web Services account that contains the folder.
3652
3684
  #
3653
3685
  # @option params [required, String] :folder_id
3654
- # The folder ID.
3686
+ # The ID of the folder.
3655
3687
  #
3656
3688
  # @return [Types::DescribeFolderResolvedPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3657
3689
  #
@@ -3734,7 +3766,7 @@ module Aws::QuickSight
3734
3766
  req.send_request(options)
3735
3767
  end
3736
3768
 
3737
- # Describes an existing IAMpolicy assignment, as specified by the
3769
+ # Describes an existing IAM policy assignment, as specified by the
3738
3770
  # assignment name.
3739
3771
  #
3740
3772
  # @option params [required, String] :aws_account_id
@@ -3837,10 +3869,10 @@ module Aws::QuickSight
3837
3869
  req.send_request(options)
3838
3870
  end
3839
3871
 
3840
- # Provides a summary and status of IP Rules.
3872
+ # Provides a summary and status of IP rules.
3841
3873
  #
3842
3874
  # @option params [required, String] :aws_account_id
3843
- # Your AWS account ID.
3875
+ # The ID of the Amazon Web Services account that contains the IP rules.
3844
3876
  #
3845
3877
  # @return [Types::DescribeIpRestrictionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3846
3878
  #
@@ -4492,6 +4524,9 @@ module Aws::QuickSight
4492
4524
  # quick_sight_console: {
4493
4525
  # initial_path: "EntryPath",
4494
4526
  # },
4527
+ # q_search_bar: {
4528
+ # initial_topic_id: "RestrictiveResourceId",
4529
+ # },
4495
4530
  # },
4496
4531
  # })
4497
4532
  #
@@ -4582,10 +4617,11 @@ module Aws::QuickSight
4582
4617
  #
4583
4618
  # * Invited nonfederated users
4584
4619
  #
4585
- # * IAMusers and IAMrole-based sessions authenticated through Federated
4586
- # Single Sign-On using SAML, OpenID Connect, or IAMfederation.
4620
+ # * IAM users and IAM role-based sessions authenticated through
4621
+ # Federated Single Sign-On using SAML, OpenID Connect, or IAM
4622
+ # federation.
4587
4623
  #
4588
- # Omit this parameter for users in the third group – IAMusers and IAM
4624
+ # Omit this parameter for users in the third group – IAM users and IAM
4589
4625
  # role-based sessions.
4590
4626
  #
4591
4627
  # @option params [String] :namespace
@@ -4597,8 +4633,8 @@ module Aws::QuickSight
4597
4633
  # A list of one or more dashboard IDs that you want to add to a session
4598
4634
  # that includes anonymous users. The `IdentityType` parameter must be
4599
4635
  # set to `ANONYMOUS` for this to work, because other identity types
4600
- # authenticate as Amazon QuickSight or IAMusers. For example, if you set
4601
- # "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
4636
+ # authenticate as Amazon QuickSight or IAM users. For example, if you
4637
+ # set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
4602
4638
  # identity-type ANONYMOUS`", the session can access all three
4603
4639
  # dashboards.
4604
4640
  #
@@ -4991,7 +5027,7 @@ module Aws::QuickSight
4991
5027
  # resp.data_sources[0].arn #=> String
4992
5028
  # resp.data_sources[0].data_source_id #=> String
4993
5029
  # resp.data_sources[0].name #=> String
4994
- # resp.data_sources[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH"
5030
+ # resp.data_sources[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "ORACLE", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER", "TIMESTREAM", "AMAZON_OPENSEARCH", "EXASOL"
4995
5031
  # resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
4996
5032
  # resp.data_sources[0].created_time #=> Time
4997
5033
  # resp.data_sources[0].last_updated_time #=> Time
@@ -5043,6 +5079,8 @@ module Aws::QuickSight
5043
5079
  # resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
5044
5080
  # resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
5045
5081
  # resp.data_sources[0].data_source_parameters.amazon_open_search_parameters.domain #=> String
5082
+ # resp.data_sources[0].data_source_parameters.exasol_parameters.host #=> String
5083
+ # resp.data_sources[0].data_source_parameters.exasol_parameters.port #=> Integer
5046
5084
  # resp.data_sources[0].alternate_data_source_parameters #=> Array
5047
5085
  # resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
5048
5086
  # resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
@@ -5092,6 +5130,8 @@ module Aws::QuickSight
5092
5130
  # resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.query #=> String
5093
5131
  # resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
5094
5132
  # resp.data_sources[0].alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> String
5133
+ # resp.data_sources[0].alternate_data_source_parameters[0].exasol_parameters.host #=> String
5134
+ # resp.data_sources[0].alternate_data_source_parameters[0].exasol_parameters.port #=> Integer
5095
5135
  # resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
5096
5136
  # resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
5097
5137
  # resp.data_sources[0].error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
@@ -5112,10 +5152,10 @@ module Aws::QuickSight
5112
5152
  # List all assets (`DASHBOARD`, `ANALYSIS`, and `DATASET`) in a folder.
5113
5153
  #
5114
5154
  # @option params [required, String] :aws_account_id
5115
- # The AWS account ID.
5155
+ # The ID for the Amazon Web Services account that contains the folder.
5116
5156
  #
5117
5157
  # @option params [required, String] :folder_id
5118
- # The folder ID.
5158
+ # The ID of the folder.
5119
5159
  #
5120
5160
  # @option params [String] :next_token
5121
5161
  # The token for the next set of results, or null if there are no more
@@ -5161,7 +5201,7 @@ module Aws::QuickSight
5161
5201
  # Lists all folders in an account.
5162
5202
  #
5163
5203
  # @option params [required, String] :aws_account_id
5164
- # The AWS account ID.
5204
+ # The ID for the Amazon Web Services account that contains the folder.
5165
5205
  #
5166
5206
  # @option params [String] :next_token
5167
5207
  # The token for the next set of results, or null if there are no more
@@ -5313,11 +5353,11 @@ module Aws::QuickSight
5313
5353
  req.send_request(options)
5314
5354
  end
5315
5355
 
5316
- # Lists IAMpolicy assignments in the current Amazon QuickSight account.
5356
+ # Lists IAM policy assignments in the current Amazon QuickSight account.
5317
5357
  #
5318
5358
  # @option params [required, String] :aws_account_id
5319
- # The ID of the Amazon Web Services account that contains these
5320
- # IAMpolicy assignments.
5359
+ # The ID of the Amazon Web Services account that contains these IAM
5360
+ # policy assignments.
5321
5361
  #
5322
5362
  # @option params [String] :assignment_status
5323
5363
  # The status of the assignments.
@@ -5367,7 +5407,7 @@ module Aws::QuickSight
5367
5407
  req.send_request(options)
5368
5408
  end
5369
5409
 
5370
- # Lists all the IAMpolicy assignments, including the Amazon Resource
5410
+ # Lists all the IAM policy assignments, including the Amazon Resource
5371
5411
  # Names (ARNs) for the IAM policies assigned to the specified user and
5372
5412
  # group or groups that the user belongs to.
5373
5413
  #
@@ -6026,14 +6066,14 @@ module Aws::QuickSight
6026
6066
  end
6027
6067
 
6028
6068
  # Creates an Amazon QuickSight user, whose identity is associated with
6029
- # the AWS Identity and Access Management (IAM) identity or role
6030
- # specified in the request.
6069
+ # the Identity and Access Management (IAM) identity or role specified in
6070
+ # the request.
6031
6071
  #
6032
6072
  # @option params [required, String] :identity_type
6033
6073
  # Amazon QuickSight supports several ways of managing the identity of
6034
6074
  # users. This parameter accepts two values:
6035
6075
  #
6036
- # * `IAM`\: A user whose identity maps to an existing IAMuser or role.
6076
+ # * `IAM`\: A user whose identity maps to an existing IAM user or role.
6037
6077
  #
6038
6078
  # * `QUICKSIGHT`\: A user whose identity is owned and managed internally
6039
6079
  # by Amazon QuickSight.
@@ -6058,17 +6098,17 @@ module Aws::QuickSight
6058
6098
  # * `RESTRICTED_AUTHOR`\: This role isn't currently available for use.
6059
6099
  #
6060
6100
  # @option params [String] :iam_arn
6061
- # The ARN of the IAMuser or role that you are registering with Amazon
6101
+ # The ARN of the IAM user or role that you are registering with Amazon
6062
6102
  # QuickSight.
6063
6103
  #
6064
6104
  # @option params [String] :session_name
6065
6105
  # You need to use this parameter only when you register one or more
6066
- # users using an assumed IAMrole. You don't need to provide the session
6067
- # name for other scenarios, for example when you are registering an
6068
- # IAMuser or an Amazon QuickSight user. You can register multiple users
6069
- # using the same IAMrole if each user has a different session name. For
6070
- # more information on assuming IAMroles, see [ `assume-role` ][1] in the
6071
- # *AWS CLI Reference.*
6106
+ # users using an assumed IAM role. You don't need to provide the
6107
+ # session name for other scenarios, for example when you are registering
6108
+ # an IAM user or an Amazon QuickSight user. You can register multiple
6109
+ # users using the same IAM role if each user has a different session
6110
+ # name. For more information on assuming IAM roles, see [ `assume-role`
6111
+ # ][1] in the *CLI Reference.*
6072
6112
  #
6073
6113
  #
6074
6114
  #
@@ -6107,9 +6147,9 @@ module Aws::QuickSight
6107
6147
  # restrictions. Currently, you need to create the profile names for
6108
6148
  # custom permission sets by using the Amazon QuickSight console. Then,
6109
6149
  # you use the `RegisterUser` API operation to assign the named set of
6110
- # permissions to a Amazon QuickSight user.
6150
+ # permissions to a QuickSight user.
6111
6151
  #
6112
- # Amazon QuickSight custom permissions are applied through IAMpolicies.
6152
+ # Amazon QuickSight custom permissions are applied through IAM policies.
6113
6153
  # Therefore, they override the permissions typically granted by
6114
6154
  # assigning Amazon QuickSight users to one of the default security
6115
6155
  # cohorts in Amazon QuickSight (admin, author, reader).
@@ -6371,7 +6411,7 @@ module Aws::QuickSight
6371
6411
  # Searches the subfolders in a folder.
6372
6412
  #
6373
6413
  # @option params [required, String] :aws_account_id
6374
- # The AWS account ID.
6414
+ # The ID for the Amazon Web Services account that contains the folder.
6375
6415
  #
6376
6416
  # @option params [required, Array<Types::FolderSearchFilter>] :filters
6377
6417
  # The filters to apply to the search. Currently, you can search only by
@@ -6447,13 +6487,14 @@ module Aws::QuickSight
6447
6487
  # template.
6448
6488
  #
6449
6489
  # Tagging for Amazon QuickSight works in a similar way to tagging for
6450
- # other AWS services, except for the following:
6490
+ # other Amazon Web Services services, except for the following:
6451
6491
  #
6452
- # * You can't use tags to track AWS costs for Amazon QuickSight. This
6453
- # restriction is because Amazon QuickSight costs are based on users
6454
- # and SPICE capacity, which aren't taggable resources.
6492
+ # * You can't use tags to track costs for Amazon QuickSight. This
6493
+ # isn't possible because you can't tag the resources that Amazon
6494
+ # QuickSight costs are based on, for example Amazon QuickSight storage
6495
+ # capacity (SPICE), number of users, type of users, and usage metrics.
6455
6496
  #
6456
- # * Amazon QuickSight doesn't currently support the Tag Editor for
6497
+ # * Amazon QuickSight doesn't currently support the tag editor for
6457
6498
  # Resource Groups.
6458
6499
  #
6459
6500
  # @option params [required, String] :resource_arn
@@ -6568,6 +6609,7 @@ module Aws::QuickSight
6568
6609
  # namespace: "Namespace",
6569
6610
  # account_customization: { # required
6570
6611
  # default_theme: "Arn",
6612
+ # default_email_customization_template: "Arn",
6571
6613
  # },
6572
6614
  # })
6573
6615
  #
@@ -6577,6 +6619,7 @@ module Aws::QuickSight
6577
6619
  # resp.aws_account_id #=> String
6578
6620
  # resp.namespace #=> String
6579
6621
  # resp.account_customization.default_theme #=> String
6622
+ # resp.account_customization.default_email_customization_template #=> String
6580
6623
  # resp.request_id #=> String
6581
6624
  # resp.status #=> Integer
6582
6625
  #
@@ -6804,8 +6847,8 @@ module Aws::QuickSight
6804
6847
  #
6805
6848
  # <note markdown="1"> Updating a Dashboard creates a new dashboard version but does not
6806
6849
  # immediately publish the new version. You can update the published
6807
- # version of a dashboard by using the UpdateDashboardPublishedVersion
6808
- # API operation.
6850
+ # version of a dashboard by using the ` UpdateDashboardPublishedVersion
6851
+ # ` API operation.
6809
6852
  #
6810
6853
  # </note>
6811
6854
  #
@@ -6825,8 +6868,8 @@ module Aws::QuickSight
6825
6868
  # using as source. You can only update a dashboard from a template, so
6826
6869
  # you use a `SourceTemplate` entity. If you need to update a dashboard
6827
6870
  # from an analysis, first convert the analysis to a template by using
6828
- # the CreateTemplate API operation. For `SourceTemplate`, specify the
6829
- # Amazon Resource Name (ARN) of the source template. The
6871
+ # the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
6872
+ # the Amazon Resource Name (ARN) of the source template. The
6830
6873
  # `SourceTemplate` ARN can contain any Amazon Web Services account and
6831
6874
  # any Amazon QuickSight-supported Amazon Web Services Region.
6832
6875
  #
@@ -6967,6 +7010,12 @@ module Aws::QuickSight
6967
7010
  # @option params [Array<Types::ResourcePermission>] :revoke_permissions
6968
7011
  # The permissions that you want to revoke from this resource.
6969
7012
  #
7013
+ # @option params [Array<Types::ResourcePermission>] :grant_link_permissions
7014
+ # Grants link permissions to all users in a defined namespace.
7015
+ #
7016
+ # @option params [Array<Types::ResourcePermission>] :revoke_link_permissions
7017
+ # Revokes link permissions from all users in a defined namespace.
7018
+ #
6970
7019
  # @return [Types::UpdateDashboardPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6971
7020
  #
6972
7021
  # * {Types::UpdateDashboardPermissionsResponse#dashboard_arn #dashboard_arn} => String
@@ -6974,6 +7023,7 @@ module Aws::QuickSight
6974
7023
  # * {Types::UpdateDashboardPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
6975
7024
  # * {Types::UpdateDashboardPermissionsResponse#request_id #request_id} => String
6976
7025
  # * {Types::UpdateDashboardPermissionsResponse#status #status} => Integer
7026
+ # * {Types::UpdateDashboardPermissionsResponse#link_sharing_configuration #link_sharing_configuration} => Types::LinkSharingConfiguration
6977
7027
  #
6978
7028
  # @example Request syntax with placeholder values
6979
7029
  #
@@ -6992,6 +7042,18 @@ module Aws::QuickSight
6992
7042
  # actions: ["String"], # required
6993
7043
  # },
6994
7044
  # ],
7045
+ # grant_link_permissions: [
7046
+ # {
7047
+ # principal: "Principal", # required
7048
+ # actions: ["String"], # required
7049
+ # },
7050
+ # ],
7051
+ # revoke_link_permissions: [
7052
+ # {
7053
+ # principal: "Principal", # required
7054
+ # actions: ["String"], # required
7055
+ # },
7056
+ # ],
6995
7057
  # })
6996
7058
  #
6997
7059
  # @example Response structure
@@ -7004,6 +7066,10 @@ module Aws::QuickSight
7004
7066
  # resp.permissions[0].actions[0] #=> String
7005
7067
  # resp.request_id #=> String
7006
7068
  # resp.status #=> Integer
7069
+ # resp.link_sharing_configuration.permissions #=> Array
7070
+ # resp.link_sharing_configuration.permissions[0].principal #=> String
7071
+ # resp.link_sharing_configuration.permissions[0].actions #=> Array
7072
+ # resp.link_sharing_configuration.permissions[0].actions[0] #=> String
7007
7073
  #
7008
7074
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardPermissions AWS API Documentation
7009
7075
  #
@@ -7486,6 +7552,10 @@ module Aws::QuickSight
7486
7552
  # amazon_open_search_parameters: {
7487
7553
  # domain: "Domain", # required
7488
7554
  # },
7555
+ # exasol_parameters: {
7556
+ # host: "Host", # required
7557
+ # port: 1, # required
7558
+ # },
7489
7559
  # },
7490
7560
  # credentials: {
7491
7561
  # credential_pair: {
@@ -7585,6 +7655,10 @@ module Aws::QuickSight
7585
7655
  # amazon_open_search_parameters: {
7586
7656
  # domain: "Domain", # required
7587
7657
  # },
7658
+ # exasol_parameters: {
7659
+ # host: "Host", # required
7660
+ # port: 1, # required
7661
+ # },
7588
7662
  # },
7589
7663
  # ],
7590
7664
  # },
@@ -7677,10 +7751,11 @@ module Aws::QuickSight
7677
7751
  # Updates the name of a folder.
7678
7752
  #
7679
7753
  # @option params [required, String] :aws_account_id
7680
- # The AWS account ID.
7754
+ # The ID for the Amazon Web Services account that contains the folder to
7755
+ # update.
7681
7756
  #
7682
7757
  # @option params [required, String] :folder_id
7683
- # The folder ID.
7758
+ # The ID of the folder.
7684
7759
  #
7685
7760
  # @option params [required, String] :name
7686
7761
  # The name of the folder.
@@ -7719,10 +7794,11 @@ module Aws::QuickSight
7719
7794
  # Updates permissions of a folder.
7720
7795
  #
7721
7796
  # @option params [required, String] :aws_account_id
7722
- # The AWS account ID.
7797
+ # The ID for the Amazon Web Services account that contains the folder to
7798
+ # update.
7723
7799
  #
7724
7800
  # @option params [required, String] :folder_id
7725
- # The folder ID.
7801
+ # The ID of the folder.
7726
7802
  #
7727
7803
  # @option params [Array<Types::ResourcePermission>] :grant_permissions
7728
7804
  # The permissions that you want to grant on a resource.
@@ -7826,12 +7902,12 @@ module Aws::QuickSight
7826
7902
  req.send_request(options)
7827
7903
  end
7828
7904
 
7829
- # Updates an existing IAMpolicy assignment. This operation updates only
7905
+ # Updates an existing IAM policy assignment. This operation updates only
7830
7906
  # the optional parameter or parameters that are specified in the
7831
7907
  # request. This overwrites all of the users included in `Identities`.
7832
7908
  #
7833
7909
  # @option params [required, String] :aws_account_id
7834
- # The ID of the Amazon Web Services account that contains the IAMpolicy
7910
+ # The ID of the Amazon Web Services account that contains the IAM policy
7835
7911
  # assignment.
7836
7912
  #
7837
7913
  # @option params [required, String] :assignment_name
@@ -7854,7 +7930,7 @@ module Aws::QuickSight
7854
7930
  # when creating the data source.
7855
7931
  #
7856
7932
  # @option params [String] :policy_arn
7857
- # The ARN for the IAMpolicy to apply to the Amazon QuickSight users and
7933
+ # The ARN for the IAM policy to apply to the Amazon QuickSight users and
7858
7934
  # groups specified in this assignment.
7859
7935
  #
7860
7936
  # @option params [Hash<String,Array>] :identities
@@ -7905,16 +7981,19 @@ module Aws::QuickSight
7905
7981
  req.send_request(options)
7906
7982
  end
7907
7983
 
7908
- # Updates content and status of IP Rules.
7984
+ # Updates the content and status of IP rules. To use this operation, you
7985
+ # need to provide the entire map of rules. You can use the
7986
+ # `DescribeIpRestriction` operation to get the current rule map.
7909
7987
  #
7910
7988
  # @option params [required, String] :aws_account_id
7911
- # Your AWS account ID.
7989
+ # The ID of the Amazon Web Services account that contains the IP rules.
7912
7990
  #
7913
7991
  # @option params [Hash<String,String>] :ip_restriction_rule_map
7914
- # Describes updated IP rules.
7992
+ # A map that describes the updated IP rules with CIDR ranges and
7993
+ # descriptions.
7915
7994
  #
7916
7995
  # @option params [Boolean] :enabled
7917
- # Whether or not IP rules are enabled.
7996
+ # A value that specifies whether IP rules are turned on.
7918
7997
  #
7919
7998
  # @return [Types::UpdateIpRestrictionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7920
7999
  #
@@ -8445,9 +8524,9 @@ module Aws::QuickSight
8445
8524
  # restrictions. Currently, you need to create the profile names for
8446
8525
  # custom permission sets by using the Amazon QuickSight console. Then,
8447
8526
  # you use the `RegisterUser` API operation to assign the named set of
8448
- # permissions to a Amazon QuickSight user.
8527
+ # permissions to a QuickSight user.
8449
8528
  #
8450
- # Amazon QuickSight custom permissions are applied through IAMpolicies.
8529
+ # Amazon QuickSight custom permissions are applied through IAM policies.
8451
8530
  # Therefore, they override the permissions typically granted by
8452
8531
  # assigning Amazon QuickSight users to one of the default security
8453
8532
  # cohorts in Amazon QuickSight (admin, author, reader).
@@ -8478,8 +8557,8 @@ module Aws::QuickSight
8478
8557
  # to provide the custom OIDC provider URL.
8479
8558
  #
8480
8559
  # * `NONE`\: This clears all the previously saved external login
8481
- # information for a user. Use ` DescribeUser ` API to check the
8482
- # external login information.
8560
+ # information for a user. Use the ` DescribeUser ` API operation to
8561
+ # check the external login information.
8483
8562
  #
8484
8563
  # @option params [String] :custom_federation_provider_url
8485
8564
  # The URL of the custom OpenID Connect (OIDC) provider that provides
@@ -8550,7 +8629,7 @@ module Aws::QuickSight
8550
8629
  params: params,
8551
8630
  config: config)
8552
8631
  context[:gem_name] = 'aws-sdk-quicksight'
8553
- context[:gem_version] = '1.55.0'
8632
+ context[:gem_version] = '1.59.0'
8554
8633
  Seahorse::Client::Request.new(handlers, context)
8555
8634
  end
8556
8635