aws-sdk-quicksight 1.15.0 → 1.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 9a9ab843cd3640e06dabbec07a2006366bb80711
4
- data.tar.gz: 1ab04327569a2885033f50e247550536a8bbc71a
2
+ SHA256:
3
+ metadata.gz: 7ace93bd5a322bfc00c3128499e747e43e43101f1ab1a078005d04ede60ee8eb
4
+ data.tar.gz: c900f582370feda0ba1f04dd7faecc57d9f07c77a2e03872517a0436fc45851d
5
5
  SHA512:
6
- metadata.gz: 9cf54f39dc374079ec04656d06e8b0d80d82f80fe30ce2b6b70f481f1be183c904806c15a8f1c78f68b8bf0fbfd3b25c2bef4b692a68c23125228cdb03ba879e
7
- data.tar.gz: fd245354dd857a725f63b06d2692a25da2185e28031dfbc8fcef26095437f78f6701ffb21458ca1a581aea44e8e9985c64e479e57e5f6a826ff76de28eee7e7a
6
+ metadata.gz: fa14ee61831193b5389424ddd8f415a3c769bdb4cefbe33ba6d42d0ea91baf6b7d78148e88aca33bd20b46729255eeef3f6353e2f62f8a4f798b9789bb1e03d6
7
+ data.tar.gz: 5111202c4a58b9eeddb9d2977a43a0fd4ee09a49780ff9fdda4de2af861cf2f0174940591fb98afed4ba0dbb0ad1161e130861ab497b6ca4ca29b000c7c8975b
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-quicksight/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # quick_sight = Aws::QuickSight::Client.new
28
+ # resp = quick_sight.cancel_ingestion(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon QuickSight all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon QuickSight are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::QuickSight::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon QuickSight API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-quicksight/customizations'
42
45
  # @service
43
46
  module Aws::QuickSight
44
47
 
45
- GEM_VERSION = '1.15.0'
48
+ GEM_VERSION = '1.20.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:quicksight)
31
31
 
32
32
  module Aws::QuickSight
33
+ # An API client for QuickSight. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::QuickSight::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::QuickSight
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::QuickSight
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::QuickSight
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::QuickSight
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -166,15 +188,29 @@ module Aws::QuickSight
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::QuickSight
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -209,16 +264,15 @@ module Aws::QuickSight
209
264
  # requests through. Formatted like 'http://proxy.com:123'.
210
265
  #
211
266
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
267
+ # seconds to wait when opening a HTTP session before raising a
213
268
  # `Timeout::Error`.
214
269
  #
215
270
  # @option options [Integer] :http_read_timeout (60) The default
216
271
  # number of seconds to wait for response data. This value can
217
- # safely be set
218
- # per-request on the session yeidled by {#session_for}.
272
+ # safely be set per-request on the session.
219
273
  #
220
274
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
275
+ # seconds a connection is allowed to sit idle before it is
222
276
  # considered stale. Stale connections are closed and removed
223
277
  # from the pool before making a request.
224
278
  #
@@ -227,7 +281,7 @@ module Aws::QuickSight
227
281
  # request body. This option has no effect unless the request has
228
282
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
283
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
284
+ # request on the session.
231
285
  #
232
286
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
287
  # HTTP debug output will be sent to the `:logger`.
@@ -297,21 +351,21 @@ module Aws::QuickSight
297
351
  end
298
352
 
299
353
  # Creates a dashboard from a template. To first create a template, see
300
- # the CreateTemplate API.
354
+ # the CreateTemplate API operation.
301
355
  #
302
- # A dashboard is an entity in QuickSight which identifies Quicksight
303
- # reports, created from analyses. QuickSight dashboards are sharable.
356
+ # A dashboard is an entity in QuickSight that identifies QuickSight
357
+ # reports, created from analyses. You can share QuickSight dashboards.
304
358
  # 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.
359
+ # from them. The `CreateDashboard`, `DescribeDashboard`, and
360
+ # `ListDashboardsByUser` API operations act on the dashboard entity. If
361
+ # you have the correct permissions, you can create a dashboard from a
362
+ # template that exists in a different AWS account.
309
363
  #
310
364
  # @option params [required, String] :aws_account_id
311
- # AWS account ID where you want to create the dashboard.
365
+ # The ID of the AWS account where you want to create the dashboard.
312
366
  #
313
367
  # @option params [required, String] :dashboard_id
314
- # The ID for the dashboard, also added to IAM policy.
368
+ # The ID for the dashboard, also added to the IAM policy.
315
369
  #
316
370
  # @option params [required, String] :name
317
371
  # The display name of the dashboard.
@@ -319,19 +373,19 @@ module Aws::QuickSight
319
373
  # @option params [Types::Parameters] :parameters
320
374
  # A structure that contains the parameters of the dashboard. These are
321
375
  # 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:
376
+ # parameters, and some parameters might accept multiple values. You can
377
+ # use the dashboard permissions structure described following to
378
+ # override two string parameters that accept multiple values.
325
379
  #
326
380
  # @option params [Array<Types::ResourcePermission>] :permissions
327
381
  # A structure that contains the permissions of the dashboard. You can
328
- # use this for granting permissions with principal and action
382
+ # use this structure for granting permissions with principal and action
329
383
  # information.
330
384
  #
331
385
  # @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
386
+ # The source entity from which the dashboard is created. The source
387
+ # entity accepts the Amazon Resource Name (ARN) of the source template
388
+ # or analysis and also references the replacement datasets for the
335
389
  # placeholders set when creating the template. The replacement datasets
336
390
  # need to follow the same schema as the datasets for which placeholders
337
391
  # were created when creating the template.
@@ -347,20 +401,23 @@ module Aws::QuickSight
347
401
  # A description for the first version of the dashboard being created.
348
402
  #
349
403
  # @option params [Types::DashboardPublishOptions] :dashboard_publish_options
350
- # Publishing options when creating dashboard.
404
+ # Options for publishing the dashboard when you create it:
351
405
  #
352
- # * AvailabilityStatus for AdHocFilteringOption - This can be either
353
- # `ENABLED` or `DISABLED`. When This is set to set to `DISABLED`,
406
+ # * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
407
+ # either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
354
408
  # QuickSight disables the left filter pane on the published dashboard,
