aws-sdk-quicksight 1.57.0 → 1.58.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -387,7 +387,7 @@ module Aws::QuickSight
387
387
  # Guide.*
388
388
  #
389
389
  # You can create customizations for your Amazon Web Services account or,
390
- # if you specify a namespace, for a Amazon QuickSight namespace instead.
390
+ # if you specify a namespace, for a QuickSight namespace instead.
391
391
  # Customizations that apply to a namespace always override
392
392
  # customizations that apply to an Amazon Web Services account. To find
393
393
  # out which customizations apply, use the `DescribeAccountCustomization`
@@ -417,7 +417,7 @@ module Aws::QuickSight
417
417
  # @option params [required, Types::AccountCustomization] :account_customization
418
418
  # The Amazon QuickSight customizations you're adding in the current
419
419
  # Amazon Web Services Region. You can add these to an Amazon Web
420
- # Services account and a Amazon QuickSight namespace.
420
+ # Services account and a QuickSight namespace.
421
421
  #
422
422
  # For example, you can add a default theme by setting
423
423
  # `AccountCustomization` to the midnight theme: `"AccountCustomization":
@@ -446,6 +446,7 @@ module Aws::QuickSight
446
446
  # namespace: "Namespace",
447
447
  # account_customization: { # required
448
448
  # default_theme: "Arn",
449
+ # default_email_customization_template: "Arn",
449
450
  # },
450
451
  # tags: [
451
452
  # {
@@ -461,6 +462,7 @@ module Aws::QuickSight
461
462
  # resp.aws_account_id #=> String
462
463
  # resp.namespace #=> String
463
464
  # resp.account_customization.default_theme #=> String
465
+ # resp.account_customization.default_email_customization_template #=> String
464
466
  # resp.request_id #=> String
465
467
  # resp.status #=> Integer
466
468
  #
@@ -613,7 +615,7 @@ module Aws::QuickSight
613
615
  # dashboard.
614
616
  #
615
617
  # @option params [required, String] :dashboard_id
616
- # The ID for the dashboard, also added to the IAMpolicy.
618
+ # The ID for the dashboard, also added to the IAM policy.
617
619
  #
618
620
  # @option params [required, String] :name
619
621
  # The display name of the dashboard.
@@ -625,8 +627,8 @@ module Aws::QuickSight
625
627
  #
626
628
  # @option params [Array<Types::ResourcePermission>] :permissions
627
629
  # A structure that contains the permissions of the dashboard. You can
628
- # use this structure for granting permissions by providing a list of
629
- # IAMaction information for each principal ARN.
630
+ # use this structure for granting permissions by providing a list of IAM
631
+ # action information for each principal ARN.
630
632
  #
631
633
  # To specify no permissions, omit the permissions list.
632
634
  #
@@ -636,8 +638,8 @@ module Aws::QuickSight
636
638
  # using as source. You can only create a dashboard from a template, so
637
639
  # you use a `SourceTemplate` entity. If you need to create a dashboard
638
640
  # from an analysis, first convert the analysis to a template by using
639
- # the CreateTemplate API operation. For `SourceTemplate`, specify the
640
- # Amazon Resource Name (ARN) of the source template. The
641
+ # the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
642
+ # the Amazon Resource Name (ARN) of the source template. The
641
643
  # `SourceTemplate`ARN can contain any Amazon Web Services account and
642
644
  # any Amazon QuickSight-supported Amazon Web Services Region.
643
645
  #
@@ -1081,7 +1083,7 @@ module Aws::QuickSight
1081
1083
  # aws_account_id: "AwsAccountId", # required
1082
1084
  # data_source_id: "ResourceId", # required
1083
1085
  # name: "ResourceName", # required
1084
- # 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
1086
+ # 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
1085
1087
  # data_source_parameters: {
1086
1088
  # amazon_elasticsearch_parameters: {
1087
1089
  # domain: "Domain", # required
@@ -1175,6 +1177,10 @@ module Aws::QuickSight
1175
1177
  # amazon_open_search_parameters: {
1176
1178
  # domain: "Domain", # required
1177
1179
  # },
1180
+ # exasol_parameters: {
1181
+ # host: "Host", # required
1182
+ # port: 1, # required
1183
+ # },
1178
1184
  # },
1179
1185
  # credentials: {
1180
1186
  # credential_pair: {
@@ -1274,6 +1280,10 @@ module Aws::QuickSight
1274
1280
  # amazon_open_search_parameters: {
1275
1281
  # domain: "Domain", # required
1276
1282
  # },
1283
+ # exasol_parameters: {
1284
+ # host: "Host", # required
1285
+ # port: 1, # required
1286
+ # },
1277
1287
  # },
1278
1288
  # ],
1279
1289
  # },
@@ -1319,10 +1329,11 @@ module Aws::QuickSight
1319
1329
  # Creates an empty shared folder.
1320
1330
  #
1321
1331
  # @option params [required, String] :aws_account_id
1322
- # The AWS Account ID.
1332
+ # The ID for the Amazon Web Services account where you want to create
1333
+ # the folder.
1323
1334
  #
