aws-sdk-quicksight 1.15.0 → 1.16.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 9a9ab843cd3640e06dabbec07a2006366bb80711
4
- data.tar.gz: 1ab04327569a2885033f50e247550536a8bbc71a
3
+ metadata.gz: dd22fde69017c17ae0dff2c1af5053d5515d4d08
4
+ data.tar.gz: 73d2b0f1102a8374c2954f6bc9f1419b782dc115
5
5
  SHA512:
6
- metadata.gz: 9cf54f39dc374079ec04656d06e8b0d80d82f80fe30ce2b6b70f481f1be183c904806c15a8f1c78f68b8bf0fbfd3b25c2bef4b692a68c23125228cdb03ba879e
7
- data.tar.gz: fd245354dd857a725f63b06d2692a25da2185e28031dfbc8fcef26095437f78f6701ffb21458ca1a581aea44e8e9985c64e479e57e5f6a826ff76de28eee7e7a
6
+ metadata.gz: 6e7d3c9eb0c4ce1024159f3c65ad048dd79018cb6833f107aa1375cad97f8862b40dbe41d894eac7e02d33c5da6040db61006f534c0acf17691731351a015ccb
7
+ data.tar.gz: cc98fbe1bef3a189ba9f45404634e4b15338b75193e7a0fc8c53268793596693fa006413d6a8f8a89020645f46bf24bbdc49fdf68b375018153bf888434912a8
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-quicksight/customizations'
42
42
  # @service
43
43
  module Aws::QuickSight
44
44
 
45
- GEM_VERSION = '1.15.0'
45
+ GEM_VERSION = '1.16.0'
46
46
 
47
47
  end
@@ -297,21 +297,21 @@ module Aws::QuickSight
297
297
  end
298
298
 
299
299
  # Creates a dashboard from a template. To first create a template, see
300
- # the CreateTemplate API.
300
+ # the CreateTemplate API operation.
301
301
  #
302
- # A dashboard is an entity in QuickSight which identifies Quicksight
303
- # reports, created from analyses. QuickSight dashboards are sharable.
302
+ # A dashboard is an entity in QuickSight that identifies QuickSight
303
+ # reports, created from analyses. You can share QuickSight dashboards.
304
304
  # With the right permissions, you can create scheduled email reports
305
- # from them. The `CreateDashboard`, `DescribeDashboard` and
306
- # `ListDashboardsByUser` APIs act on the dashboard entity. If you have
307
- # the correct permissions, you can create a dashboard from a template
308
- # that exists in a different AWS account.
305
+ # from them. The `CreateDashboard`, `DescribeDashboard`, and
306
+ # `ListDashboardsByUser` API operations act on the dashboard entity. If
307
+ # you have the correct permissions, you can create a dashboard from a
308
+ # template that exists in a different AWS account.
309
309
  #
310
310
  # @option params [required, String] :aws_account_id
311
- # AWS account ID where you want to create the dashboard.
311
+ # The ID of the AWS account where you want to create the dashboard.
312
312
  #
313
313
  # @option params [required, String] :dashboard_id
314
- # The ID for the dashboard, also added to IAM policy.
314
+ # The ID for the dashboard, also added to the IAM policy.
315
315
  #
316
316
  # @option params [required, String] :name
317
317
  # The display name of the dashboard.
@@ -319,19 +319,19 @@ module Aws::QuickSight
319
319
  # @option params [Types::Parameters] :parameters
320
320
  # A structure that contains the parameters of the dashboard. These are
321
321
  # parameter overrides for a dashboard. A dashboard can have any type of
322
- # parameters and some parameters might accept multiple values. You could
323
- # use the following structure to override two string parameters that
324
- # accept multiple values:
322
+ # parameters, and some parameters might accept multiple values. You can
323
+ # use the dashboard permissions structure described following to
324
+ # override two string parameters that accept multiple values.
325
325
  #
326
326
  # @option params [Array<Types::ResourcePermission>] :permissions
327
327
  # A structure that contains the permissions of the dashboard. You can
328
- # use this for granting permissions with principal and action
328
+ # use this structure for granting permissions with principal and action
329
329
  # information.
330
330
  #
331
331
  # @option params [required, Types::DashboardSourceEntity] :source_entity
332
- # Source entity from which the dashboard is created. The souce entity
333
- # accepts the Amazon Resource Name (ARN) of the source template or
334
- # analysis and also references the replacement datasets for the
332
+ # The source entity from which the dashboard is created. The source
333
+ # entity accepts the Amazon Resource Name (ARN) of the source template
334
+ # or analysis and also references the replacement datasets for the
335
335
  # placeholders set when creating the template. The replacement datasets
336
336
  # need to follow the same schema as the datasets for which placeholders
337
337
  # were created when creating the template.
@@ -347,20 +347,23 @@ module Aws::QuickSight
347
347
  # A description for the first version of the dashboard being created.
348
348
  #
349
349
  # @option params [Types::DashboardPublishOptions] :dashboard_publish_options
350
- # Publishing options when creating dashboard.
350
+ # Options for publishing the dashboard when you create it:
351
351
  #
352
- # * AvailabilityStatus for AdHocFilteringOption - This can be either
353
- # `ENABLED` or `DISABLED`. When This is set to set to `DISABLED`,
352
+ # * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
353
+ # either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
354
354
  # QuickSight disables the left filter pane on the published dashboard,
355
- # which can be used for AdHoc filtering. Enabled by default.
355
+ # which can be used for ad hoc (one-time) filtering. This option is
356
+ # `ENABLED` by default.
356
357
  #