355
- # which can be used for AdHoc filtering. Enabled by default.
409
+ # which can be used for ad hoc (one-time) filtering. This option is
410
+ # `ENABLED` by default.
356
411
  #
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.
412
+ # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
413
+ # either `ENABLED` or `DISABLED`. The visual option to export data to
414
+ # .csv format isn't enabled when this is set to `DISABLED`. This
415
+ # option is `ENABLED` by default.
360
416
  #
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.
417
+ # * `VisibilityState` for `SheetControlsOption` - This visibility state
418
+ # can be either `COLLAPSED` or `EXPANDED`. The sheet controls pane is
419
+ # collapsed by default when set to true. This option is `COLLAPSED` by
420
+ # default.
364
421
  #
365
422
  # @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
366
423
  #
@@ -461,7 +518,7 @@ module Aws::QuickSight
461
518
  # Creates a dataset.
462
519
  #
463
520
  # @option params [required, String] :aws_account_id
464
- # The AWS Account ID.
521
+ # The AWS account ID.
465
522
  #
466
523
  # @option params [required, String] :data_set_id
467
524
  # An ID for the dataset that you want to create. This ID is unique per
@@ -479,7 +536,7 @@ module Aws::QuickSight
479
536
  # physical tables.
480
537
  #
481
538
  # @option params [required, String] :import_mode
482
- # Indicates whether or not you want to import the data into SPICE.
539
+ # Indicates whether you want to import the data into SPICE.
483
540
  #
484
541
  # @option params [Array<Types::ColumnGroup>] :column_groups
485
542
  # Groupings of columns that work together in certain QuickSight
@@ -489,7 +546,8 @@ module Aws::QuickSight
489
546
  # A list of resource permissions on the dataset.
490
547
  #
491
548
  # @option params [Types::RowLevelPermissionDataSet] :row_level_permission_data_set
492
- # Row-level security configuration on the data you want to create.
549
+ # The row-level security configuration for the data that you want to
550
+ # create.
493
551
  #
494
552
  # @option params [Array<Types::Tag>] :tags
495
553
  # Contains a map of the key-value pairs for the resource tag or tags
@@ -936,35 +994,37 @@ module Aws::QuickSight
936
994
  req.send_request(options)
937
995
  end
938
996
 
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.
997
+ # Creates an assignment with one specified IAM policy, identified by its
998
+ # Amazon Resource Name (ARN). This policy will be assigned to specified
999
+ # groups or users of Amazon QuickSight. The users and groups need to be
1000
+ # in the same namespace.
942
1001
  #
943
1002
  # @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.
1003
+ # The ID of the AWS account where you want to assign an IAM policy to
1004
+ # QuickSight users or groups.
946
1005
  #
947
1006
  # @option params [required, String] :assignment_name
948
1007
  # The name of the assignment. It must be unique within an AWS account.
949
1008
  #
950
1009
  # @option params [required, String] :assignment_status
951
- # The status of an assignment:
1010
+ # The status of the assignment. Possible values are as follows:
952
1011
  #
953
- # * ENABLED - Anything specified in this assignment is used while
1012
+ # * `ENABLED` - Anything specified in this assignment is used when
954
1013
  # creating the data source.
955
1014
  #
956
- # * DISABLED - This assignment isn't used while creating the data
1015
+ # * `DISABLED` - This assignment isn't used when creating the data
957
1016
  # source.
958
1017
  #
959
- # * DRAFT - Assignment is an unfinished draft and isn't used while
960
- # creating the data source.
1018
+ # * `DRAFT` - This assignment is an unfinished draft and isn't used
1019
+ # when creating the data source.
961
1020
  #
962
1021
  # @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.
1022
+ # The ARN for the IAM policy to apply to the QuickSight users and groups
1023
+ # specified in this assignment.
965
1024
  #
966
1025
  # @option params [Hash<String,Array>] :identities
967
- # QuickSight users and/or groups that you want to assign the policy to.
1026
+ # The QuickSight users, groups, or both that you want to assign the
1027
+ # policy to.
968
1028
  #
969
1029
  # @option params [required, String] :namespace
970
1030
  # The namespace that contains the assignment.
@@ -1023,7 +1083,7 @@ module Aws::QuickSight
1023
1083
  #
1024
1084
  #
1025
1085
  #
1026
- # [1]: https://aws.example.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/
1086
+ # [1]: https://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/
1027
1087
  #
1028
1088
  # @option params [required, String] :data_set_id
1029
1089
  # The ID of the dataset used in the ingestion.
@@ -1068,15 +1128,15 @@ module Aws::QuickSight
1068
1128
  end
1069
1129
 
1070
1130
  # Creates a template from an existing QuickSight analysis or template.
1071
- # The resulting template can be used to create a dashboard.
1131
+ # You can use the resulting template to create a dashboard.
1072
1132
  #
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.
1133
+ # A *template* is an entity in QuickSight that encapsulates the metadata
1134
+ # required to create an analysis and that you can use to create s
1135
+ # dashboard. A template adds a layer of abstraction by using
1136
+ # placeholders to replace the dataset associated with the analysis. You
1137
+ # can use templates to create dashboards by replacing dataset
1138
+ # placeholders with datasets that follow the same schema that was used
1139
+ # to create the source analysis and template.
1080
1140
  #
1081
1141
  # @option params [required, String] :aws_account_id
1082
1142
  # The ID for the AWS account that the group is in. Currently, you use
@@ -1084,8 +1144,8 @@ module Aws::QuickSight
1084
1144
  # account.
1085
1145
  #
1086
1146
  # @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.
1147
+ # An ID for the template that you want to create. This template is
1148
+ # unique per AWS Region in each AWS account.
1089
1149
  #
1090
1150
  # @option params [String] :name
1091
1151
  # A display name for the template.
@@ -1095,8 +1155,8 @@ module Aws::QuickSight
1095
1155
  #
1096
1156
  # @option params [required, Types::TemplateSourceEntity] :source_entity
1097
1157
  # 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
1158
+ # template is being created. Currently, you can create a template from
1159
+ # an analysis or another template. If the ARN is for an analysis,
1100
1160
  # include its dataset references.
1101
1161
  #
1102
1162
  # @option params [Array<Types::Tag>] :tags
@@ -1105,10 +1165,10 @@ module Aws::QuickSight
1105
1165
  #
1106
1166
  # @option params [String] :version_description
1107
1167
  # 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.
1168
+ # operation creates the first version of the template. Every time
1169
+ # `UpdateTemplate` is called, a new version is created. Each version of
1170
+ # the template maintains a description of the version in the
1171
+ # `VersionDescription` field.
1112
1172
  #
1113
1173
  # @return [Types::CreateTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1114
1174
  #