1324
1335
  # @option params [required, String] :folder_id
1325
- # The folder ID.
1336
+ # The ID of the folder.
1326
1337
  #
1327
1338
  # @option params [String] :name
1328
1339
  # The name of the folder.
@@ -1394,10 +1405,10 @@ module Aws::QuickSight
1394
1405
  # folder.
1395
1406
  #
1396
1407
  # @option params [required, String] :aws_account_id
1397
- # The AWS Account ID.
1408
+ # The ID for the Amazon Web Services account that contains the folder.
1398
1409
  #
1399
1410
  # @option params [required, String] :folder_id
1400
- # The folder ID.
1411
+ # The ID of the folder.
1401
1412
  #
1402
1413
  # @option params [required, String] :member_id
1403
1414
  # The ID of the asset (the dashboard, analysis, or dataset).
@@ -1539,7 +1550,7 @@ module Aws::QuickSight
1539
1550
  req.send_request(options)
1540
1551
  end
1541
1552
 
1542
- # Creates an assignment with one specified IAMpolicy, identified by its
1553
+ # Creates an assignment with one specified IAM policy, identified by its
1543
1554
  # Amazon Resource Name (ARN). This policy assignment is attached to the
1544
1555
  # specified groups or users of Amazon QuickSight. Assignment names are
1545
1556
  # unique per Amazon Web Services account. To avoid overwriting rules in
@@ -1547,7 +1558,7 @@ module Aws::QuickSight
1547
1558
  #
1548
1559
  # @option params [required, String] :aws_account_id
1549
1560
  # The ID of the Amazon Web Services account where you want to assign an
1550
- # IAMpolicy to Amazon QuickSight users or groups.
1561
+ # IAM policy to Amazon QuickSight users or groups.
1551
1562
  #
1552
1563
  # @option params [required, String] :assignment_name
1553
1564
  # The name of the assignment, also called a rule. It must be unique
@@ -1566,7 +1577,7 @@ module Aws::QuickSight
1566
1577
  # when creating the data source.
1567
1578
  #
1568
1579
  # @option params [String] :policy_arn
1569
- # The ARN for the IAMpolicy to apply to the Amazon QuickSight users and
1580
+ # The ARN for the IAM policy to apply to the Amazon QuickSight users and
1570
1581
  # groups specified in this assignment.
1571
1582
  #
1572
1583
  # @option params [Hash<String,Array>] :identities
@@ -1938,7 +1949,7 @@ module Aws::QuickSight
1938
1949
  # The ID of the theme that a custom theme will inherit from. All themes
1939
1950
  # inherit from one of the starting themes defined by Amazon QuickSight.
1940
1951
  # For a list of the starting themes, use `ListThemes` or choose
1941
- # **Themes** from within a Amazon QuickSight analysis.
1952
+ # **Themes** from within an analysis.
1942
1953
  #
1943
1954
  # @option params [String] :version_description
1944
1955
  # A description of the first version of the theme that you're creating.
@@ -2330,10 +2341,10 @@ module Aws::QuickSight
2330
2341
  # Deletes an empty folder.
2331
2342
  #
2332
2343
  # @option params [required, String] :aws_account_id
2333
- # The AWS Account ID for the folder.
2344
+ # The ID for the Amazon Web Services account that contains the folder.
2334
2345
  #
2335
2346
  # @option params [required, String] :folder_id
2336
- # The folder ID.
2347
+ # The ID of the folder.
2337
2348
  #
2338
2349
  # @return [Types::DeleteFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2339
2350
  #
@@ -2369,7 +2380,7 @@ module Aws::QuickSight
2369
2380
  # folder.
2370
2381
  #
2371
2382
  # @option params [required, String] :aws_account_id
2372
- # The AWS Account ID.
2383
+ # The ID for the Amazon Web Services account that contains the folder.
2373
2384
  #
2374
2385
  # @option params [required, String] :folder_id
2375
2386
  # The Folder ID.
@@ -2496,11 +2507,11 @@ module Aws::QuickSight
2496
2507
  req.send_request(options)
2497
2508
  end
2498
2509
 
2499
- # Deletes an existing IAMpolicy assignment.
2510
+ # Deletes an existing IAM policy assignment.
2500
2511
  #
2501
2512
  # @option params [required, String] :aws_account_id
2502
- # The Amazon Web Services account ID where you want to delete the
2503
- # IAMpolicy assignment.
2513
+ # The Amazon Web Services account ID where you want to delete the IAM
2514
+ # policy assignment.
2504
2515
  #
2505
2516
  # @option params [required, String] :assignment_name
2506
2517
  # The name of the assignment.
@@ -2858,11 +2869,11 @@ module Aws::QuickSight
2858
2869
  #
2859
2870
  # * `Amazon Web Services account` - The Amazon Web Services account
2860
2871
  # exists at the top of the hierarchy. It has the potential to use all