357
- # * AvailabilityStatus for ExportToCSVOption - This can be either
358
- # `ENABLED` or `DISABLED`. The visual option to export data to CSV is
359
- # disabled when this is set to `DISABLED`. Enabled by default.
358
+ # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
359
+ # either `ENABLED` or `DISABLED`. The visual option to export data to
360
+ # .csv format isn't enabled when this is set to `DISABLED`. This
361
+ # option is `ENABLED` by default.
360
362
  #
361
- # * VisibilityState for SheetControlsOption - This can be either
362
- # `COLLAPSED` or `EXPANDED`. The sheet controls pane is collapsed by
363
- # default when set to true. Collapsed by default.
363
+ # * `VisibilityState` for `SheetControlsOption` - This visibility state
364
+ # can be either `COLLAPSED` or `EXPANDED`. The sheet controls pane is
365
+ # collapsed by default when set to true. This option is `COLLAPSED` by
366
+ # default.
364
367
  #
365
368
  # @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
366
369
  #
@@ -461,7 +464,7 @@ module Aws::QuickSight
461
464
  # Creates a dataset.
462
465
  #
463
466
  # @option params [required, String] :aws_account_id
464
- # The AWS Account ID.
467
+ # The AWS account ID.
465
468
  #
466
469
  # @option params [required, String] :data_set_id
467
470
  # An ID for the dataset that you want to create. This ID is unique per
@@ -479,7 +482,7 @@ module Aws::QuickSight
479
482
  # physical tables.
480
483
  #
481
484
  # @option params [required, String] :import_mode
482
- # Indicates whether or not you want to import the data into SPICE.
485
+ # Indicates whether you want to import the data into SPICE.
483
486
  #
484
487
  # @option params [Array<Types::ColumnGroup>] :column_groups
485
488
  # Groupings of columns that work together in certain QuickSight
@@ -489,7 +492,8 @@ module Aws::QuickSight
489
492
  # A list of resource permissions on the dataset.
490
493
  #
491
494
  # @option params [Types::RowLevelPermissionDataSet] :row_level_permission_data_set
492
- # Row-level security configuration on the data you want to create.
495
+ # The row-level security configuration for the data that you want to
496
+ # create.
493
497
  #
494
498
  # @option params [Array<Types::Tag>] :tags
495
499
  # Contains a map of the key-value pairs for the resource tag or tags
@@ -936,35 +940,37 @@ module Aws::QuickSight
936
940
  req.send_request(options)
937
941
  end
938
942
 
939
- # Creates an assignment with one specified IAM policy Amazon Resource
940
- # Name (ARN) and will assigned to specified groups or users of
941
- # QuickSight. Users and groups need to be in the same namespace.
943
+ # Creates an assignment with one specified IAM policy, identified by its
944
+ # Amazon Resource Name (ARN). This policy will be assigned to specified
945
+ # groups or users of Amazon QuickSight. The users and groups need to be
946
+ # in the same namespace.
942
947
  #
943
948
  # @option params [required, String] :aws_account_id
944
- # The AWS Account ID where you want to assign QuickSight users or groups
945
- # to an IAM policy.
949
+ # The ID of the AWS account where you want to assign an IAM policy to
950
+ # QuickSight users or groups.
946
951
  #
947
952
  # @option params [required, String] :assignment_name
948
953
  # The name of the assignment. It must be unique within an AWS account.
949
954
  #
950
955
  # @option params [required, String] :assignment_status
951
- # The status of an assignment:
956
+ # The status of the assignment. Possible values are as follows:
952
957
  #
953
- # * ENABLED - Anything specified in this assignment is used while
958
+ # * `ENABLED` - Anything specified in this assignment is used when
954
959
  # creating the data source.
955
960
  #
956
- # * DISABLED - This assignment isn't used while creating the data
961
+ # * `DISABLED` - This assignment isn't used when creating the data
957
962
  # source.
958
963
  #
959
- # * DRAFT - Assignment is an unfinished draft and isn't used while
960
- # creating the data source.
964
+ # * `DRAFT` - This assignment is an unfinished draft and isn't used
965
+ # when creating the data source.
961
966
  #
962
967
  # @option params [String] :policy_arn
963
- # An IAM policy Amazon Resource Name (ARN) that you want to apply to the
964
- # QuickSight users and groups specified in this assignment.
968
+ # The ARN for the IAM policy to apply to the QuickSight users and groups
969
+ # specified in this assignment.
965
970
  #
966
971
  # @option params [Hash<String,Array>] :identities
967
- # QuickSight users and/or groups that you want to assign the policy to.
972
+ # The QuickSight users, groups, or both that you want to assign the
973
+ # policy to.
968
974
  #
969
975
  # @option params [required, String] :namespace
970
976
  # The namespace that contains the assignment.
@@ -1068,15 +1074,15 @@ module Aws::QuickSight
1068
1074
  end
1069
1075
 
1070
1076
  # Creates a template from an existing QuickSight analysis or template.
1071
- # The resulting template can be used to create a dashboard.
1077
+ # You can use the resulting template to create a dashboard.
1072
1078
  #
1073
- # A template is an entity in QuickSight which encapsulates the metadata
1074
- # required to create an analysis that can be used to create dashboard.
1075
- # It adds a layer of abstraction by use placeholders to replace the
1076
- # dataset associated with the analysis. You can use templates to create
1077
- # dashboards by replacing dataset placeholders with datasets which
1078
- # follow the same schema that was used to create the source analysis and
1079
- # template.
1079
+ # A *template* is an entity in QuickSight that encapsulates the metadata
1080
+ # required to create an analysis and that you can use to create s
1081
+ # dashboard. A template adds a layer of abstraction by using
1082
+ # placeholders to replace the dataset associated with the analysis. You
1083
+ # can use templates to create dashboards by replacing dataset
1084
+ # placeholders with datasets that follow the same schema that was used
1085
+ # to create the source analysis and template.
1080
1086
  #
1081
1087
  # @option params [required, String] :aws_account_id