@@ -1175,14 +1235,16 @@ module Aws::QuickSight
1175
1235
  # Creates a template alias for a template.
1176
1236
  #
1177
1237
  # @option params [required, String] :aws_account_id
1178
- # AWS account ID that contains the template you are aliasing.
1238
+ # The ID of the AWS account that contains the template that you creating
1239
+ # an alias for.
1179
1240
  #
1180
1241
  # @option params [required, String] :template_id
1181
1242
  # An ID for the template.
1182
1243
  #
1183
1244
  # @option params [required, String] :alias_name
1184
1245
  # The name that you want to give to the template alias that you're
1185
- # creating. Aliases that start with `$` are reserved by QuickSight.
1246
+ # creating. Don't start the alias name with the `$` character. Alias
1247
+ # names that start with `$` are reserved by QuickSight.
1186
1248
  #
1187
1249
  # @option params [required, Integer] :template_version_number
1188
1250
  # The version number of the template.
@@ -1222,13 +1284,14 @@ module Aws::QuickSight
1222
1284
  # Deletes a dashboard.
1223
1285
  #
1224
1286
  # @option params [required, String] :aws_account_id
1225
- # AWS account ID that contains the dashboard you are deleting.
1287
+ # The ID of the AWS account that contains the dashboard that you're
1288
+ # deleting.
1226
1289
  #
1227
1290
  # @option params [required, String] :dashboard_id
1228
1291
  # The ID for the dashboard.
1229
1292
  #
1230
1293
  # @option params [Integer] :version_number
1231
- # The version number of the dashboard. If version number property is
1294
+ # The version number of the dashboard. If the version number property is
1232
1295
  # provided, only the specified version of the dashboard is deleted.
1233
1296
  #
1234
1297
  # @return [Types::DeleteDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -1427,10 +1490,10 @@ module Aws::QuickSight
1427
1490
  req.send_request(options)
1428
1491
  end
1429
1492
 
1430
- # Deletes an existing assignment.
1493
+ # Deletes an existing IAM policy assignment.
1431
1494
  #
1432
1495
  # @option params [required, String] :aws_account_id
1433
- # The AWS account ID where you want to delete an IAM policy assignment.
1496
+ # The AWS account ID where you want to delete the IAM policy assignment.
1434
1497
  #
1435
1498
  # @option params [required, String] :assignment_name
1436
1499
  # The name of the assignment.
@@ -1470,7 +1533,8 @@ module Aws::QuickSight
1470
1533
  # Deletes a template.
1471
1534
  #
1472
1535
  # @option params [required, String] :aws_account_id
1473
- # AWS account ID that contains the template you are deleting.
1536
+ # The ID of the AWS account that contains the template that you're
1537
+ # deleting.
1474
1538
  #
1475
1539
  # @option params [required, String] :template_id
1476
1540
  # An ID for the template you want to delete.
@@ -1511,19 +1575,21 @@ module Aws::QuickSight
1511
1575
  req.send_request(options)
1512
1576
  end
1513
1577
 
1514
- # Update template alias of given template.
1578
+ # Deletes the item that the specified template alias points to. If you
1579
+ # provide a specific alias, you delete the version of the template that
1580
+ # the alias points to.
1515
1581
  #
1516
1582
  # @option params [required, String] :aws_account_id
1517
- # AWS account ID that contains the template alias you are deleting.
1583
+ # The ID of the AWS account that contains the item to delete.
1518
1584
  #
1519
1585
  # @option params [required, String] :template_id
1520
- # An ID for the template.
1586
+ # The ID for the template that the specified alias is for.
1521
1587
  #
1522
1588
  # @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.
1589
+ # The name for the template alias. If you name a specific alias, you
1590
+ # delete the version that the alias points to. You can specify the
1591
+ # latest version of the template by providing the keyword `$LATEST` in
1592
+ # the `AliasName` parameter.
1527
1593
  #
1528
1594
  # @return [Types::DeleteTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1529
1595
  #
@@ -1642,14 +1708,15 @@ module Aws::QuickSight
1642
1708
  # Provides a summary for a dashboard.
1643
1709
  #
1644
1710
  # @option params [required, String] :aws_account_id
1645
- # AWS account ID that contains the dashboard you are describing.
1711
+ # The ID of the AWS account that contains the dashboard that you're
1712
+ # describing.
1646
1713
  #
1647
1714
  # @option params [required, String] :dashboard_id
1648
1715
  # The ID for the dashboard.
1649
1716
  #
1650
1717
  # @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.
1718
+ # The version number for the dashboard. If a version number isn't
1719
+ # passed, the latest published dashboard version is described.
1653
1720
  #
1654
1721
  # @option params [String] :alias_name
1655
1722
  # The alias name.
@@ -1676,12 +1743,14 @@ module Aws::QuickSight
1676
1743
  # resp.dashboard.name #=> String
1677
1744
  # resp.dashboard.version.created_time #=> Time
1678
1745
  # resp.dashboard.version.errors #=> Array
1679
- # resp.dashboard.version.errors[0].type #=> String, one of "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING"
1746
+ # resp.dashboard.version.errors[0].type #=> String, one of "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING"
1680
1747
  # resp.dashboard.version.errors[0].message #=> String
1681
1748
  # resp.dashboard.version.version_number #=> Integer
1682
1749
  # resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
1683
1750
  # resp.dashboard.version.arn #=> String
1684
1751
  # resp.dashboard.version.source_entity_arn #=> String
1752
+ # resp.dashboard.version.data_set_arns #=> Array
1753
+ # resp.dashboard.version.data_set_arns[0] #=> String
1685
1754
  # resp.dashboard.version.description #=> String
1686
1755
  # resp.dashboard.created_time #=> Time
1687
1756
  # resp.dashboard.last_published_time #=> Time
@@ -1698,14 +1767,14 @@ module Aws::QuickSight
1698
1767
  req.send_request(options)
1699
1768
  end
1700
1769
 
1701
- # Describes read and write permissions on a dashboard.
1770
+ # Describes read and write permissions for a dashboard.
1702
1771
  #
1703
1772
  # @option params [required, String] :aws_account_id
1704
- # AWS account ID that contains the dashboard you are describing
1705
- # permissions of.
1773
+ # The ID of the AWS account that contains the dashboard that you're
1774
+ # describing permissions for.
1706
1775
  #
1707
1776
  # @option params [required, String] :dashboard_id
1708
- # The ID for the dashboard, also added to IAM policy.
1777
+ # The ID for the dashboard, also added to the IAM policy.
1709
1778
  #