2861
- # of the Amazon Web Services Regions and AWS Services. When you
2862
- # subscribe to Amazon QuickSight, you choose one Amazon Web Services
2863
- # Region to use as your home Region. That's where your free SPICE
2864
- # capacity is located. You can use Amazon QuickSight in any supported
2865
- # Amazon Web Services Region.
2872
+ # of the Amazon Web Services Regions and Amazon Web Services Services.
2873
+ # When you subscribe to Amazon QuickSight, you choose one Amazon Web
2874
+ # Services Region to use as your home Region. That's where your free
2875
+ # SPICE capacity is located. You can use Amazon QuickSight in any
2876
+ # supported Amazon Web Services Region.
2866
2877
  #
2867
2878
  # * `Amazon Web Services Region` - In each Amazon Web Services Region
2868
2879
  # where you sign in to Amazon QuickSight at least once, Amazon
@@ -2873,8 +2884,8 @@ module Aws::QuickSight
2873
2884
  # constrained to a namespace.
2874
2885
  #
2875
2886
  # To run the command in a different Amazon Web Services Region, you
2876
- # change your Region settings. If you're using the AWS CLI, you can
2877
- # use one of the following options:
2887
+ # change your Region settings. If you're using the CLI, you can use
2888
+ # one of the following options:
2878
2889
  #
2879
2890
  # * Use [command line options][1].
2880
2891
  #
@@ -2882,12 +2893,12 @@ module Aws::QuickSight
2882
2893
  #
2883
2894
  # * Run `aws configure` to change your default Amazon Web Services
2884
2895
  # Region. Use Enter to key the same settings for your keys. For more
2885
- # information, see [Configuring the AWS CLI][3].
2896
+ # information, see [Configuring the CLI][3].
2886
2897
  #
2887
- # * `Namespace` - A Amazon QuickSight namespace is a partition that
2888
- # contains users and assets (data sources, datasets, dashboards, and
2889
- # so on). To access assets that are in a specific namespace, users and
2890
- # groups must also be part of the same namespace. People who share a
2898
+ # * `Namespace` - A QuickSight namespace is a partition that contains
2899
+ # users and assets (data sources, datasets, dashboards, and so on). To
2900
+ # access assets that are in a specific namespace, users and groups
2901
+ # must also be part of the same namespace. People who share a
2891
2902
  # namespace are completely isolated from users and assets in other
2892
2903
  # namespaces, even if they are in the same Amazon Web Services account
2893
2904
  # and Amazon Web Services Region.
@@ -2946,6 +2957,7 @@ module Aws::QuickSight
2946
2957
  # resp.aws_account_id #=> String
2947
2958
  # resp.namespace #=> String
2948
2959
  # resp.account_customization.default_theme #=> String
2960
+ # resp.account_customization.default_email_customization_template #=> String
2949
2961
  # resp.request_id #=> String
2950
2962
  # resp.status #=> Integer
2951
2963
  #
@@ -3167,7 +3179,7 @@ module Aws::QuickSight
3167
3179
  # that you're describing permissions for.
3168
3180
  #
3169
3181
  # @option params [required, String] :dashboard_id
3170
- # The ID for the dashboard, also added to the IAMpolicy.
3182
+ # The ID for the dashboard, also added to the IAM policy.
3171
3183
  #
3172
3184
  # @return [Types::DescribeDashboardPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3173
3185
  #
@@ -3176,6 +3188,7 @@ module Aws::QuickSight
3176
3188
  # * {Types::DescribeDashboardPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
3177
3189
  # * {Types::DescribeDashboardPermissionsResponse#status #status} => Integer
3178
3190
  # * {Types::DescribeDashboardPermissionsResponse#request_id #request_id} => String
3191
+ # * {Types::DescribeDashboardPermissionsResponse#link_sharing_configuration #link_sharing_configuration} => Types::LinkSharingConfiguration
3179
3192
  #
3180
3193
  # @example Request syntax with placeholder values
3181
3194
  #
@@ -3194,6 +3207,10 @@ module Aws::QuickSight
3194
3207
  # resp.permissions[0].actions[0] #=> String
3195
3208
  # resp.status #=> Integer
3196
3209
  # resp.request_id #=> String
3210
+ # resp.link_sharing_configuration.permissions #=> Array
3211
+ # resp.link_sharing_configuration.permissions[0].principal #=> String
3212
+ # resp.link_sharing_configuration.permissions[0].actions #=> Array
3213
+ # resp.link_sharing_configuration.permissions[0].actions[0] #=> String
3197
3214
  #
3198
3215
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissions AWS API Documentation
3199
3216
  #
@@ -3405,7 +3422,7 @@ module Aws::QuickSight
3405
3422
  # resp.data_source.arn #=> String
3406
3423
  # resp.data_source.data_source_id #=> String
3407
3424
  # resp.data_source.name #=> String
3408
- # 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"
3425
+ # 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"
3409
3426
  # resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3410
3427
  # resp.data_source.created_time #=> Time
3411
3428
  # resp.data_source.last_updated_time #=> Time
@@ -3457,6 +3474,8 @@ module Aws::QuickSight
3457
3474
  # resp.data_source.data_source_parameters.twitter_parameters.query #=> String
3458
3475
  # resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer
3459
3476
  # resp.data_source.data_source_parameters.amazon_open_search_parameters.domain #=> String