1082
1088
  # The ID for the AWS account that the group is in. Currently, you use
@@ -1084,8 +1090,8 @@ module Aws::QuickSight
1084
1090
  # account.
1085
1091
  #
1086
1092
  # @option params [required, String] :template_id
1087
- # An ID for the template you want to create. This is unique per AWS
1088
- # region per AWS account.
1093
+ # An ID for the template that you want to create. This template is
1094
+ # unique per AWS Region in each AWS account.
1089
1095
  #
1090
1096
  # @option params [String] :name
1091
1097
  # A display name for the template.
@@ -1095,8 +1101,8 @@ module Aws::QuickSight
1095
1101
  #
1096
1102
  # @option params [required, Types::TemplateSourceEntity] :source_entity
1097
1103
  # The Amazon Resource Name (ARN) of the source entity from which this
1098
- # template is being created. Templates can be currently created from an
1099
- # analysis or another template. If the ARN is for an analysis, you must
1104
+ # template is being created. Currently, you can create a template from
1105
+ # an analysis or another template. If the ARN is for an analysis,
1100
1106
  # include its dataset references.
1101
1107
  #
1102
1108
  # @option params [Array<Types::Tag>] :tags
@@ -1105,10 +1111,10 @@ module Aws::QuickSight
1105
1111
  #
1106
1112
  # @option params [String] :version_description
1107
1113
  # A description of the current template version being created. This API
1108
- # created the first version of the template. Every time UpdateTemplate
1109
- # is called a new version is created. Each version of the template
1110
- # maintains a description of the version in the VersionDescription
1111
- # field.
1114
+ # operation creates the first version of the template. Every time
1115
+ # `UpdateTemplate` is called, a new version is created. Each version of
1116
+ # the template maintains a description of the version in the
1117
+ # `VersionDescription` field.
1112
1118
  #
1113
1119
  # @return [Types::CreateTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1114
1120
  #
@@ -1175,14 +1181,16 @@ module Aws::QuickSight
1175
1181
  # Creates a template alias for a template.
1176
1182
  #
1177
1183
  # @option params [required, String] :aws_account_id
1178
- # AWS account ID that contains the template you are aliasing.
1184
+ # The ID of the AWS account that contains the template that you creating
1185
+ # an alias for.
1179
1186
  #
1180
1187
  # @option params [required, String] :template_id
1181
1188
  # An ID for the template.
1182
1189
  #
1183
1190
  # @option params [required, String] :alias_name
1184
1191
  # The name that you want to give to the template alias that you're
1185
- # creating. Aliases that start with `$` are reserved by QuickSight.
1192
+ # creating. Don't start the alias name with the `$` character. Alias
1193
+ # names that start with `$` are reserved by QuickSight.
1186
1194
  #
1187
1195
  # @option params [required, Integer] :template_version_number
1188
1196
  # The version number of the template.
@@ -1222,13 +1230,14 @@ module Aws::QuickSight
1222
1230
  # Deletes a dashboard.
1223
1231
  #
1224
1232
  # @option params [required, String] :aws_account_id
1225
- # AWS account ID that contains the dashboard you are deleting.
1233
+ # The ID of the AWS account that contains the dashboard that you're
1234
+ # deleting.
1226
1235
  #
1227
1236
  # @option params [required, String] :dashboard_id
1228
1237
  # The ID for the dashboard.
1229
1238
  #
1230
1239
  # @option params [Integer] :version_number
1231
- # The version number of the dashboard. If version number property is
1240
+ # The version number of the dashboard. If the version number property is
1232
1241
  # provided, only the specified version of the dashboard is deleted.
1233
1242
  #
1234
1243
  # @return [Types::DeleteDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1427,10 +1436,10 @@ module Aws::QuickSight
1427
1436
  req.send_request(options)
1428
1437
  end
1429
1438
 
1430
- # Deletes an existing assignment.
1439
+ # Deletes an existing IAM policy assignment.
1431
1440
  #
1432
1441
  # @option params [required, String] :aws_account_id
1433
- # The AWS account ID where you want to delete an IAM policy assignment.
1442
+ # The AWS account ID where you want to delete the IAM policy assignment.
1434
1443
  #
1435
1444
  # @option params [required, String] :assignment_name
1436
1445
  # The name of the assignment.
@@ -1470,7 +1479,8 @@ module Aws::QuickSight
1470
1479
  # Deletes a template.
1471
1480
  #
1472
1481
  # @option params [required, String] :aws_account_id
1473
- # AWS account ID that contains the template you are deleting.
1482
+ # The ID of the AWS account that contains the template that you're
1483
+ # deleting.
1474
1484
  #
1475
1485
  # @option params [required, String] :template_id
1476
1486
  # An ID for the template you want to delete.
@@ -1511,19 +1521,21 @@ module Aws::QuickSight
1511
1521
  req.send_request(options)
1512
1522
  end
1513
1523
 
1514
- # Update template alias of given template.
1524
+ # Deletes the item that the specified template alias points to. If you
1525
+ # provide a specific alias, you delete the version of the template that
1526
+ # the alias points to.
1515
1527
  #
1516
1528
  # @option params [required, String] :aws_account_id
1517
- # AWS account ID that contains the template alias you are deleting.
1529
+ # The ID of the AWS account that contains the item to delete.
1518
1530
  #
1519
1531
  # @option params [required, String] :template_id
1520
- # An ID for the template.
1532
+ # The ID for the template that the specified alias is for.
1521
1533
  #
1522
1534
  # @option params [required, String] :alias_name
1523
- # The alias of the template that you want to delete. If you provide a
1524
- # specific alias, you delete the version that the alias points to. You
1525
- # can specify the latest version of the template by providing the
1526
- # keyword `$LATEST` in the `AliasName` parameter.
1535
+ # The name for the template alias. If you name a specific alias, you
1536
+ # delete the version that the alias points to. You can specify the
1537
+ # latest version of the template by providing the keyword `$LATEST` in
1538
+ # the `AliasName` parameter.
1527
1539
  #