1710
1779
  # @return [Types::DescribeDashboardPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1711
1780
  #
@@ -1745,7 +1814,7 @@ module Aws::QuickSight
1745
1814
  # Describes a dataset.
1746
1815
  #
1747
1816
  # @option params [required, String] :aws_account_id
1748
- # The AWS Account ID.
1817
+ # The AWS account ID.
1749
1818
  #
1750
1819
  # @option params [required, String] :data_set_id
1751
1820
  # The ID for the dataset that you want to create. This ID is unique per
@@ -1846,7 +1915,7 @@ module Aws::QuickSight
1846
1915
  # `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
1847
1916
  #
1848
1917
  # @option params [required, String] :aws_account_id
1849
- # The AWS Account ID.
1918
+ # The AWS account ID.
1850
1919
  #
1851
1920
  # @option params [required, String] :data_set_id
1852
1921
  # The ID for the dataset that you want to create. This ID is unique per
@@ -2068,11 +2137,12 @@ module Aws::QuickSight
2068
2137
  req.send_request(options)
2069
2138
  end
2070
2139
 
2071
- # Describes an existing IAMPolicy Assignment by specified assignment
2072
- # name.
2140
+ # Describes an existing IAM policy assignment, as specified by the
2141
+ # assignment name.
2073
2142
  #
2074
2143
  # @option params [required, String] :aws_account_id
2075
- # The AWS account ID that contains the assignment you want to describe.
2144
+ # The ID of the AWS account that contains the assignment that you want
2145
+ # to describe.
2076
2146
  #
2077
2147
  # @option params [required, String] :assignment_name
2078
2148
  # The name of the assignment.
@@ -2172,18 +2242,19 @@ module Aws::QuickSight
2172
2242
  # Describes a template's metadata.
2173
2243
  #
2174
2244
  # @option params [required, String] :aws_account_id
2175
- # AWS account ID that contains the template you are describing.
2245
+ # The ID of the AWS account that contains the template that you're
2246
+ # describing.
2176
2247
  #
2177
2248
  # @option params [required, String] :template_id
2178
- # An ID for the template.
2249
+ # The ID for the template.
2179
2250
  #
2180
2251
  # @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.
2252
+ # (Optional) The number for the version to describe. If a
2253
+ # `VersionNumber` parameter value isn't provided, the latest version of
2254
+ # the template is described.
2184
2255
  #
2185
2256
  # @option params [String] :alias_name
2186
- # The alias of the template that you want to describe. If you provide a
2257
+ # The alias of the template that you want to describe. If you name a
2187
2258
  # specific alias, you describe the version that the alias points to. You
2188
2259
  # can specify the latest version of the template by providing the
2189
2260
  # keyword `$LATEST` in the `AliasName` parameter. The keyword
@@ -2209,7 +2280,7 @@ module Aws::QuickSight
2209
2280
  # resp.template.name #=> String
2210
2281
  # resp.template.version.created_time #=> Time
2211
2282
  # resp.template.version.errors #=> Array
2212
- # resp.template.version.errors[0].type #=> String, one of "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE"
2283
+ # resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE"
2213
2284
  # resp.template.version.errors[0].message #=> String
2214
2285
  # resp.template.version.version_number #=> Integer
2215
2286
  # resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
@@ -2239,18 +2310,19 @@ module Aws::QuickSight
2239
2310
  req.send_request(options)
2240
2311
  end
2241
2312
 
2242
- # Describes the template aliases of a template.
2313
+ # Describes the template alias for a template.
2243
2314
  #
2244
2315
  # @option params [required, String] :aws_account_id
2245
- # AWS account ID that contains the template alias you are describing.
2316
+ # The ID of the AWS account that contains the template alias that
2317
+ # you're describing.
2246
2318
  #
2247
2319
  # @option params [required, String] :template_id
2248
- # An ID for the template.
2320
+ # The ID for the template.
2249
2321
  #
2250
2322
  # @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
2323
+ # The name of the template alias that you want to describe. If you name
2324
+ # a specific alias, you describe the version that the alias points to.
2325
+ # You can specify the latest version of the template by providing the
2254
2326
  # keyword `$LATEST` in the `AliasName` parameter. The keyword
2255
2327
  # `$PUBLISHED` doesn't apply to templates.
2256
2328
  #
@@ -2288,7 +2360,8 @@ module Aws::QuickSight
2288
2360
  # Describes read and write permissions on a template.
2289
2361
  #
2290
2362
  # @option params [required, String] :aws_account_id
2291
- # AWS account ID that contains the template you are describing.
2363
+ # The ID of the AWS account that contains the template that you're
2364
+ # describing.
2292
2365
  #
2293
2366
  # @option params [required, String] :template_id
2294
2367
  # The ID for the template.
@@ -2375,12 +2448,12 @@ module Aws::QuickSight
2375
2448
  req.send_request(options)
2376
2449
  end
2377
2450
 
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] .
2451
+ # Generates a server-side embeddable URL and authorization code. For
2452
+ # this process to work properly, first configure the dashboards and user
2453
+ # permissions. For more information, see [Embedding Amazon QuickSight
2454
+ # Dashboards][1] in the *Amazon QuickSight User Guide* or [Embedding
2455
+ # Amazon QuickSight Dashboards][2] in the *Amazon QuickSight API
2456
+ # Reference*.
2384
2457
  #
2385
2458
  # Currently, you can use `GetDashboardEmbedURL` only from the server,
2386
2459
  # not from the user’s browser.
@@ -2391,25 +2464,26 @@ module Aws::QuickSight
2391
2464
  # [2]: https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html
2392
2465
  #
2393
2466
  # @option params [required, String] :aws_account_id
2394
- # AWS account ID that contains the dashboard you are embedding.
2467
+ # The ID for the AWS account that contains the dashboard that you're
2468
+ # embedding.
2395
2469
  #
2396
2470
  # @option params [required, String] :dashboard_id
2397
- # The ID for the dashboard, also added to IAM policy
2471
+ # The ID for the dashboard, also added to the IAM policy.
2398
2472
  #
2399
2473
  # @option params [required, String] :identity_type
2400
- # The authentication method the user uses to sign in.
2474
+ # The authentication method that the user uses to sign in.
2401
2475
  #
2402
2476
  # @option params [Integer] :session_lifetime_in_minutes
2403
2477
  # How many minutes the session is valid. The session lifetime must be
2404
- # between 15 and 600 minutes.
2478
+ # 15-600 minutes.
2405
2479
  #