3477
+ # resp.data_source.data_source_parameters.exasol_parameters.host #=> String
3478
+ # resp.data_source.data_source_parameters.exasol_parameters.port #=> Integer
3460
3479
  # resp.data_source.alternate_data_source_parameters #=> Array
3461
3480
  # resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
3462
3481
  # resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
@@ -3506,6 +3525,8 @@ module Aws::QuickSight
3506
3525
  # resp.data_source.alternate_data_source_parameters[0].twitter_parameters.query #=> String
3507
3526
  # resp.data_source.alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
3508
3527
  # resp.data_source.alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> String
3528
+ # resp.data_source.alternate_data_source_parameters[0].exasol_parameters.host #=> String
3529
+ # resp.data_source.alternate_data_source_parameters[0].exasol_parameters.port #=> Integer
3509
3530
  # resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
3510
3531
  # resp.data_source.ssl_properties.disable_ssl #=> Boolean
3511
3532
  # 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"
@@ -3569,10 +3590,10 @@ module Aws::QuickSight
3569
3590
  # Describes a folder.
3570
3591
  #
3571
3592
  # @option params [required, String] :aws_account_id
3572
- # The AWS account ID.
3593
+ # The ID for the Amazon Web Services account that contains the folder.
3573
3594
  #
3574
3595
  # @option params [required, String] :folder_id
3575
- # The folder ID.
3596
+ # The ID of the folder.
3576
3597
  #
3577
3598
  # @return [Types::DescribeFolderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3578
3599
  #
@@ -3612,10 +3633,10 @@ module Aws::QuickSight
3612
3633
  # Describes permissions for a folder.
3613
3634
  #
3614
3635
  # @option params [required, String] :aws_account_id
3615
- # The AWS Account ID.
3636
+ # The ID for the Amazon Web Services account that contains the folder.
3616
3637
  #
3617
3638
  # @option params [required, String] :folder_id
3618
- # The folder ID.
3639
+ # The ID of the folder.
3619
3640
  #
3620
3641
  # @return [Types::DescribeFolderPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3621
3642
  #
@@ -3657,10 +3678,10 @@ module Aws::QuickSight
3657
3678
  # ancestor folders.
3658
3679
  #
3659
3680
  # @option params [required, String] :aws_account_id
3660
- # The AWS account ID.
3681
+ # The ID for the Amazon Web Services account that contains the folder.
3661
3682
  #
3662
3683
  # @option params [required, String] :folder_id
3663
- # The folder ID.
3684
+ # The ID of the folder.
3664
3685
  #
3665
3686
  # @return [Types::DescribeFolderResolvedPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3666
3687
  #
@@ -3743,7 +3764,7 @@ module Aws::QuickSight
3743
3764
  req.send_request(options)
3744
3765
  end
3745
3766
 
3746
- # Describes an existing IAMpolicy assignment, as specified by the
3767
+ # Describes an existing IAM policy assignment, as specified by the
3747
3768
  # assignment name.
3748
3769
  #
3749
3770
  # @option params [required, String] :aws_account_id
@@ -3846,10 +3867,10 @@ module Aws::QuickSight
3846
3867
  req.send_request(options)
3847
3868
  end
3848
3869
 
3849
- # Provides a summary and status of IP Rules.
3870
+ # Provides a summary and status of IP rules.
3850
3871
  #
3851
3872
  # @option params [required, String] :aws_account_id
3852
- # Your AWS account ID.
3873
+ # The ID of the Amazon Web Services account that contains the IP rules.
3853
3874
  #
3854
3875
  # @return [Types::DescribeIpRestrictionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3855
3876
  #
@@ -4480,8 +4501,7 @@ module Aws::QuickSight
4480
4501
  #
4481
4502
  # @option params [required, Types::RegisteredUserEmbeddingExperienceConfiguration] :experience_configuration
4482
4503
  # The experience you are embedding. For registered users, you can embed
4483
- # Amazon QuickSight dashboards, the entire Amazon QuickSight console, or
4484
- # the Amazon QuickSight Q search bar.
4504
+ # Amazon QuickSight dashboards or the entire Amazon QuickSight console.
4485
4505
  #
4486
4506
  # @return [Types::GenerateEmbedUrlForRegisteredUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4487
4507
  #
@@ -4595,10 +4615,11 @@ module Aws::QuickSight
4595
4615
  #
4596
4616
  # * Invited nonfederated users
4597
4617
  #
4598
- # * IAMusers and IAMrole-based sessions authenticated through Federated
4599
- # Single Sign-On using SAML, OpenID Connect, or IAMfederation.
4618
+ # * IAM users and IAM role-based sessions authenticated through
4619
+ # Federated Single Sign-On using SAML, OpenID Connect, or IAM
4620
+ # federation.
4600
4621
  #
4601
- # Omit this parameter for users in the third group – IAMusers and IAM
4622
+ # Omit this parameter for users in the third group – IAM users and IAM
4602
4623
  # role-based sessions.
4603
4624
  #
4604
4625
  # @option params [String] :namespace
@@ -4610,8 +4631,8 @@ module Aws::QuickSight
4610
4631
  # A list of one or more dashboard IDs that you want to add to a session