1528
1540
  # @return [Types::DeleteTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1529
1541
  #
@@ -1642,14 +1654,15 @@ module Aws::QuickSight
1642
1654
  # Provides a summary for a dashboard.
1643
1655
  #
1644
1656
  # @option params [required, String] :aws_account_id
1645
- # AWS account ID that contains the dashboard you are describing.
1657
+ # The ID of the AWS account that contains the dashboard that you're
1658
+ # describing.
1646
1659
  #
1647
1660
  # @option params [required, String] :dashboard_id
1648
1661
  # The ID for the dashboard.
1649
1662
  #
1650
1663
  # @option params [Integer] :version_number
1651
- # The version number for the dashboard. If version number isnt passed
1652
- # the latest published dashboard version is described.
1664
+ # The version number for the dashboard. If a version number isn't
1665
+ # passed, the latest published dashboard version is described.
1653
1666
  #
1654
1667
  # @option params [String] :alias_name
1655
1668
  # The alias name.
@@ -1698,14 +1711,14 @@ module Aws::QuickSight
1698
1711
  req.send_request(options)
1699
1712
  end
1700
1713
 
1701
- # Describes read and write permissions on a dashboard.
1714
+ # Describes read and write permissions for a dashboard.
1702
1715
  #
1703
1716
  # @option params [required, String] :aws_account_id
1704
- # AWS account ID that contains the dashboard you are describing
1705
- # permissions of.
1717
+ # The ID of the AWS account that contains the dashboard that you're
1718
+ # describing permissions for.
1706
1719
  #
1707
1720
  # @option params [required, String] :dashboard_id
1708
- # The ID for the dashboard, also added to IAM policy.
1721
+ # The ID for the dashboard, also added to the IAM policy.
1709
1722
  #
1710
1723
  # @return [Types::DescribeDashboardPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1711
1724
  #
@@ -1745,7 +1758,7 @@ module Aws::QuickSight
1745
1758
  # Describes a dataset.
1746
1759
  #
1747
1760
  # @option params [required, String] :aws_account_id
1748
- # The AWS Account ID.
1761
+ # The AWS account ID.
1749
1762
  #
1750
1763
  # @option params [required, String] :data_set_id
1751
1764
  # The ID for the dataset that you want to create. This ID is unique per
@@ -1846,7 +1859,7 @@ module Aws::QuickSight
1846
1859
  # `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
1847
1860
  #
1848
1861
  # @option params [required, String] :aws_account_id
1849
- # The AWS Account ID.
1862
+ # The AWS account ID.
1850
1863
  #
1851
1864
  # @option params [required, String] :data_set_id
1852
1865
  # The ID for the dataset that you want to create. This ID is unique per
@@ -2068,11 +2081,12 @@ module Aws::QuickSight
2068
2081
  req.send_request(options)
2069
2082
  end
2070
2083
 
2071
- # Describes an existing IAMPolicy Assignment by specified assignment
2072
- # name.
2084
+ # Describes an existing IAM policy assignment, as specified by the
2085
+ # assignment name.
2073
2086
  #
2074
2087
  # @option params [required, String] :aws_account_id
2075
- # The AWS account ID that contains the assignment you want to describe.
2088
+ # The ID of the AWS account that contains the assignment that you want
2089
+ # to describe.
2076
2090
  #
2077
2091
  # @option params [required, String] :assignment_name
2078
2092
  # The name of the assignment.
@@ -2172,18 +2186,19 @@ module Aws::QuickSight
2172
2186
  # Describes a template's metadata.
2173
2187
  #
2174
2188
  # @option params [required, String] :aws_account_id
2175
- # AWS account ID that contains the template you are describing.
2189
+ # The ID of the AWS account that contains the template that you're
2190
+ # describing.
2176
2191
  #
2177
2192
  # @option params [required, String] :template_id
2178
- # An ID for the template.
2193
+ # The ID for the template.
2179
2194
  #
2180
2195
  # @option params [Integer] :version_number
2181
- # This is an optional field, when a version number is provided the
2182
- # corresponding version is describe, if it's not provided the latest
2183
- # version of the template is described.
2196
+ # (Optional) The number for the version to describe. If a
2197
+ # `VersionNumber` parameter value isn't provided, the latest version of
2198
+ # the template is described.
2184
2199
  #
2185
2200
  # @option params [String] :alias_name
2186
- # The alias of the template that you want to describe. If you provide a
2201
+ # The alias of the template that you want to describe. If you name a
2187
2202
  # specific alias, you describe the version that the alias points to. You
2188
2203
  # can specify the latest version of the template by providing the
2189
2204
  # keyword `$LATEST` in the `AliasName` parameter. The keyword
@@ -2239,18 +2254,19 @@ module Aws::QuickSight
2239
2254
  req.send_request(options)
2240
2255
  end
2241
2256
 
2242
- # Describes the template aliases of a template.
2257
+ # Describes the template alias for a template.
2243
2258
  #
2244
2259
  # @option params [required, String] :aws_account_id
2245
- # AWS account ID that contains the template alias you are describing.
2260
+ # The ID of the AWS account that contains the template alias that
2261
+ # you're describing.
2246
2262
  #
2247
2263
  # @option params [required, String] :template_id
2248
- # An ID for the template.
2264
+ # The ID for the template.
2249
2265
  #
2250
2266
  # @option params [required, String] :alias_name