2406
2480
  # @option params [Boolean] :undo_redo_disabled
2407
- # Remove the undo/redo button on embedded dashboard. The default is
2481
+ # Remove the undo/redo button on the embedded dashboard. The default is
2408
2482
  # FALSE, which enables the undo/redo button.
2409
2483
  #
2410
2484
  # @option params [Boolean] :reset_disabled
2411
- # Remove the reset button on embedded dashboard. The default is FALSE,
2412
- # which allows the reset button.
2485
+ # Remove the reset button on the embedded dashboard. The default is
2486
+ # FALSE, which enables the reset button.
2413
2487
  #
2414
2488
  # @option params [String] :user_arn
2415
2489
  # The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
@@ -2419,11 +2493,11 @@ module Aws::QuickSight
2419
2493
  #
2420
2494
  # * Active Directory (AD) users or group members
2421
2495
  #
2422
- # * Invited non-federated users
2496
+ # * Invited nonfederated users
2423
2497
  #
2424
2498
  # * IAM users and IAM role-based sessions authenticated through
2425
2499
  # Federated Single Sign-On using SAML, OpenID Connect, or IAM
2426
- # Federation
2500
+ # federation.
2427
2501
  #
2428
2502
  # @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2429
2503
  #
@@ -2458,11 +2532,12 @@ module Aws::QuickSight
2458
2532
  req.send_request(options)
2459
2533
  end
2460
2534
 
2461
- # Lists all the versions of the dashboards in the Quicksight
2535
+ # Lists all the versions of the dashboards in the QuickSight
2462
2536
  # subscription.
2463
2537
  #
2464
2538
  # @option params [required, String] :aws_account_id
2465
- # AWS account ID that contains the dashboard you are listing.
2539
+ # The ID of the AWS account that contains the dashboard that you're
2540
+ # listing versions for.
2466
2541
  #
2467
2542
  # @option params [required, String] :dashboard_id
2468
2543
  # The ID for the dashboard.
@@ -2481,6 +2556,8 @@ module Aws::QuickSight
2481
2556
  # * {Types::ListDashboardVersionsResponse#status #status} => Integer
2482
2557
  # * {Types::ListDashboardVersionsResponse#request_id #request_id} => String
2483
2558
  #
2559
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2560
+ #
2484
2561
  # @example Request syntax with placeholder values
2485
2562
  #
2486
2563
  # resp = client.list_dashboard_versions({
@@ -2512,10 +2589,11 @@ module Aws::QuickSight
2512
2589
  req.send_request(options)
2513
2590
  end
2514
2591
 
2515
- # Lists dashboards in the AWS account.
2592
+ # Lists dashboards in an AWS account.
2516
2593
  #
2517
2594
  # @option params [required, String] :aws_account_id
2518
- # AWS account ID that contains the dashboards you are listing.
2595
+ # The ID of the AWS account that contains the dashboards that you're
2596
+ # listing.
2519
2597
  #
2520
2598
  # @option params [String] :next_token
2521
2599
  # The token for the next set of results, or null if there are no more
@@ -2531,6 +2609,8 @@ module Aws::QuickSight
2531
2609
  # * {Types::ListDashboardsResponse#status #status} => Integer
2532
2610
  # * {Types::ListDashboardsResponse#request_id #request_id} => String
2533
2611
  #
2612
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2613
+ #
2534
2614
  # @example Request syntax with placeholder values
2535
2615
  #
2536
2616
  # resp = client.list_dashboards({
@@ -2562,13 +2642,14 @@ module Aws::QuickSight
2562
2642
  req.send_request(options)
2563
2643
  end
2564
2644
 
2565
- # Lists all of the datasets belonging to this account in an AWS region.
2645
+ # Lists all of the datasets belonging to the current AWS account in an
2646
+ # AWS Region.
2566
2647
  #
2567
2648
  # The permissions resource is
2568
2649
  # `arn:aws:quicksight:region:aws-account-id:dataset/*`.
2569
2650
  #
2570
2651
  # @option params [required, String] :aws_account_id
2571
- # The AWS Account ID.
2652
+ # The AWS account ID.
2572
2653
  #
2573
2654
  # @option params [String] :next_token
2574
2655
  # The token for the next set of results, or null if there are no more
@@ -2584,6 +2665,8 @@ module Aws::QuickSight
2584
2665
  # * {Types::ListDataSetsResponse#request_id #request_id} => String
2585
2666
  # * {Types::ListDataSetsResponse#status #status} => Integer
2586
2667
  #
2668
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2669
+ #
2587
2670
  # @example Request syntax with placeholder values
2588
2671
  #
2589
2672
  # resp = client.list_data_sets({
@@ -2636,6 +2719,8 @@ module Aws::QuickSight
2636
2719
  # * {Types::ListDataSourcesResponse#request_id #request_id} => String
2637
2720
  # * {Types::ListDataSourcesResponse#status #status} => Integer
2638
2721
  #
2722
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2723
+ #
2639
2724
  # @example Request syntax with placeholder values
2640
2725
  #
2641
2726
  # resp = client.list_data_sources({
@@ -2821,16 +2906,16 @@ module Aws::QuickSight
2821
2906
  req.send_request(options)
2822
2907
  end
2823
2908
 
2824
- # Lists assignments in current QuickSight account.
2909
+ # Lists IAM policy assignments in the current Amazon QuickSight account.
2825
2910
  #
2826
2911
  # @option params [required, String] :aws_account_id
2827
- # The AWS account ID that contains this IAM policy assignment.
2912
+ # The ID of the AWS account that contains these IAM policy assignments.
2828
2913
  #
2829
2914
  # @option params [String] :assignment_status
2830
- # The status of the assignment.
2915
+ # The status of the assignments.
2831
2916
  #
2832
2917
  # @option params [required, String] :namespace
2833
- # The namespace for this assignment.
2918
+ # The namespace for the assignments.
2834
2919
  #
2835
2920
  # @option params [String] :next_token
2836
2921
  # The token for the next set of results, or null if there are no more
@@ -2874,12 +2959,12 @@ module Aws::QuickSight
2874
2959
  req.send_request(options)
2875
2960
  end
2876
2961
 
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.
2962
+ # Lists all the IAM policy assignments, including the Amazon Resource
2963
+ # Names (ARNs) for the IAM policies assigned to the specified user and
2964
+ # group or groups that the user belongs to.
2880
2965
  #
2881
2966
  # @option params [required, String] :aws_account_id
2882
- # The AWS account ID that contains the assignment.
2967
+ # The ID of the AWS account that contains the assignments.
2883
2968
  #
