aws-sdk-quicksight 1.15.0 → 1.20.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-quicksight.rb +7 -4
- data/lib/aws-sdk-quicksight/client.rb +373 -199
- 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 +511 -357
- metadata +3 -3
@@ -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
|
@@ -8,17 +8,17 @@
|
|
8
8
|
module Aws::QuickSight
|
9
9
|
module Types
|
10
10
|
|
11
|
-
# You don't have access to this. The provided credentials
|
12
|
-
# validated. You might not be authorized to carry out the
|
13
|
-
#
|
14
|
-
# service, that your policies have the correct permissions,
|
15
|
-
# are using the correct access keys.
|
11
|
+
# You don't have access to this item. The provided credentials
|
12
|
+
# couldn't be validated. You might not be authorized to carry out the
|
13
|
+
# request. Make sure that your account is authorized to use the Amazon
|
14
|
+
# QuickSight service, that your policies have the correct permissions,
|
15
|
+
# and that you are using the correct access keys.
|
16
16
|
#
|
17
17
|
# @!attribute [rw] message
|
18
18
|
# @return [String]
|
19
19
|
#
|
20
20
|
# @!attribute [rw] request_id
|
21
|
-
# The AWS request
|
21
|
+
# The AWS request ID for this request.
|
22
22
|
# @return [String]
|
23
23
|
#
|
24
24
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccessDeniedException AWS API Documentation
|
@@ -207,10 +207,10 @@ module Aws::QuickSight
|
|
207
207
|
# @return [String]
|
208
208
|
#
|
209
209
|
# @!attribute [rw] column_id
|
210
|
-
# A unique ID to identify a calculated column. During dataset
|
211
|
-
# if the column ID of a calculated column matches that of an
|
212
|
-
# calculated column, QuickSight preserves the existing
|
213
|
-
# column.
|
210
|
+
# A unique ID to identify a calculated column. During a dataset
|
211
|
+
# update, if the column ID of a calculated column matches that of an
|
212
|
+
# existing calculated column, Amazon QuickSight preserves the existing
|
213
|
+
# calculated column.
|
214
214
|
# @return [String]
|
215
215
|
#
|
216
216
|
# @!attribute [rw] expression
|
@@ -303,7 +303,8 @@ module Aws::QuickSight
|
|
303
303
|
#
|
304
304
|
# @!attribute [rw] format
|
305
305
|
# When casting a column from string to datetime type, you can supply a
|
306
|
-
#
|
306
|
+
# string in a format supported by Amazon QuickSight to denote the
|
307
|
+
# source data format.
|
307
308
|
# @return [String]
|
308
309
|
#
|
309
310
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CastColumnTypeOperation AWS API Documentation
|
@@ -315,9 +316,9 @@ module Aws::QuickSight
|
|
315
316
|
include Aws::Structure
|
316
317
|
end
|
317
318
|
|
318
|
-
# Groupings of columns that work together in certain QuickSight
|
319
|
-
# features. This is a variant type structure.
|
320
|
-
#
|
319
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
320
|
+
# features. This is a variant type structure. For this structure to be
|
321
|
+
# valid, only one of the attributes can be non-null.
|
321
322
|
#
|
322
323
|
# @note When making an API call, you may pass ColumnGroup
|
323
324
|
# data as a hash:
|
@@ -341,7 +342,7 @@ module Aws::QuickSight
|
|
341
342
|
include Aws::Structure
|
342
343
|
end
|
343
344
|
|
344
|
-
# A structure describing the name,
|
345
|
+
# A structure describing the name, data type, and geographic role of the
|
345
346
|
# columns.
|
346
347
|
#
|
347
348
|
# @!attribute [rw] name
|
@@ -362,7 +363,7 @@ module Aws::QuickSight
|
|
362
363
|
# @return [String]
|
363
364
|
#
|
364
365
|
# @!attribute [rw] column_group_column_schema_list
|
365
|
-
# A structure containing the list of column group
|
366
|
+
# A structure containing the list of schemas for column group columns.
|
366
367
|
# @return [Array<Types::ColumnGroupColumnSchema>]
|
367
368
|
#
|
368
369
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ColumnGroupSchema AWS API Documentation
|
@@ -396,9 +397,9 @@ module Aws::QuickSight
|
|
396
397
|
include Aws::Structure
|
397
398
|
end
|
398
399
|
|
399
|
-
# A tag for a column in a TagColumnOperation. This is a
|
400
|
-
# structure.
|
401
|
-
#
|
400
|
+
# A tag for a column in a `TagColumnOperation` structure. This is a
|
401
|
+
# variant type structure. For this structure to be valid, only one of
|
402
|
+
# the attributes can be non-null.
|
402
403
|
#
|
403
404
|
# @note When making an API call, you may pass ColumnTag
|
404
405
|
# data as a hash:
|
@@ -418,8 +419,8 @@ module Aws::QuickSight
|
|
418
419
|
include Aws::Structure
|
419
420
|
end
|
420
421
|
|
421
|
-
# A resource is already in
|
422
|
-
# before a new update can be applied.
|
422
|
+
# A resource is already in a state that indicates an action is happening
|
423
|
+
# that must complete before a new update can be applied.
|
423
424
|
#
|
424
425
|
# @!attribute [rw] message
|
425
426
|
# @return [String]
|
@@ -441,7 +442,7 @@ module Aws::QuickSight
|
|
441
442
|
# @return [String]
|
442
443
|
#
|
443
444
|
# @!attribute [rw] request_id
|
444
|
-
# The AWS request
|
445
|
+
# The AWS request ID for this request.
|
445
446
|
# @return [String]
|
446
447
|
#
|
447
448
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ConflictException AWS API Documentation
|
@@ -550,11 +551,11 @@ module Aws::QuickSight
|
|
550
551
|
# }
|
551
552
|
#
|
552
553
|
# @!attribute [rw] aws_account_id
|
553
|
-
# AWS account
|
554
|
+
# The ID of the AWS account where you want to create the dashboard.
|
554
555
|
# @return [String]
|
555
556
|
#
|
556
557
|
# @!attribute [rw] dashboard_id
|
557
|
-
# The ID for the dashboard, also added to IAM policy.
|
558
|
+
# The ID for the dashboard, also added to the IAM policy.
|
558
559
|
# @return [String]
|
559
560
|
#
|
560
561
|
# @!attribute [rw] name
|
@@ -564,21 +565,21 @@ module Aws::QuickSight
|
|
564
565
|
# @!attribute [rw] parameters
|
565
566
|
# A structure that contains the parameters of the dashboard. These are
|
566
567
|
# parameter overrides for a dashboard. A dashboard can have any type
|
567
|
-
# of parameters and some parameters might accept multiple values. You
|
568
|
-
#
|
569
|
-
# that accept multiple values
|
568
|
+
# of parameters, and some parameters might accept multiple values. You
|
569
|
+
# can use the dashboard permissions structure described following to
|
570
|
+
# override two string parameters that accept multiple values.
|
570
571
|
# @return [Types::Parameters]
|
571
572
|
#
|
572
573
|
# @!attribute [rw] permissions
|
573
574
|
# A structure that contains the permissions of the dashboard. You can
|
574
|
-
# use this for granting permissions with principal and
|
575
|
-
# information.
|
575
|
+
# use this structure for granting permissions with principal and
|
576
|
+
# action information.
|
576
577
|
# @return [Array<Types::ResourcePermission>]
|
577
578
|
#
|
578
579
|
# @!attribute [rw] source_entity
|
579
|
-
#
|
580
|
-
# accepts the Amazon Resource Name (ARN) of the source template
|
581
|
-
# analysis and also references the replacement datasets for the
|
580
|
+
# The source entity from which the dashboard is created. The source
|
581
|
+
# entity accepts the Amazon Resource Name (ARN) of the source template
|
582
|
+
# or analysis and also references the replacement datasets for the
|
582
583
|
# placeholders set when creating the template. The replacement
|
583
584
|
# datasets need to follow the same schema as the datasets for which
|
584
585
|
# placeholders were created when creating the template.
|
@@ -597,21 +598,23 @@ module Aws::QuickSight
|
|
597
598
|
# @return [String]
|
598
599
|
#
|
599
600
|
# @!attribute [rw] dashboard_publish_options
|
600
|
-
#
|
601
|
+
# Options for publishing the dashboard when you create it:
|
601
602
|
#
|
602
|
-
# * AvailabilityStatus for AdHocFilteringOption - This can
|
603
|
-
# `ENABLED` or `DISABLED`. When
|
603
|
+
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
604
|
+
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
604
605
|
# QuickSight disables the left filter pane on the published
|
605
|
-
# dashboard, which can be used for
|
606
|
-
# default.
|
607
|
-
#
|
608
|
-
# * AvailabilityStatus for ExportToCSVOption - This can be
|
609
|
-
# `ENABLED` or `DISABLED`. The visual option to export data
|
610
|
-
#
|
611
|
-
#
|
612
|
-
#
|
613
|
-
#
|
614
|
-
#
|
606
|
+
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
607
|
+
# option is `ENABLED` by default.
|
608
|
+
#
|
609
|
+
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
610
|
+
# either `ENABLED` or `DISABLED`. The visual option to export data
|
611
|
+
# to .csv format isn't enabled when this is set to `DISABLED`. This
|
612
|
+
# option is `ENABLED` by default.
|
613
|
+
#
|
614
|
+
# * `VisibilityState` for `SheetControlsOption` - This visibility
|
615
|
+
# state can be either `COLLAPSED` or `EXPANDED`. The sheet controls
|
616
|
+
# pane is collapsed by default when set to true. This option is
|
617
|
+
# `COLLAPSED` by default.
|
615
618
|
# @return [Types::DashboardPublishOptions]
|
616
619
|
#
|
617
620
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateDashboardRequest AWS API Documentation
|
@@ -643,7 +646,7 @@ module Aws::QuickSight
|
|
643
646
|
# @return [String]
|
644
647
|
#
|
645
648
|
# @!attribute [rw] creation_status
|
646
|
-
# The
|
649
|
+
# The status of the dashboard creation request.
|
647
650
|
# @return [String]
|
648
651
|
#
|
649
652
|
# @!attribute [rw] status
|
@@ -794,7 +797,7 @@ module Aws::QuickSight
|
|
794
797
|
# }
|
795
798
|
#
|
796
799
|
# @!attribute [rw] aws_account_id
|
797
|
-
# The AWS
|
800
|
+
# The AWS account ID.
|
798
801
|
# @return [String]
|
799
802
|
#
|
800
803
|
# @!attribute [rw] data_set_id
|
@@ -817,7 +820,7 @@ module Aws::QuickSight
|
|
817
820
|
# @return [Hash<String,Types::LogicalTable>]
|
818
821
|
#
|
819
822
|
# @!attribute [rw] import_mode
|
820
|
-
# Indicates whether
|
823
|
+
# Indicates whether you want to import the data into SPICE.
|
821
824
|
# @return [String]
|
822
825
|
#
|
823
826
|
# @!attribute [rw] column_groups
|
@@ -830,7 +833,8 @@ module Aws::QuickSight
|
|
830
833
|
# @return [Array<Types::ResourcePermission>]
|
831
834
|
#
|
832
835
|
# @!attribute [rw] row_level_permission_data_set
|
833
|
-
#
|
836
|
+
# The row-level security configuration for the data that you want to
|
837
|
+
# create.
|
834
838
|
# @return [Types::RowLevelPermissionDataSet]
|
835
839
|
#
|
836
840
|
# @!attribute [rw] tags
|
@@ -865,12 +869,12 @@ module Aws::QuickSight
|
|
865
869
|
#
|
866
870
|
# @!attribute [rw] ingestion_arn
|
867
871
|
# The ARN for the ingestion, which is triggered as a result of dataset
|
868
|
-
# creation if the import mode is SPICE
|
872
|
+
# creation if the import mode is SPICE.
|
869
873
|
# @return [String]
|
870
874
|
#
|
871
875
|
# @!attribute [rw] ingestion_id
|
872
876
|
# The ID of the ingestion, which is triggered as a result of dataset
|
873
|
-
# creation if the import mode is SPICE
|
877
|
+
# creation if the import mode is SPICE.
|
874
878
|
# @return [String]
|
875
879
|
#
|
876
880
|
# @!attribute [rw] request_id
|
@@ -1249,8 +1253,8 @@ module Aws::QuickSight
|
|
1249
1253
|
# }
|
1250
1254
|
#
|
1251
1255
|
# @!attribute [rw] aws_account_id
|
1252
|
-
# The AWS
|
1253
|
-
#
|
1256
|
+
# The ID of the AWS account where you want to assign an IAM policy to
|
1257
|
+
# QuickSight users or groups.
|
1254
1258
|
# @return [String]
|
1255
1259
|
#
|
1256
1260
|
# @!attribute [rw] assignment_name
|
@@ -1258,26 +1262,26 @@ module Aws::QuickSight
|
|
1258
1262
|
# @return [String]
|
1259
1263
|
#
|
1260
1264
|
# @!attribute [rw] assignment_status
|
1261
|
-
# The status of
|
1265
|
+
# The status of the assignment. Possible values are as follows:
|
1262
1266
|
#
|
1263
|
-
# * ENABLED - Anything specified in this assignment is used
|
1267
|
+
# * `ENABLED` - Anything specified in this assignment is used when
|
1264
1268
|
# creating the data source.
|
1265
1269
|
#
|
1266
|
-
# * DISABLED - This assignment isn't used
|
1270
|
+
# * `DISABLED` - This assignment isn't used when creating the data
|
1267
1271
|
# source.
|
1268
1272
|
#
|
1269
|
-
# * DRAFT -
|
1270
|
-
# creating the data source.
|
1273
|
+
# * `DRAFT` - This assignment is an unfinished draft and isn't used
|
1274
|
+
# when creating the data source.
|
1271
1275
|
# @return [String]
|
1272
1276
|
#
|
1273
1277
|
# @!attribute [rw] policy_arn
|
1274
|
-
#
|
1275
|
-
#
|
1278
|
+
# The ARN for the IAM policy to apply to the QuickSight users and
|
1279
|
+
# groups specified in this assignment.
|
1276
1280
|
# @return [String]
|
1277
1281
|
#
|
1278
1282
|
# @!attribute [rw] identities
|
1279
|
-
# QuickSight users
|
1280
|
-
# to.
|
1283
|
+
# The QuickSight users, groups, or both that you want to assign the
|
1284
|
+
# policy to.
|
1281
1285
|
# @return [Hash<String,Array<String>>]
|
1282
1286
|
#
|
1283
1287
|
# @!attribute [rw] namespace
|
@@ -1297,33 +1301,35 @@ module Aws::QuickSight
|
|
1297
1301
|
end
|
1298
1302
|
|
1299
1303
|
# @!attribute [rw] assignment_name
|
1300
|
-
# The name of the assignment.
|
1304
|
+
# The name of the assignment. This name must be unique within the AWS
|
1305
|
+
# account.
|
1301
1306
|
# @return [String]
|
1302
1307
|
#
|
1303
1308
|
# @!attribute [rw] assignment_id
|
1304
|
-
#
|
1309
|
+
# The ID for the assignment.
|
1305
1310
|
# @return [String]
|
1306
1311
|
#
|
1307
1312
|
# @!attribute [rw] assignment_status
|
1308
|
-
# The status of
|
1313
|
+
# The status of the assignment. Possible values are as follows:
|
1309
1314
|
#
|
1310
|
-
# * ENABLED - Anything specified in this assignment is used
|
1315
|
+
# * `ENABLED` - Anything specified in this assignment is used when
|
1311
1316
|
# creating the data source.
|
1312
1317
|
#
|
1313
|
-
# * DISABLED - This assignment isn't used
|
1318
|
+
# * `DISABLED` - This assignment isn't used when creating the data
|
1314
1319
|
# source.
|
1315
1320
|
#
|
1316
|
-
# * DRAFT -
|
1317
|
-
# creating the data source.
|
1321
|
+
# * `DRAFT` - This assignment is an unfinished draft and isn't used
|
1322
|
+
# when creating the data source.
|
1318
1323
|
# @return [String]
|
1319
1324
|
#
|
1320
1325
|
# @!attribute [rw] policy_arn
|
1321
|
-
#
|
1322
|
-
#
|
1326
|
+
# The ARN for the IAM policy that is applied to the QuickSight users
|
1327
|
+
# and groups specified in this assignment.
|
1323
1328
|
# @return [String]
|
1324
1329
|
#
|
1325
1330
|
# @!attribute [rw] identities
|
1326
|
-
# QuickSight users
|
1331
|
+
# The QuickSight users, groups, or both that the IAM policy is
|
1332
|
+
# assigned to.
|
1327
1333
|
# @return [Hash<String,Array<String>>]
|
1328
1334
|
#
|
1329
1335
|
# @!attribute [rw] request_id
|
@@ -1419,7 +1425,8 @@ module Aws::QuickSight
|
|
1419
1425
|
# }
|
1420
1426
|
#
|
1421
1427
|
# @!attribute [rw] aws_account_id
|
1422
|
-
# AWS account
|
1428
|
+
# The ID of the AWS account that contains the template that you
|
1429
|
+
# creating an alias for.
|
1423
1430
|
# @return [String]
|
1424
1431
|
#
|
1425
1432
|
# @!attribute [rw] template_id
|
@@ -1428,7 +1435,8 @@ module Aws::QuickSight
|
|
1428
1435
|
#
|
1429
1436
|
# @!attribute [rw] alias_name
|
1430
1437
|
# The name that you want to give to the template alias that you're
|
1431
|
-
# creating.
|
1438
|
+
# creating. Don't start the alias name with the `$` character. Alias
|
1439
|
+
# names that start with `$` are reserved by QuickSight.
|
1432
1440
|
# @return [String]
|
1433
1441
|
#
|
1434
1442
|
# @!attribute [rw] template_version_number
|
@@ -1446,7 +1454,7 @@ module Aws::QuickSight
|
|
1446
1454
|
end
|
1447
1455
|
|
1448
1456
|
# @!attribute [rw] template_alias
|
1449
|
-
# Information
|
1457
|
+
# Information about the template alias.
|
1450
1458
|
# @return [Types::TemplateAlias]
|
1451
1459
|
#
|
1452
1460
|
# @!attribute [rw] status
|
@@ -1509,8 +1517,8 @@ module Aws::QuickSight
|
|
1509
1517
|
# @return [String]
|
1510
1518
|
#
|
1511
1519
|
# @!attribute [rw] template_id
|
1512
|
-
# An ID for the template you want to create. This is
|
1513
|
-
#
|
1520
|
+
# An ID for the template that you want to create. This template is
|
1521
|
+
# unique per AWS Region in each AWS account.
|
1514
1522
|
# @return [String]
|
1515
1523
|
#
|
1516
1524
|
# @!attribute [rw] name
|
@@ -1523,9 +1531,9 @@ module Aws::QuickSight
|
|
1523
1531
|
#
|
1524
1532
|
# @!attribute [rw] source_entity
|
1525
1533
|
# The Amazon Resource Name (ARN) of the source entity from which this
|
1526
|
-
# template is being created.
|
1527
|
-
# an analysis or another template. If the ARN is for an analysis,
|
1528
|
-
#
|
1534
|
+
# template is being created. Currently, you can create a template from
|
1535
|
+
# an analysis or another template. If the ARN is for an analysis,
|
1536
|
+
# include its dataset references.
|
1529
1537
|
# @return [Types::TemplateSourceEntity]
|
1530
1538
|
#
|
1531
1539
|
# @!attribute [rw] tags
|
@@ -1535,10 +1543,10 @@ module Aws::QuickSight
|
|
1535
1543
|
#
|
1536
1544
|
# @!attribute [rw] version_description
|
1537
1545
|
# A description of the current template version being created. This
|
1538
|
-
# API
|
1539
|
-
# UpdateTemplate is called a new version is created. Each version
|
1540
|
-
# the template maintains a description of the version in the
|
1541
|
-
# VersionDescription field.
|
1546
|
+
# API operation creates the first version of the template. Every time
|
1547
|
+
# `UpdateTemplate` is called, a new version is created. Each version
|
1548
|
+
# of the template maintains a description of the version in the
|
1549
|
+
# `VersionDescription` field.
|
1542
1550
|
# @return [String]
|
1543
1551
|
#
|
1544
1552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTemplateRequest AWS API Documentation
|
@@ -1555,7 +1563,7 @@ module Aws::QuickSight
|
|
1555
1563
|
end
|
1556
1564
|
|
1557
1565
|
# @!attribute [rw] arn
|
1558
|
-
# The
|
1566
|
+
# The ARN for the template.
|
1559
1567
|
# @return [String]
|
1560
1568
|
#
|
1561
1569
|
# @!attribute [rw] version_arn
|
@@ -1591,7 +1599,8 @@ module Aws::QuickSight
|
|
1591
1599
|
include Aws::Structure
|
1592
1600
|
end
|
1593
1601
|
|
1594
|
-
# The combination of
|
1602
|
+
# The combination of user name and password that are used as
|
1603
|
+
# credentials.
|
1595
1604
|
#
|
1596
1605
|
# @note When making an API call, you may pass CredentialPair
|
1597
1606
|
# data as a hash:
|
@@ -1602,7 +1611,7 @@ module Aws::QuickSight
|
|
1602
1611
|
# }
|
1603
1612
|
#
|
1604
1613
|
# @!attribute [rw] username
|
1605
|
-
#
|
1614
|
+
# User name.
|
1606
1615
|
# @return [String]
|
1607
1616
|
#
|
1608
1617
|
# @!attribute [rw] password
|
@@ -1667,11 +1676,11 @@ module Aws::QuickSight
|
|
1667
1676
|
# @return [String]
|
1668
1677
|
#
|
1669
1678
|
# @!attribute [rw] arn
|
1670
|
-
# The Amazon Resource
|
1679
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1671
1680
|
# @return [String]
|
1672
1681
|
#
|
1673
1682
|
# @!attribute [rw] name
|
1674
|
-
# A display name for the
|
1683
|
+
# A display name for the dashboard.
|
1675
1684
|
# @return [String]
|
1676
1685
|
#
|
1677
1686
|
# @!attribute [rw] version
|
@@ -1679,15 +1688,15 @@ module Aws::QuickSight
|
|
1679
1688
|
# @return [Types::DashboardVersion]
|
1680
1689
|
#
|
1681
1690
|
# @!attribute [rw] created_time
|
1682
|
-
# The time this was created.
|
1691
|
+
# The time that this dataset was created.
|
1683
1692
|
# @return [Time]
|
1684
1693
|
#
|
1685
1694
|
# @!attribute [rw] last_published_time
|
1686
|
-
# The last time this was published.
|
1695
|
+
# The last time that this dataset was published.
|
1687
1696
|
# @return [Time]
|
1688
1697
|
#
|
1689
1698
|
# @!attribute [rw] last_updated_time
|
1690
|
-
# The last time this was updated.
|
1699
|
+
# The last time that this dataset was updated.
|
1691
1700
|
# @return [Time]
|
1692
1701
|
#
|
1693
1702
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Dashboard AWS API Documentation
|
@@ -1739,11 +1748,11 @@ module Aws::QuickSight
|
|
1739
1748
|
# }
|
1740
1749
|
#
|
1741
1750
|
# @!attribute [rw] ad_hoc_filtering_option
|
1742
|
-
# Ad hoc filtering option.
|
1751
|
+
# Ad hoc (one-time) filtering option.
|
1743
1752
|
# @return [Types::AdHocFilteringOption]
|
1744
1753
|
#
|
1745
1754
|
# @!attribute [rw] export_to_csv_option
|
1746
|
-
# Export to
|
1755
|
+
# Export to .csv option.
|
1747
1756
|
# @return [Types::ExportToCSVOption]
|
1748
1757
|
#
|
1749
1758
|
# @!attribute [rw] sheet_controls_option
|
@@ -1759,6 +1768,42 @@ module Aws::QuickSight
|
|
1759
1768
|
include Aws::Structure
|
1760
1769
|
end
|
1761
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
|
+
|
1762
1807
|
# Dashboard source entity.
|
1763
1808
|
#
|
1764
1809
|
# @note When making an API call, you may pass DashboardSourceEntity
|
@@ -1807,7 +1852,7 @@ module Aws::QuickSight
|
|
1807
1852
|
# @return [Array<Types::DataSetReference>]
|
1808
1853
|
#
|
1809
1854
|
# @!attribute [rw] arn
|
1810
|
-
# The Amazon Resource
|
1855
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1811
1856
|
# @return [String]
|
1812
1857
|
#
|
1813
1858
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardSourceTemplate AWS API Documentation
|
@@ -1821,7 +1866,7 @@ module Aws::QuickSight
|
|
1821
1866
|
# Dashboard summary.
|
1822
1867
|
#
|
1823
1868
|
# @!attribute [rw] arn
|
1824
|
-
# The Amazon Resource
|
1869
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1825
1870
|
# @return [String]
|
1826
1871
|
#
|
1827
1872
|
# @!attribute [rw] dashboard_id
|
@@ -1829,15 +1874,15 @@ module Aws::QuickSight
|
|
1829
1874
|
# @return [String]
|
1830
1875
|
#
|
1831
1876
|
# @!attribute [rw] name
|
1832
|
-
# A display name for the
|
1877
|
+
# A display name for the dashboard.
|
1833
1878
|
# @return [String]
|
1834
1879
|
#
|
1835
1880
|
# @!attribute [rw] created_time
|
1836
|
-
# The time this was created.
|
1881
|
+
# The time that this dashboard was created.
|
1837
1882
|
# @return [Time]
|
1838
1883
|
#
|
1839
1884
|
# @!attribute [rw] last_updated_time
|
1840
|
-
# The last time this was updated.
|
1885
|
+
# The last time that this dashboard was updated.
|
1841
1886
|
# @return [Time]
|
1842
1887
|
#
|
1843
1888
|
# @!attribute [rw] published_version_number
|
@@ -1845,7 +1890,7 @@ module Aws::QuickSight
|
|
1845
1890
|
# @return [Integer]
|
1846
1891
|
#
|
1847
1892
|
# @!attribute [rw] last_published_time
|
1848
|
-
# The last time this was published.
|
1893
|
+
# The last time that this dashboard was published.
|
1849
1894
|
# @return [Time]
|
1850
1895
|
#
|
1851
1896
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardSummary AWS API Documentation
|
@@ -1864,7 +1909,7 @@ module Aws::QuickSight
|
|
1864
1909
|
# Dashboard version.
|
1865
1910
|
#
|
1866
1911
|
# @!attribute [rw] created_time
|
1867
|
-
# The time this was created.
|
1912
|
+
# The time that this dashboard version was created.
|
1868
1913
|
# @return [Time]
|
1869
1914
|
#
|
1870
1915
|
# @!attribute [rw] errors
|
@@ -1880,13 +1925,18 @@ module Aws::QuickSight
|
|
1880
1925
|
# @return [String]
|
1881
1926
|
#
|
1882
1927
|
# @!attribute [rw] arn
|
1883
|
-
# The Amazon Resource
|
1928
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1884
1929
|
# @return [String]
|
1885
1930
|
#
|
1886
1931
|
# @!attribute [rw] source_entity_arn
|
1887
1932
|
# Source entity ARN.
|
1888
1933
|
# @return [String]
|
1889
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
|
+
#
|
1890
1940
|
# @!attribute [rw] description
|
1891
1941
|
# Description.
|
1892
1942
|
# @return [String]
|
@@ -1900,6 +1950,7 @@ module Aws::QuickSight
|
|
1900
1950
|
:status,
|
1901
1951
|
:arn,
|
1902
1952
|
:source_entity_arn,
|
1953
|
+
:data_set_arns,
|
1903
1954
|
:description)
|
1904
1955
|
include Aws::Structure
|
1905
1956
|
end
|
@@ -1907,11 +1958,11 @@ module Aws::QuickSight
|
|
1907
1958
|
# Dashboard version summary.
|
1908
1959
|
#
|
1909
1960
|
# @!attribute [rw] arn
|
1910
|
-
# The Amazon Resource
|
1961
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1911
1962
|
# @return [String]
|
1912
1963
|
#
|
1913
1964
|
# @!attribute [rw] created_time
|
1914
|
-
# The time this was created.
|
1965
|
+
# The time that this dashboard version was created.
|
1915
1966
|
# @return [Time]
|
1916
1967
|
#
|
1917
1968
|
# @!attribute [rw] version_number
|
@@ -1945,7 +1996,7 @@ module Aws::QuickSight
|
|
1945
1996
|
# Dataset.
|
1946
1997
|
#
|
1947
1998
|
# @!attribute [rw] arn
|
1948
|
-
# The Amazon Resource
|
1999
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1949
2000
|
# @return [String]
|
1950
2001
|
#
|
1951
2002
|
# @!attribute [rw] data_set_id
|
@@ -1957,11 +2008,11 @@ module Aws::QuickSight
|
|
1957
2008
|
# @return [String]
|
1958
2009
|
#
|
1959
2010
|
# @!attribute [rw] created_time
|
1960
|
-
# The time this was created.
|
2011
|
+
# The time that this dataset was created.
|
1961
2012
|
# @return [Time]
|
1962
2013
|
#
|
1963
2014
|
# @!attribute [rw] last_updated_time
|
1964
|
-
# The last time this was updated.
|
2015
|
+
# The last time that this dataset was updated.
|
1965
2016
|
# @return [Time]
|
1966
2017
|
#
|
1967
2018
|
# @!attribute [rw] physical_table_map
|
@@ -1980,7 +2031,7 @@ module Aws::QuickSight
|
|
1980
2031
|
# @return [Array<Types::OutputColumn>]
|
1981
2032
|
#
|
1982
2033
|
# @!attribute [rw] import_mode
|
1983
|
-
# Indicates whether
|
2034
|
+
# Indicates whether you want to import the data into SPICE.
|
1984
2035
|
# @return [String]
|
1985
2036
|
#
|
1986
2037
|
# @!attribute [rw] consumed_spice_capacity_in_bytes
|
@@ -1989,12 +2040,12 @@ module Aws::QuickSight
|
|
1989
2040
|
# @return [Integer]
|
1990
2041
|
#
|
1991
2042
|
# @!attribute [rw] column_groups
|
1992
|
-
# Groupings of columns that work together in certain QuickSight
|
2043
|
+
# Groupings of columns that work together in certain Amazon QuickSight
|
1993
2044
|
# features. Currently, only geospatial hierarchy is supported.
|
1994
2045
|
# @return [Array<Types::ColumnGroup>]
|
1995
2046
|
#
|
1996
2047
|
# @!attribute [rw] row_level_permission_data_set
|
1997
|
-
#
|
2048
|
+
# The row-level security configuration for the dataset.
|
1998
2049
|
# @return [Types::RowLevelPermissionDataSet]
|
1999
2050
|
#
|
2000
2051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSet AWS API Documentation
|
@@ -2053,7 +2104,7 @@ module Aws::QuickSight
|
|
2053
2104
|
# @return [String]
|
2054
2105
|
#
|
2055
2106
|
# @!attribute [rw] data_set_arn
|
2056
|
-
# Dataset ARN.
|
2107
|
+
# Dataset Amazon Resource Name (ARN).
|
2057
2108
|
# @return [String]
|
2058
2109
|
#
|
2059
2110
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetReference AWS API Documentation
|
@@ -2080,7 +2131,7 @@ module Aws::QuickSight
|
|
2080
2131
|
# Dataset summary.
|
2081
2132
|
#
|
2082
2133
|
# @!attribute [rw] arn
|
2083
|
-
# The Amazon Resource
|
2134
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
2084
2135
|
# @return [String]
|
2085
2136
|
#
|
2086
2137
|
# @!attribute [rw] data_set_id
|
@@ -2092,19 +2143,19 @@ module Aws::QuickSight
|
|
2092
2143
|
# @return [String]
|
2093
2144
|
#
|
2094
2145
|
# @!attribute [rw] created_time
|
2095
|
-
# The time this was created.
|
2146
|
+
# The time that this dataset was created.
|
2096
2147
|
# @return [Time]
|
2097
2148
|
#
|
2098
2149
|
# @!attribute [rw] last_updated_time
|
2099
|
-
# The last time this was updated.
|
2150
|
+
# The last time that this dataset was updated.
|
2100
2151
|
# @return [Time]
|
2101
2152
|
#
|
2102
2153
|
# @!attribute [rw] import_mode
|
2103
|
-
# Indicates whether
|
2154
|
+
# Indicates whether you want to import the data into SPICE.
|
2104
2155
|
# @return [String]
|
2105
2156
|
#
|
2106
2157
|
# @!attribute [rw] row_level_permission_data_set
|
2107
|
-
#
|
2158
|
+
# The row-level security configuration for the dataset.
|
2108
2159
|
# @return [Types::RowLevelPermissionDataSet]
|
2109
2160
|
#
|
2110
2161
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSetSummary AWS API Documentation
|
@@ -2123,7 +2174,7 @@ module Aws::QuickSight
|
|
2123
2174
|
# The structure of a data source.
|
2124
2175
|
#
|
2125
2176
|
# @!attribute [rw] arn
|
2126
|
-
# The Amazon Resource
|
2177
|
+
# The Amazon Resource Name (ARN) of the data source.
|
2127
2178
|
# @return [String]
|
2128
2179
|
#
|
2129
2180
|
# @!attribute [rw] data_source_id
|
@@ -2136,8 +2187,8 @@ module Aws::QuickSight
|
|
2136
2187
|
# @return [String]
|
2137
2188
|
#
|
2138
2189
|
# @!attribute [rw] type
|
2139
|
-
# The type of the data source. This indicates which database
|
2140
|
-
# the data source connects to.
|
2190
|
+
# The type of the data source. This type indicates which database
|
2191
|
+
# engine the data source connects to.
|
2141
2192
|
# @return [String]
|
2142
2193
|
#
|
2143
2194
|
# @!attribute [rw] status
|
@@ -2145,17 +2196,17 @@ module Aws::QuickSight
|
|
2145
2196
|
# @return [String]
|
2146
2197
|
#
|
2147
2198
|
# @!attribute [rw] created_time
|
2148
|
-
# The time this was created.
|
2199
|
+
# The time that this data source was created.
|
2149
2200
|
# @return [Time]
|
2150
2201
|
#
|
2151
2202
|
# @!attribute [rw] last_updated_time
|
2152
|
-
# The last time this was updated.
|
2203
|
+
# The last time that this data source was updated.
|
2153
2204
|
# @return [Time]
|
2154
2205
|
#
|
2155
2206
|
# @!attribute [rw] data_source_parameters
|
2156
|
-
# The parameters that QuickSight uses to connect to your
|
2157
|
-
# source. This is a variant type structure.
|
2158
|
-
#
|
2207
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
2208
|
+
# underlying source. This is a variant type structure. For this
|
2209
|
+
# structure to be valid, only one of the attributes can be non-null.
|
2159
2210
|
# @return [Types::DataSourceParameters]
|
2160
2211
|
#
|
2161
2212
|
# @!attribute [rw] vpc_connection_properties
|
@@ -2214,7 +2265,7 @@ module Aws::QuickSight
|
|
2214
2265
|
include Aws::Structure
|
2215
2266
|
end
|
2216
2267
|
|
2217
|
-
# Error information
|
2268
|
+
# Error information for the data source creation or update.
|
2218
2269
|
#
|
2219
2270
|
# @!attribute [rw] type
|
2220
2271
|
# Error type.
|
@@ -2232,9 +2283,9 @@ module Aws::QuickSight
|
|
2232
2283
|
include Aws::Structure
|
2233
2284
|
end
|
2234
2285
|
|
2235
|
-
# The parameters that QuickSight uses to connect to your
|
2236
|
-
# source. This is a variant type structure.
|
2237
|
-
#
|
2286
|
+
# The parameters that Amazon QuickSight uses to connect to your
|
2287
|
+
# underlying data source. This is a variant type structure. For this
|
2288
|
+
# structure to be valid, only one of the attributes can be non-null.
|
2238
2289
|
#
|
2239
2290
|
# @note When making an API call, you may pass DataSourceParameters
|
2240
2291
|
# data as a hash:
|
@@ -2327,15 +2378,15 @@ module Aws::QuickSight
|
|
2327
2378
|
# }
|
2328
2379
|
#
|
2329
2380
|
# @!attribute [rw] amazon_elasticsearch_parameters
|
2330
|
-
# Amazon Elasticsearch parameters.
|
2381
|
+
# Amazon Elasticsearch Service parameters.
|
2331
2382
|
# @return [Types::AmazonElasticsearchParameters]
|
2332
2383
|
#
|
2333
2384
|
# @!attribute [rw] athena_parameters
|
2334
|
-
# Athena parameters.
|
2385
|
+
# Amazon Athena parameters.
|
2335
2386
|
# @return [Types::AthenaParameters]
|
2336
2387
|
#
|
2337
2388
|
# @!attribute [rw] aurora_parameters
|
2338
|
-
# Aurora MySQL parameters.
|
2389
|
+
# Amazon Aurora MySQL parameters.
|
2339
2390
|
# @return [Types::AuroraParameters]
|
2340
2391
|
#
|
2341
2392
|
# @!attribute [rw] aurora_postgre_sql_parameters
|
@@ -2367,11 +2418,11 @@ module Aws::QuickSight
|
|
2367
2418
|
# @return [Types::PrestoParameters]
|
2368
2419
|
#
|
2369
2420
|
# @!attribute [rw] rds_parameters
|
2370
|
-
# RDS parameters.
|
2421
|
+
# Amazon RDS parameters.
|
2371
2422
|
# @return [Types::RdsParameters]
|
2372
2423
|
#
|
2373
2424
|
# @!attribute [rw] redshift_parameters
|
2374
|
-
# Redshift parameters.
|
2425
|
+
# Amazon Redshift parameters.
|
2375
2426
|
# @return [Types::RedshiftParameters]
|
2376
2427
|
#
|
2377
2428
|
# @!attribute [rw] s3_parameters
|
@@ -2489,7 +2540,8 @@ module Aws::QuickSight
|
|
2489
2540
|
# }
|
2490
2541
|
#
|
2491
2542
|
# @!attribute [rw] aws_account_id
|
2492
|
-
# AWS account
|
2543
|
+
# The ID of the AWS account that contains the dashboard that you're
|
2544
|
+
# deleting.
|
2493
2545
|
# @return [String]
|
2494
2546
|
#
|
2495
2547
|
# @!attribute [rw] dashboard_id
|
@@ -2497,8 +2549,8 @@ module Aws::QuickSight
|
|
2497
2549
|
# @return [String]
|
2498
2550
|
#
|
2499
2551
|
# @!attribute [rw] version_number
|
2500
|
-
# The version number of the dashboard. If version number property
|
2501
|
-
# provided, only the specified version of the dashboard is deleted.
|
2552
|
+
# The version number of the dashboard. If the version number property
|
2553
|
+
# is provided, only the specified version of the dashboard is deleted.
|
2502
2554
|
# @return [Integer]
|
2503
2555
|
#
|
2504
2556
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDashboardRequest AWS API Documentation
|
@@ -2515,7 +2567,7 @@ module Aws::QuickSight
|
|
2515
2567
|
# @return [Integer]
|
2516
2568
|
#
|
2517
2569
|
# @!attribute [rw] arn
|
2518
|
-
# The Secure Socket Layer (SSL) properties that apply
|
2570
|
+
# The Secure Socket Layer (SSL) properties that apply for the
|
2519
2571
|
# resource.
|
2520
2572
|
# @return [String]
|
2521
2573
|
#
|
@@ -2754,7 +2806,7 @@ module Aws::QuickSight
|
|
2754
2806
|
# }
|
2755
2807
|
#
|
2756
2808
|
# @!attribute [rw] aws_account_id
|
2757
|
-
# The AWS account ID where you want to delete
|
2809
|
+
# The AWS account ID where you want to delete the IAM policy
|
2758
2810
|
# assignment.
|
2759
2811
|
# @return [String]
|
2760
2812
|
#
|
@@ -2806,18 +2858,18 @@ module Aws::QuickSight
|
|
2806
2858
|
# }
|
2807
2859
|
#
|
2808
2860
|
# @!attribute [rw] aws_account_id
|
2809
|
-
# AWS account
|
2861
|
+
# The ID of the AWS account that contains the item to delete.
|
2810
2862
|
# @return [String]
|
2811
2863
|
#
|
2812
2864
|
# @!attribute [rw] template_id
|
2813
|
-
#
|
2865
|
+
# The ID for the template that the specified alias is for.
|
2814
2866
|
# @return [String]
|
2815
2867
|
#
|
2816
2868
|
# @!attribute [rw] alias_name
|
2817
|
-
# The
|
2818
|
-
#
|
2819
|
-
#
|
2820
|
-
#
|
2869
|
+
# The name for the template alias. If you name a specific alias, you
|
2870
|
+
# delete the version that the alias points to. You can specify the
|
2871
|
+
# latest version of the template by providing the keyword `$LATEST` in
|
2872
|
+
# the `AliasName` parameter.
|
2821
2873
|
# @return [String]
|
2822
2874
|
#
|
2823
2875
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTemplateAliasRequest AWS API Documentation
|
@@ -2834,11 +2886,11 @@ module Aws::QuickSight
|
|
2834
2886
|
# @return [Integer]
|
2835
2887
|
#
|
2836
2888
|
# @!attribute [rw] template_id
|
2837
|
-
# An ID for the template.
|
2889
|
+
# An ID for the template associated with the deletion.
|
2838
2890
|
# @return [String]
|
2839
2891
|
#
|
2840
2892
|
# @!attribute [rw] alias_name
|
2841
|
-
# The name
|
2893
|
+
# The name for the template alias.
|
2842
2894
|
# @return [String]
|
2843
2895
|
#
|
2844
2896
|
# @!attribute [rw] arn
|
@@ -2870,7 +2922,8 @@ module Aws::QuickSight
|
|
2870
2922
|
# }
|
2871
2923
|
#
|
2872
2924
|
# @!attribute [rw] aws_account_id
|
2873
|
-
# AWS account
|
2925
|
+
# The ID of the AWS account that contains the template that you're
|
2926
|
+
# deleting.
|
2874
2927
|
# @return [String]
|
2875
2928
|
#
|
2876
2929
|
# @!attribute [rw] template_id
|
@@ -3023,12 +3076,12 @@ module Aws::QuickSight
|
|
3023
3076
|
# }
|
3024
3077
|
#
|
3025
3078
|
# @!attribute [rw] aws_account_id
|
3026
|
-
# AWS account
|
3027
|
-
# permissions
|
3079
|
+
# The ID of the AWS account that contains the dashboard that you're
|
3080
|
+
# describing permissions for.
|
3028
3081
|
# @return [String]
|
3029
3082
|
#
|
3030
3083
|
# @!attribute [rw] dashboard_id
|
3031
|
-
# The ID for the dashboard, also added to IAM policy.
|
3084
|
+
# The ID for the dashboard, also added to the IAM policy.
|
3032
3085
|
# @return [String]
|
3033
3086
|
#
|
3034
3087
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardPermissionsRequest AWS API Documentation
|
@@ -3048,7 +3101,7 @@ module Aws::QuickSight
|
|
3048
3101
|
# @return [String]
|
3049
3102
|
#
|
3050
3103
|
# @!attribute [rw] permissions
|
3051
|
-
# A structure that contains the permissions
|
3104
|
+
# A structure that contains the permissions for the dashboard.
|
3052
3105
|
# @return [Array<Types::ResourcePermission>]
|
3053
3106
|
#
|
3054
3107
|
# @!attribute [rw] status
|
@@ -3081,7 +3134,8 @@ module Aws::QuickSight
|
|
3081
3134
|
# }
|
3082
3135
|
#
|
3083
3136
|
# @!attribute [rw] aws_account_id
|
3084
|
-
# AWS account
|
3137
|
+
# The ID of the AWS account that contains the dashboard that you're
|
3138
|
+
# describing.
|
3085
3139
|
# @return [String]
|
3086
3140
|
#
|
3087
3141
|
# @!attribute [rw] dashboard_id
|
@@ -3089,8 +3143,8 @@ module Aws::QuickSight
|
|
3089
3143
|
# @return [String]
|
3090
3144
|
#
|
3091
3145
|
# @!attribute [rw] version_number
|
3092
|
-
# The version number for the dashboard. If version number isn
|
3093
|
-
# the latest published dashboard version is described.
|
3146
|
+
# The version number for the dashboard. If a version number isn't
|
3147
|
+
# passed, the latest published dashboard version is described.
|
3094
3148
|
# @return [Integer]
|
3095
3149
|
#
|
3096
3150
|
# @!attribute [rw] alias_name
|
@@ -3112,7 +3166,7 @@ module Aws::QuickSight
|
|
3112
3166
|
# @return [Types::Dashboard]
|
3113
3167
|
#
|
3114
3168
|
# @!attribute [rw] status
|
3115
|
-
# The
|
3169
|
+
# The HTTP status of this request.
|
3116
3170
|
# @return [Integer]
|
3117
3171
|
#
|
3118
3172
|
# @!attribute [rw] request_id
|
@@ -3137,7 +3191,7 @@ module Aws::QuickSight
|
|
3137
3191
|
# }
|
3138
3192
|
#
|
3139
3193
|
# @!attribute [rw] aws_account_id
|
3140
|
-
# The AWS
|
3194
|
+
# The AWS account ID.
|
3141
3195
|
# @return [String]
|
3142
3196
|
#
|
3143
3197
|
# @!attribute [rw] data_set_id
|
@@ -3194,7 +3248,7 @@ module Aws::QuickSight
|
|
3194
3248
|
# }
|
3195
3249
|
#
|
3196
3250
|
# @!attribute [rw] aws_account_id
|
3197
|
-
# The AWS
|
3251
|
+
# The AWS account ID.
|
3198
3252
|
# @return [String]
|
3199
3253
|
#
|
3200
3254
|
# @!attribute [rw] data_set_id
|
@@ -3397,8 +3451,8 @@ module Aws::QuickSight
|
|
3397
3451
|
# }
|
3398
3452
|
#
|
3399
3453
|
# @!attribute [rw] aws_account_id
|
3400
|
-
# The AWS account
|
3401
|
-
# describe.
|
3454
|
+
# The ID of the AWS account that contains the assignment that you want
|
3455
|
+
# to describe.
|
3402
3456
|
# @return [String]
|
3403
3457
|
#
|
3404
3458
|
# @!attribute [rw] assignment_name
|
@@ -3500,19 +3554,20 @@ module Aws::QuickSight
|
|
3500
3554
|
# }
|
3501
3555
|
#
|
3502
3556
|
# @!attribute [rw] aws_account_id
|
3503
|
-
# AWS account
|
3557
|
+
# The ID of the AWS account that contains the template alias that
|
3558
|
+
# you're describing.
|
3504
3559
|
# @return [String]
|
3505
3560
|
#
|
3506
3561
|
# @!attribute [rw] template_id
|
3507
|
-
#
|
3562
|
+
# The ID for the template.
|
3508
3563
|
# @return [String]
|
3509
3564
|
#
|
3510
3565
|
# @!attribute [rw] alias_name
|
3511
|
-
# The
|
3512
|
-
# a specific alias, you describe the version that the alias
|
3513
|
-
# You can specify the latest version of the template by
|
3514
|
-
# keyword `$LATEST` in the `AliasName` parameter. The
|
3515
|
-
# `$PUBLISHED` doesn't apply to templates.
|
3566
|
+
# The name of the template alias that you want to describe. If you
|
3567
|
+
# name a specific alias, you describe the version that the alias
|
3568
|
+
# points to. You can specify the latest version of the template by
|
3569
|
+
# providing the keyword `$LATEST` in the `AliasName` parameter. The
|
3570
|
+
# keyword `$PUBLISHED` doesn't apply to templates.
|
3516
3571
|
# @return [String]
|
3517
3572
|
#
|
3518
3573
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateAliasRequest AWS API Documentation
|
@@ -3554,7 +3609,8 @@ module Aws::QuickSight
|
|
3554
3609
|
# }
|
3555
3610
|
#
|
3556
3611
|
# @!attribute [rw] aws_account_id
|
3557
|
-
# AWS account
|
3612
|
+
# The ID of the AWS account that contains the template that you're
|
3613
|
+
# describing.
|
3558
3614
|
# @return [String]
|
3559
3615
|
#
|
3560
3616
|
# @!attribute [rw] template_id
|
@@ -3611,22 +3667,23 @@ module Aws::QuickSight
|
|
3611
3667
|
# }
|
3612
3668
|
#
|
3613
3669
|
# @!attribute [rw] aws_account_id
|
3614
|
-
# AWS account
|
3670
|
+
# The ID of the AWS account that contains the template that you're
|
3671
|
+
# describing.
|
3615
3672
|
# @return [String]
|
3616
3673
|
#
|
3617
3674
|
# @!attribute [rw] template_id
|
3618
|
-
#
|
3675
|
+
# The ID for the template.
|
3619
3676
|
# @return [String]
|
3620
3677
|
#
|
3621
3678
|
# @!attribute [rw] version_number
|
3622
|
-
#
|
3623
|
-
#
|
3624
|
-
#
|
3679
|
+
# (Optional) The number for the version to describe. If a
|
3680
|
+
# `VersionNumber` parameter value isn't provided, the latest version
|
3681
|
+
# of the template is described.
|
3625
3682
|
# @return [Integer]
|
3626
3683
|
#
|
3627
3684
|
# @!attribute [rw] alias_name
|
3628
|
-
# The alias of the template that you want to describe. If you
|
3629
|
-
#
|
3685
|
+
# The alias of the template that you want to describe. If you name a
|
3686
|
+
# specific alias, you describe the version that the alias points to.
|
3630
3687
|
# You can specify the latest version of the template by providing the
|
3631
3688
|
# keyword `$LATEST` in the `AliasName` parameter. The keyword
|
3632
3689
|
# `$PUBLISHED` doesn't apply to templates.
|
@@ -3643,7 +3700,7 @@ module Aws::QuickSight
|
|
3643
3700
|
end
|
3644
3701
|
|
3645
3702
|
# @!attribute [rw] template
|
3646
|
-
# The template structure
|
3703
|
+
# The template structure for the object you want to describe.
|
3647
3704
|
# @return [Types::Template]
|
3648
3705
|
#
|
3649
3706
|
# @!attribute [rw] status
|
@@ -3711,9 +3768,9 @@ module Aws::QuickSight
|
|
3711
3768
|
include Aws::Structure
|
3712
3769
|
end
|
3713
3770
|
|
3714
|
-
# The domain specified
|
3715
|
-
# dashboards must be added to the approved list by an Amazon
|
3716
|
-
# admin.
|
3771
|
+
# The domain specified isn't on the allow list. All domains for
|
3772
|
+
# embedded dashboards must be added to the approved list by an Amazon
|
3773
|
+
# QuickSight admin.
|
3717
3774
|
#
|
3718
3775
|
# @!attribute [rw] message
|
3719
3776
|
# @return [String]
|
@@ -3730,14 +3787,14 @@ module Aws::QuickSight
|
|
3730
3787
|
include Aws::Structure
|
3731
3788
|
end
|
3732
3789
|
|
3733
|
-
# Error information
|
3790
|
+
# Error information for the SPICE ingestion of a dataset.
|
3734
3791
|
#
|
3735
3792
|
# @!attribute [rw] type
|
3736
3793
|
# Error type.
|
3737
3794
|
# @return [String]
|
3738
3795
|
#
|
3739
3796
|
# @!attribute [rw] message
|
3740
|
-
# Error
|
3797
|
+
# Error message.
|
3741
3798
|
# @return [String]
|
3742
3799
|
#
|
3743
3800
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ErrorInfo AWS API Documentation
|
@@ -3748,7 +3805,7 @@ module Aws::QuickSight
|
|
3748
3805
|
include Aws::Structure
|
3749
3806
|
end
|
3750
3807
|
|
3751
|
-
# Export to
|
3808
|
+
# Export to .csv option.
|
3752
3809
|
#
|
3753
3810
|
# @note When making an API call, you may pass ExportToCSVOption
|
3754
3811
|
# data as a hash:
|
@@ -3768,7 +3825,7 @@ module Aws::QuickSight
|
|
3768
3825
|
include Aws::Structure
|
3769
3826
|
end
|
3770
3827
|
|
3771
|
-
# A transform operation that filters rows based on
|
3828
|
+
# A transform operation that filters rows based on a condition.
|
3772
3829
|
#
|
3773
3830
|
# @note When making an API call, you may pass FilterOperation
|
3774
3831
|
# data as a hash:
|
@@ -3778,8 +3835,8 @@ module Aws::QuickSight
|
|
3778
3835
|
# }
|
3779
3836
|
#
|
3780
3837
|
# @!attribute [rw] condition_expression
|
3781
|
-
# An expression that must evaluate to a
|
3782
|
-
# the expression
|
3838
|
+
# An expression that must evaluate to a Boolean value. Rows for which
|
3839
|
+
# the expression evaluates to true are kept in the dataset.
|
3783
3840
|
# @return [String]
|
3784
3841
|
#
|
3785
3842
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FilterOperation AWS API Documentation
|
@@ -3835,30 +3892,31 @@ module Aws::QuickSight
|
|
3835
3892
|
# }
|
3836
3893
|
#
|
3837
3894
|
# @!attribute [rw] aws_account_id
|
3838
|
-
# AWS account
|
3895
|
+
# The ID for the AWS account that contains the dashboard that you're
|
3896
|
+
# embedding.
|
3839
3897
|
# @return [String]
|
3840
3898
|
#
|
3841
3899
|
# @!attribute [rw] dashboard_id
|
3842
|
-
# The ID for the dashboard, also added to IAM policy
|
3900
|
+
# The ID for the dashboard, also added to the IAM policy.
|
3843
3901
|
# @return [String]
|
3844
3902
|
#
|
3845
3903
|
# @!attribute [rw] identity_type
|
3846
|
-
# The authentication method the user uses to sign in.
|
3904
|
+
# The authentication method that the user uses to sign in.
|
3847
3905
|
# @return [String]
|
3848
3906
|
#
|
3849
3907
|
# @!attribute [rw] session_lifetime_in_minutes
|
3850
3908
|
# How many minutes the session is valid. The session lifetime must be
|
3851
|
-
#
|
3909
|
+
# 15-600 minutes.
|
3852
3910
|
# @return [Integer]
|
3853
3911
|
#
|
3854
3912
|
# @!attribute [rw] undo_redo_disabled
|
3855
|
-
# Remove the undo/redo button on embedded dashboard. The default
|
3856
|
-
# FALSE, which enables the undo/redo button.
|
3913
|
+
# Remove the undo/redo button on the embedded dashboard. The default
|
3914
|
+
# is FALSE, which enables the undo/redo button.
|
3857
3915
|
# @return [Boolean]
|
3858
3916
|
#
|
3859
3917
|
# @!attribute [rw] reset_disabled
|
3860
|
-
# Remove the reset button on embedded dashboard. The default is
|
3861
|
-
# which
|
3918
|
+
# Remove the reset button on the embedded dashboard. The default is
|
3919
|
+
# FALSE, which enables the reset button.
|
3862
3920
|
# @return [Boolean]
|
3863
3921
|
#
|
3864
3922
|
# @!attribute [rw] user_arn
|
@@ -3869,11 +3927,11 @@ module Aws::QuickSight
|
|
3869
3927
|
#
|
3870
3928
|
# * Active Directory (AD) users or group members
|
3871
3929
|
#
|
3872
|
-
# * Invited
|
3930
|
+
# * Invited nonfederated users
|
3873
3931
|
#
|
3874
3932
|
# * IAM users and IAM role-based sessions authenticated through
|
3875
3933
|
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
3876
|
-
#
|
3934
|
+
# federation.
|
3877
3935
|
# @return [String]
|
3878
3936
|
#
|
3879
3937
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
|
@@ -3890,10 +3948,10 @@ module Aws::QuickSight
|
|
3890
3948
|
end
|
3891
3949
|
|
3892
3950
|
# @!attribute [rw] embed_url
|
3893
|
-
# URL that you can put into your server-side webpage to embed your
|
3951
|
+
# An URL that you can put into your server-side webpage to embed your
|
3894
3952
|
# dashboard. This URL is valid for 5 minutes, and the resulting
|
3895
3953
|
# session is valid for 10 hours. The API provides the URL with an
|
3896
|
-
#
|
3954
|
+
# `auth_code` value that enables a single sign-on session.
|
3897
3955
|
# @return [String]
|
3898
3956
|
#
|
3899
3957
|
# @!attribute [rw] status
|
@@ -3919,7 +3977,7 @@ module Aws::QuickSight
|
|
3919
3977
|
# QuickSight groups.
|
3920
3978
|
#
|
3921
3979
|
# @!attribute [rw] arn
|
3922
|
-
# The Amazon Resource
|
3980
|
+
# The Amazon Resource Name (ARN) for the group.
|
3923
3981
|
# @return [String]
|
3924
3982
|
#
|
3925
3983
|
# @!attribute [rw] group_name
|
@@ -3948,7 +4006,7 @@ module Aws::QuickSight
|
|
3948
4006
|
# be users. Groups can't be members of another group. .
|
3949
4007
|
#
|
3950
4008
|
# @!attribute [rw] arn
|
3951
|
-
# The Amazon Resource
|
4009
|
+
# The Amazon Resource Name (ARN) for the group member (user).
|
3952
4010
|
# @return [String]
|
3953
4011
|
#
|
3954
4012
|
# @!attribute [rw] member_name
|
@@ -3963,10 +4021,10 @@ module Aws::QuickSight
|
|
3963
4021
|
include Aws::Structure
|
3964
4022
|
end
|
3965
4023
|
|
3966
|
-
# IAM policy assignment.
|
4024
|
+
# An IAM policy assignment.
|
3967
4025
|
#
|
3968
4026
|
# @!attribute [rw] aws_account_id
|
3969
|
-
# AWS account ID.
|
4027
|
+
# The AWS account ID.
|
3970
4028
|
# @return [String]
|
3971
4029
|
#
|
3972
4030
|
# @!attribute [rw] assignment_id
|
@@ -3978,7 +4036,7 @@ module Aws::QuickSight
|
|
3978
4036
|
# @return [String]
|
3979
4037
|
#
|
3980
4038
|
# @!attribute [rw] policy_arn
|
3981
|
-
#
|
4039
|
+
# The Amazon Resource Name (ARN) for the IAM policy.
|
3982
4040
|
# @return [String]
|
3983
4041
|
#
|
3984
4042
|
# @!attribute [rw] identities
|
@@ -4001,7 +4059,7 @@ module Aws::QuickSight
|
|
4001
4059
|
include Aws::Structure
|
4002
4060
|
end
|
4003
4061
|
|
4004
|
-
# IAM policy assignment
|
4062
|
+
# IAM policy assignment summary.
|
4005
4063
|
#
|
4006
4064
|
# @!attribute [rw] assignment_name
|
4007
4065
|
# Assignment name.
|
@@ -4019,8 +4077,8 @@ module Aws::QuickSight
|
|
4019
4077
|
include Aws::Structure
|
4020
4078
|
end
|
4021
4079
|
|
4022
|
-
# The identity type specified
|
4023
|
-
# include IAM and QUICKSIGHT
|
4080
|
+
# The identity type specified isn't supported. Supported identity types
|
4081
|
+
# include `IAM` and `QUICKSIGHT`.
|
4024
4082
|
#
|
4025
4083
|
# @!attribute [rw] message
|
4026
4084
|
# @return [String]
|
@@ -4037,10 +4095,10 @@ module Aws::QuickSight
|
|
4037
4095
|
include Aws::Structure
|
4038
4096
|
end
|
4039
4097
|
|
4040
|
-
# Information
|
4098
|
+
# Information about the SPICE ingestion for a dataset.
|
4041
4099
|
#
|
4042
4100
|
# @!attribute [rw] arn
|
4043
|
-
# The Amazon Resource
|
4101
|
+
# The Amazon Resource Name (ARN) of the resource.
|
4044
4102
|
# @return [String]
|
4045
4103
|
#
|
4046
4104
|
# @!attribute [rw] ingestion_id
|
@@ -4056,23 +4114,23 @@ module Aws::QuickSight
|
|
4056
4114
|
# @return [Types::ErrorInfo]
|
4057
4115
|
#
|
4058
4116
|
# @!attribute [rw] row_info
|
4059
|
-
# Information
|
4117
|
+
# Information about rows for a data set SPICE ingestion.
|
4060
4118
|
# @return [Types::RowInfo]
|
4061
4119
|
#
|
4062
4120
|
# @!attribute [rw] queue_info
|
4063
|
-
# Information
|
4121
|
+
# Information about a queued dataset SPICE ingestion.
|
4064
4122
|
# @return [Types::QueueInfo]
|
4065
4123
|
#
|
4066
4124
|
# @!attribute [rw] created_time
|
4067
|
-
# The time this ingestion started.
|
4125
|
+
# The time that this ingestion started.
|
4068
4126
|
# @return [Time]
|
4069
4127
|
#
|
4070
4128
|
# @!attribute [rw] ingestion_time_in_seconds
|
4071
|
-
# The time this ingestion took, measured in seconds.
|
4129
|
+
# The time that this ingestion took, measured in seconds.
|
4072
4130
|
# @return [Integer]
|
4073
4131
|
#
|
4074
4132
|
# @!attribute [rw] ingestion_size_in_bytes
|
4075
|
-
#
|
4133
|
+
# The size of the data ingested, in bytes.
|
4076
4134
|
# @return [Integer]
|
4077
4135
|
#
|
4078
4136
|
# @!attribute [rw] request_source
|
@@ -4100,7 +4158,7 @@ module Aws::QuickSight
|
|
4100
4158
|
include Aws::Structure
|
4101
4159
|
end
|
4102
4160
|
|
4103
|
-
# Metadata
|
4161
|
+
# Metadata for a column that is used as the input of a transform
|
4104
4162
|
# operation.
|
4105
4163
|
#
|
4106
4164
|
# @note When making an API call, you may pass InputColumn
|
@@ -4187,7 +4245,7 @@ module Aws::QuickSight
|
|
4187
4245
|
include Aws::Structure
|
4188
4246
|
end
|
4189
4247
|
|
4190
|
-
# One or more parameters
|
4248
|
+
# One or more parameters has a value that isn't valid.
|
4191
4249
|
#
|
4192
4250
|
# @!attribute [rw] message
|
4193
4251
|
# @return [String]
|
@@ -4295,7 +4353,8 @@ module Aws::QuickSight
|
|
4295
4353
|
# }
|
4296
4354
|
#
|
4297
4355
|
# @!attribute [rw] aws_account_id
|
4298
|
-
# AWS account
|
4356
|
+
# The ID of the AWS account that contains the dashboard that you're
|
4357
|
+
# listing versions for.
|
4299
4358
|
# @return [String]
|
4300
4359
|
#
|
4301
4360
|
# @!attribute [rw] dashboard_id
|
@@ -4359,7 +4418,8 @@ module Aws::QuickSight
|
|
4359
4418
|
# }
|
4360
4419
|
#
|
4361
4420
|
# @!attribute [rw] aws_account_id
|
4362
|
-
# AWS account
|
4421
|
+
# The ID of the AWS account that contains the dashboards that you're
|
4422
|
+
# listing.
|
4363
4423
|
# @return [String]
|
4364
4424
|
#
|
4365
4425
|
# @!attribute [rw] next_token
|
@@ -4381,8 +4441,8 @@ module Aws::QuickSight
|
|
4381
4441
|
end
|
4382
4442
|
|
4383
4443
|
# @!attribute [rw] dashboard_summary_list
|
4384
|
-
# A structure that contains all of the dashboards
|
4385
|
-
#
|
4444
|
+
# A structure that contains all of the dashboards in your AWS account.
|
4445
|
+
# This structure provides basic information about the dashboards.
|
4386
4446
|
# @return [Array<Types::DashboardSummary>]
|
4387
4447
|
#
|
4388
4448
|
# @!attribute [rw] next_token
|
@@ -4418,7 +4478,7 @@ module Aws::QuickSight
|
|
4418
4478
|
# }
|
4419
4479
|
#
|
4420
4480
|
# @!attribute [rw] aws_account_id
|
4421
|
-
# The AWS
|
4481
|
+
# The AWS account ID.
|
4422
4482
|
# @return [String]
|
4423
4483
|
#
|
4424
4484
|
# @!attribute [rw] next_token
|
@@ -4670,7 +4730,7 @@ module Aws::QuickSight
|
|
4670
4730
|
# }
|
4671
4731
|
#
|
4672
4732
|
# @!attribute [rw] aws_account_id
|
4673
|
-
# The AWS account
|
4733
|
+
# The ID of the AWS account that contains the assignments.
|
4674
4734
|
# @return [String]
|
4675
4735
|
#
|
4676
4736
|
# @!attribute [rw] user_name
|
@@ -4702,7 +4762,7 @@ module Aws::QuickSight
|
|
4702
4762
|
end
|
4703
4763
|
|
4704
4764
|
# @!attribute [rw] active_assignments
|
4705
|
-
#
|
4765
|
+
# The active assignments for this user.
|
4706
4766
|
# @return [Array<Types::ActiveIAMPolicyAssignment>]
|
4707
4767
|
#
|
4708
4768
|
# @!attribute [rw] request_id
|
@@ -4740,15 +4800,16 @@ module Aws::QuickSight
|
|
4740
4800
|
# }
|
4741
4801
|
#
|
4742
4802
|
# @!attribute [rw] aws_account_id
|
4743
|
-
# The AWS account
|
4803
|
+
# The ID of the AWS account that contains these IAM policy
|
4804
|
+
# assignments.
|
4744
4805
|
# @return [String]
|
4745
4806
|
#
|
4746
4807
|
# @!attribute [rw] assignment_status
|
4747
|
-
# The status of the
|
4808
|
+
# The status of the assignments.
|
4748
4809
|
# @return [String]
|
4749
4810
|
#
|
4750
4811
|
# @!attribute [rw] namespace
|
4751
|
-
# The namespace for
|
4812
|
+
# The namespace for the assignments.
|
4752
4813
|
# @return [String]
|
4753
4814
|
#
|
4754
4815
|
# @!attribute [rw] next_token
|
@@ -4914,7 +4975,8 @@ module Aws::QuickSight
|
|
4914
4975
|
# }
|
4915
4976
|
#
|
4916
4977
|
# @!attribute [rw] aws_account_id
|
4917
|
-
# AWS account
|
4978
|
+
# The ID of the AWS account that contains the template aliases that
|
4979
|
+
# you're listing.
|
4918
4980
|
# @return [String]
|
4919
4981
|
#
|
4920
4982
|
# @!attribute [rw] template_id
|
@@ -4978,7 +5040,8 @@ module Aws::QuickSight
|
|
4978
5040
|
# }
|
4979
5041
|
#
|
4980
5042
|
# @!attribute [rw] aws_account_id
|
4981
|
-
# AWS account
|
5043
|
+
# The ID of the AWS account that contains the templates that you're
|
5044
|
+
# listing.
|
4982
5045
|
# @return [String]
|
4983
5046
|
#
|
4984
5047
|
# @!attribute [rw] template_id
|
@@ -5042,7 +5105,8 @@ module Aws::QuickSight
|
|
5042
5105
|
# }
|
5043
5106
|
#
|
5044
5107
|
# @!attribute [rw] aws_account_id
|
5045
|
-
# AWS account
|
5108
|
+
# The ID of the AWS account that contains the templates that you're
|
5109
|
+
# listing.
|
5046
5110
|
# @return [String]
|
5047
5111
|
#
|
5048
5112
|
# @!attribute [rw] next_token
|
@@ -5107,7 +5171,7 @@ module Aws::QuickSight
|
|
5107
5171
|
# @return [String]
|
5108
5172
|
#
|
5109
5173
|
# @!attribute [rw] aws_account_id
|
5110
|
-
# The AWS
|
5174
|
+
# The AWS account ID that the user is in. Currently, you use the ID
|
5111
5175
|
# for the AWS account that contains your Amazon QuickSight account.
|
5112
5176
|
# @return [String]
|
5113
5177
|
#
|
@@ -5224,10 +5288,11 @@ module Aws::QuickSight
|
|
5224
5288
|
include Aws::Structure
|
5225
5289
|
end
|
5226
5290
|
|
5227
|
-
# A unit that joins and data transformations
|
5228
|
-
# has a source, which can be either a
|
5229
|
-
#
|
5230
|
-
#
|
5291
|
+
# A *logical table* is a unit that joins and that data transformations
|
5292
|
+
# operate on. A logical table has a source, which can be either a
|
5293
|
+
# physical table or result of a join. When a logical table points to a
|
5294
|
+
# physical table, the logical table acts as a mutable copy of that
|
5295
|
+
# physical table through transform operations.
|
5231
5296
|
#
|
5232
5297
|
# @note When making an API call, you may pass LogicalTable
|
5233
5298
|
# data as a hash:
|
@@ -5302,9 +5367,9 @@ module Aws::QuickSight
|
|
5302
5367
|
include Aws::Structure
|
5303
5368
|
end
|
5304
5369
|
|
5305
|
-
# Information
|
5306
|
-
# structure.
|
5307
|
-
#
|
5370
|
+
# Information about the source of a logical table. This is a variant
|
5371
|
+
# type structure. For this structure to be valid, only one of the
|
5372
|
+
# attributes can be non-null.
|
5308
5373
|
#
|
5309
5374
|
# @note When making an API call, you may pass LogicalTableSource
|
5310
5375
|
# data as a hash:
|
@@ -5501,10 +5566,10 @@ module Aws::QuickSight
|
|
5501
5566
|
include Aws::Structure
|
5502
5567
|
end
|
5503
5568
|
|
5504
|
-
# A view of a data source
|
5505
|
-
# in the underlying source. This is a variant type structure.
|
5506
|
-
#
|
5507
|
-
#
|
5569
|
+
# A view of a data source that contains information about the shape of
|
5570
|
+
# the data in the underlying source. This is a variant type structure.
|
5571
|
+
# For this structure to be valid, only one of the attributes can be
|
5572
|
+
# non-null.
|
5508
5573
|
#
|
5509
5574
|
# @note When making an API call, you may pass PhysicalTable
|
5510
5575
|
# data as a hash:
|
@@ -5674,7 +5739,7 @@ module Aws::QuickSight
|
|
5674
5739
|
include Aws::Structure
|
5675
5740
|
end
|
5676
5741
|
|
5677
|
-
# Information
|
5742
|
+
# Information about a queued dataset SPICE ingestion.
|
5678
5743
|
#
|
5679
5744
|
# @!attribute [rw] waiting_on_ingestion
|
5680
5745
|
# The ID of the queued ingestion.
|
@@ -5693,9 +5758,9 @@ module Aws::QuickSight
|
|
5693
5758
|
include Aws::Structure
|
5694
5759
|
end
|
5695
5760
|
|
5696
|
-
# The user
|
5697
|
-
# requires finding a user based on a provided user
|
5698
|
-
# `DeleteUser`, `DescribeUser`, and so on.
|
5761
|
+
# The user with the provided name isn't found. This error can happen in
|
5762
|
+
# any operation that requires finding a user based on a provided user
|
5763
|
+
# name, such as `DeleteUser`, `DescribeUser`, and so on.
|
5699
5764
|
#
|
5700
5765
|
# @!attribute [rw] message
|
5701
5766
|
# @return [String]
|
@@ -5712,7 +5777,7 @@ module Aws::QuickSight
|
|
5712
5777
|
include Aws::Structure
|
5713
5778
|
end
|
5714
5779
|
|
5715
|
-
# RDS parameters.
|
5780
|
+
# Amazon RDS parameters.
|
5716
5781
|
#
|
5717
5782
|
# @note When making an API call, you may pass RdsParameters
|
5718
5783
|
# data as a hash:
|
@@ -5738,8 +5803,9 @@ module Aws::QuickSight
|
|
5738
5803
|
include Aws::Structure
|
5739
5804
|
end
|
5740
5805
|
|
5741
|
-
# Redshift parameters. The `ClusterId` field can be blank if
|
5742
|
-
# `Port` are both set
|
5806
|
+
# Amazon Redshift parameters. The `ClusterId` field can be blank if
|
5807
|
+
# `Host` and `Port` are both set. The `Host` and `Port` fields can be
|
5808
|
+
# blank if the `ClusterId` field is set.
|
5743
5809
|
#
|
5744
5810
|
# @note When making an API call, you may pass RedshiftParameters
|
5745
5811
|
# data as a hash:
|
@@ -5752,11 +5818,11 @@ module Aws::QuickSight
|
|
5752
5818
|
# }
|
5753
5819
|
#
|
5754
5820
|
# @!attribute [rw] host
|
5755
|
-
# Host. This can be blank if
|
5821
|
+
# Host. This field can be blank if `ClusterId` is provided.
|
5756
5822
|
# @return [String]
|
5757
5823
|
#
|
5758
5824
|
# @!attribute [rw] port
|
5759
|
-
# Port. This can be blank if the `ClusterId` is provided.
|
5825
|
+
# Port. This field can be blank if the `ClusterId` is provided.
|
5760
5826
|
# @return [Integer]
|
5761
5827
|
#
|
5762
5828
|
# @!attribute [rw] database
|
@@ -5764,7 +5830,8 @@ module Aws::QuickSight
|
|
5764
5830
|
# @return [String]
|
5765
5831
|
#
|
5766
5832
|
# @!attribute [rw] cluster_id
|
5767
|
-
# Cluster ID. This can be blank if the `Host` and `Port` are
|
5833
|
+
# Cluster ID. This field can be blank if the `Host` and `Port` are
|
5834
|
+
# provided.
|
5768
5835
|
# @return [String]
|
5769
5836
|
#
|
5770
5837
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RedshiftParameters AWS API Documentation
|
@@ -5841,7 +5908,7 @@ module Aws::QuickSight
|
|
5841
5908
|
#
|
5842
5909
|
#
|
5843
5910
|
#
|
5844
|
-
# [1]: https://
|
5911
|
+
# [1]: https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sts/assume-role.html
|
5845
5912
|
# @return [String]
|
5846
5913
|
#
|
5847
5914
|
# @!attribute [rw] aws_account_id
|
@@ -5923,11 +5990,12 @@ module Aws::QuickSight
|
|
5923
5990
|
# @return [String]
|
5924
5991
|
#
|
5925
5992
|
# @!attribute [rw] schema
|
5926
|
-
# The schema name.
|
5993
|
+
# The schema name. This name applies to certain relational database
|
5994
|
+
# engines.
|
5927
5995
|
# @return [String]
|
5928
5996
|
#
|
5929
5997
|
# @!attribute [rw] name
|
5930
|
-
#
|
5998
|
+
# The name of the relational table.
|
5931
5999
|
# @return [String]
|
5932
6000
|
#
|
5933
6001
|
# @!attribute [rw] input_columns
|
@@ -5955,11 +6023,11 @@ module Aws::QuickSight
|
|
5955
6023
|
# }
|
5956
6024
|
#
|
5957
6025
|
# @!attribute [rw] column_name
|
5958
|
-
#
|
6026
|
+
# The name of the column to be renamed.
|
5959
6027
|
# @return [String]
|
5960
6028
|
#
|
5961
6029
|
# @!attribute [rw] new_column_name
|
5962
|
-
#
|
6030
|
+
# The new name for the column.
|
5963
6031
|
# @return [String]
|
5964
6032
|
#
|
5965
6033
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RenameColumnOperation AWS API Documentation
|
@@ -6025,15 +6093,15 @@ module Aws::QuickSight
|
|
6025
6093
|
# }
|
6026
6094
|
#
|
6027
6095
|
# @!attribute [rw] principal
|
6028
|
-
# The Amazon Resource Name (ARN) of
|
6029
|
-
# IAM ARN. If you are using cross-account resource
|
6030
|
-
# the IAM ARN of an account root. Otherwise, it is
|
6031
|
-
# QuickSight user or group. .
|
6096
|
+
# The Amazon Resource Name (ARN) of an Amazon QuickSight user or
|
6097
|
+
# group, or an IAM ARN. If you are using cross-account resource
|
6098
|
+
# sharing, this is the IAM ARN of an account root. Otherwise, it is
|
6099
|
+
# the ARN of a QuickSight user or group. .
|
6032
6100
|
# @return [String]
|
6033
6101
|
#
|
6034
6102
|
# @!attribute [rw] actions
|
6035
|
-
# The action to grant or revoke permissions on
|
6036
|
-
# "quicksight:DescribeDashboard"
|
6103
|
+
# The action to grant or revoke permissions on, for example
|
6104
|
+
# `"quicksight:DescribeDashboard"`.
|
6037
6105
|
# @return [Array<String>]
|
6038
6106
|
#
|
6039
6107
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourcePermission AWS API Documentation
|
@@ -6066,7 +6134,7 @@ module Aws::QuickSight
|
|
6066
6134
|
include Aws::Structure
|
6067
6135
|
end
|
6068
6136
|
|
6069
|
-
# Information
|
6137
|
+
# Information about rows for a data set SPICE ingestion.
|
6070
6138
|
#
|
6071
6139
|
# @!attribute [rw] rows_ingested
|
6072
6140
|
# The number of rows that were ingested.
|
@@ -6084,7 +6152,7 @@ module Aws::QuickSight
|
|
6084
6152
|
include Aws::Structure
|
6085
6153
|
end
|
6086
6154
|
|
6087
|
-
#
|
6155
|
+
# The row-level security configuration for the dataset.
|
6088
6156
|
#
|
6089
6157
|
# @note When making an API call, you may pass RowLevelPermissionDataSet
|
6090
6158
|
# data as a hash:
|
@@ -6095,7 +6163,7 @@ module Aws::QuickSight
|
|
6095
6163
|
# }
|
6096
6164
|
#
|
6097
6165
|
# @!attribute [rw] arn
|
6098
|
-
# The Amazon Resource
|
6166
|
+
# The Amazon Resource Name (ARN) of the permission dataset.
|
6099
6167
|
# @return [String]
|
6100
6168
|
#
|
6101
6169
|
# @!attribute [rw] permission_policy
|
@@ -6157,11 +6225,11 @@ module Aws::QuickSight
|
|
6157
6225
|
# }
|
6158
6226
|
#
|
6159
6227
|
# @!attribute [rw] data_source_arn
|
6160
|
-
#
|
6228
|
+
# The amazon Resource Name (ARN) for the data source.
|
6161
6229
|
# @return [String]
|
6162
6230
|
#
|
6163
6231
|
# @!attribute [rw] upload_settings
|
6164
|
-
# Information
|
6232
|
+
# Information about the format for the S3 source file or files.
|
6165
6233
|
# @return [Types::UploadSettings]
|
6166
6234
|
#
|
6167
6235
|
# @!attribute [rw] input_columns
|
@@ -6177,6 +6245,81 @@ module Aws::QuickSight
|
|
6177
6245
|
include Aws::Structure
|
6178
6246
|
end
|
6179
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
|
+
|
6180
6323
|
# ServiceNow parameters.
|
6181
6324
|
#
|
6182
6325
|
# @note When making an API call, you may pass ServiceNowParameters
|
@@ -6197,8 +6340,8 @@ module Aws::QuickSight
|
|
6197
6340
|
include Aws::Structure
|
6198
6341
|
end
|
6199
6342
|
|
6200
|
-
# The number of minutes specified for the lifetime of a session
|
6201
|
-
# valid. The session lifetime must be
|
6343
|
+
# The number of minutes specified for the lifetime of a session isn't
|
6344
|
+
# valid. The session lifetime must be 15-600 minutes.
|
6202
6345
|
#
|
6203
6346
|
# @!attribute [rw] message
|
6204
6347
|
# @return [String]
|
@@ -6336,7 +6479,7 @@ module Aws::QuickSight
|
|
6336
6479
|
# }
|
6337
6480
|
#
|
6338
6481
|
# @!attribute [rw] disable_ssl
|
6339
|
-
# A
|
6482
|
+
# A Boolean option to control whether SSL should be disabled.
|
6340
6483
|
# @return [Boolean]
|
6341
6484
|
#
|
6342
6485
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SslProperties AWS API Documentation
|
@@ -6372,8 +6515,8 @@ module Aws::QuickSight
|
|
6372
6515
|
include Aws::Structure
|
6373
6516
|
end
|
6374
6517
|
|
6375
|
-
# The keys of the key-value pairs for the resource tag or tags
|
6376
|
-
# to the resource.
|
6518
|
+
# The key or keys of the key-value pairs for the resource tag or tags
|
6519
|
+
# assigned to the resource.
|
6377
6520
|
#
|
6378
6521
|
# @note When making an API call, you may pass Tag
|
6379
6522
|
# data as a hash:
|
@@ -6480,13 +6623,13 @@ module Aws::QuickSight
|
|
6480
6623
|
include Aws::Structure
|
6481
6624
|
end
|
6482
6625
|
|
6483
|
-
# A template object. A template is an entity in QuickSight
|
6484
|
-
# encapsulates the metadata required to create an analysis that
|
6485
|
-
#
|
6486
|
-
# the dataset associated with the
|
6487
|
-
# can
|
6488
|
-
# with datasets
|
6489
|
-
# source analysis and template.
|
6626
|
+
# A template object. A *template* is an entity in QuickSight that
|
6627
|
+
# encapsulates the metadata required to create an analysis and that you
|
6628
|
+
# can use to create a dashboard. A template adds a layer of abstraction
|
6629
|
+
# by using placeholders to replace the dataset associated with the
|
6630
|
+
# analysis. You can use templates to create dashboards by replacing
|
6631
|
+
# dataset placeholders with datasets that follow the same schema that
|
6632
|
+
# was used to create the source analysis and template.
|
6490
6633
|
#
|
6491
6634
|
# You can share templates across AWS accounts by allowing users in other
|
6492
6635
|
# AWS accounts to create a template or a dashboard from an existing
|
@@ -6536,7 +6679,7 @@ module Aws::QuickSight
|
|
6536
6679
|
# @return [String]
|
6537
6680
|
#
|
6538
6681
|
# @!attribute [rw] arn
|
6539
|
-
# The ARN of the template alias.
|
6682
|
+
# The Amazon Resource Name (ARN) of the template alias.
|
6540
6683
|
# @return [String]
|
6541
6684
|
#
|
6542
6685
|
# @!attribute [rw] template_version_number
|
@@ -6587,7 +6730,7 @@ module Aws::QuickSight
|
|
6587
6730
|
# }
|
6588
6731
|
#
|
6589
6732
|
# @!attribute [rw] arn
|
6590
|
-
# The Amazon Resource
|
6733
|
+
# The Amazon Resource Name (ARN) of the resource.
|
6591
6734
|
# @return [String]
|
6592
6735
|
#
|
6593
6736
|
# @!attribute [rw] data_set_references
|
@@ -6649,7 +6792,7 @@ module Aws::QuickSight
|
|
6649
6792
|
# }
|
6650
6793
|
#
|
6651
6794
|
# @!attribute [rw] arn
|
6652
|
-
# The Amazon Resource
|
6795
|
+
# The Amazon Resource Name (ARN) of the resource.
|
6653
6796
|
# @return [String]
|
6654
6797
|
#
|
6655
6798
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TemplateSourceTemplate AWS API Documentation
|
@@ -6666,8 +6809,8 @@ module Aws::QuickSight
|
|
6666
6809
|
# @return [String]
|
6667
6810
|
#
|
6668
6811
|
# @!attribute [rw] template_id
|
6669
|
-
# The ID of the template. This is unique per AWS Region for each
|
6670
|
-
# account.
|
6812
|
+
# The ID of the template. This ID is unique per AWS Region for each
|
6813
|
+
# AWS account.
|
6671
6814
|
# @return [String]
|
6672
6815
|
#
|
6673
6816
|
# @!attribute [rw] name
|
@@ -6680,11 +6823,11 @@ module Aws::QuickSight
|
|
6680
6823
|
# @return [Integer]
|
6681
6824
|
#
|
6682
6825
|
# @!attribute [rw] created_time
|
6683
|
-
# The last time this was created.
|
6826
|
+
# The last time that this template was created.
|
6684
6827
|
# @return [Time]
|
6685
6828
|
#
|
6686
6829
|
# @!attribute [rw] last_updated_time
|
6687
|
-
# The last time this was updated.
|
6830
|
+
# The last time that this template was updated.
|
6688
6831
|
# @return [Time]
|
6689
6832
|
#
|
6690
6833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TemplateSummary AWS API Documentation
|
@@ -6702,7 +6845,7 @@ module Aws::QuickSight
|
|
6702
6845
|
# A version of a template.
|
6703
6846
|
#
|
6704
6847
|
# @!attribute [rw] created_time
|
6705
|
-
# The time this was created.
|
6848
|
+
# The time that this template version was created.
|
6706
6849
|
# @return [Time]
|
6707
6850
|
#
|
6708
6851
|
# @!attribute [rw] errors
|
@@ -6748,7 +6891,7 @@ module Aws::QuickSight
|
|
6748
6891
|
# The template version.
|
6749
6892
|
#
|
6750
6893
|
# @!attribute [rw] arn
|
6751
|
-
# The ARN of the template version.
|
6894
|
+
# The Amazon Resource Name (ARN) of the template version.
|
6752
6895
|
# @return [String]
|
6753
6896
|
#
|
6754
6897
|
# @!attribute [rw] version_number
|
@@ -6756,7 +6899,7 @@ module Aws::QuickSight
|
|
6756
6899
|
# @return [Integer]
|
6757
6900
|
#
|
6758
6901
|
# @!attribute [rw] created_time
|
6759
|
-
# The time this was created.
|
6902
|
+
# The time that this template version was created.
|
6760
6903
|
# @return [Time]
|
6761
6904
|
#
|
6762
6905
|
# @!attribute [rw] status
|
@@ -6764,7 +6907,7 @@ module Aws::QuickSight
|
|
6764
6907
|
# @return [String]
|
6765
6908
|
#
|
6766
6909
|
# @!attribute [rw] description
|
6767
|
-
# The
|
6910
|
+
# The description of the template version.
|
6768
6911
|
# @return [String]
|
6769
6912
|
#
|
6770
6913
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TemplateVersionSummary AWS API Documentation
|
@@ -6828,8 +6971,8 @@ module Aws::QuickSight
|
|
6828
6971
|
end
|
6829
6972
|
|
6830
6973
|
# A data transformation on a logical table. This is a variant type
|
6831
|
-
# structure.
|
6832
|
-
#
|
6974
|
+
# structure. For this structure to be valid, only one of the attributes
|
6975
|
+
# can be non-null.
|
6833
6976
|
#
|
6834
6977
|
# @note When making an API call, you may pass TransformOperation
|
6835
6978
|
# data as a hash:
|
@@ -7017,7 +7160,8 @@ module Aws::QuickSight
|
|
7017
7160
|
# }
|
7018
7161
|
#
|
7019
7162
|
# @!attribute [rw] aws_account_id
|
7020
|
-
# AWS account
|
7163
|
+
# The ID of the AWS account that contains the dashboard whose
|
7164
|
+
# permissions you're updating.
|
7021
7165
|
# @return [String]
|
7022
7166
|
#
|
7023
7167
|
# @!attribute [rw] dashboard_id
|
@@ -7083,7 +7227,8 @@ module Aws::QuickSight
|
|
7083
7227
|
# }
|
7084
7228
|
#
|
7085
7229
|
# @!attribute [rw] aws_account_id
|
7086
|
-
# AWS account
|
7230
|
+
# The ID of the AWS account that contains the dashboard that you're
|
7231
|
+
# updating.
|
7087
7232
|
# @return [String]
|
7088
7233
|
#
|
7089
7234
|
# @!attribute [rw] dashboard_id
|
@@ -7188,7 +7333,8 @@ module Aws::QuickSight
|
|
7188
7333
|
# }
|
7189
7334
|
#
|
7190
7335
|
# @!attribute [rw] aws_account_id
|
7191
|
-
# AWS account
|
7336
|
+
# The ID of the AWS account that contains the dashboard that you're
|
7337
|
+
# updating.
|
7192
7338
|
# @return [String]
|
7193
7339
|
#
|
7194
7340
|
# @!attribute [rw] dashboard_id
|
@@ -7201,11 +7347,11 @@ module Aws::QuickSight
|
|
7201
7347
|
#
|
7202
7348
|
# @!attribute [rw] source_entity
|
7203
7349
|
# The template or analysis from which the dashboard is created. The
|
7204
|
-
# SouceTemplate entity accepts the
|
7205
|
-
# references to replacement datasets for the
|
7206
|
-
# creating the template. The replacement
|
7207
|
-
# same schema as the datasets for which
|
7208
|
-
# creating the template.
|
7350
|
+
# `SouceTemplate` entity accepts the Amazon Resource Name (ARN) of the
|
7351
|
+
# template and also references to replacement datasets for the
|
7352
|
+
# placeholders set when creating the template. The replacement
|
7353
|
+
# datasets need to follow the same schema as the datasets for which
|
7354
|
+
# placeholders were created when creating the template.
|
7209
7355
|
# @return [Types::DashboardSourceEntity]
|
7210
7356
|
#
|
7211
7357
|
# @!attribute [rw] parameters
|
@@ -7217,21 +7363,23 @@ module Aws::QuickSight
|
|
7217
7363
|
# @return [String]
|
7218
7364
|
#
|
7219
7365
|
# @!attribute [rw] dashboard_publish_options
|
7220
|
-
#
|
7366
|
+
# Options for publishing the dashboard when you create it:
|
7221
7367
|
#
|
7222
|
-
# * AvailabilityStatus for AdHocFilteringOption - This can
|
7223
|
-
# `ENABLED` or `DISABLED`. When
|
7368
|
+
# * `AvailabilityStatus` for `AdHocFilteringOption` - This status can
|
7369
|
+
# be either `ENABLED` or `DISABLED`. When this is set to `DISABLED`,
|
7224
7370
|
# QuickSight disables the left filter pane on the published
|
7225
|
-
# dashboard, which can be used for
|
7226
|
-
# default.
|
7227
|
-
#
|
7228
|
-
# * AvailabilityStatus for ExportToCSVOption - This can be
|
7229
|
-
# `ENABLED` or `DISABLED`. The visual option to export data
|
7230
|
-
#
|
7231
|
-
#
|
7232
|
-
#
|
7233
|
-
#
|
7234
|
-
#
|
7371
|
+
# dashboard, which can be used for ad hoc (one-time) filtering. This
|
7372
|
+
# option is `ENABLED` by default.
|
7373
|
+
#
|
7374
|
+
# * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
|
7375
|
+
# either `ENABLED` or `DISABLED`. The visual option to export data
|
7376
|
+
# to .csv format isn't enabled when this is set to `DISABLED`. This
|
7377
|
+
# option is `ENABLED` by default.
|
7378
|
+
#
|
7379
|
+
# * `VisibilityState` for `SheetControlsOption` - This visibility
|
7380
|
+
# state can be either `COLLAPSED` or `EXPANDED`. The sheet controls
|
7381
|
+
# pane is collapsed by default when set to true. This option is
|
7382
|
+
# `COLLAPSED` by default.
|
7235
7383
|
# @return [Types::DashboardPublishOptions]
|
7236
7384
|
#
|
7237
7385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDashboardRequest AWS API Documentation
|
@@ -7304,12 +7452,12 @@ module Aws::QuickSight
|
|
7304
7452
|
# }
|
7305
7453
|
#
|
7306
7454
|
# @!attribute [rw] aws_account_id
|
7307
|
-
# The AWS
|
7455
|
+
# The AWS account ID.
|
7308
7456
|
# @return [String]
|
7309
7457
|
#
|
7310
7458
|
# @!attribute [rw] data_set_id
|
7311
|
-
# The ID for the dataset
|
7312
|
-
# per AWS Region for each AWS account.
|
7459
|
+
# The ID for the dataset whose permissions you want to update. This ID
|
7460
|
+
# is unique per AWS Region for each AWS account.
|
7313
7461
|
# @return [String]
|
7314
7462
|
#
|
7315
7463
|
# @!attribute [rw] grant_permissions
|
@@ -7335,8 +7483,8 @@ module Aws::QuickSight
|
|
7335
7483
|
# @return [String]
|
7336
7484
|
#
|
7337
7485
|
# @!attribute [rw] data_set_id
|
7338
|
-
# The ID for the dataset
|
7339
|
-
# per AWS Region for each AWS account.
|
7486
|
+
# The ID for the dataset whose permissions you want to update. This ID
|
7487
|
+
# is unique per AWS Region for each AWS account.
|
7340
7488
|
# @return [String]
|
7341
7489
|
#
|
7342
7490
|
# @!attribute [rw] request_id
|
@@ -7473,11 +7621,11 @@ module Aws::QuickSight
|
|
7473
7621
|
# }
|
7474
7622
|
#
|
7475
7623
|
# @!attribute [rw] aws_account_id
|
7476
|
-
# The AWS
|
7624
|
+
# The AWS account ID.
|
7477
7625
|
# @return [String]
|
7478
7626
|
#
|
7479
7627
|
# @!attribute [rw] data_set_id
|
7480
|
-
# The ID for the dataset that you want to
|
7628
|
+
# The ID for the dataset that you want to update. This ID is unique
|
7481
7629
|
# per AWS Region for each AWS account.
|
7482
7630
|
# @return [String]
|
7483
7631
|
#
|
@@ -7496,7 +7644,7 @@ module Aws::QuickSight
|
|
7496
7644
|
# @return [Hash<String,Types::LogicalTable>]
|
7497
7645
|
#
|
7498
7646
|
# @!attribute [rw] import_mode
|
7499
|
-
# Indicates whether
|
7647
|
+
# Indicates whether you want to import the data into SPICE.
|
7500
7648
|
# @return [String]
|
7501
7649
|
#
|
7502
7650
|
# @!attribute [rw] column_groups
|
@@ -7505,7 +7653,8 @@ module Aws::QuickSight
|
|
7505
7653
|
# @return [Array<Types::ColumnGroup>]
|
7506
7654
|
#
|
7507
7655
|
# @!attribute [rw] row_level_permission_data_set
|
7508
|
-
#
|
7656
|
+
# The row-level security configuration for the data you want to
|
7657
|
+
# create.
|
7509
7658
|
# @return [Types::RowLevelPermissionDataSet]
|
7510
7659
|
#
|
7511
7660
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateDataSetRequest AWS API Documentation
|
@@ -7533,12 +7682,12 @@ module Aws::QuickSight
|
|
7533
7682
|
#
|
7534
7683
|
# @!attribute [rw] ingestion_arn
|
7535
7684
|
# The ARN for the ingestion, which is triggered as a result of dataset
|
7536
|
-
# creation if the import mode is SPICE
|
7685
|
+
# creation if the import mode is SPICE.
|
7537
7686
|
# @return [String]
|
7538
7687
|
#
|
7539
7688
|
# @!attribute [rw] ingestion_id
|
7540
7689
|
# The ID of the ingestion, which is triggered as a result of dataset
|
7541
|
-
# creation if the import mode is SPICE
|
7690
|
+
# creation if the import mode is SPICE.
|
7542
7691
|
# @return [String]
|
7543
7692
|
#
|
7544
7693
|
# @!attribute [rw] request_id
|
@@ -7897,11 +8046,12 @@ module Aws::QuickSight
|
|
7897
8046
|
# }
|
7898
8047
|
#
|
7899
8048
|
# @!attribute [rw] aws_account_id
|
7900
|
-
# The AWS account
|
8049
|
+
# The ID of the AWS account that contains the IAM policy assignment.
|
7901
8050
|
# @return [String]
|
7902
8051
|
#
|
7903
8052
|
# @!attribute [rw] assignment_name
|
7904
|
-
# The name of the assignment.
|
8053
|
+
# The name of the assignment. This name must be unique within an AWS
|
8054
|
+
# account.
|
7905
8055
|
# @return [String]
|
7906
8056
|
#
|
7907
8057
|
# @!attribute [rw] namespace
|
@@ -7909,26 +8059,26 @@ module Aws::QuickSight
|
|
7909
8059
|
# @return [String]
|
7910
8060
|
#
|
7911
8061
|
# @!attribute [rw] assignment_status
|
7912
|
-
# The status of
|
8062
|
+
# The status of the assignment. Possible values are as follows:
|
7913
8063
|
#
|
7914
|
-
# * ENABLED - Anything specified in this assignment is used
|
8064
|
+
# * `ENABLED` - Anything specified in this assignment is used when
|
7915
8065
|
# creating the data source.
|
7916
8066
|
#
|
7917
|
-
# * DISABLED - This assignment isn't used
|
8067
|
+
# * `DISABLED` - This assignment isn't used when creating the data
|
7918
8068
|
# source.
|
7919
8069
|
#
|
7920
|
-
# * DRAFT -
|
7921
|
-
# creating the data source.
|
8070
|
+
# * `DRAFT` - This assignment is an unfinished draft and isn't used
|
8071
|
+
# when creating the data source.
|
7922
8072
|
# @return [String]
|
7923
8073
|
#
|
7924
8074
|
# @!attribute [rw] policy_arn
|
7925
|
-
#
|
7926
|
-
# specified
|
8075
|
+
# The ARN for the IAM policy to apply to the QuickSight users and
|
8076
|
+
# groups specified in this assignment.
|
7927
8077
|
# @return [String]
|
7928
8078
|
#
|
7929
8079
|
# @!attribute [rw] identities
|
7930
|
-
# QuickSight users
|
7931
|
-
#
|
8080
|
+
# The QuickSight users, groups, or both that you want to assign the
|
8081
|
+
# policy to.
|
7932
8082
|
# @return [Hash<String,Array<String>>]
|
7933
8083
|
#
|
7934
8084
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateIAMPolicyAssignmentRequest AWS API Documentation
|
@@ -7952,25 +8102,26 @@ module Aws::QuickSight
|
|
7952
8102
|
# @return [String]
|
7953
8103
|
#
|
7954
8104
|
# @!attribute [rw] policy_arn
|
7955
|
-
# The IAM policy
|
7956
|
-
# specified in this
|
8105
|
+
# The ARN for the IAM policy applied to the QuickSight users and
|
8106
|
+
# groups specified in this assignment.
|
7957
8107
|
# @return [String]
|
7958
8108
|
#
|
7959
8109
|
# @!attribute [rw] identities
|
7960
|
-
# QuickSight users
|
8110
|
+
# The QuickSight users, groups, or both that the IAM policy is
|
8111
|
+
# assigned to.
|
7961
8112
|
# @return [Hash<String,Array<String>>]
|
7962
8113
|
#
|
7963
8114
|
# @!attribute [rw] assignment_status
|
7964
|
-
# The status of the assignment:
|
8115
|
+
# The status of the assignment. Possible values are as follows:
|
7965
8116
|
#
|
7966
|
-
# * ENABLED - Anything specified in this assignment is used
|
8117
|
+
# * `ENABLED` - Anything specified in this assignment is used when
|
7967
8118
|
# creating the data source.
|
7968
8119
|
#
|
7969
|
-
# * DISABLED - This assignment isn't used
|
8120
|
+
# * `DISABLED` - This assignment isn't used when creating the data
|
7970
8121
|
# source.
|
7971
8122
|
#
|
7972
|
-
# * DRAFT -
|
7973
|
-
# creating the data source.
|
8123
|
+
# * `DRAFT` - This assignment is an unfinished draft and isn't used
|
8124
|
+
# when creating the data source.
|
7974
8125
|
# @return [String]
|
7975
8126
|
#
|
7976
8127
|
# @!attribute [rw] request_id
|
@@ -8005,7 +8156,8 @@ module Aws::QuickSight
|
|
8005
8156
|
# }
|
8006
8157
|
#
|
8007
8158
|
# @!attribute [rw] aws_account_id
|
8008
|
-
# AWS account
|
8159
|
+
# The ID of the AWS account that contains the template alias that
|
8160
|
+
# you're updating.
|
8009
8161
|
# @return [String]
|
8010
8162
|
#
|
8011
8163
|
# @!attribute [rw] template_id
|
@@ -8013,7 +8165,7 @@ module Aws::QuickSight
|
|
8013
8165
|
# @return [String]
|
8014
8166
|
#
|
8015
8167
|
# @!attribute [rw] alias_name
|
8016
|
-
# The alias of the template that you want to update. If you
|
8168
|
+
# The alias of the template that you want to update. If you name a
|
8017
8169
|
# specific alias, you update the version that the alias points to. You
|
8018
8170
|
# can specify the latest version of the template by providing the
|
8019
8171
|
# keyword `$LATEST` in the `AliasName` parameter. The keyword
|
@@ -8076,7 +8228,7 @@ module Aws::QuickSight
|
|
8076
8228
|
# }
|
8077
8229
|
#
|
8078
8230
|
# @!attribute [rw] aws_account_id
|
8079
|
-
# AWS account
|
8231
|
+
# The ID of the AWS account that contains the template.
|
8080
8232
|
# @return [String]
|
8081
8233
|
#
|
8082
8234
|
# @!attribute [rw] template_id
|
@@ -8157,7 +8309,8 @@ module Aws::QuickSight
|
|
8157
8309
|
# }
|
8158
8310
|
#
|
8159
8311
|
# @!attribute [rw] aws_account_id
|
8160
|
-
# AWS account
|
8312
|
+
# The ID of the AWS account that contains the template that you're
|
8313
|
+
# updating.
|
8161
8314
|
# @return [String]
|
8162
8315
|
#
|
8163
8316
|
# @!attribute [rw] template_id
|
@@ -8166,15 +8319,15 @@ module Aws::QuickSight
|
|
8166
8319
|
#
|
8167
8320
|
# @!attribute [rw] source_entity
|
8168
8321
|
# The source QuickSight entity from which this template is being
|
8169
|
-
#
|
8322
|
+
# updated. You can currently update templates from an Analysis or
|
8170
8323
|
# another template.
|
8171
8324
|
# @return [Types::TemplateSourceEntity]
|
8172
8325
|
#
|
8173
8326
|
# @!attribute [rw] version_description
|
8174
|
-
# A description of the current template version being updated.
|
8175
|
-
# time you
|
8176
|
-
#
|
8177
|
-
# `VersionDescription` field.
|
8327
|
+
# A description of the current template version that is being updated.
|
8328
|
+
# Every time you call `UpdateTemplate`, you create a new version of
|
8329
|
+
# the template. Each version of the template maintains a description
|
8330
|
+
# of the version in the `VersionDescription` field.
|
8178
8331
|
# @return [String]
|
8179
8332
|
#
|
8180
8333
|
# @!attribute [rw] name
|
@@ -8201,8 +8354,8 @@ module Aws::QuickSight
|
|
8201
8354
|
# @return [String]
|
8202
8355
|
#
|
8203
8356
|
# @!attribute [rw] version_arn
|
8204
|
-
# The
|
8205
|
-
#
|
8357
|
+
# The ARN for the template, including the version information of the
|
8358
|
+
# first version.
|
8206
8359
|
# @return [String]
|
8207
8360
|
#
|
8208
8361
|
# @!attribute [rw] creation_status
|
@@ -8303,7 +8456,7 @@ module Aws::QuickSight
|
|
8303
8456
|
include Aws::Structure
|
8304
8457
|
end
|
8305
8458
|
|
8306
|
-
# Information
|
8459
|
+
# Information about the format for a source file or files.
|
8307
8460
|
#
|
8308
8461
|
# @note When making an API call, you may pass UploadSettings
|
8309
8462
|
# data as a hash:
|
@@ -8325,7 +8478,8 @@ module Aws::QuickSight
|
|
8325
8478
|
# @return [Integer]
|
8326
8479
|
#
|
8327
8480
|
# @!attribute [rw] contains_header
|
8328
|
-
# Whether
|
8481
|
+
# Whether the file has a header row, or the files each have a header
|
8482
|
+
# row.
|
8329
8483
|
# @return [Boolean]
|
8330
8484
|
#
|
8331
8485
|
# @!attribute [rw] text_qualifier
|
@@ -8351,7 +8505,7 @@ module Aws::QuickSight
|
|
8351
8505
|
# QuickSight subscription can't contain more than 20 million users.
|
8352
8506
|
#
|
8353
8507
|
# @!attribute [rw] arn
|
8354
|
-
# The Amazon Resource
|
8508
|
+
# The Amazon Resource Name (ARN) for the user.
|
8355
8509
|
# @return [String]
|
8356
8510
|
#
|
8357
8511
|
# @!attribute [rw] user_name
|
@@ -8386,9 +8540,9 @@ module Aws::QuickSight
|
|
8386
8540
|
# @return [String]
|
8387
8541
|
#
|
8388
8542
|
# @!attribute [rw] active
|
8389
|
-
#
|
8390
|
-
# that’s not an IAM user or an
|
8391
|
-
# they sign in and provide a password.
|
8543
|
+
# The active status of user. When you create an Amazon QuickSight user
|
8544
|
+
# that’s not an IAM user or an Active Directory user, that user is
|
8545
|
+
# inactive until they sign in and provide a password.
|
8392
8546
|
# @return [Boolean]
|
8393
8547
|
#
|
8394
8548
|
# @!attribute [rw] principal_id
|