2251
- # The alias of the template that you want to describe. If you provide a
2252
- # specific alias, you describe the version that the alias points to. You
2253
- # can specify the latest version of the template by providing the
2267
+ # The name of the template alias that you want to describe. If you name
2268
+ # a specific alias, you describe the version that the alias points to.
2269
+ # You can specify the latest version of the template by providing the
2254
2270
  # keyword `$LATEST` in the `AliasName` parameter. The keyword
2255
2271
  # `$PUBLISHED` doesn't apply to templates.
2256
2272
  #
@@ -2288,7 +2304,8 @@ module Aws::QuickSight
2288
2304
  # Describes read and write permissions on a template.
2289
2305
  #
2290
2306
  # @option params [required, String] :aws_account_id
2291
- # AWS account ID that contains the template you are describing.
2307
+ # The ID of the AWS account that contains the template that you're
2308
+ # describing.
2292
2309
  #
2293
2310
  # @option params [required, String] :template_id
2294
2311
  # The ID for the template.
@@ -2375,12 +2392,12 @@ module Aws::QuickSight
2375
2392
  req.send_request(options)
2376
2393
  end
2377
2394
 
2378
- # Generates a server-side embeddable URL and authorization code. Before
2379
- # this can work properly, first you need to configure the dashboards and
2380
- # user permissions. For more information, see the Amazon QuickSight User
2381
- # Guide section on [Embedding Amazon QuickSight Dashboards][1] or see
2382
- # the Amazon QuickSight API Reference section on [Embedding Amazon
2383
- # QuickSight Dashboards][2] .
2395
+ # Generates a server-side embeddable URL and authorization code. For
2396
+ # this process to work properly, first configure the dashboards and user
2397
+ # permissions. For more information, see [Embedding Amazon QuickSight
2398
+ # Dashboards][1] in the *Amazon QuickSight User Guide* or [Embedding
2399
+ # Amazon QuickSight Dashboards][2] in the *Amazon QuickSight API
2400
+ # Reference*.
2384
2401
  #
2385
2402
  # Currently, you can use `GetDashboardEmbedURL` only from the server,
2386
2403
  # not from the user’s browser.
@@ -2391,25 +2408,26 @@ module Aws::QuickSight
2391
2408
  # [2]: https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html
2392
2409
  #
2393
2410
  # @option params [required, String] :aws_account_id
2394
- # AWS account ID that contains the dashboard you are embedding.
2411
+ # The ID for the AWS account that contains the dashboard that you're
2412
+ # embedding.
2395
2413
  #
2396
2414
  # @option params [required, String] :dashboard_id
2397
- # The ID for the dashboard, also added to IAM policy
2415
+ # The ID for the dashboard, also added to the IAM policy.
2398
2416
  #
2399
2417
  # @option params [required, String] :identity_type
2400
- # The authentication method the user uses to sign in.
2418
+ # The authentication method that the user uses to sign in.
2401
2419
  #
2402
2420
  # @option params [Integer] :session_lifetime_in_minutes
2403
2421
  # How many minutes the session is valid. The session lifetime must be
2404
- # between 15 and 600 minutes.
2422
+ # 15-600 minutes.
2405
2423
  #
2406
2424
  # @option params [Boolean] :undo_redo_disabled
2407
- # Remove the undo/redo button on embedded dashboard. The default is
2425
+ # Remove the undo/redo button on the embedded dashboard. The default is
2408
2426
  # FALSE, which enables the undo/redo button.
2409
2427
  #
2410
2428
  # @option params [Boolean] :reset_disabled
2411
- # Remove the reset button on embedded dashboard. The default is FALSE,
2412
- # which allows the reset button.
2429
+ # Remove the reset button on the embedded dashboard. The default is
2430
+ # FALSE, which enables the reset button.
2413
2431
  #
2414
2432
  # @option params [String] :user_arn
2415
2433
  # The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
@@ -2419,11 +2437,11 @@ module Aws::QuickSight
2419
2437
  #
2420
2438
  # * Active Directory (AD) users or group members
2421
2439
  #
2422
- # * Invited non-federated users
2440
+ # * Invited nonfederated users
2423
2441
  #
2424
2442
  # * IAM users and IAM role-based sessions authenticated through
2425
2443
  # Federated Single Sign-On using SAML, OpenID Connect, or IAM
2426
- # Federation
2444
+ # federation.
2427
2445
  #
2428
2446
  # @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2429
2447
  #
@@ -2458,11 +2476,12 @@ module Aws::QuickSight
2458
2476
  req.send_request(options)
2459
2477
  end
2460
2478
 
2461
- # Lists all the versions of the dashboards in the Quicksight
2479
+ # Lists all the versions of the dashboards in the QuickSight
2462
2480
  # subscription.
2463
2481
  #
2464
2482
  # @option params [required, String] :aws_account_id
2465
- # AWS account ID that contains the dashboard you are listing.
2483
+ # The ID of the AWS account that contains the dashboard that you're
2484
+ # listing versions for.
2466
2485
  #
2467
2486
  # @option params [required, String] :dashboard_id
2468
2487
  # The ID for the dashboard.
@@ -2512,10 +2531,11 @@ module Aws::QuickSight
2512
2531
  req.send_request(options)
2513
2532
  end
2514
2533
 
2515
- # Lists dashboards in the AWS account.
2534
+ # Lists dashboards in an AWS account.
2516
2535
  #
2517
2536
  # @option params [required, String] :aws_account_id
2518
- # AWS account ID that contains the dashboards you are listing.
2537
+ # The ID of the AWS account that contains the dashboards that you're
2538
+ # listing.
2519
2539
  #
2520
2540
  # @option params [String] :next_token
2521
2541
  # The token for the next set of results, or null if there are no more
@@ -2562,13 +2582,14 @@ module Aws::QuickSight
2562
2582
  req.send_request(options)
2563
2583
  end
2564
2584
 