2884
2969
  # @option params [required, String] :user_name
2885
2970
  # The name of the user.
@@ -2951,6 +3036,8 @@ module Aws::QuickSight
2951
3036
  # * {Types::ListIngestionsResponse#request_id #request_id} => String
2952
3037
  # * {Types::ListIngestionsResponse#status #status} => Integer
2953
3038
  #
3039
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3040
+ #
2954
3041
  # @example Request syntax with placeholder values
2955
3042
  #
2956
3043
  # resp = client.list_ingestions({
@@ -3028,7 +3115,8 @@ module Aws::QuickSight
3028
3115
  # Lists all the aliases of a template.
3029
3116
  #
3030
3117
  # @option params [required, String] :aws_account_id
3031
- # AWS account ID that contains the template aliases you are listing.
3118
+ # The ID of the AWS account that contains the template aliases that
3119
+ # you're listing.
3032
3120
  #
3033
3121
  # @option params [required, String] :template_id
3034
3122
  # The ID for the template.
@@ -3047,6 +3135,8 @@ module Aws::QuickSight
3047
3135
  # * {Types::ListTemplateAliasesResponse#request_id #request_id} => String
3048
3136
  # * {Types::ListTemplateAliasesResponse#next_token #next_token} => String
3049
3137
  #
3138
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3139
+ #
3050
3140
  # @example Request syntax with placeholder values
3051
3141
  #
3052
3142
  # resp = client.list_template_aliases({
@@ -3075,10 +3165,12 @@ module Aws::QuickSight
3075
3165
  req.send_request(options)
3076
3166
  end
3077
3167
 
3078
- # Lists all the versions of the templates in the Quicksight account.
3168
+ # Lists all the versions of the templates in the current Amazon
3169
+ # QuickSight account.
3079
3170
  #
3080
3171
  # @option params [required, String] :aws_account_id
3081
- # AWS account ID that contains the templates you are listing.
3172
+ # The ID of the AWS account that contains the templates that you're
3173
+ # listing.
3082
3174
  #
3083
3175
  # @option params [required, String] :template_id
3084
3176
  # The ID for the template.
@@ -3097,6 +3189,8 @@ module Aws::QuickSight
3097
3189
  # * {Types::ListTemplateVersionsResponse#status #status} => Integer
3098
3190
  # * {Types::ListTemplateVersionsResponse#request_id #request_id} => String
3099
3191
  #
3192
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3193
+ #
3100
3194
  # @example Request syntax with placeholder values
3101
3195
  #
3102
3196
  # resp = client.list_template_versions({
@@ -3127,10 +3221,11 @@ module Aws::QuickSight
3127
3221
  req.send_request(options)
3128
3222
  end
3129
3223
 
3130
- # Lists all the templates in the QuickSight account.
3224
+ # Lists all the templates in the current Amazon QuickSight account.
3131
3225
  #
3132
3226
  # @option params [required, String] :aws_account_id
3133
- # AWS account ID that contains the templates you are listing.
3227
+ # The ID of the AWS account that contains the templates that you're
3228
+ # listing.
3134
3229
  #
3135
3230
  # @option params [String] :next_token
3136
3231
  # The token for the next set of results, or null if there are no more
@@ -3146,6 +3241,8 @@ module Aws::QuickSight
3146
3241
  # * {Types::ListTemplatesResponse#status #status} => Integer
3147
3242
  # * {Types::ListTemplatesResponse#request_id #request_id} => String
3148
3243
  #
3244
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3245
+ #
3149
3246
  # @example Request syntax with placeholder values
3150
3247
  #
3151
3248
  # resp = client.list_templates({
@@ -3184,7 +3281,7 @@ module Aws::QuickSight
3184
3281
  # memberships for.
3185
3282
  #
3186
3283
  # @option params [required, String] :aws_account_id
3187
- # The AWS Account ID that the user is in. Currently, you use the ID for
3284
+ # The AWS account ID that the user is in. Currently, you use the ID for
3188
3285
  # the AWS account that contains your Amazon QuickSight account.
3189
3286
  #
3190
3287
  # @option params [required, String] :namespace
@@ -3335,7 +3432,7 @@ module Aws::QuickSight
3335
3432
  #
3336
3433
  #
3337
3434
  #
3338
- # [1]: https://docs.aws.example.com/cli/latest/reference/sts/assume-role.html
3435
+ # [1]: https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sts/assume-role.html
3339
3436
  #
3340
3437
  # @option params [required, String] :aws_account_id
3341
3438
  # The ID for the AWS account that the user is in. Currently, you use the
@@ -3390,6 +3487,72 @@ module Aws::QuickSight
3390
3487
  req.send_request(options)
3391
3488
  end
3392
3489
 
3490
+ # Searchs for dashboards that belong to a user.
3491
+ #
3492
+ # @option params [required, String] :aws_account_id
3493
+ # The ID of the AWS account that contains the user whose dashboards
3494
+ # you're searching for.
3495
+ #
3496
+ # @option params [required, Array<Types::DashboardSearchFilter>] :filters
3497
+ # The filters to apply to the search. Currently, you can search only by
3498
+ # user name. For example, `"Filters": [ \{ "Name": "QUICKSIGHT_USER",
3499
+ # "Operator": "StringEquals", "Value":
3500
+ # "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]`
3501
+ #
3502
+ # @option params [String] :next_token
3503
+ # The token for the next set of results, or null if there are no more
3504
+ # results.
3505
+ #
3506
+ # @option params [Integer] :max_results
3507
+ # The maximum number of results to be returned per request.
3508
+ #
3509
+ # @return [Types::SearchDashboardsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3510
+ #
3511
+ # * {Types::SearchDashboardsResponse#dashboard_summary_list #dashboard_summary_list} => Array&lt;Types::DashboardSummary&gt;
3512
+ # * {Types::SearchDashboardsResponse#next_token #next_token} => String
3513
+ # * {Types::SearchDashboardsResponse#status #status} => Integer
3514
+ # * {Types::SearchDashboardsResponse#request_id #request_id} => String
3515
+ #
3516
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3517
+ #
3518
+ # @example Request syntax with placeholder values
3519
+ #
3520
+ # resp = client.search_dashboards({
3521
+ # aws_account_id: "AwsAccountId", # required
3522
+ # filters: [ # required
3523
+ # {
3524
+ # operator: "StringEquals", # required, accepts StringEquals
3525
+ # name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
3526
+ # value: "String",
3527
+ # },
3528
+ # ],
3529
+ # next_token: "String",
3530
+ # max_results: 1,
3531
+ # })
3532
+ #
3533
+ # @example Response structure
3534
+ #
3535
+ # resp.dashboard_summary_list #=> Array
3536
+ # resp.dashboard_summary_list[0].arn #=> String
3537
+ # resp.dashboard_summary_list[0].dashboard_id #=> String
3538
+ # resp.dashboard_summary_list[0].name #=> String
3539
+ # resp.dashboard_summary_list[0].created_time #=> Time
3540
+ # resp.dashboard_summary_list[0].last_updated_time #=> Time
3541
+ # resp.dashboard_summary_list[0].published_version_number #=> Integer
3542
+ # resp.dashboard_summary_list[0].last_published_time #=> Time
3543
+ # resp.next_token #=> String
3544
+ # resp.status #=> Integer
3545
+ # resp.request_id #=> String
3546
+ #
3547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboards AWS API Documentation
3548
+ #
3549
+ # @overload search_dashboards(params = {})
3550
+ # @param [Hash] params ({})
3551
+ def search_dashboards(params = {}, options = {})
3552
+ req = build_request(:search_dashboards, params)
3553
+ req.send_request(options)
3554
+ end
3555
+
3393
3556
  # Assigns one or more tags (key-value pairs) to the specified QuickSight