4611
4632
  # that includes anonymous users. The `IdentityType` parameter must be
4612
4633
  # set to `ANONYMOUS` for this to work, because other identity types
4613
- # authenticate as Amazon QuickSight or IAMusers. For example, if you set
4614
- # "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
4634
+ # authenticate as Amazon QuickSight or IAM users. For example, if you
4635
+ # set "`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3
4615
4636
  # identity-type ANONYMOUS`", the session can access all three
4616
4637
  # dashboards.
4617
4638
  #
@@ -5004,7 +5025,7 @@ module Aws::QuickSight
5004
5025
  # resp.data_sources[0].arn #=> String
5005
5026
  # resp.data_sources[0].data_source_id #=> String
5006
5027
  # resp.data_sources[0].name #=> String
5007
- # 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"
5028
+ # 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"
5008
5029
  # resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5009
5030
  # resp.data_sources[0].created_time #=> Time
5010
5031
  # resp.data_sources[0].last_updated_time #=> Time
@@ -5056,6 +5077,8 @@ module Aws::QuickSight
5056
5077
  # resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
5057
5078
  # resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
5058
5079
  # resp.data_sources[0].data_source_parameters.amazon_open_search_parameters.domain #=> String
5080
+ # resp.data_sources[0].data_source_parameters.exasol_parameters.host #=> String
5081
+ # resp.data_sources[0].data_source_parameters.exasol_parameters.port #=> Integer
5059
5082
  # resp.data_sources[0].alternate_data_source_parameters #=> Array
5060
5083
  # resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
5061
5084
  # resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
@@ -5105,6 +5128,8 @@ module Aws::QuickSight
5105
5128
  # resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.query #=> String
5106
5129
  # resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
5107
5130
  # resp.data_sources[0].alternate_data_source_parameters[0].amazon_open_search_parameters.domain #=> String
5131
+ # resp.data_sources[0].alternate_data_source_parameters[0].exasol_parameters.host #=> String
5132
+ # resp.data_sources[0].alternate_data_source_parameters[0].exasol_parameters.port #=> Integer
5108
5133
  # resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
5109
5134
  # resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
5110
5135
  # 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"
@@ -5125,10 +5150,10 @@ module Aws::QuickSight
5125
5150
  # List all assets (`DASHBOARD`, `ANALYSIS`, and `DATASET`) in a folder.
5126
5151
  #
5127
5152
  # @option params [required, String] :aws_account_id
5128
- # The AWS account ID.
5153
+ # The ID for the Amazon Web Services account that contains the folder.
5129
5154
  #
5130
5155
  # @option params [required, String] :folder_id
5131
- # The folder ID.
5156
+ # The ID of the folder.
5132
5157
  #
5133
5158
  # @option params [String] :next_token
5134
5159
  # The token for the next set of results, or null if there are no more
@@ -5174,7 +5199,7 @@ module Aws::QuickSight
5174
5199
  # Lists all folders in an account.
5175
5200
  #
5176
5201
  # @option params [required, String] :aws_account_id
5177
- # The AWS account ID.
5202
+ # The ID for the Amazon Web Services account that contains the folder.
5178
5203
  #
5179
5204
  # @option params [String] :next_token
5180
5205
  # The token for the next set of results, or null if there are no more
@@ -5326,11 +5351,11 @@ module Aws::QuickSight
5326
5351
  req.send_request(options)
5327
5352
  end
5328
5353
 
5329
- # Lists IAMpolicy assignments in the current Amazon QuickSight account.
5354
+ # Lists IAM policy assignments in the current Amazon QuickSight account.
5330
5355
  #
5331
5356
  # @option params [required, String] :aws_account_id
5332
- # The ID of the Amazon Web Services account that contains these
5333
- # IAMpolicy assignments.
5357
+ # The ID of the Amazon Web Services account that contains these IAM
5358
+ # policy assignments.
5334
5359
  #
5335
5360
  # @option params [String] :assignment_status
5336
5361
  # The status of the assignments.
@@ -5380,7 +5405,7 @@ module Aws::QuickSight
5380
5405
  req.send_request(options)
5381
5406
  end
5382
5407
 
5383
- # Lists all the IAMpolicy assignments, including the Amazon Resource
5408
+ # Lists all the IAM policy assignments, including the Amazon Resource
5384
5409
  # Names (ARNs) for the IAM policies assigned to the specified user and
5385
5410
  # group or groups that the user belongs to.
5386
5411
  #
@@ -6039,14 +6064,14 @@ module Aws::QuickSight
6039
6064
  end
6040
6065
 
6041
6066
  # Creates an Amazon QuickSight user, whose identity is associated with
6042
- # the AWS Identity and Access Management (IAM) identity or role
6043
- # specified in the request.
6067
+ # the Identity and Access Management (IAM) identity or role specified in
6068
+ # the request.
6044
6069
  #
6045
6070
  # @option params [required, String] :identity_type
6046
6071
  # Amazon QuickSight supports several ways of managing the identity of
6047
6072
  # users. This parameter accepts two values:
6048
6073
  #
6049
- # * `IAM`\: A user whose identity maps to an existing IAMuser or role.
6074
+ # * `IAM`\: A user whose identity maps to an existing IAM user or role.
6050
6075
  #
6051
6076
  # * `QUICKSIGHT`\: A user whose identity is owned and managed internally
6052
6077
  # by Amazon QuickSight.
@@ -6071,17 +6096,17 @@ module Aws::QuickSight
6071
6096
  # * `RESTRICTED_AUTHOR`\: This role isn't currently available for use.
6072
6097
  #
6073
6098
  # @option params [String] :iam_arn
6074
- # The ARN of the IAMuser or role that you are registering with Amazon
6099
+ # The ARN of the IAM user or role that you are registering with Amazon
6075
6100
  # QuickSight.
6076
6101
  #
6077
6102
  # @option params [String] :session_name
6078
6103
  # You need to use this parameter only when you register one or more
6079
- # users using an assumed IAMrole. You don't need to provide the session
6080
- # name for other scenarios, for example when you are registering an
6081
- # IAMuser or an Amazon QuickSight user. You can register multiple users
6082
- # using the same IAMrole if each user has a different session name. For
6083
- # more information on assuming IAMroles, see [ `assume-role` ][1] in the
6084
- # *AWS CLI Reference.*
6104
+ # users using an assumed IAM role. You don't need to provide the
6105
+ # session name for other scenarios, for example when you are registering
6106
+ # an IAM user or an Amazon QuickSight user. You can register multiple
6107
+ # users using the same IAM role if each user has a different session
6108
+ # name. For more information on assuming IAM roles, see [ `assume-role`
6109
+ # ][1] in the *CLI Reference.*
6085
6110
  #
6086
6111
  #
6087
6112
  #
@@ -6120,9 +6145,9 @@ module Aws::QuickSight
6120
6145
  # restrictions. Currently, you need to create the profile names for
6121
6146
  # custom permission sets by using the Amazon QuickSight console. Then,
6122
6147
  # you use the `RegisterUser` API operation to assign the named set of
6123
- # permissions to a Amazon QuickSight user.
6148
+ # permissions to a QuickSight user.
6124
6149
  #
6125
- # Amazon QuickSight custom permissions are applied through IAMpolicies.
6150
+ # Amazon QuickSight custom permissions are applied through IAM policies.
6126
6151
  # Therefore, they override the permissions typically granted by
6127
6152
  # assigning Amazon QuickSight users to one of the default security
6128
6153
  # cohorts in Amazon QuickSight (admin, author, reader).
@@ -6384,7 +6409,7 @@ module Aws::QuickSight
6384
6409
  # Searches the subfolders in a folder.
6385
6410
  #
6386
6411
  # @option params [required, String] :aws_account_id
6387
- # The AWS account ID.
6412
+ # The ID for the Amazon Web Services account that contains the folder.
6388
6413
  #
6389
6414
  # @option params [required, Array<Types::FolderSearchFilter>] :filters
6390
6415
  # The filters to apply to the search. Currently, you can search only by
@@ -6460,13 +6485,14 @@ module Aws::QuickSight
6460
6485
  # template.
6461
6486
  #
6462
6487
  # Tagging for Amazon QuickSight works in a similar way to tagging for
6463
- # other AWS services, except for the following:
6488
+ # other Amazon Web Services services, except for the following:
6464
6489
  #
6465
- # * You can't use tags to track AWS costs for Amazon QuickSight. This
6466
- # restriction is because Amazon QuickSight costs are based on users
6467
- # and SPICE capacity, which aren't taggable resources.
6490
+ # * You can't use tags to track costs for Amazon QuickSight. This
6491
+ # isn't possible because you can't tag the resources that Amazon
6492
+ # QuickSight costs are based on, for example Amazon QuickSight storage
6493
+ # capacity (SPICE), number of users, type of users, and usage metrics.
6468
6494
  #
6469
- # * Amazon QuickSight doesn't currently support the Tag Editor for
6495
+ # * Amazon QuickSight doesn't currently support the tag editor for
6470
6496
  # Resource Groups.
6471
6497
  #
6472
6498
  # @option params [required, String] :resource_arn
@@ -6581,6 +6607,7 @@ module Aws::QuickSight
6581
6607
  # namespace: "Namespace",
6582
6608
  # account_customization: { # required
6583
6609
  # default_theme: "Arn",
6610
+ # default_email_customization_template: "Arn",
6584
6611
  # },
6585
6612
  # })
6586
6613
  #
@@ -6590,6 +6617,7 @@ module Aws::QuickSight
6590
6617
  # resp.aws_account_id #=> String
6591
6618
  # resp.namespace #=> String
6592
6619
  # resp.account_customization.default_theme #=> String
6620
+ # resp.account_customization.default_email_customization_template #=> String
6593
6621
  # resp.request_id #=> String
6594
6622
  # resp.status #=> Integer
6595
6623
  #
@@ -6817,8 +6845,8 @@ module Aws::QuickSight
6817
6845
  #
6818
6846
  # <note markdown="1"> Updating a Dashboard creates a new dashboard version but does not