2565
- # Lists all of the datasets belonging to this account in an AWS region.
2585
+ # Lists all of the datasets belonging to the current AWS account in an
2586
+ # AWS Region.
2566
2587
  #
2567
2588
  # The permissions resource is
2568
2589
  # `arn:aws:quicksight:region:aws-account-id:dataset/*`.
2569
2590
  #
2570
2591
  # @option params [required, String] :aws_account_id
2571
- # The AWS Account ID.
2592
+ # The AWS account ID.
2572
2593
  #
2573
2594
  # @option params [String] :next_token
2574
2595
  # The token for the next set of results, or null if there are no more
@@ -2821,16 +2842,16 @@ module Aws::QuickSight
2821
2842
  req.send_request(options)
2822
2843
  end
2823
2844
 
2824
- # Lists assignments in current QuickSight account.
2845
+ # Lists IAM policy assignments in the current Amazon QuickSight account.
2825
2846
  #
2826
2847
  # @option params [required, String] :aws_account_id
2827
- # The AWS account ID that contains this IAM policy assignment.
2848
+ # The ID of the AWS account that contains these IAM policy assignments.
2828
2849
  #
2829
2850
  # @option params [String] :assignment_status
2830
- # The status of the assignment.
2851
+ # The status of the assignments.
2831
2852
  #
2832
2853
  # @option params [required, String] :namespace
2833
- # The namespace for this assignment.
2854
+ # The namespace for the assignments.
2834
2855
  #
2835
2856
  # @option params [String] :next_token
2836
2857
  # The token for the next set of results, or null if there are no more
@@ -2874,12 +2895,12 @@ module Aws::QuickSight
2874
2895
  req.send_request(options)
2875
2896
  end
2876
2897
 
2877
- # Lists all the assignments and the Amazon Resource Names (ARNs) for the
2878
- # associated IAM policies assigned to the specified user and the group
2879
- # or groups that the user belongs to.
2898
+ # Lists all the IAM policy assignments, including the Amazon Resource
2899
+ # Names (ARNs) for the IAM policies assigned to the specified user and
2900
+ # group or groups that the user belongs to.
2880
2901
  #
2881
2902
  # @option params [required, String] :aws_account_id
2882
- # The AWS account ID that contains the assignment.
2903
+ # The ID of the AWS account that contains the assignments.
2883
2904
  #
2884
2905
  # @option params [required, String] :user_name
2885
2906
  # The name of the user.
@@ -3028,7 +3049,8 @@ module Aws::QuickSight
3028
3049
  # Lists all the aliases of a template.
3029
3050
  #
3030
3051
  # @option params [required, String] :aws_account_id
3031
- # AWS account ID that contains the template aliases you are listing.
3052
+ # The ID of the AWS account that contains the template aliases that
3053
+ # you're listing.
3032
3054
  #
3033
3055
  # @option params [required, String] :template_id
3034
3056
  # The ID for the template.
@@ -3075,10 +3097,12 @@ module Aws::QuickSight
3075
3097
  req.send_request(options)
3076
3098
  end
3077
3099
 
3078
- # Lists all the versions of the templates in the Quicksight account.
3100
+ # Lists all the versions of the templates in the current Amazon
3101
+ # QuickSight account.
3079
3102
  #
3080
3103
  # @option params [required, String] :aws_account_id
3081
- # AWS account ID that contains the templates you are listing.
3104
+ # The ID of the AWS account that contains the templates that you're
3105
+ # listing.
3082
3106
  #
3083
3107
  # @option params [required, String] :template_id
3084
3108
  # The ID for the template.
@@ -3127,10 +3151,11 @@ module Aws::QuickSight
3127
3151
  req.send_request(options)
3128
3152
  end
3129
3153
 
3130
- # Lists all the templates in the QuickSight account.
3154
+ # Lists all the templates in the current Amazon QuickSight account.
3131
3155
  #
3132
3156
  # @option params [required, String] :aws_account_id
3133
- # AWS account ID that contains the templates you are listing.
3157
+ # The ID of the AWS account that contains the templates that you're
3158
+ # listing.
3134
3159
  #
3135
3160
  # @option params [String] :next_token
3136
3161
  # The token for the next set of results, or null if there are no more
@@ -3184,7 +3209,7 @@ module Aws::QuickSight
3184
3209
  # memberships for.
3185
3210
  #
3186
3211
  # @option params [required, String] :aws_account_id
3187
- # The AWS Account ID that the user is in. Currently, you use the ID for
3212
+ # The AWS account ID that the user is in. Currently, you use the ID for
3188
3213
  # the AWS account that contains your Amazon QuickSight account.
3189
3214
  #
3190
3215
  # @option params [required, String] :namespace
@@ -3488,10 +3513,11 @@ module Aws::QuickSight
3488
3513
  req.send_request(options)
3489
3514
  end
3490
3515
 
3491
- # Updates a dashboard in the AWS account.
3516
+ # Updates a dashboard in an AWS account.
3492
3517
  #
3493
3518
  # @option params [required, String] :aws_account_id
3494
- # AWS account ID that contains the dashboard you are updating.
3519
+ # The ID of the AWS account that contains the dashboard that you're
3520
+ # updating.
3495
3521
  #
3496
3522
  # @option params [required, String] :dashboard_id
3497
3523
  # The ID for the dashboard.
@@ -3501,11 +3527,11 @@ module Aws::QuickSight
3501
3527
  #
3502
3528
  # @option params [required, Types::DashboardSourceEntity] :source_entity
3503
3529
  # The template or analysis from which the dashboard is created. The