3394
3557
  # resource.
3395
3558
  #
@@ -3488,10 +3651,11 @@ module Aws::QuickSight
3488
3651
  req.send_request(options)
3489
3652
  end
3490
3653
 
3491
- # Updates a dashboard in the AWS account.
3654
+ # Updates a dashboard in an AWS account.
3492
3655
  #
3493
3656
  # @option params [required, String] :aws_account_id
3494
- # AWS account ID that contains the dashboard you are updating.
3657
+ # The ID of the AWS account that contains the dashboard that you're
3658
+ # updating.
3495
3659
  #
3496
3660
  # @option params [required, String] :dashboard_id
3497
3661
  # The ID for the dashboard.
@@ -3501,11 +3665,11 @@ module Aws::QuickSight
3501
3665
  #
3502
3666
  # @option params [required, Types::DashboardSourceEntity] :source_entity
3503
3667
  # 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.
3668
+ # `SouceTemplate` entity accepts the Amazon Resource Name (ARN) of the
3669
+ # template and also references to replacement datasets for the
3670
+ # placeholders set when creating the template. The replacement datasets
3671
+ # need to follow the same schema as the datasets for which placeholders
3672
+ # were created when creating the template.
3509
3673
  #
3510
3674
  # @option params [Types::Parameters] :parameters
3511
3675
  # A structure that contains the parameters of the dashboard.
@@ -3514,20 +3678,23 @@ module Aws::QuickSight
3514
3678
  # A description for the first version of the dashboard being created.
3515
3679
  #
3516
3680
  # @option params [Types::DashboardPublishOptions] :dashboard_publish_options
3517
- # Publishing options when creating a dashboard.
3681
+ # Options for publishing the dashboard when you create it:
3518
3682
  #
3519
- # * AvailabilityStatus for AdHocFilteringOption - This can be either
3520
- # `ENABLED` or `DISABLED`. When This is set to set to `DISABLED`,
3683
+ # * `AvailabilityStatus` for `AdHocFilteringOption` - This status can be
3684
+ # either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
3521
3685
  # QuickSight disables the left filter pane on the published dashboard,
3522
- # which can be used for AdHoc filtering. Enabled by default.
3686
+ # which can be used for ad hoc (one-time) filtering. This option is
3687
+ # `ENABLED` by default.
3523
3688
  #
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.
3689
+ # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
3690
+ # either `ENABLED` or `DISABLED`. The visual option to export data to
3691
+ # .csv format isn't enabled when this is set to `DISABLED`. This
3692
+ # option is `ENABLED` by default.
3527
3693
  #
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.
3694
+ # * `VisibilityState` for `SheetControlsOption` - This visibility state
3695
+ # can be either `COLLAPSED` or `EXPANDED`. The sheet controls pane is
3696
+ # collapsed by default when set to true. This option is `COLLAPSED` by
3697
+ # default.
3531
3698
  #
3532
3699
  # @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3533
3700
  #
@@ -3616,7 +3783,8 @@ module Aws::QuickSight
3616
3783
  # Updates read and write permissions on a dashboard.
3617
3784
  #
3618
3785
  # @option params [required, String] :aws_account_id
3619
- # AWS account ID that contains the dashboard you are updating.
3786
+ # The ID of the AWS account that contains the dashboard whose
3787
+ # permissions you're updating.
3620
3788
  #
3621
3789
  # @option params [required, String] :dashboard_id
3622
3790
  # The ID for the dashboard.
@@ -3677,7 +3845,8 @@ module Aws::QuickSight
3677
3845
  # Updates the published version of a dashboard.
3678
3846
  #
3679
3847
  # @option params [required, String] :aws_account_id
3680
- # AWS account ID that contains the dashboard you are updating.
3848
+ # The ID of the AWS account that contains the dashboard that you're
3849
+ # updating.
3681
3850
  #
3682
3851
  # @option params [required, String] :dashboard_id
3683
3852
  # The ID for the dashboard.
@@ -3719,10 +3888,10 @@ module Aws::QuickSight
3719
3888
  # Updates a dataset.
3720
3889
  #
3721
3890
  # @option params [required, String] :aws_account_id
3722
- # The AWS Account ID.
3891
+ # The AWS account ID.
3723
3892
  #
3724
3893
  # @option params [required, String] :data_set_id
3725
- # The ID for the dataset that you want to create. This ID is unique per
3894
+ # The ID for the dataset that you want to update. This ID is unique per
3726
3895
  # AWS Region for each AWS account.
3727
3896
  #
3728
3897
  # @option params [required, String] :name
@@ -3737,14 +3906,14 @@ module Aws::QuickSight
3737
3906
  # physical tables.
3738
3907
  #
3739
3908
  # @option params [required, String] :import_mode
3740
- # Indicates whether or not you want to import the data into SPICE.
3909
+ # Indicates whether you want to import the data into SPICE.
3741
3910
  #
3742
3911
  # @option params [Array<Types::ColumnGroup>] :column_groups
3743
3912
  # Groupings of columns that work together in certain QuickSight
3744
3913
  # features. Currently, only geospatial hierarchy is supported.
3745
3914
  #
3746
3915
  # @option params [Types::RowLevelPermissionDataSet] :row_level_permission_data_set
