aws-sdk-quicksight 1.16.0 → 1.21.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 +5 -5
- data/lib/aws-sdk-quicksight.rb +7 -4
- data/lib/aws-sdk-quicksight/client.rb +156 -18
- data/lib/aws-sdk-quicksight/client_api.rb +49 -0
- data/lib/aws-sdk-quicksight/errors.rb +39 -17
- data/lib/aws-sdk-quicksight/resource.rb +1 -0
- data/lib/aws-sdk-quicksight/types.rb +122 -6
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 1e73fd7eba4d340583e0d6cc079d83ca869e92d078ac839b46b75a13663c0321
|
4
|
+
data.tar.gz: 255660358324d44dc894be27390649955c3b49845392a9f672ffdd66d23563e4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6f7590abc72fabf7b37f7c5ed1c6c4fa20359c17f1c415b6a80a722e0097f1023c8680e3f64e4aab5cc2532df50cb44a8dd41cb80cd18c057227fdae09e78f69
|
7
|
+
data.tar.gz: 380004d912de6dbb29aee670cfa065f92030c80f021c75611b2693022674f620ea19d8668af638057dfca9af4b8b887324f56476761a4c96a54b117e0107290e
|
data/lib/aws-sdk-quicksight.rb
CHANGED
@@ -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
|
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
|
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.
|
48
|
+
GEM_VERSION = '1.21.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
|
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
|
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
|
@@ -154,7 +176,7 @@ module Aws::QuickSight
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -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.
|
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
|
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)
|
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
|
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
|
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
|
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`.
|
@@ -1029,7 +1083,7 @@ module Aws::QuickSight
|
|
1029
1083
|
#
|
1030
1084
|
#
|
1031
1085
|
#
|
1032
|
-
# [1]: https://aws.
|
1086
|
+
# [1]: https://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/
|
1033
1087
|
#
|
1034
1088
|
# @option params [required, String] :data_set_id
|
1035
1089
|
# The ID of the dataset used in the ingestion.
|
@@ -1689,12 +1743,14 @@ module Aws::QuickSight
|
|
1689
1743
|
# resp.dashboard.name #=> String
|
1690
1744
|
# resp.dashboard.version.created_time #=> Time
|
1691
1745
|
# resp.dashboard.version.errors #=> Array
|
1692
|
-
# 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"
|
1693
1747
|
# resp.dashboard.version.errors[0].message #=> String
|
1694
1748
|
# resp.dashboard.version.version_number #=> Integer
|
1695
1749
|
# resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
1696
1750
|
# resp.dashboard.version.arn #=> String
|
1697
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
|
1698
1754
|
# resp.dashboard.version.description #=> String
|
1699
1755
|
# resp.dashboard.created_time #=> Time
|
1700
1756
|
# resp.dashboard.last_published_time #=> Time
|
@@ -2224,7 +2280,7 @@ module Aws::QuickSight
|
|
2224
2280
|
# resp.template.name #=> String
|
2225
2281
|
# resp.template.version.created_time #=> Time
|
2226
2282
|
# resp.template.version.errors #=> Array
|
2227
|
-
# 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"
|
2228
2284
|
# resp.template.version.errors[0].message #=> String
|
2229
2285
|
# resp.template.version.version_number #=> Integer
|
2230
2286
|
# resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
|
@@ -2500,6 +2556,8 @@ module Aws::QuickSight
|
|
2500
2556
|
# * {Types::ListDashboardVersionsResponse#status #status} => Integer
|
2501
2557
|
# * {Types::ListDashboardVersionsResponse#request_id #request_id} => String
|
2502
2558
|
#
|
2559
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2560
|
+
#
|
2503
2561
|
# @example Request syntax with placeholder values
|
2504
2562
|
#
|
2505
2563
|
# resp = client.list_dashboard_versions({
|
@@ -2551,6 +2609,8 @@ module Aws::QuickSight
|
|
2551
2609
|
# * {Types::ListDashboardsResponse#status #status} => Integer
|
2552
2610
|
# * {Types::ListDashboardsResponse#request_id #request_id} => String
|
2553
2611
|
#
|
2612
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2613
|
+
#
|
2554
2614
|
# @example Request syntax with placeholder values
|
2555
2615
|
#
|
2556
2616
|
# resp = client.list_dashboards({
|
@@ -2605,6 +2665,8 @@ module Aws::QuickSight
|
|
2605
2665
|
# * {Types::ListDataSetsResponse#request_id #request_id} => String
|
2606
2666
|
# * {Types::ListDataSetsResponse#status #status} => Integer
|
2607
2667
|
#
|
2668
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2669
|
+
#
|
2608
2670
|
# @example Request syntax with placeholder values
|
2609
2671
|
#
|
2610
2672
|
# resp = client.list_data_sets({
|
@@ -2657,6 +2719,8 @@ module Aws::QuickSight
|
|
2657
2719
|
# * {Types::ListDataSourcesResponse#request_id #request_id} => String
|
2658
2720
|
# * {Types::ListDataSourcesResponse#status #status} => Integer
|
2659
2721
|
#
|
2722
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2723
|
+
#
|
2660
2724
|
# @example Request syntax with placeholder values
|
2661
2725
|
#
|
2662
2726
|
# resp = client.list_data_sources({
|
@@ -2972,6 +3036,8 @@ module Aws::QuickSight
|
|
2972
3036
|
# * {Types::ListIngestionsResponse#request_id #request_id} => String
|
2973
3037
|
# * {Types::ListIngestionsResponse#status #status} => Integer
|
2974
3038
|
#
|
3039
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3040
|
+
#
|
2975
3041
|
# @example Request syntax with placeholder values
|
2976
3042
|
#
|
2977
3043
|
# resp = client.list_ingestions({
|
@@ -3069,6 +3135,8 @@ module Aws::QuickSight
|
|
3069
3135
|
# * {Types::ListTemplateAliasesResponse#request_id #request_id} => String
|
3070
3136
|
# * {Types::ListTemplateAliasesResponse#next_token #next_token} => String
|
3071
3137
|
#
|
3138
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3139
|
+
#
|
3072
3140
|
# @example Request syntax with placeholder values
|
3073
3141
|
#
|
3074
3142
|
# resp = client.list_template_aliases({
|
@@ -3121,6 +3189,8 @@ module Aws::QuickSight
|
|
3121
3189
|
# * {Types::ListTemplateVersionsResponse#status #status} => Integer
|
3122
3190
|
# * {Types::ListTemplateVersionsResponse#request_id #request_id} => String
|
3123
3191
|
#
|
3192
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3193
|
+
#
|
3124
3194
|
# @example Request syntax with placeholder values
|
3125
3195
|
#
|
3126
3196
|
# resp = client.list_template_versions({
|
@@ -3171,6 +3241,8 @@ module Aws::QuickSight
|
|
3171
3241
|
# * {Types::ListTemplatesResponse#status #status} => Integer
|
3172
3242
|
# * {Types::ListTemplatesResponse#request_id #request_id} => String
|
3173
3243
|
#
|
3244
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3245
|
+
#
|
3174
3246
|
# @example Request syntax with placeholder values
|
3175
3247
|
#
|
3176
3248
|
# resp = client.list_templates({
|
@@ -3360,7 +3432,7 @@ module Aws::QuickSight
|
|
3360
3432
|
#
|
3361
3433
|
#
|
3362
3434
|
#
|
3363
|
-
# [1]: https://
|
3435
|
+
# [1]: https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sts/assume-role.html
|
3364
3436
|
#
|
3365
3437
|
# @option params [required, String] :aws_account_id
|
3366
3438
|
# The ID for the AWS account that the user is in. Currently, you use the
|
@@ -3415,6 +3487,72 @@ module Aws::QuickSight
|
|
3415
3487
|
req.send_request(options)
|
3416
3488
|
end
|
3417
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<Types::DashboardSummary>
|
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
|
+
|
3418
3556
|
# Assigns one or more tags (key-value pairs) to the specified QuickSight
|
3419
3557
|
# resource.
|
3420
3558
|
#
|
@@ -4587,7 +4725,7 @@ module Aws::QuickSight
|
|
4587
4725
|
params: params,
|
4588
4726
|
config: config)
|
4589
4727
|
context[:gem_name] = 'aws-sdk-quicksight'
|
4590
|
-
context[:gem_version] = '1.
|
4728
|
+
context[:gem_version] = '1.21.0'
|
4591
4729
|
Seahorse::Client::Request.new(handlers, context)
|
4592
4730
|
end
|
4593
4731
|
|
@@ -77,8 +77,11 @@ module Aws::QuickSight
|
|
77
77
|
DashboardError = Shapes::StructureShape.new(name: 'DashboardError')
|
78
78
|
DashboardErrorList = Shapes::ListShape.new(name: 'DashboardErrorList')
|
79
79
|
DashboardErrorType = Shapes::StringShape.new(name: 'DashboardErrorType')
|
80
|
+
DashboardFilterAttribute = Shapes::StringShape.new(name: 'DashboardFilterAttribute')
|
80
81
|
DashboardName = Shapes::StringShape.new(name: 'DashboardName')
|
81
82
|
DashboardPublishOptions = Shapes::StructureShape.new(name: 'DashboardPublishOptions')
|
83
|
+
DashboardSearchFilter = Shapes::StructureShape.new(name: 'DashboardSearchFilter')
|
84
|
+
DashboardSearchFilterList = Shapes::ListShape.new(name: 'DashboardSearchFilterList')
|
82
85
|
DashboardSourceEntity = Shapes::StructureShape.new(name: 'DashboardSourceEntity')
|
83
86
|
DashboardSourceTemplate = Shapes::StructureShape.new(name: 'DashboardSourceTemplate')
|
84
87
|
DashboardSummary = Shapes::StructureShape.new(name: 'DashboardSummary')
|
@@ -88,6 +91,7 @@ module Aws::QuickSight
|
|
88
91
|
DashboardVersionSummary = Shapes::StructureShape.new(name: 'DashboardVersionSummary')
|
89
92
|
DashboardVersionSummaryList = Shapes::ListShape.new(name: 'DashboardVersionSummaryList')
|
90
93
|
DataSet = Shapes::StructureShape.new(name: 'DataSet')
|
94
|
+
DataSetArnsList = Shapes::ListShape.new(name: 'DataSetArnsList')
|
91
95
|
DataSetConfiguration = Shapes::StructureShape.new(name: 'DataSetConfiguration')
|
92
96
|
DataSetConfigurationList = Shapes::ListShape.new(name: 'DataSetConfigurationList')
|
93
97
|
DataSetImportMode = Shapes::StringShape.new(name: 'DataSetImportMode')
|
@@ -167,6 +171,7 @@ module Aws::QuickSight
|
|
167
171
|
Expression = Shapes::StringShape.new(name: 'Expression')
|
168
172
|
FileFormat = Shapes::StringShape.new(name: 'FileFormat')
|
169
173
|
FilterOperation = Shapes::StructureShape.new(name: 'FilterOperation')
|
174
|
+
FilterOperator = Shapes::StringShape.new(name: 'FilterOperator')
|
170
175
|
GeoSpatialColumnGroup = Shapes::StructureShape.new(name: 'GeoSpatialColumnGroup')
|
171
176
|
GeoSpatialCountryCode = Shapes::StringShape.new(name: 'GeoSpatialCountryCode')
|
172
177
|
GeoSpatialDataRole = Shapes::StringShape.new(name: 'GeoSpatialDataRole')
|
@@ -298,6 +303,8 @@ module Aws::QuickSight
|
|
298
303
|
S3Key = Shapes::StringShape.new(name: 'S3Key')
|
299
304
|
S3Parameters = Shapes::StructureShape.new(name: 'S3Parameters')
|
300
305
|
S3Source = Shapes::StructureShape.new(name: 'S3Source')
|
306
|
+
SearchDashboardsRequest = Shapes::StructureShape.new(name: 'SearchDashboardsRequest')
|
307
|
+
SearchDashboardsResponse = Shapes::StructureShape.new(name: 'SearchDashboardsResponse')
|
301
308
|
ServiceNowParameters = Shapes::StructureShape.new(name: 'ServiceNowParameters')
|
302
309
|
SessionLifetimeInMinutes = Shapes::IntegerShape.new(name: 'SessionLifetimeInMinutes')
|
303
310
|
SessionLifetimeInMinutesInvalidException = Shapes::StructureShape.new(name: 'SessionLifetimeInMinutesInvalidException')
|
@@ -656,6 +663,13 @@ module Aws::QuickSight
|
|
656
663
|
DashboardPublishOptions.add_member(:sheet_controls_option, Shapes::ShapeRef.new(shape: SheetControlsOption, location_name: "SheetControlsOption"))
|
657
664
|
DashboardPublishOptions.struct_class = Types::DashboardPublishOptions
|
658
665
|
|
666
|
+
DashboardSearchFilter.add_member(:operator, Shapes::ShapeRef.new(shape: FilterOperator, required: true, location_name: "Operator"))
|
667
|
+
DashboardSearchFilter.add_member(:name, Shapes::ShapeRef.new(shape: DashboardFilterAttribute, location_name: "Name"))
|
668
|
+
DashboardSearchFilter.add_member(:value, Shapes::ShapeRef.new(shape: String, location_name: "Value"))
|
669
|
+
DashboardSearchFilter.struct_class = Types::DashboardSearchFilter
|
670
|
+
|
671
|
+
DashboardSearchFilterList.member = Shapes::ShapeRef.new(shape: DashboardSearchFilter)
|
672
|
+
|
659
673
|
DashboardSourceEntity.add_member(:source_template, Shapes::ShapeRef.new(shape: DashboardSourceTemplate, location_name: "SourceTemplate"))
|
660
674
|
DashboardSourceEntity.struct_class = Types::DashboardSourceEntity
|
661
675
|
|
@@ -680,6 +694,7 @@ module Aws::QuickSight
|
|
680
694
|
DashboardVersion.add_member(:status, Shapes::ShapeRef.new(shape: ResourceStatus, location_name: "Status"))
|
681
695
|
DashboardVersion.add_member(:arn, Shapes::ShapeRef.new(shape: Arn, location_name: "Arn"))
|
682
696
|
DashboardVersion.add_member(:source_entity_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "SourceEntityArn"))
|
697
|
+
DashboardVersion.add_member(:data_set_arns, Shapes::ShapeRef.new(shape: DataSetArnsList, location_name: "DataSetArns"))
|
683
698
|
DashboardVersion.add_member(:description, Shapes::ShapeRef.new(shape: VersionDescription, location_name: "Description"))
|
684
699
|
DashboardVersion.struct_class = Types::DashboardVersion
|
685
700
|
|
@@ -707,6 +722,8 @@ module Aws::QuickSight
|
|
707
722
|
DataSet.add_member(:row_level_permission_data_set, Shapes::ShapeRef.new(shape: RowLevelPermissionDataSet, location_name: "RowLevelPermissionDataSet"))
|
708
723
|
DataSet.struct_class = Types::DataSet
|
709
724
|
|
725
|
+
DataSetArnsList.member = Shapes::ShapeRef.new(shape: Arn)
|
726
|
+
|
710
727
|
DataSetConfiguration.add_member(:placeholder, Shapes::ShapeRef.new(shape: String, location_name: "Placeholder"))
|
711
728
|
DataSetConfiguration.add_member(:data_set_schema, Shapes::ShapeRef.new(shape: DataSetSchema, location_name: "DataSetSchema"))
|
712
729
|
DataSetConfiguration.add_member(:column_group_schema_list, Shapes::ShapeRef.new(shape: ColumnGroupSchemaList, location_name: "ColumnGroupSchemaList"))
|
@@ -1472,6 +1489,18 @@ module Aws::QuickSight
|
|
1472
1489
|
S3Source.add_member(:input_columns, Shapes::ShapeRef.new(shape: InputColumnList, required: true, location_name: "InputColumns"))
|
1473
1490
|
S3Source.struct_class = Types::S3Source
|
1474
1491
|
|
1492
|
+
SearchDashboardsRequest.add_member(:aws_account_id, Shapes::ShapeRef.new(shape: AwsAccountId, required: true, location: "uri", location_name: "AwsAccountId"))
|
1493
|
+
SearchDashboardsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: DashboardSearchFilterList, required: true, location_name: "Filters"))
|
1494
|
+
SearchDashboardsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
1495
|
+
SearchDashboardsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
1496
|
+
SearchDashboardsRequest.struct_class = Types::SearchDashboardsRequest
|
1497
|
+
|
1498
|
+
SearchDashboardsResponse.add_member(:dashboard_summary_list, Shapes::ShapeRef.new(shape: DashboardSummaryList, location_name: "DashboardSummaryList"))
|
1499
|
+
SearchDashboardsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "NextToken"))
|
1500
|
+
SearchDashboardsResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusCode, location: "statusCode", location_name: "Status"))
|
1501
|
+
SearchDashboardsResponse.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
1502
|
+
SearchDashboardsResponse.struct_class = Types::SearchDashboardsResponse
|
1503
|
+
|
1475
1504
|
ServiceNowParameters.add_member(:site_base_url, Shapes::ShapeRef.new(shape: SiteBaseUrl, required: true, location_name: "SiteBaseUrl"))
|
1476
1505
|
ServiceNowParameters.struct_class = Types::ServiceNowParameters
|
1477
1506
|
|
@@ -2609,6 +2638,26 @@ module Aws::QuickSight
|
|
2609
2638
|
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
2610
2639
|
end)
|
2611
2640
|
|
2641
|
+
api.add_operation(:search_dashboards, Seahorse::Model::Operation.new.tap do |o|
|
2642
|
+
o.name = "SearchDashboards"
|
2643
|
+
o.http_method = "POST"
|
2644
|
+
o.http_request_uri = "/accounts/{AwsAccountId}/search/dashboards"
|
2645
|
+
o.input = Shapes::ShapeRef.new(shape: SearchDashboardsRequest)
|
2646
|
+
o.output = Shapes::ShapeRef.new(shape: SearchDashboardsResponse)
|
2647
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
2648
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2649
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
2650
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedUserEditionException)
|
2651
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
|
2652
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
2653
|
+
o[:pager] = Aws::Pager.new(
|
2654
|
+
limit_key: "max_results",
|
2655
|
+
tokens: {
|
2656
|
+
"next_token" => "next_token"
|
2657
|
+
}
|
2658
|
+
)
|
2659
|
+
end)
|
2660
|
+
|
2612
2661
|
api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
|
2613
2662
|
o.name = "TagResource"
|
2614
2663
|
o.http_method = "POST"
|
@@ -6,6 +6,45 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::QuickSight
|
9
|
+
|
10
|
+
# When QuickSight returns an error response, the Ruby SDK constructs and raises an error.
|
11
|
+
# These errors all extend Aws::QuickSight::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
|
+
#
|
13
|
+
# You can rescue all QuickSight errors using ServiceError:
|
14
|
+
#
|
15
|
+
# begin
|
16
|
+
# # do stuff
|
17
|
+
# rescue Aws::QuickSight::Errors::ServiceError
|
18
|
+
# # rescues all QuickSight API errors
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
#
|
22
|
+
# ## Request Context
|
23
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
24
|
+
# information about the request that generated the error.
|
25
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
26
|
+
#
|
27
|
+
# ## Error Classes
|
28
|
+
# * {AccessDeniedException}
|
29
|
+
# * {ConcurrentUpdatingException}
|
30
|
+
# * {ConflictException}
|
31
|
+
# * {DomainNotWhitelistedException}
|
32
|
+
# * {IdentityTypeNotSupportedException}
|
33
|
+
# * {InternalFailureException}
|
34
|
+
# * {InvalidNextTokenException}
|
35
|
+
# * {InvalidParameterValueException}
|
36
|
+
# * {LimitExceededException}
|
37
|
+
# * {PreconditionNotMetException}
|
38
|
+
# * {QuickSightUserNotFoundException}
|
39
|
+
# * {ResourceExistsException}
|
40
|
+
# * {ResourceNotFoundException}
|
41
|
+
# * {ResourceUnavailableException}
|
42
|
+
# * {SessionLifetimeInMinutesInvalidException}
|
43
|
+
# * {ThrottlingException}
|
44
|
+
# * {UnsupportedUserEditionException}
|
45
|
+
#
|
46
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
47
|
+
# if they are not defined above.
|
9
48
|
module Errors
|
10
49
|
|
11
50
|
extend Aws::Errors::DynamicErrors
|
@@ -28,7 +67,6 @@ module Aws::QuickSight
|
|
28
67
|
def request_id
|
29
68
|
@data[:request_id]
|
30
69
|
end
|
31
|
-
|
32
70
|
end
|
33
71
|
|
34
72
|
class ConcurrentUpdatingException < ServiceError
|
@@ -49,7 +87,6 @@ module Aws::QuickSight
|
|
49
87
|
def request_id
|
50
88
|
@data[:request_id]
|
51
89
|
end
|
52
|
-
|
53
90
|
end
|
54
91
|
|
55
92
|
class ConflictException < ServiceError
|
@@ -70,7 +107,6 @@ module Aws::QuickSight
|
|
70
107
|
def request_id
|
71
108
|
@data[:request_id]
|
72
109
|
end
|
73
|
-
|
74
110
|
end
|
75
111
|
|
76
112
|
class DomainNotWhitelistedException < ServiceError
|
@@ -91,7 +127,6 @@ module Aws::QuickSight
|
|
91
127
|
def request_id
|
92
128
|
@data[:request_id]
|
93
129
|
end
|
94
|
-
|
95
130
|
end
|
96
131
|
|
97
132
|
class IdentityTypeNotSupportedException < ServiceError
|
@@ -112,7 +147,6 @@ module Aws::QuickSight
|
|
112
147
|
def request_id
|
113
148
|
@data[:request_id]
|
114
149
|
end
|
115
|
-
|
116
150
|
end
|
117
151
|
|
118
152
|
class InternalFailureException < ServiceError
|
@@ -133,7 +167,6 @@ module Aws::QuickSight
|
|
133
167
|
def request_id
|
134
168
|
@data[:request_id]
|
135
169
|
end
|
136
|
-
|
137
170
|
end
|
138
171
|
|
139
172
|
class InvalidNextTokenException < ServiceError
|
@@ -154,7 +187,6 @@ module Aws::QuickSight
|
|
154
187
|
def request_id
|
155
188
|
@data[:request_id]
|
156
189
|
end
|
157
|
-
|
158
190
|
end
|
159
191
|
|
160
192
|
class InvalidParameterValueException < ServiceError
|
@@ -175,7 +207,6 @@ module Aws::QuickSight
|
|
175
207
|
def request_id
|
176
208
|
@data[:request_id]
|
177
209
|
end
|
178
|
-
|
179
210
|
end
|
180
211
|
|
181
212
|
class LimitExceededException < ServiceError
|
@@ -201,7 +232,6 @@ module Aws::QuickSight
|
|
201
232
|
def request_id
|
202
233
|
@data[:request_id]
|
203
234
|
end
|
204
|
-
|
205
235
|
end
|
206
236
|
|
207
237
|
class PreconditionNotMetException < ServiceError
|
@@ -222,7 +252,6 @@ module Aws::QuickSight
|
|
222
252
|
def request_id
|
223
253
|
@data[:request_id]
|
224
254
|
end
|
225
|
-
|
226
255
|
end
|
227
256
|
|
228
257
|
class QuickSightUserNotFoundException < ServiceError
|
@@ -243,7 +272,6 @@ module Aws::QuickSight
|
|
243
272
|
def request_id
|
244
273
|
@data[:request_id]
|
245
274
|
end
|
246
|
-
|
247
275
|
end
|
248
276
|
|
249
277
|
class ResourceExistsException < ServiceError
|
@@ -269,7 +297,6 @@ module Aws::QuickSight
|
|
269
297
|
def request_id
|
270
298
|
@data[:request_id]
|
271
299
|
end
|
272
|
-
|
273
300
|
end
|
274
301
|
|
275
302
|
class ResourceNotFoundException < ServiceError
|
@@ -295,7 +322,6 @@ module Aws::QuickSight
|
|
295
322
|
def request_id
|
296
323
|
@data[:request_id]
|
297
324
|
end
|
298
|
-
|
299
325
|
end
|
300
326
|
|
301
327
|
class ResourceUnavailableException < ServiceError
|
@@ -321,7 +347,6 @@ module Aws::QuickSight
|
|
321
347
|
def request_id
|
322
348
|
@data[:request_id]
|
323
349
|
end
|
324
|
-
|
325
350
|
end
|
326
351
|
|
327
352
|
class SessionLifetimeInMinutesInvalidException < ServiceError
|
@@ -342,7 +367,6 @@ module Aws::QuickSight
|
|
342
367
|
def request_id
|
343
368
|
@data[:request_id]
|
344
369
|
end
|
345
|
-
|
346
370
|
end
|
347
371
|
|
348
372
|
class ThrottlingException < ServiceError
|
@@ -363,7 +387,6 @@ module Aws::QuickSight
|
|
363
387
|
def request_id
|
364
388
|
@data[:request_id]
|
365
389
|
end
|
366
|
-
|
367
390
|
end
|
368
391
|
|
369
392
|
class UnsupportedUserEditionException < ServiceError
|
@@ -384,7 +407,6 @@ module Aws::QuickSight
|
|
384
407
|
def request_id
|
385
408
|
@data[:request_id]
|
386
409
|
end
|
387
|
-
|
388
410
|
end
|
389
411
|
|
390
412
|
end
|
@@ -1680,7 +1680,7 @@ module Aws::QuickSight
|
|
1680
1680
|
# @return [String]
|
1681
1681
|
#
|
1682
1682
|
# @!attribute [rw] name
|
1683
|
-
# A display name for the
|
1683
|
+
# A display name for the dashboard.
|
1684
1684
|
# @return [String]
|
1685
1685
|
#
|
1686
1686
|
# @!attribute [rw] version
|
@@ -1768,6 +1768,42 @@ module Aws::QuickSight
|
|
1768
1768
|
include Aws::Structure
|
1769
1769
|
end
|
1770
1770
|
|
1771
|
+
# A filter that you apply when searching for dashboards.
|
1772
|
+
#
|
1773
|
+
# @note When making an API call, you may pass DashboardSearchFilter
|
1774
|
+
# data as a hash:
|
1775
|
+
#
|
1776
|
+
# {
|
1777
|
+
# operator: "StringEquals", # required, accepts StringEquals
|
1778
|
+
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
|
1779
|
+
# value: "String",
|
1780
|
+
# }
|
1781
|
+
#
|
1782
|
+
# @!attribute [rw] operator
|
1783
|
+
# The comparison operator that you want to use as a filter. For
|
1784
|
+
# example, `"Operator": "StringEquals"`.
|
1785
|
+
# @return [String]
|
1786
|
+
#
|
1787
|
+
# @!attribute [rw] name
|
1788
|
+
# The name of the value that you want to use as a filter. For example,
|
1789
|
+
# `"Name": "QUICKSIGHT_USER"`.
|
1790
|
+
# @return [String]
|
1791
|
+
#
|
1792
|
+
# @!attribute [rw] value
|
1793
|
+
# The value of the named item, in this case `QUICKSIGHT_USER`, that
|
1794
|
+
# you want to use as a filter. For example, `"Value":
|
1795
|
+
# "arn:aws:quicksight:us-east-1:1:user/default/UserName1"`.
|
1796
|
+
# @return [String]
|
1797
|
+
#
|
1798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardSearchFilter AWS API Documentation
|
1799
|
+
#
|
1800
|
+
class DashboardSearchFilter < Struct.new(
|
1801
|
+
:operator,
|
1802
|
+
:name,
|
1803
|
+
:value)
|
1804
|
+
include Aws::Structure
|
1805
|
+
end
|
1806
|
+
|
1771
1807
|
# Dashboard source entity.
|
1772
1808
|
#
|
1773
1809
|
# @note When making an API call, you may pass DashboardSourceEntity
|
@@ -1896,6 +1932,11 @@ module Aws::QuickSight
|
|
1896
1932
|
# Source entity ARN.
|
1897
1933
|
# @return [String]
|
1898
1934
|
#
|
1935
|
+
# @!attribute [rw] data_set_arns
|
1936
|
+
# The Amazon Resource Numbers (ARNs) for the datasets that are
|
1937
|
+
# associated with a version of the dashboard.
|
1938
|
+
# @return [Array<String>]
|
1939
|
+
#
|
1899
1940
|
# @!attribute [rw] description
|
1900
1941
|
# Description.
|
1901
1942
|
# @return [String]
|
@@ -1909,6 +1950,7 @@ module Aws::QuickSight
|
|
1909
1950
|
:status,
|
1910
1951
|
:arn,
|
1911
1952
|
:source_entity_arn,
|
1953
|
+
:data_set_arns,
|
1912
1954
|
:description)
|
1913
1955
|
include Aws::Structure
|
1914
1956
|
end
|
@@ -4399,9 +4441,8 @@ module Aws::QuickSight
|
|
4399
4441
|
end
|
4400
4442
|
|
4401
4443
|
# @!attribute [rw] dashboard_summary_list
|
4402
|
-
# A structure that contains all of the dashboards
|
4403
|
-
#
|
4404
|
-
# dashboards.
|
4444
|
+
# A structure that contains all of the dashboards in your AWS account.
|
4445
|
+
# This structure provides basic information about the dashboards.
|
4405
4446
|
# @return [Array<Types::DashboardSummary>]
|
4406
4447
|
#
|
4407
4448
|
# @!attribute [rw] next_token
|
@@ -5867,7 +5908,7 @@ module Aws::QuickSight
|
|
5867
5908
|
#
|
5868
5909
|
#
|
5869
5910
|
#
|
5870
|
-
# [1]: https://
|
5911
|
+
# [1]: https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sts/assume-role.html
|
5871
5912
|
# @return [String]
|
5872
5913
|
#
|
5873
5914
|
# @!attribute [rw] aws_account_id
|
@@ -6204,6 +6245,81 @@ module Aws::QuickSight
|
|
6204
6245
|
include Aws::Structure
|
6205
6246
|
end
|
6206
6247
|
|
6248
|
+
# @note When making an API call, you may pass SearchDashboardsRequest
|
6249
|
+
# data as a hash:
|
6250
|
+
#
|
6251
|
+
# {
|
6252
|
+
# aws_account_id: "AwsAccountId", # required
|
6253
|
+
# filters: [ # required
|
6254
|
+
# {
|
6255
|
+
# operator: "StringEquals", # required, accepts StringEquals
|
6256
|
+
# name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
|
6257
|
+
# value: "String",
|
6258
|
+
# },
|
6259
|
+
# ],
|
6260
|
+
# next_token: "String",
|
6261
|
+
# max_results: 1,
|
6262
|
+
# }
|
6263
|
+
#
|
6264
|
+
# @!attribute [rw] aws_account_id
|
6265
|
+
# The ID of the AWS account that contains the user whose dashboards
|
6266
|
+
# you're searching for.
|
6267
|
+
# @return [String]
|
6268
|
+
#
|
6269
|
+
# @!attribute [rw] filters
|
6270
|
+
# The filters to apply to the search. Currently, you can search only
|
6271
|
+
# by user name. For example, `"Filters": [ \{ "Name":
|
6272
|
+
# "QUICKSIGHT_USER", "Operator": "StringEquals", "Value":
|
6273
|
+
# "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]`
|
6274
|
+
# @return [Array<Types::DashboardSearchFilter>]
|
6275
|
+
#
|
6276
|
+
# @!attribute [rw] next_token
|
6277
|
+
# The token for the next set of results, or null if there are no more
|
6278
|
+
# results.
|
6279
|
+
# @return [String]
|
6280
|
+
#
|
6281
|
+
# @!attribute [rw] max_results
|
6282
|
+
# The maximum number of results to be returned per request.
|
6283
|
+
# @return [Integer]
|
6284
|
+
#
|
6285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboardsRequest AWS API Documentation
|
6286
|
+
#
|
6287
|
+
class SearchDashboardsRequest < Struct.new(
|
6288
|
+
:aws_account_id,
|
6289
|
+
:filters,
|
6290
|
+
:next_token,
|
6291
|
+
:max_results)
|
6292
|
+
include Aws::Structure
|
6293
|
+
end
|
6294
|
+
|
6295
|
+
# @!attribute [rw] dashboard_summary_list
|
6296
|
+
# The list of dashboards owned by the user specified in `Filters` in
|
6297
|
+
# your request.
|
6298
|
+
# @return [Array<Types::DashboardSummary>]
|
6299
|
+
#
|
6300
|
+
# @!attribute [rw] next_token
|
6301
|
+
# The token for the next set of results, or null if there are no more
|
6302
|
+
# results.
|
6303
|
+
# @return [String]
|
6304
|
+
#
|
6305
|
+
# @!attribute [rw] status
|
6306
|
+
# The HTTP status of the request.
|
6307
|
+
# @return [Integer]
|
6308
|
+
#
|
6309
|
+
# @!attribute [rw] request_id
|
6310
|
+
# The AWS request ID for this operation.
|
6311
|
+
# @return [String]
|
6312
|
+
#
|
6313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchDashboardsResponse AWS API Documentation
|
6314
|
+
#
|
6315
|
+
class SearchDashboardsResponse < Struct.new(
|
6316
|
+
:dashboard_summary_list,
|
6317
|
+
:next_token,
|
6318
|
+
:status,
|
6319
|
+
:request_id)
|
6320
|
+
include Aws::Structure
|
6321
|
+
end
|
6322
|
+
|
6207
6323
|
# ServiceNow parameters.
|
6208
6324
|
#
|
6209
6325
|
# @note When making an API call, you may pass ServiceNowParameters
|
@@ -6775,7 +6891,7 @@ module Aws::QuickSight
|
|
6775
6891
|
# The template version.
|
6776
6892
|
#
|
6777
6893
|
# @!attribute [rw] arn
|
6778
|
-
# The ARN of the template version.
|
6894
|
+
# The Amazon Resource Name (ARN) of the template version.
|
6779
6895
|
# @return [String]
|
6780
6896
|
#
|
6781
6897
|
# @!attribute [rw] version_number
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-quicksight
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.21.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2020-05-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
81
81
|
version: '0'
|
82
82
|
requirements: []
|
83
83
|
rubyforge_project:
|
84
|
-
rubygems_version: 2.
|
84
|
+
rubygems_version: 2.7.6.2
|
85
85
|
signing_key:
|
86
86
|
specification_version: 4
|
87
87
|
summary: AWS SDK for Ruby - Amazon QuickSight
|