3504
- # SouceTemplate entity accepts the Arn of the template and also
3505
- # references to replacement datasets for the placeholders set when
3506
- # creating the template. The replacement datasets need to follow the
3507
- # same schema as the datasets for which placeholders were created when
3508
- # creating the template.
3530
+ # `SouceTemplate` entity accepts the Amazon Resource Name (ARN) of the
3531
+ # template and also references to replacement datasets for the
3532
+ # placeholders set when creating the template. The replacement datasets
3533
+ # need to follow the same schema as the datasets for which placeholders
3534
+ # were created when creating the template.
3509
3535
  #
3510
3536
  # @option params [Types::Parameters] :parameters
3511
3537
  # A structure that contains the parameters of the dashboard.
@@ -3514,20 +3540,23 @@ module Aws::QuickSight
3514
3540
  # A description for the first version of the dashboard being created.
3515
3541
  #
3516
3542
  # @option params [Types::DashboardPublishOptions] :dashboard_publish_options
3517
- # Publishing options when creating a dashboard.
3543
+ # Options for publishing the dashboard when you create it:
3518
3544
  #
3519
- # * AvailabilityStatus for AdHocFilteringOption - This can be either
3520
- # `ENABLED` or `DISABLED`. When This is set to set to `DISABLED`,
3545
+ # * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
3546
+ # either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
3521
3547
  # QuickSight disables the left filter pane on the published dashboard,
3522
- # which can be used for AdHoc filtering. Enabled by default.
3548
+ # which can be used for ad hoc (one-time) filtering. This option is
3549
+ # `ENABLED` by default.
3523
3550
  #
3524
- # * AvailabilityStatus for ExportToCSVOption - This can be either
3525
- # `ENABLED` or `DISABLED`. The visual option to export data to CSV is
3526
- # disabled when this is set to `DISABLED`. Enabled by default.
3551
+ # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
3552
+ # either `ENABLED` or `DISABLED`. The visual option to export data to
3553
+ # .csv format isn't enabled when this is set to `DISABLED`. This
3554
+ # option is `ENABLED` by default.
3527
3555
  #
3528
- # * VisibilityState for SheetControlsOption - This can be either
3529
- # `COLLAPSED` or `EXPANDED`. The sheet controls pane is collapsed by
3530
- # default when set to true. Collapsed by default.
3556
+ # * `VisibilityState` for `SheetControlsOption` - This visibility state
3557
+ # can be either `COLLAPSED` or `EXPANDED`. The sheet controls pane is
3558
+ # collapsed by default when set to true. This option is `COLLAPSED` by
3559
+ # default.
3531
3560
  #
3532
3561
  # @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3533
3562
  #
@@ -3616,7 +3645,8 @@ module Aws::QuickSight
3616
3645
  # Updates read and write permissions on a dashboard.
3617
3646
  #
3618
3647
  # @option params [required, String] :aws_account_id
3619
- # AWS account ID that contains the dashboard you are updating.
3648
+ # The ID of the AWS account that contains the dashboard whose
3649
+ # permissions you're updating.
3620
3650
  #
3621
3651
  # @option params [required, String] :dashboard_id
3622
3652
  # The ID for the dashboard.
@@ -3677,7 +3707,8 @@ module Aws::QuickSight
3677
3707
  # Updates the published version of a dashboard.
3678
3708
  #
3679
3709
  # @option params [required, String] :aws_account_id
3680
- # AWS account ID that contains the dashboard you are updating.
3710
+ # The ID of the AWS account that contains the dashboard that you're
3711
+ # updating.
3681
3712
  #
3682
3713
  # @option params [required, String] :dashboard_id
3683
3714
  # The ID for the dashboard.
@@ -3719,10 +3750,10 @@ module Aws::QuickSight
3719
3750
  # Updates a dataset.
3720
3751
  #
3721
3752
  # @option params [required, String] :aws_account_id
3722
- # The AWS Account ID.
3753
+ # The AWS account ID.
3723
3754
  #
3724
3755
  # @option params [required, String] :data_set_id
3725
- # The ID for the dataset that you want to create. This ID is unique per
3756
+ # The ID for the dataset that you want to update. This ID is unique per
3726
3757
  # AWS Region for each AWS account.
3727
3758
  #
3728
3759
  # @option params [required, String] :name
@@ -3737,14 +3768,14 @@ module Aws::QuickSight
3737
3768
  # physical tables.
3738
3769
  #
3739
3770
  # @option params [required, String] :import_mode
3740
- # Indicates whether or not you want to import the data into SPICE.
3771
+ # Indicates whether you want to import the data into SPICE.
3741
3772
  #
3742
3773
  # @option params [Array<Types::ColumnGroup>] :column_groups
3743
3774
  # Groupings of columns that work together in certain QuickSight
3744
3775
  # features. Currently, only geospatial hierarchy is supported.
3745
3776
  #
3746
3777
  # @option params [Types::RowLevelPermissionDataSet] :row_level_permission_data_set
3747
- # Row-level security configuration on the data you want to create.
3778
+ # The row-level security configuration for the data you want to create.
3748
3779
  #
3749
3780
  # @return [Types::UpdateDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3750
3781
  #
@@ -3893,11 +3924,11 @@ module Aws::QuickSight
3893
3924
  # `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
3894
3925
  #
3895
3926
  # @option params [required, String] :aws_account_id
3896
- # The AWS Account ID.
3927
+ # The AWS account ID.
3897
3928
  #
3898
3929
  # @option params [required, String] :data_set_id
3899
- # The ID for the dataset that you want to create. This ID is unique per
3900
- # AWS Region for each AWS account.
3930
+ # The ID for the dataset whose permissions you want to update. This ID
3931
+ # is unique per AWS Region for each AWS account.
3901
3932
  #
3902
3933
  # @option params [Array<Types::ResourcePermission>] :grant_permissions
3903
3934
  # The resource permissions that you want to grant to the dataset.
@@ -4215,37 +4246,39 @@ module Aws::QuickSight
4215
4246
  req.send_request(options)
4216
4247
  end
4217
4248
 