3747
- # Row-level security configuration on the data you want to create.
3916
+ # The row-level security configuration for the data you want to create.
3748
3917
  #
3749
3918
  # @return [Types::UpdateDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3750
3919
  #
@@ -3893,11 +4062,11 @@ module Aws::QuickSight
3893
4062
  # `arn:aws:quicksight:region:aws-account-id:dataset/data-set-id`.
3894
4063
  #
3895
4064
  # @option params [required, String] :aws_account_id
3896
- # The AWS Account ID.
4065
+ # The AWS account ID.
3897
4066
  #
3898
4067
  # @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.
4068
+ # The ID for the dataset whose permissions you want to update. This ID
4069
+ # is unique per AWS Region for each AWS account.
3901
4070
  #
3902
4071
  # @option params [Array<Types::ResourcePermission>] :grant_permissions
3903
4072
  # The resource permissions that you want to grant to the dataset.
@@ -4215,37 +4384,39 @@ module Aws::QuickSight
4215
4384
  req.send_request(options)
4216
4385
  end
4217
4386
 
4218
- # Updates an existing assignment. This operation updates only the
4219
- # optional parameter or parameters that are specified in the request.
4387
+ # Updates an existing IAM policy assignment. This operation updates only
4388
+ # the optional parameter or parameters that are specified in the
4389
+ # request.
4220
4390
  #
4221
4391
  # @option params [required, String] :aws_account_id
4222
- # The AWS account ID that contains the IAM policy assignment.
4392
+ # The ID of the AWS account that contains the IAM policy assignment.
4223
4393
  #
4224
4394
  # @option params [required, String] :assignment_name
4225
- # The name of the assignment. It must be unique within an AWS account.
4395
+ # The name of the assignment. This name must be unique within an AWS
4396
+ # account.
4226
4397
  #
4227
4398
  # @option params [required, String] :namespace
4228
4399
  # The namespace of the assignment.
4229
4400
  #
4230
4401
  # @option params [String] :assignment_status
4231
- # The status of an assignment:
4402
+ # The status of the assignment. Possible values are as follows:
4232
4403
  #
4233
- # * ENABLED - Anything specified in this assignment is used while
4404
+ # * `ENABLED` - Anything specified in this assignment is used when
4234
4405
  # creating the data source.
4235
4406
  #
4236
- # * DISABLED - This assignment isn't used while creating the data
4407
+ # * `DISABLED` - This assignment isn't used when creating the data
4237
4408
  # source.
4238
4409
  #
4239
- # * DRAFT - Assignment is an unfinished draft and isn't used while
4240
- # creating the data source.
4410
+ # * `DRAFT` - This assignment is an unfinished draft and isn't used
4411
+ # when creating the data source.
4241
4412
  #
4242
4413
  # @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.
4414
+ # The ARN for the IAM policy to apply to the QuickSight users and groups
4415
+ # specified in this assignment.
4245
4416
  #
4246
4417
  # @option params [Hash<String,Array>] :identities
4247
- # QuickSight users and/or groups that you want to assign to the
4248
- # specified IAM policy.
4418
+ # The QuickSight users, groups, or both that you want to assign the
4419
+ # policy to.
4249
4420
  #
4250
4421
  # @return [Types::UpdateIAMPolicyAssignmentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4251
4422
  #
@@ -4291,24 +4462,26 @@ module Aws::QuickSight
4291
4462
  req.send_request(options)
4292
4463
  end
4293
4464
 
4294
- # Updates a template from an existing QuickSight analysis.
4465
+ # Updates a template from an existing Amazon QuickSight analysis or
4466
+ # another template.
4295
4467
  #
4296
4468
  # @option params [required, String] :aws_account_id
4297
- # AWS account ID that contains the template you are updating.
4469
+ # The ID of the AWS account that contains the template that you're
4470
+ # updating.
4298
4471
  #
4299
4472
  # @option params [required, String] :template_id
4300
4473
  # The ID for the template.
4301
4474
  #
4302
4475
  # @option params [required, Types::TemplateSourceEntity] :source_entity
4303
4476
  # The source QuickSight entity from which this template is being
4304
- # created. Templates can be currently created from an Analysis or
4477
+ # updated. You can currently update templates from an Analysis or
4305
4478
  # another template.
4306
4479
  #
4307
4480
  # @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.
4481
+ # A description of the current template version that is being updated.
4482
+ # Every time you call `UpdateTemplate`, you create a new version of the
4483
+ # template. Each version of the template maintains a description of the
4484
+ # version in the `VersionDescription` field.
4312
4485
  #
4313
4486
  # @option params [String] :name
4314
4487
  # The name for the template.
@@ -4366,13 +4539,14 @@ module Aws::QuickSight
4366
4539
  # Updates the template alias of a template.
4367
4540
  #
4368
4541
  # @option params [required, String] :aws_account_id
4369
- # AWS account ID that contains the template aliases you are updating.
4542
+ # The ID of the AWS account that contains the template alias that
4543
+ # you're updating.
4370
4544
  #
4371
4545
  # @option params [required, String] :template_id
4372
4546
  # The ID for the template.
4373
4547
  #
4374
4548
  # @option params [required, String] :alias_name
4375
- # The alias of the template that you want to update. If you provide a
4549
+ # The alias of the template that you want to update. If you name a
4376
4550
  # specific alias, you update the version that the alias points to. You
4377
4551
  # can specify the latest version of the template by providing the
4378
4552
  # keyword `$LATEST` in the `AliasName` parameter. The keyword
@@ -4413,10 +4587,10 @@ module Aws::QuickSight
4413
4587
  req.send_request(options)
4414
4588
  end
4415
4589
 
4416
- # Updates the permissions on a template.
4590
+ # Updates the resource permissions for a template.
4417
4591
  #
4418
4592
  # @option params [required, String] :aws_account_id
4419
- # AWS account ID that contains the template.
4593
+ # The ID of the AWS account that contains the template.
4420
4594
  #
4421
4595
  # @option params [required, String] :template_id
4422
4596
  # The ID for the template.
@@ -4551,7 +4725,7 @@ module Aws::QuickSight
4551
4725
  params: params,
4552
4726
  config: config)
4553
4727
  context[:gem_name] = 'aws-sdk-quicksight'
4554
- context[:gem_version] = '1.15.0'
4728
+ context[:gem_version] = '1.20.0'
4555
4729
  Seahorse::Client::Request.new(handlers, context)
4556
4730
  end
4557
4731