6819
6847
  # immediately publish the new version. You can update the published
6820
- # version of a dashboard by using the UpdateDashboardPublishedVersion
6821
- # API operation.
6848
+ # version of a dashboard by using the ` UpdateDashboardPublishedVersion
6849
+ # ` API operation.
6822
6850
  #
6823
6851
  # </note>
6824
6852
  #
@@ -6838,8 +6866,8 @@ module Aws::QuickSight
6838
6866
  # using as source. You can only update a dashboard from a template, so
6839
6867
  # you use a `SourceTemplate` entity. If you need to update a dashboard
6840
6868
  # from an analysis, first convert the analysis to a template by using
6841
- # the CreateTemplate API operation. For `SourceTemplate`, specify the
6842
- # Amazon Resource Name (ARN) of the source template. The
6869
+ # the ` CreateTemplate ` API operation. For `SourceTemplate`, specify
6870
+ # the Amazon Resource Name (ARN) of the source template. The
6843
6871
  # `SourceTemplate` ARN can contain any Amazon Web Services account and
6844
6872
  # any Amazon QuickSight-supported Amazon Web Services Region.
6845
6873
  #
@@ -6980,6 +7008,12 @@ module Aws::QuickSight
6980
7008
  # @option params [Array<Types::ResourcePermission>] :revoke_permissions
6981
7009
  # The permissions that you want to revoke from this resource.
6982
7010
  #
7011
+ # @option params [Array<Types::ResourcePermission>] :grant_link_permissions
7012
+ # Grants link permissions to all users in a defined namespace.
7013
+ #
7014
+ # @option params [Array<Types::ResourcePermission>] :revoke_link_permissions
7015
+ # Revokes link permissions from all users in a defined namespace.
7016
+ #
6983
7017
  # @return [Types::UpdateDashboardPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6984
7018
  #
6985
7019
  # * {Types::UpdateDashboardPermissionsResponse#dashboard_arn #dashboard_arn} => String
@@ -6987,6 +7021,7 @@ module Aws::QuickSight
6987
7021
  # * {Types::UpdateDashboardPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
6988
7022
  # * {Types::UpdateDashboardPermissionsResponse#request_id #request_id} => String
6989
7023
  # * {Types::UpdateDashboardPermissionsResponse#status #status} => Integer
7024
+ # * {Types::UpdateDashboardPermissionsResponse#link_sharing_configuration #link_sharing_configuration} => Types::LinkSharingConfiguration
6990
7025
  #
6991
7026
  # @example Request syntax with placeholder values
6992
7027
  #
@@ -7005,6 +7040,18 @@ module Aws::QuickSight
7005
7040
  # actions: ["String"], # required
7006
7041
  # },
7007
7042
  # ],
7043
+ # grant_link_permissions: [
7044
+ # {
7045
+ # principal: "Principal", # required
7046
+ # actions: ["String"], # required
7047
+ # },
7048
+ # ],
7049
+ # revoke_link_permissions: [
7050
+ # {
7051
+ # principal: "Principal", # required
7052
+ # actions: ["String"], # required
7053
+ # },
7054
+ # ],
7008
7055
  # })
7009
7056
  #
7010
7057
  # @example Response structure
@@ -7017,6 +7064,10 @@ module Aws::QuickSight
7017
7064
  # resp.permissions[0].actions[0] #=> String
7018
7065
  # resp.request_id #=> String
7019
7066
  # resp.status #=> Integer
7067
+ # resp.link_sharing_configuration.permissions #=> Array
7068
+ # resp.link_sharing_configuration.permissions[0].principal #=> String
7069
+ # resp.link_sharing_configuration.permissions[0].actions #=> Array
7070
+ # resp.link_sharing_configuration.permissions[0].actions[0] #=> String
7020
7071
  #
7021
7072
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardPermissions AWS API Documentation
7022
7073
  #
@@ -7499,6 +7550,10 @@ module Aws::QuickSight
7499
7550
  # amazon_open_search_parameters: {
7500
7551
  # domain: "Domain", # required
7501
7552
  # },
7553
+ # exasol_parameters: {
7554
+ # host: "Host", # required
7555
+ # port: 1, # required
7556
+ # },
7502
7557
  # },
7503
7558
  # credentials: {
7504
7559
  # credential_pair: {
@@ -7598,6 +7653,10 @@ module Aws::QuickSight
7598
7653
  # amazon_open_search_parameters: {
7599
7654
  # domain: "Domain", # required
7600
7655
  # },
7656
+ # exasol_parameters: {
7657
+ # host: "Host", # required
7658
+ # port: 1, # required
7659
+ # },
7601
7660
  # },
7602
7661
  # ],
7603
7662
  # },
@@ -7690,10 +7749,11 @@ module Aws::QuickSight
7690
7749
  # Updates the name of a folder.
7691
7750
  #
7692
7751
  # @option params [required, String] :aws_account_id
7693
- # The AWS account ID.
7752
+ # The ID for the Amazon Web Services account that contains the folder to
7753
+ # update.
7694
7754
  #