4218
- # Updates an existing assignment. This operation updates only the
4219
- # optional parameter or parameters that are specified in the request.
4249
+ # Updates an existing IAM policy assignment. This operation updates only
4250
+ # the optional parameter or parameters that are specified in the
4251
+ # request.
4220
4252
  #
4221
4253
  # @option params [required, String] :aws_account_id
4222
- # The AWS account ID that contains the IAM policy assignment.
4254
+ # The ID of the AWS account that contains the IAM policy assignment.
4223
4255
  #
4224
4256
  # @option params [required, String] :assignment_name
4225
- # The name of the assignment. It must be unique within an AWS account.
4257
+ # The name of the assignment. This name must be unique within an AWS
4258
+ # account.
4226
4259
  #
4227
4260
  # @option params [required, String] :namespace
4228
4261
  # The namespace of the assignment.
4229
4262
  #
4230
4263
  # @option params [String] :assignment_status
4231
- # The status of an assignment:
4264
+ # The status of the assignment. Possible values are as follows:
4232
4265
  #
4233
- # * ENABLED - Anything specified in this assignment is used while
4266
+ # * `ENABLED` - Anything specified in this assignment is used when
4234
4267
  # creating the data source.
4235
4268
  #
4236
- # * DISABLED - This assignment isn't used while creating the data
4269
+ # * `DISABLED` - This assignment isn't used when creating the data
4237
4270
  # source.
4238
4271
  #
4239
- # * DRAFT - Assignment is an unfinished draft and isn't used while
4240
- # creating the data source.
4272
+ # * `DRAFT` - This assignment is an unfinished draft and isn't used
4273
+ # when creating the data source.
4241
4274
  #
4242
4275
  # @option params [String] :policy_arn
4243
- # An IAM policy Amazon Resource Name (ARN) that will be applied to
4244
- # specified QuickSight users and groups in this assignment.
4276
+ # The ARN for the IAM policy to apply to the QuickSight users and groups
4277
+ # specified in this assignment.
4245
4278
  #
4246
4279
  # @option params [Hash<String,Array>] :identities
4247
- # QuickSight users and/or groups that you want to assign to the
4248
- # specified IAM policy.
4280
+ # The QuickSight users, groups, or both that you want to assign the
4281
+ # policy to.
4249
4282
  #
4250
4283
  # @return [Types::UpdateIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4251
4284
  #
@@ -4291,24 +4324,26 @@ module Aws::QuickSight
4291
4324
  req.send_request(options)
4292
4325
  end
4293
4326
 
4294
- # Updates a template from an existing QuickSight analysis.
4327
+ # Updates a template from an existing Amazon QuickSight analysis or
4328
+ # another template.
4295
4329
  #
4296
4330
  # @option params [required, String] :aws_account_id
4297
- # AWS account ID that contains the template you are updating.
4331
+ # The ID of the AWS account that contains the template that you're
4332
+ # updating.
4298
4333
  #
4299
4334
  # @option params [required, String] :template_id
4300
4335
  # The ID for the template.
4301
4336
  #
4302
4337
  # @option params [required, Types::TemplateSourceEntity] :source_entity
4303
4338
  # The source QuickSight entity from which this template is being
4304
- # created. Templates can be currently created from an Analysis or
4339
+ # updated. You can currently update templates from an Analysis or
4305
4340
  # another template.
4306
4341
  #
4307
4342
  # @option params [String] :version_description
4308
- # A description of the current template version being updated. Every
4309
- # time you cal `UpdateTemplate` you create a new version. Each version
4310
- # of the template maintains a description of the version in the
4311
- # `VersionDescription` field.
4343
+ # A description of the current template version that is being updated.
4344
+ # Every time you call `UpdateTemplate`, you create a new version of the
4345
+ # template. Each version of the template maintains a description of the
4346
+ # version in the `VersionDescription` field.
4312
4347
  #
4313
4348
  # @option params [String] :name
4314
4349
  # The name for the template.
@@ -4366,13 +4401,14 @@ module Aws::QuickSight
4366
4401
  # Updates the template alias of a template.
4367
4402
  #
4368
4403
  # @option params [required, String] :aws_account_id
4369
- # AWS account ID that contains the template aliases you are updating.
4404
+ # The ID of the AWS account that contains the template alias that
4405
+ # you're updating.
4370
4406
  #
4371
4407
  # @option params [required, String] :template_id
4372
4408
  # The ID for the template.
4373
4409
  #
4374
4410
  # @option params [required, String] :alias_name
4375
- # The alias of the template that you want to update. If you provide a
4411
+ # The alias of the template that you want to update. If you name a
4376
4412
  # specific alias, you update the version that the alias points to. You
4377
4413
  # can specify the latest version of the template by providing the
4378
4414
  # keyword `$LATEST` in the `AliasName` parameter. The keyword
@@ -4413,10 +4449,10 @@ module Aws::QuickSight
4413
4449
  req.send_request(options)
4414
4450
  end
4415
4451
 
4416
- # Updates the permissions on a template.
4452
+ # Updates the resource permissions for a template.
4417
4453
  #
4418
4454
  # @option params [required, String] :aws_account_id
4419
- # AWS account ID that contains the template.
4455
+ # The ID of the AWS account that contains the template.
4420
4456
  #
4421
4457
  # @option params [required, String] :template_id
4422
4458
  # The ID for the template.
@@ -4551,7 +4587,7 @@ module Aws::QuickSight
4551
4587
  params: params,
4552
4588
  config: config)
4553
4589
  context[:gem_name] = 'aws-sdk-quicksight'
4554
- context[:gem_version] = '1.15.0'
4590
+ context[:gem_version] = '1.16.0'
4555
4591
  Seahorse::Client::Request.new(handlers, context)
4556
4592
  end
4557
4593