7695
7755
  # @option params [required, String] :folder_id
7696
- # The folder ID.
7756
+ # The ID of the folder.
7697
7757
  #
7698
7758
  # @option params [required, String] :name
7699
7759
  # The name of the folder.
@@ -7732,10 +7792,11 @@ module Aws::QuickSight
7732
7792
  # Updates permissions of a folder.
7733
7793
  #
7734
7794
  # @option params [required, String] :aws_account_id
7735
- # The AWS account ID.
7795
+ # The ID for the Amazon Web Services account that contains the folder to
7796
+ # update.
7736
7797
  #
7737
7798
  # @option params [required, String] :folder_id
7738
- # The folder ID.
7799
+ # The ID of the folder.
7739
7800
  #
7740
7801
  # @option params [Array<Types::ResourcePermission>] :grant_permissions
7741
7802
  # The permissions that you want to grant on a resource.
@@ -7839,12 +7900,12 @@ module Aws::QuickSight
7839
7900
  req.send_request(options)
7840
7901
  end
7841
7902
 
7842
- # Updates an existing IAMpolicy assignment. This operation updates only
7903
+ # Updates an existing IAM policy assignment. This operation updates only
7843
7904
  # the optional parameter or parameters that are specified in the
7844
7905
  # request. This overwrites all of the users included in `Identities`.
7845
7906
  #
7846
7907
  # @option params [required, String] :aws_account_id
7847
- # The ID of the Amazon Web Services account that contains the IAMpolicy
7908
+ # The ID of the Amazon Web Services account that contains the IAM policy
7848
7909
  # assignment.
7849
7910
  #
7850
7911
  # @option params [required, String] :assignment_name
@@ -7867,7 +7928,7 @@ module Aws::QuickSight
7867
7928
  # when creating the data source.
7868
7929
  #
7869
7930
  # @option params [String] :policy_arn
7870
- # The ARN for the IAMpolicy to apply to the Amazon QuickSight users and
7931
+ # The ARN for the IAM policy to apply to the Amazon QuickSight users and
7871
7932
  # groups specified in this assignment.
7872
7933
  #
7873
7934
  # @option params [Hash<String,Array>] :identities
@@ -7918,16 +7979,19 @@ module Aws::QuickSight
7918
7979
  req.send_request(options)
7919
7980
  end
7920
7981
 
7921
- # Updates content and status of IP Rules.
7982
+ # Updates the content and status of IP rules. To use this operation, you
7983
+ # need to provide the entire map of rules. You can use the
7984
+ # `DescribeIpRestriction` operation to get the current rule map.
7922
7985
  #
7923
7986
  # @option params [required, String] :aws_account_id
7924
- # Your AWS account ID.
7987
+ # The ID of the Amazon Web Services account that contains the IP rules.
7925
7988
  #
7926
7989
  # @option params [Hash<String,String>] :ip_restriction_rule_map
7927
- # Describes updated IP rules.
7990
+ # A map that describes the updated IP rules with CIDR ranges and
7991
+ # descriptions.
7928
7992
  #
7929
7993
  # @option params [Boolean] :enabled
7930
- # Whether or not IP rules are enabled.
7994
+ # A value that specifies whether IP rules are turned on.
7931
7995
  #
7932
7996
  # @return [Types::UpdateIpRestrictionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7933
7997
  #
@@ -8458,9 +8522,9 @@ module Aws::QuickSight
8458
8522
  # restrictions. Currently, you need to create the profile names for
8459
8523
  # custom permission sets by using the Amazon QuickSight console. Then,
8460
8524
  # you use the `RegisterUser` API operation to assign the named set of
8461
- # permissions to a Amazon QuickSight user.
8525
+ # permissions to a QuickSight user.
8462
8526
  #
8463
- # Amazon QuickSight custom permissions are applied through IAMpolicies.
8527
+ # Amazon QuickSight custom permissions are applied through IAM policies.
8464
8528
  # Therefore, they override the permissions typically granted by
8465
8529
  # assigning Amazon QuickSight users to one of the default security
8466
8530
  # cohorts in Amazon QuickSight (admin, author, reader).
@@ -8491,8 +8555,8 @@ module Aws::QuickSight
8491
8555
  # to provide the custom OIDC provider URL.
8492
8556
  #
8493
8557
  # * `NONE`\: This clears all the previously saved external login
8494
- # information for a user. Use ` DescribeUser ` API to check the
8495
- # external login information.
8558
+ # information for a user. Use the ` DescribeUser ` API operation to
8559
+ # check the external login information.
8496
8560
  #
8497
8561
  # @option params [String] :custom_federation_provider_url
8498
8562
  # The URL of the custom OpenID Connect (OIDC) provider that provides
@@ -8563,7 +8627,7 @@ module Aws::QuickSight
8563
8627
  params: params,
8564
8628
  config: config)
8565
8629
  context[:gem_name] = 'aws-sdk-quicksight'
8566
- context[:gem_version] = '1.57.0'
8630
+ context[:gem_version] = '1.58.0'
8567
8631
  Seahorse::Client::Request.new(handlers, context)
8568
8632
  end
8569
8633