aws-sdk-quicksight 1.26.0 → 1.27.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -32,7 +32,8 @@ module Aws::QuickSight
32
32
  include Aws::Structure
33
33
  end
34
34
 
35
- # The customizations associated with your AWS account for QuickSight.
35
+ # The Amazon QuickSight customizations associated with your AWS account
36
+ # or a QuickSight namespace in a specific AWS Region.
36
37
  #
37
38
  # @note When making an API call, you may pass AccountCustomization
38
39
  # data as a hash:
@@ -56,12 +57,15 @@ module Aws::QuickSight
56
57
  # The QuickSight settings associated with your AWS account.
57
58
  #
58
59
  # @!attribute [rw] account_name
59
- # The name associated with the QuickSight subscription in your AWS
60
- # account.
60
+ # The "account name" you provided for the QuickSight subscription in
61
+ # your AWS account. You create this name when you sign up for
62
+ # QuickSight. It is unique in all of AWS and it appears only in the
63
+ # console when users sign in.
61
64
  # @return [String]
62
65
  #
63
66
  # @!attribute [rw] edition
64
- # The edition of QuickSight that you're currently subscribed to.
67
+ # The edition of QuickSight that you're currently subscribed to:
68
+ # Enterprise edition or Standard edition.
65
69
  # @return [String]
66
70
  #
67
71
  # @!attribute [rw] default_namespace
@@ -144,6 +148,218 @@ module Aws::QuickSight
144
148
  include Aws::Structure
145
149
  end
146
150
 
151
+ # Metadata structure for an analysis in Amazon QuickSight
152
+ #
153
+ # @!attribute [rw] analysis_id
154
+ # The ID of the analysis.
155
+ # @return [String]
156
+ #
157
+ # @!attribute [rw] arn
158
+ # The Amazon Resource Name (ARN) of the analysis.
159
+ # @return [String]
160
+ #
161
+ # @!attribute [rw] name
162
+ # The descriptive name of the analysis.
163
+ # @return [String]
164
+ #
165
+ # @!attribute [rw] status
166
+ # Status associated with the analysis.
167
+ # @return [String]
168
+ #
169
+ # @!attribute [rw] errors
170
+ # Errors associated with the analysis.
171
+ # @return [Array<Types::AnalysisError>]
172
+ #
173
+ # @!attribute [rw] data_set_arns
174
+ # The ARNs of the datasets of the analysis.
175
+ # @return [Array<String>]
176
+ #
177
+ # @!attribute [rw] theme_arn
178
+ # The ARN of the theme of the analysis.
179
+ # @return [String]
180
+ #
181
+ # @!attribute [rw] created_time
182
+ # The time that the analysis was created.
183
+ # @return [Time]
184
+ #
185
+ # @!attribute [rw] last_updated_time
186
+ # The time that the analysis was last updated.
187
+ # @return [Time]
188
+ #
189
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Analysis AWS API Documentation
190
+ #
191
+ class Analysis < Struct.new(
192
+ :analysis_id,
193
+ :arn,
194
+ :name,
195
+ :status,
196
+ :errors,
197
+ :data_set_arns,
198
+ :theme_arn,
199
+ :created_time,
200
+ :last_updated_time)
201
+ SENSITIVE = []
202
+ include Aws::Structure
203
+ end
204
+
205
+ # A metadata error structure for an analysis.
206
+ #
207
+ # @!attribute [rw] type
208
+ # The type of the analysis error.
209
+ # @return [String]
210
+ #
211
+ # @!attribute [rw] message
212
+ # The message associated with the analysis error.
213
+ # @return [String]
214
+ #
215
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisError AWS API Documentation
216
+ #
217
+ class AnalysisError < Struct.new(
218
+ :type,
219
+ :message)
220
+ SENSITIVE = []
221
+ include Aws::Structure
222
+ end
223
+
224
+ # A filter that you apply when searching for one or more analyses.
225
+ #
226
+ # @note When making an API call, you may pass AnalysisSearchFilter
227
+ # data as a hash:
228
+ #
229
+ # {
230
+ # operator: "StringEquals", # accepts StringEquals
231
+ # name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
232
+ # value: "String",
233
+ # }
234
+ #
235
+ # @!attribute [rw] operator
236
+ # The comparison operator that you want to use as a filter, for
237
+ # example `"Operator": "StringEquals"`.
238
+ # @return [String]
239
+ #
240
+ # @!attribute [rw] name
241
+ # The name of the value that you want to use as a filter, for example
242
+ # `"Name": "QUICKSIGHT_USER"`.
243
+ # @return [String]
244
+ #
245
+ # @!attribute [rw] value
246
+ # The value of the named item, in this case `QUICKSIGHT_USER`, that
247
+ # you want to use as a filter, for example `"Value"`. An example is
248
+ # `"arn:aws:quicksight:us-east-1:1:user/default/UserName1"`.
249
+ # @return [String]
250
+ #
251
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSearchFilter AWS API Documentation
252
+ #
253
+ class AnalysisSearchFilter < Struct.new(
254
+ :operator,
255
+ :name,
256
+ :value)
257
+ SENSITIVE = []
258
+ include Aws::Structure
259
+ end
260
+
261
+ # The source entity of an analysis.
262
+ #
263
+ # @note When making an API call, you may pass AnalysisSourceEntity
264
+ # data as a hash:
265
+ #
266
+ # {
267
+ # source_template: {
268
+ # data_set_references: [ # required
269
+ # {
270
+ # data_set_placeholder: "NonEmptyString", # required
271
+ # data_set_arn: "Arn", # required
272
+ # },
273
+ # ],
274
+ # arn: "Arn", # required
275
+ # },
276
+ # }
277
+ #
278
+ # @!attribute [rw] source_template
279
+ # The source template for the source entity of the analysis.
280
+ # @return [Types::AnalysisSourceTemplate]
281
+ #
282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSourceEntity AWS API Documentation
283
+ #
284
+ class AnalysisSourceEntity < Struct.new(
285
+ :source_template)
286
+ SENSITIVE = []
287
+ include Aws::Structure
288
+ end
289
+
290
+ # The source template of an analysis.
291
+ #
292
+ # @note When making an API call, you may pass AnalysisSourceTemplate
293
+ # data as a hash:
294
+ #
295
+ # {
296
+ # data_set_references: [ # required
297
+ # {
298
+ # data_set_placeholder: "NonEmptyString", # required
299
+ # data_set_arn: "Arn", # required
300
+ # },
301
+ # ],
302
+ # arn: "Arn", # required
303
+ # }
304
+ #
305
+ # @!attribute [rw] data_set_references
306
+ # The dataset references of the source template of an analysis.
307
+ # @return [Array<Types::DataSetReference>]
308
+ #
309
+ # @!attribute [rw] arn
310
+ # The Amazon Resource Name (ARN) of the source template of an
311
+ # analysis.
312
+ # @return [String]
313
+ #
314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSourceTemplate AWS API Documentation
315
+ #
316
+ class AnalysisSourceTemplate < Struct.new(
317
+ :data_set_references,
318
+ :arn)
319
+ SENSITIVE = []
320
+ include Aws::Structure
321
+ end
322
+
323
+ # The summary metadata that describes an analysis.
324
+ #
325
+ # @!attribute [rw] arn
326
+ # The Amazon Resource Name (ARN) for the analysis.
327
+ # @return [String]
328
+ #
329
+ # @!attribute [rw] analysis_id
330
+ # The ID of the analysis. This ID displays in the URL.
331
+ # @return [String]
332
+ #
333
+ # @!attribute [rw] name
334
+ # The name of the analysis. This name is displayed in the QuickSight
335
+ # console.
336
+ # @return [String]
337
+ #
338
+ # @!attribute [rw] status
339
+ # The last known status for the analysis.
340
+ # @return [String]
341
+ #
342
+ # @!attribute [rw] created_time
343
+ # The time that the analysis was created.
344
+ # @return [Time]
345
+ #
346
+ # @!attribute [rw] last_updated_time
347
+ # The time that the analysis was last updated.
348
+ # @return [Time]
349
+ #
350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AnalysisSummary AWS API Documentation
351
+ #
352
+ class AnalysisSummary < Struct.new(
353
+ :arn,
354
+ :analysis_id,
355
+ :name,
356
+ :status,
357
+ :created_time,
358
+ :last_updated_time)
359
+ SENSITIVE = []
360
+ include Aws::Structure
361
+ end
362
+
147
363
  # Amazon Athena parameters.
148
364
  #
149
365
  # @note When making an API call, you may pass AthenaParameters
@@ -510,8 +726,8 @@ module Aws::QuickSight
510
726
  include Aws::Structure
511
727
  end
512
728
 
513
- # A resource is already in a state that indicates an action is happening
514
- # that must complete before a new update can be applied.
729
+ # A resource is already in a state that indicates an operation is
730
+ # happening that must complete before a new update can be applied.
515
731
  #
516
732
  # @!attribute [rw] message
517
733
  # @return [String]
@@ -563,17 +779,22 @@ module Aws::QuickSight
563
779
  # @return [String]
564
780
  #
565
781
  # @!attribute [rw] namespace
566
- # The namespace associated with the customization that you're
567
- # creating.
782
+ # The QuickSight namespace that you want to add customizations to.
568
783
  # @return [String]
569
784
  #
570
785
  # @!attribute [rw] account_customization
571
- # The customizations you're adding to the QuickSight subscription for
572
- # the AWS account. For example, you could add a default theme by
573
- # setting `AccountCustomization` to the midnight theme
574
- # (`DefaultTheme="arn:aws:quicksight::aws:theme/MIDNIGHT"`) or to a
575
- # custom theme
576
- # (`DefaultTheme="arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"`).
786
+ # The QuickSight customizations you're adding in the current AWS
787
+ # Region. You can add these to an AWS account and a QuickSight
788
+ # namespace.
789
+ #
790
+ # For example, you could add a default theme by setting
791
+ # `AccountCustomization` to the midnight theme:
792
+ # `"AccountCustomization": \{ "DefaultTheme":
793
+ # "arn:aws:quicksight::aws:theme/MIDNIGHT" \}. `. Or, you could add a
794
+ # custom theme by specifying `"AccountCustomization": \{
795
+ # "DefaultTheme":
796
+ # "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
797
+ # \}`.
577
798
  # @return [Types::AccountCustomization]
578
799
  #
579
800
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomizationRequest AWS API Documentation
@@ -596,8 +817,8 @@ module Aws::QuickSight
596
817
  # @return [String]
597
818
  #
598
819
  # @!attribute [rw] account_customization
599
- # The customizations you're adding to the QuickSight subscription for
600
- # the AWS account.
820
+ # The QuickSight customizations you're adding in the current AWS
821
+ # Region.
601
822
  # @return [Types::AccountCustomization]
602
823
  #
603
824
  # @!attribute [rw] request_id
@@ -620,6 +841,159 @@ module Aws::QuickSight
620
841
  include Aws::Structure
621
842
  end
622
843
 
844
+ # @note When making an API call, you may pass CreateAnalysisRequest
845
+ # data as a hash:
846
+ #
847
+ # {
848
+ # aws_account_id: "AwsAccountId", # required
849
+ # analysis_id: "RestrictiveResourceId", # required
850
+ # name: "AnalysisName", # required
851
+ # parameters: {
852
+ # string_parameters: [
853
+ # {
854
+ # name: "NonEmptyString", # required
855
+ # values: ["String"], # required
856
+ # },
857
+ # ],
858
+ # integer_parameters: [
859
+ # {
860
+ # name: "NonEmptyString", # required
861
+ # values: [1], # required
862
+ # },
863
+ # ],
864
+ # decimal_parameters: [
865
+ # {
866
+ # name: "NonEmptyString", # required
867
+ # values: [1.0], # required
868
+ # },
869
+ # ],
870
+ # date_time_parameters: [
871
+ # {
872
+ # name: "NonEmptyString", # required
873
+ # values: [Time.now], # required
874
+ # },
875
+ # ],
876
+ # },
877
+ # permissions: [
878
+ # {
879
+ # principal: "Principal", # required
880
+ # actions: ["String"], # required
881
+ # },
882
+ # ],
883
+ # source_entity: { # required
884
+ # source_template: {
885
+ # data_set_references: [ # required
886
+ # {
887
+ # data_set_placeholder: "NonEmptyString", # required
888
+ # data_set_arn: "Arn", # required
889
+ # },
890
+ # ],
891
+ # arn: "Arn", # required
892
+ # },
893
+ # },
894
+ # theme_arn: "Arn",
895
+ # tags: [
896
+ # {
897
+ # key: "TagKey", # required
898
+ # value: "TagValue", # required
899
+ # },
900
+ # ],
901
+ # }
902
+ #
903
+ # @!attribute [rw] aws_account_id
904
+ # The ID of the AWS account where you are creating an analysis.
905
+ # @return [String]
906
+ #
907
+ # @!attribute [rw] analysis_id
908
+ # The ID for the analysis that you're creating. This ID displays in
909
+ # the URL of the analysis.
910
+ # @return [String]
911
+ #
912
+ # @!attribute [rw] name
913
+ # A descriptive name for the analysis that you're creating. This name
914
+ # displays for the analysis in the QuickSight console.
915
+ # @return [String]
916
+ #
917
+ # @!attribute [rw] parameters
918
+ # The parameter names and override values that you want to use. An
919
+ # analysis can have any parameter type, and some parameters might
920
+ # accept multiple values.
921
+ # @return [Types::Parameters]
922
+ #
923
+ # @!attribute [rw] permissions
924
+ # A structure that describes the principals and the resource-level
925
+ # permissions on an analysis. You can use the `Permissions` structure
926
+ # to grant permissions by providing a list of AWS Identity and Access
927
+ # Management (IAM) action information for each principal listed by
928
+ # Amazon Resource Name (ARN).
929
+ #
930
+ # To specify no permissions, omit `Permissions`.
931
+ # @return [Array<Types::ResourcePermission>]
932
+ #
933
+ # @!attribute [rw] source_entity
934
+ # A source entity to use for the analysis that you're creating. This
935
+ # metadata structure contains details that describe a source template
936
+ # and one or more datasets.
937
+ # @return [Types::AnalysisSourceEntity]
938
+ #
939
+ # @!attribute [rw] theme_arn
940
+ # The ARN for the theme to apply to the analysis that you're
941
+ # creating. To see the theme in the QuickSight console, make sure that
942
+ # you have access to it.
943
+ # @return [String]
944
+ #
945
+ # @!attribute [rw] tags
946
+ # Contains a map of the key-value pairs for the resource tag or tags
947
+ # assigned to the analysis.
948
+ # @return [Array<Types::Tag>]
949
+ #
950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysisRequest AWS API Documentation
951
+ #
952
+ class CreateAnalysisRequest < Struct.new(
953
+ :aws_account_id,
954
+ :analysis_id,
955
+ :name,
956
+ :parameters,
957
+ :permissions,
958
+ :source_entity,
959
+ :theme_arn,
960
+ :tags)
961
+ SENSITIVE = []
962
+ include Aws::Structure
963
+ end
964
+
965
+ # @!attribute [rw] arn
966
+ # The ARN for the analysis.
967
+ # @return [String]
968
+ #
969
+ # @!attribute [rw] analysis_id
970
+ # The ID of the analysis.
971
+ # @return [String]
972
+ #
973
+ # @!attribute [rw] creation_status
974
+ # The status of the creation of the analysis.
975
+ # @return [String]
976
+ #
977
+ # @!attribute [rw] status
978
+ # The HTTP status of the request.
979
+ # @return [Integer]
980
+ #
981
+ # @!attribute [rw] request_id
982
+ # The AWS request ID for this operation.
983
+ # @return [String]
984
+ #
985
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysisResponse AWS API Documentation
986
+ #
987
+ class CreateAnalysisResponse < Struct.new(
988
+ :arn,
989
+ :analysis_id,
990
+ :creation_status,
991
+ :status,
992
+ :request_id)
993
+ SENSITIVE = []
994
+ include Aws::Structure
995
+ end
996
+
623
997
  # A transform operation that creates calculated columns. Columns created
624
998
  # in one such operation form a lexical closure.
625
999
  #
@@ -739,8 +1113,10 @@ module Aws::QuickSight
739
1113
  #
740
1114
  # @!attribute [rw] permissions
741
1115
  # A structure that contains the permissions of the dashboard. You can
742
- # use this structure for granting permissions with principal and
743
- # action information.
1116
+ # use this structure for granting permissions by providing a list of
1117
+ # IAM action information for each principal ARN.
1118
+ #
1119
+ # To specify no permissions, omit the permissions list.
744
1120
  # @return [Array<Types::ResourcePermission>]
745
1121
  #
746
1122
  # @!attribute [rw] source_entity
@@ -779,7 +1155,7 @@ module Aws::QuickSight
779
1155
  #
780
1156
  # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
781
1157
  # either `ENABLED` or `DISABLED`. The visual option to export data
782
- # to .csv format isn't enabled when this is set to `DISABLED`. This
1158
+ # to .CSV format isn't enabled when this is set to `DISABLED`. This
783
1159
  # option is `ENABLED` by default.
784
1160
  #
785
1161
  # * `VisibilityState` for `SheetControlsOption` - This visibility
@@ -1760,7 +2136,7 @@ module Aws::QuickSight
1760
2136
  # process. A status of `CREATED` means that your namespace is ready to
1761
2137
  # use. If an error occurs, it indicates if the process is `retryable`
1762
2138
  # or `non-retryable`. In the case of a non-retryable error, refer to
1763
- # the error message for follow-up actions.
2139
+ # the error message for follow-up tasks.
1764
2140
  # @return [String]
1765
2141
  #
1766
2142
  # @!attribute [rw] identity_store
@@ -2317,13 +2693,14 @@ module Aws::QuickSight
2317
2693
  # A set of alternate data source parameters that you want to share for
2318
2694
  # these credentials. The credentials are applied in tandem with the
2319
2695
  # data source parameters when you copy a data source by using a create
2320
- # or update request. The API compares the `DataSourceParameters`
2321
- # structure that's in the request with the structures in the
2322
- # `AlternateDataSourceParameters` allowlist. If the structures are an
2323
- # exact match, the request is allowed to use the new data source with
2324
- # the existing credentials. If the `AlternateDataSourceParameters`
2325
- # list is null, the `DataSourceParameters` originally used with these
2326
- # `Credentials` is automatically allowed.
2696
+ # or update request. The API operation compares the
2697
+ # `DataSourceParameters` structure that's in the request with the
2698
+ # structures in the `AlternateDataSourceParameters` allowlist. If the
2699
+ # structures are an exact match, the request is allowed to use the new
2700
+ # data source with the existing credentials. If the
2701
+ # `AlternateDataSourceParameters` list is null, the
2702
+ # `DataSourceParameters` originally used with these `Credentials` is
2703
+ # automatically allowed.
2327
2704
  # @return [Array<Types::DataSourceParameters>]
2328
2705
  #
2329
2706
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CredentialPair AWS API Documentation
@@ -2631,11 +3008,11 @@ module Aws::QuickSight
2631
3008
  # @return [Time]
2632
3009
  #
2633
3010
  # @!attribute [rw] errors
2634
- # Errors.
3011
+ # Errors associated with this dashboard version.
2635
3012
  # @return [Array<Types::DashboardError>]
2636
3013
  #
2637
3014
  # @!attribute [rw] version_number
2638
- # Version number.
3015
+ # Version number for this version of the dashboard.
2639
3016
  # @return [Integer]
2640
3017
  #
2641
3018
  # @!attribute [rw] status
@@ -2652,13 +3029,17 @@ module Aws::QuickSight
2652
3029
  #
2653
3030
  # @!attribute [rw] data_set_arns
2654
3031
  # The Amazon Resource Numbers (ARNs) for the datasets that are
2655
- # associated with a version of the dashboard.
3032
+ # associated with this version of the dashboard.
2656
3033
  # @return [Array<String>]
2657
3034
  #
2658
3035
  # @!attribute [rw] description
2659
3036
  # Description.
2660
3037
  # @return [String]
2661
3038
  #
3039
+ # @!attribute [rw] theme_arn
3040
+ # The ARN of the theme associated with a version of the dashboard.
3041
+ # @return [String]
3042
+ #
2662
3043
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DashboardVersion AWS API Documentation
2663
3044
  #
2664
3045
  class DashboardVersion < Struct.new(
@@ -2669,7 +3050,8 @@ module Aws::QuickSight
2669
3050
  :arn,
2670
3051
  :source_entity_arn,
2671
3052
  :data_set_arns,
2672
- :description)
3053
+ :description,
3054
+ :theme_arn)
2673
3055
  SENSITIVE = []
2674
3056
  include Aws::Structure
2675
3057
  end
@@ -2975,12 +3357,12 @@ module Aws::QuickSight
2975
3357
  # A set of alternate data source parameters that you want to share for
2976
3358
  # the credentials stored with this data source. The credentials are
2977
3359
  # applied in tandem with the data source parameters when you copy a
2978
- # data source by using a create or update request. The API compares
2979
- # the `DataSourceParameters` structure that's in the request with the
2980
- # structures in the `AlternateDataSourceParameters` allowlist. If the
2981
- # structures are an exact match, the request is allowed to use the
2982
- # credentials from this existing data source. If the
2983
- # `AlternateDataSourceParameters` list is null, the `Credentials`
3360
+ # data source by using a create or update request. The API operation
3361
+ # compares the `DataSourceParameters` structure that's in the request
3362
+ # with the structures in the `AlternateDataSourceParameters`
3363
+ # allowlist. If the structures are an exact match, the request is
3364
+ # allowed to use the credentials from this existing data source. If
3365
+ # the `AlternateDataSourceParameters` list is null, the `Credentials`
2984
3366
  # originally used with this `DataSourceParameters` are automatically
2985
3367
  # allowed.
2986
3368
  # @return [Array<Types::DataSourceParameters>]
@@ -3357,7 +3739,7 @@ module Aws::QuickSight
3357
3739
  include Aws::Structure
3358
3740
  end
3359
3741
 
3360
- # Date time parameter.
3742
+ # A date-time parameter.
3361
3743
  #
3362
3744
  # @note When making an API call, you may pass DateTimeParameter
3363
3745
  # data as a hash:
@@ -3368,11 +3750,11 @@ module Aws::QuickSight
3368
3750
  # }
3369
3751
  #
3370
3752
  # @!attribute [rw] name
3371
- # A display name for the dataset.
3753
+ # A display name for the date-time parameter.
3372
3754
  # @return [String]
3373
3755
  #
3374
3756
  # @!attribute [rw] values
3375
- # Values.
3757
+ # The values for the date-time parameter.
3376
3758
  # @return [Array<Time>]
3377
3759
  #
3378
3760
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DateTimeParameter AWS API Documentation
@@ -3384,7 +3766,7 @@ module Aws::QuickSight
3384
3766
  include Aws::Structure
3385
3767
  end
3386
3768
 
3387
- # Decimal parameter.
3769
+ # A decimal parameter.
3388
3770
  #
3389
3771
  # @note When making an API call, you may pass DecimalParameter
3390
3772
  # data as a hash:
@@ -3395,11 +3777,11 @@ module Aws::QuickSight
3395
3777
  # }
3396
3778
  #
3397
3779
  # @!attribute [rw] name
3398
- # A display name for the dataset.
3780
+ # A display name for the decimal parameter.
3399
3781
  # @return [String]
3400
3782
  #
3401
3783
  # @!attribute [rw] values
3402
- # Values.
3784
+ # The values for the decimal parameter.
3403
3785
  # @return [Array<Float>]
3404
3786
  #
3405
3787
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DecimalParameter AWS API Documentation
@@ -3421,12 +3803,12 @@ module Aws::QuickSight
3421
3803
  #
3422
3804
  # @!attribute [rw] aws_account_id
3423
3805
  # The ID for the AWS account that you want to delete QuickSight
3424
- # customizations from.
3806
+ # customizations from in this AWS Region.
3425
3807
  # @return [String]
3426
3808
  #
3427
3809
  # @!attribute [rw] namespace
3428
- # The namespace associated with the customization that you're
3429
- # deleting.
3810
+ # The QuickSight namespace that you're deleting the customizations
3811
+ # from.
3430
3812
  # @return [String]
3431
3813
  #
3432
3814
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomizationRequest AWS API Documentation
@@ -3455,6 +3837,81 @@ module Aws::QuickSight
3455
3837
  include Aws::Structure
3456
3838
  end
3457
3839
 
3840
+ # @note When making an API call, you may pass DeleteAnalysisRequest
3841
+ # data as a hash:
3842
+ #
3843
+ # {
3844
+ # aws_account_id: "AwsAccountId", # required
3845
+ # analysis_id: "RestrictiveResourceId", # required
3846
+ # recovery_window_in_days: 1,
3847
+ # force_delete_without_recovery: false,
3848
+ # }
3849
+ #
3850
+ # @!attribute [rw] aws_account_id
3851
+ # The ID of the AWS account where you want to delete an analysis.
3852
+ # @return [String]
3853
+ #
3854
+ # @!attribute [rw] analysis_id
3855
+ # The ID of the analysis that you're deleting.
3856
+ # @return [String]
3857
+ #
3858
+ # @!attribute [rw] recovery_window_in_days
3859
+ # A value that specifies the number of days that QuickSight waits
3860
+ # before it deletes the analysis. You can't use this parameter with
3861
+ # the `ForceDeleteWithoutRecovery` option in the same API call. The
3862
+ # default value is 30.
3863
+ # @return [Integer]
3864
+ #
3865
+ # @!attribute [rw] force_delete_without_recovery
3866
+ # This option defaults to the value `NoForceDeleteWithoutRecovery`. To
3867
+ # immediately delete the analysis, add the
3868
+ # `ForceDeleteWithoutRecovery` option. You can't restore an analysis
3869
+ # after it's deleted.
3870
+ # @return [Boolean]
3871
+ #
3872
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysisRequest AWS API Documentation
3873
+ #
3874
+ class DeleteAnalysisRequest < Struct.new(
3875
+ :aws_account_id,
3876
+ :analysis_id,
3877
+ :recovery_window_in_days,
3878
+ :force_delete_without_recovery)
3879
+ SENSITIVE = []
3880
+ include Aws::Structure
3881
+ end
3882
+
3883
+ # @!attribute [rw] status
3884
+ # The HTTP status of the request.
3885
+ # @return [Integer]
3886
+ #
3887
+ # @!attribute [rw] arn
3888
+ # The Amazon Resource Name (ARN) of the deleted analysis.
3889
+ # @return [String]
3890
+ #
3891
+ # @!attribute [rw] analysis_id
3892
+ # The ID of the deleted analysis.
3893
+ # @return [String]
3894
+ #
3895
+ # @!attribute [rw] deletion_time
3896
+ # The date and time that the analysis is scheduled to be deleted.
3897
+ # @return [Time]
3898
+ #
3899
+ # @!attribute [rw] request_id
3900
+ # The AWS request ID for this operation.
3901
+ # @return [String]
3902
+ #
3903
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysisResponse AWS API Documentation
3904
+ #
3905
+ class DeleteAnalysisResponse < Struct.new(
3906
+ :status,
3907
+ :arn,
3908
+ :analysis_id,
3909
+ :deletion_time,
3910
+ :request_id)
3911
+ SENSITIVE = []
3912
+ include Aws::Structure
3913
+ end
3914
+
3458
3915
  # @note When making an API call, you may pass DeleteDashboardRequest
3459
3916
  # data as a hash:
3460
3917
  #
@@ -4196,14 +4653,17 @@ module Aws::QuickSight
4196
4653
  # @return [String]
4197
4654
  #
4198
4655
  # @!attribute [rw] namespace
4199
- # The namespace associated with the customization that you're
4200
- # describing.
4656
+ # The QuickSight namespace that you want to describe QuickSight
4657
+ # customizations for.
4201
4658
  # @return [String]
4202
4659
  #
4203
4660
  # @!attribute [rw] resolved
4204
- # The status of the creation of the customization. This is an
4205
- # asynchronous process. A status of `CREATED` means that your
4206
- # customization is ready to use.
4661
+ # The `Resolved` flag works with the other parameters to determine
4662
+ # which view of QuickSight customizations is returned. You can add
4663
+ # this flag to your command to use the same view that QuickSight uses
4664
+ # to identify which customizations to apply to the console. Omit this
4665
+ # flag, or set it to `no-resolved`, to reveal customizations that are
4666
+ # configured at different levels.
4207
4667
  # @return [Boolean]
4208
4668
  #
4209
4669
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationRequest AWS API Documentation
@@ -4217,17 +4677,15 @@ module Aws::QuickSight
4217
4677
  end
4218
4678
 
4219
4679
  # @!attribute [rw] aws_account_id
4220
- # The ID for the AWS account that you want to describe QuickSight
4221
- # customizations for.
4680
+ # The ID for the AWS account that you're describing.
4222
4681
  # @return [String]
4223
4682
  #
4224
4683
  # @!attribute [rw] namespace
4225
- # The namespace associated with the customization that you're
4226
- # describing.
4684
+ # The QuickSight namespace that you're describing.
4227
4685
  # @return [String]
4228
4686
  #
4229
4687
  # @!attribute [rw] account_customization
4230
- # The customizations associated with QuickSight.
4688
+ # The QuickSight customizations that exist in the current AWS Region.
4231
4689
  # @return [Types::AccountCustomization]
4232
4690
  #
4233
4691
  # @!attribute [rw] request_id
@@ -4258,8 +4716,8 @@ module Aws::QuickSight
4258
4716
  # }
4259
4717
  #
4260
4718
  # @!attribute [rw] aws_account_id
4261
- # The ID for the AWS account that contains the QuickSight namespaces
4262
- # that you want to list.
4719
+ # The ID for the AWS account that contains the settings that you want
4720
+ # to list.
4263
4721
  # @return [String]
4264
4722
  #
4265
4723
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettingsRequest AWS API Documentation
@@ -4271,13 +4729,15 @@ module Aws::QuickSight
4271
4729
  end
4272
4730
 
4273
4731
  # @!attribute [rw] account_settings
4274
- # The settings associated with the QuickSight subscription associated
4275
- # with this AWS account. This information includes the edition of
4276
- # Amazon QuickSight that you subscribed to (Standard or Enterprise)
4277
- # and the notification email for the QuickSight subscription. The
4278
- # QuickSight console, the QuickSight subscription is sometimes
4279
- # referred to as a QuickSight "account" even though it is
4280
- # technically not an account, but a subscription in your AWS account.
4732
+ # The QuickSight settings for this AWS account. This information
4733
+ # includes the edition of Amazon QuickSight that you subscribed to
4734
+ # (Standard or Enterprise) and the notification email for the
4735
+ # QuickSight subscription. The QuickSight console, the QuickSight
4736
+ # subscription is sometimes referred to as a QuickSight "account"
4737
+ # even though it's technically not an account by itself. Instead,
4738
+ # it's a subscription to the QuickSight service for your AWS account.
4739
+ # The edition that you subscribe to applies to QuickSight in every AWS
4740
+ # Region where you use it.
4281
4741
  # @return [Types::AccountSettings]
4282
4742
  #
4283
4743
  # @!attribute [rw] request_id
@@ -4298,6 +4758,118 @@ module Aws::QuickSight
4298
4758
  include Aws::Structure
4299
4759
  end
4300
4760
 
4761
+ # @note When making an API call, you may pass DescribeAnalysisPermissionsRequest
4762
+ # data as a hash:
4763
+ #
4764
+ # {
4765
+ # aws_account_id: "AwsAccountId", # required
4766
+ # analysis_id: "RestrictiveResourceId", # required
4767
+ # }
4768
+ #
4769
+ # @!attribute [rw] aws_account_id
4770
+ # The ID of the AWS account that contains the analysis whose
4771
+ # permissions you're describing. You must be using the AWS account
4772
+ # that the analysis is in.
4773
+ # @return [String]
4774
+ #
4775
+ # @!attribute [rw] analysis_id
4776
+ # The ID of the analysis whose permissions you're describing. The ID
4777
+ # is part of the analysis URL.
4778
+ # @return [String]
4779
+ #
4780
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissionsRequest AWS API Documentation
4781
+ #
4782
+ class DescribeAnalysisPermissionsRequest < Struct.new(
4783
+ :aws_account_id,
4784
+ :analysis_id)
4785
+ SENSITIVE = []
4786
+ include Aws::Structure
4787
+ end
4788
+
4789
+ # @!attribute [rw] analysis_id
4790
+ # The ID of the analysis whose permissions you're describing.
4791
+ # @return [String]
4792
+ #
4793
+ # @!attribute [rw] analysis_arn
4794
+ # The Amazon Resource Name (ARN) of the analysis whose permissions
4795
+ # you're describing.
4796
+ # @return [String]
4797
+ #
4798
+ # @!attribute [rw] permissions
4799
+ # A structure that describes the principals and the resource-level
4800
+ # permissions on an analysis.
4801
+ # @return [Array<Types::ResourcePermission>]
4802
+ #
4803
+ # @!attribute [rw] status
4804
+ # The HTTP status of the request.
4805
+ # @return [Integer]
4806
+ #
4807
+ # @!attribute [rw] request_id
4808
+ # The AWS request ID for this operation.
4809
+ # @return [String]
4810
+ #
4811
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissionsResponse AWS API Documentation
4812
+ #
4813
+ class DescribeAnalysisPermissionsResponse < Struct.new(
4814
+ :analysis_id,
4815
+ :analysis_arn,
4816
+ :permissions,
4817
+ :status,
4818
+ :request_id)
4819
+ SENSITIVE = []
4820
+ include Aws::Structure
4821
+ end
4822
+
4823
+ # @note When making an API call, you may pass DescribeAnalysisRequest
4824
+ # data as a hash:
4825
+ #
4826
+ # {
4827
+ # aws_account_id: "AwsAccountId", # required
4828
+ # analysis_id: "RestrictiveResourceId", # required
4829
+ # }
4830
+ #
4831
+ # @!attribute [rw] aws_account_id
4832
+ # The ID of the AWS account that contains the analysis. You must be
4833
+ # using the AWS account that the analysis is in.
4834
+ # @return [String]
4835
+ #
4836
+ # @!attribute [rw] analysis_id
4837
+ # The ID of the analysis that you're describing. The ID is part of
4838
+ # the URL of the analysis.
4839
+ # @return [String]
4840
+ #
4841
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisRequest AWS API Documentation
4842
+ #
4843
+ class DescribeAnalysisRequest < Struct.new(
4844
+ :aws_account_id,
4845
+ :analysis_id)
4846
+ SENSITIVE = []
4847
+ include Aws::Structure
4848
+ end
4849
+
4850
+ # @!attribute [rw] analysis
4851
+ # A metadata structure that contains summary information for the
4852
+ # analysis that you're describing.
4853
+ # @return [Types::Analysis]
4854
+ #
4855
+ # @!attribute [rw] status
4856
+ # The HTTP status of the request.
4857
+ # @return [Integer]
4858
+ #
4859
+ # @!attribute [rw] request_id
4860
+ # The AWS request ID for this operation.
4861
+ # @return [String]
4862
+ #
4863
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisResponse AWS API Documentation
4864
+ #
4865
+ class DescribeAnalysisResponse < Struct.new(
4866
+ :analysis,
4867
+ :status,
4868
+ :request_id)
4869
+ SENSITIVE = []
4870
+ include Aws::Structure
4871
+ end
4872
+
4301
4873
  # @note When making an API call, you may pass DescribeDashboardPermissionsRequest
4302
4874
  # data as a hash:
4303
4875
  #
@@ -4824,8 +5396,8 @@ module Aws::QuickSight
4824
5396
  # response includes the namespace ARN, name, AWS Region, creation
4825
5397
  # status, and identity store. `DescribeNamespace` also works for
4826
5398
  # namespaces that are in the process of being created. For incomplete
4827
- # namespaces, this API lists the namespace error types and messages
4828
- # associated with the creation process.
5399
+ # namespaces, this API operation lists the namespace error types and
5400
+ # messages associated with the creation process.
4829
5401
  # @return [Types::NamespaceInfoV2]
4830
5402
  #
4831
5403
  # @!attribute [rw] request_id
@@ -5430,6 +6002,9 @@ module Aws::QuickSight
5430
6002
  # * IAM users and IAM role-based sessions authenticated through
5431
6003
  # Federated Single Sign-On using SAML, OpenID Connect, or IAM
5432
6004
  # federation.
6005
+ #
6006
+ # Omit this parameter for users in the third group – IAM users and IAM
6007
+ # role-based sessions.
5433
6008
  # @return [String]
5434
6009
  #
5435
6010
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest AWS API Documentation
@@ -5449,8 +6024,9 @@ module Aws::QuickSight
5449
6024
  # @!attribute [rw] embed_url
5450
6025
  # A single-use URL that you can put into your server-side webpage to
5451
6026
  # embed your dashboard. This URL is valid for 5 minutes. The API
5452
- # provides the URL with an `auth_code` value that enables one (and
5453
- # only one) sign-on to a user session that is valid for 10 hours.
6027
+ # operation provides the URL with an `auth_code` value that enables
6028
+ # one (and only one) sign-on to a user session that is valid for 10
6029
+ # hours.
5454
6030
  # @return [String]
5455
6031
  #
5456
6032
  # @!attribute [rw] status
@@ -5482,12 +6058,27 @@ module Aws::QuickSight
5482
6058
  # }
5483
6059
  #
5484
6060
  # @!attribute [rw] aws_account_id
5485
- # The ID for the AWS account that contains the QuickSight session that
5486
- # you're embedding.
6061
+ # The ID for the AWS account associated with your QuickSight
6062
+ # subscription.
5487
6063
  # @return [String]
5488
6064
  #
5489
6065
  # @!attribute [rw] entry_point
5490
- # The entry point for the embedded session.
6066
+ # The URL you use to access the embedded session. The entry point URL
6067
+ # is constrained to the following paths:
6068
+ #
6069
+ # * `/start`
6070
+ #
6071
+ # * `/start/analyses`
6072
+ #
6073
+ # * `/start/dashboards`
6074
+ #
6075
+ # * `/start/favorites`
6076
+ #
6077
+ # * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
6078
+ # key from the QuickSight console URL of the dashboard
6079
+ #
6080
+ # * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
6081
+ # from the QuickSight console URL of the analysis
5491
6082
  # @return [String]
5492
6083
  #
5493
6084
  # @!attribute [rw] session_lifetime_in_minutes
@@ -5497,17 +6088,20 @@ module Aws::QuickSight
5497
6088
  #
5498
6089
  # @!attribute [rw] user_arn
5499
6090
  # The Amazon QuickSight user's Amazon Resource Name (ARN), for use
5500
- # with `QUICKSIGHT` identity type. You can use this for any Amazon
5501
- # QuickSight users in your account (readers, authors, or admins)
5502
- # authenticated as one of the following:
6091
+ # with `QUICKSIGHT` identity type. You can use this for any type of
6092
+ # Amazon QuickSight users in your account (readers, authors, or
6093
+ # admins). They need to be authenticated as one of the following:
5503
6094
  #
5504
- # * Active Directory (AD) users or group members
6095
+ # 1. Active Directory (AD) users or group members
5505
6096
  #
5506
- # * Invited nonfederated users
6097
+ # 2. Invited nonfederated users
5507
6098
  #
5508
- # * IAM users and IAM role-based sessions authenticated through
5509
- # Federated Single Sign-On using SAML, OpenID Connect, or IAM
5510
- # federation.
6099
+ # 3. IAM users and IAM role-based sessions authenticated through
6100
+ # Federated Single Sign-On using SAML, OpenID Connect, or IAM
6101
+ # federation
6102
+ #
6103
+ # Omit this parameter for users in the third group – IAM users and IAM
6104
+ # role-based sessions.
5511
6105
  # @return [String]
5512
6106
  #
5513
6107
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrlRequest AWS API Documentation
@@ -5524,8 +6118,9 @@ module Aws::QuickSight
5524
6118
  # @!attribute [rw] embed_url
5525
6119
  # A single-use URL that you can put into your server-side web page to
5526
6120
  # embed your QuickSight session. This URL is valid for 5 minutes. The
5527
- # API provides the URL with an `auth_code` value that enables one (and
5528
- # only one) sign-on to a user session that is valid for 10 hours.
6121
+ # API operation provides the URL with an `auth_code` value that
6122
+ # enables one (and only one) sign-on to a user session that is valid
6123
+ # for 10 hours.
5529
6124
  # @return [String]
5530
6125
  #
5531
6126
  # @!attribute [rw] status
@@ -5547,9 +6142,7 @@ module Aws::QuickSight
5547
6142
  end
5548
6143
 
5549
6144
  # A *group* in Amazon QuickSight consists of a set of users. You can use
5550
- # groups to make it easier to manage access and security. Currently, an
5551
- # Amazon QuickSight subscription can't contain more than 500 Amazon
5552
- # QuickSight groups.
6145
+ # groups to make it easier to manage access and security.
5553
6146
  #
5554
6147
  # @!attribute [rw] arn
5555
6148
  # The Amazon Resource Name (ARN) for the group.
@@ -5789,7 +6382,7 @@ module Aws::QuickSight
5789
6382
  include Aws::Structure
5790
6383
  end
5791
6384
 
5792
- # Integer parameter.
6385
+ # An integer parameter.
5793
6386
  #
5794
6387
  # @note When making an API call, you may pass IntegerParameter
5795
6388
  # data as a hash:
@@ -5800,11 +6393,11 @@ module Aws::QuickSight
5800
6393
  # }
5801
6394
  #
5802
6395
  # @!attribute [rw] name
5803
- # A display name for the dataset.
6396
+ # The name of the integer parameter.
5804
6397
  # @return [String]
5805
6398
  #
5806
6399
  # @!attribute [rw] values
5807
- # Values.
6400
+ # The values for the integer parameter.
5808
6401
  # @return [Array<Integer>]
5809
6402
  #
5810
6403
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/IntegerParameter AWS API Documentation
@@ -5953,6 +6546,64 @@ module Aws::QuickSight
5953
6546
  include Aws::Structure
5954
6547
  end
5955
6548
 
6549
+ # @note When making an API call, you may pass ListAnalysesRequest
6550
+ # data as a hash:
6551
+ #
6552
+ # {
6553
+ # aws_account_id: "AwsAccountId", # required
6554
+ # next_token: "String",
6555
+ # max_results: 1,
6556
+ # }
6557
+ #
6558
+ # @!attribute [rw] aws_account_id
6559
+ # The ID of the AWS account that contains the analyses.
6560
+ # @return [String]
6561
+ #
6562
+ # @!attribute [rw] next_token
6563
+ # A pagination token that can be used in a subsequent request.
6564
+ # @return [String]
6565
+ #
6566
+ # @!attribute [rw] max_results
6567
+ # The maximum number of results to return.
6568
+ # @return [Integer]
6569
+ #
6570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalysesRequest AWS API Documentation
6571
+ #
6572
+ class ListAnalysesRequest < Struct.new(
6573
+ :aws_account_id,
6574
+ :next_token,
6575
+ :max_results)
6576
+ SENSITIVE = []
6577
+ include Aws::Structure
6578
+ end
6579
+
6580
+ # @!attribute [rw] analysis_summary_list
6581
+ # Metadata describing each of the analyses that are listed.
6582
+ # @return [Array<Types::AnalysisSummary>]
6583
+ #
6584
+ # @!attribute [rw] next_token
6585
+ # A pagination token that can be used in a subsequent request.
6586
+ # @return [String]
6587
+ #
6588
+ # @!attribute [rw] status
6589
+ # The HTTP status of the request.
6590
+ # @return [Integer]
6591
+ #
6592
+ # @!attribute [rw] request_id
6593
+ # The AWS request ID for this operation.
6594
+ # @return [String]
6595
+ #
6596
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalysesResponse AWS API Documentation
6597
+ #
6598
+ class ListAnalysesResponse < Struct.new(
6599
+ :analysis_summary_list,
6600
+ :next_token,
6601
+ :status,
6602
+ :request_id)
6603
+ SENSITIVE = []
6604
+ include Aws::Structure
6605
+ end
6606
+
5956
6607
  # @note When making an API call, you may pass ListDashboardVersionsRequest
5957
6608
  # data as a hash:
5958
6609
  #
@@ -7472,7 +8123,7 @@ module Aws::QuickSight
7472
8123
  # @return [String]
7473
8124
  #
7474
8125
  # @!attribute [rw] namespace_error
7475
- # An error that occured when the namespace was created.
8126
+ # An error that occurred when the namespace was created.
7476
8127
  # @return [Types::NamespaceError]
7477
8128
  #
7478
8129
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NamespaceInfoV2 AWS API Documentation
@@ -7507,7 +8158,7 @@ module Aws::QuickSight
7507
8158
  include Aws::Structure
7508
8159
  end
7509
8160
 
7510
- # Parameters.
8161
+ # A list of QuickSight parameters and the list's override values.
7511
8162
  #
7512
8163
  # @note When making an API call, you may pass Parameters
7513
8164
  # data as a hash:
@@ -7552,7 +8203,7 @@ module Aws::QuickSight
7552
8203
  # @return [Array<Types::DecimalParameter>]
7553
8204
  #
7554
8205
  # @!attribute [rw] date_time_parameters
7555
- # DateTime parameters.
8206
+ # Date-time parameters.
7556
8207
  # @return [Array<Types::DateTimeParameter>]
7557
8208
  #
7558
8209
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Parameters AWS API Documentation
@@ -7938,23 +8589,31 @@ module Aws::QuickSight
7938
8589
  #
7939
8590
  # @!attribute [rw] custom_permissions_name
7940
8591
  # (Enterprise edition only) The name of the custom permissions profile
7941
- # that you want to assign to this user. Currently, custom permissions
7942
- # profile names are assigned to permissions profiles in the QuickSight
7943
- # console. You use this API to assign the named set of permissions to
7944
- # a QuickSight user.
8592
+ # that you want to assign to this user. Customized permissions allows
8593
+ # you to control a user's access by restricting access the following
8594
+ # operations:
8595
+ #
8596
+ # * Create and update data sources
7945
8597
  #
7946
- # Customizing permissions in the QuickSight UI allows you to control a
7947
- # user's access to the following operations:
8598
+ # * Create and update datasets
7948
8599
  #
7949
- # *
7950
- # *
7951
- # *
7952
- # *
8600
+ # * Create and update email reports
8601
+ #
8602
+ # * Subscribe to email reports
8603
+ #
8604
+ # To add custom permissions to an existing user, use ` UpdateUser `
8605
+ # instead.
8606
+ #
8607
+ # A set of custom permissions includes any combination of these
8608
+ # restrictions. Currently, you need to create the profile names for
8609
+ # custom permission sets by using the QuickSight console. Then, you
8610
+ # use the `RegisterUser` API operation to assign the named set of
8611
+ # permissions to a QuickSight user.
7953
8612
  #
7954
8613
  # QuickSight custom permissions are applied through IAM policies.
7955
8614
  # Therefore, they override the permissions typically granted by
7956
- # assigning QuickSight users to one of the default security cohorts
7957
- # (admin, author, reader) in QuickSight.
8615
+ # assigning QuickSight users to one of the default security cohorts in
8616
+ # QuickSight (admin, author, reader).
7958
8617
  #
7959
8618
  # This feature is available only to QuickSight Enterprise edition
7960
8619
  # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
@@ -7978,7 +8637,7 @@ module Aws::QuickSight
7978
8637
  end
7979
8638
 
7980
8639
  # @!attribute [rw] user
7981
- # The user name.
8640
+ # The user's user name.
7982
8641
  # @return [Types::User]
7983
8642
  #
7984
8643
  # @!attribute [rw] user_invitation_url
@@ -8147,7 +8806,7 @@ module Aws::QuickSight
8147
8806
  # @return [String]
8148
8807
  #
8149
8808
  # @!attribute [rw] actions
8150
- # The action to grant or revoke permissions on, for example
8809
+ # The IAM action to grant or revoke permissions on, for example
8151
8810
  # `"quicksight:DescribeDashboard"`.
8152
8811
  # @return [Array<String>]
8153
8812
  #
@@ -8162,22 +8821,75 @@ module Aws::QuickSight
8162
8821
 
8163
8822
  # This resource is currently unavailable.
8164
8823
  #
8165
- # @!attribute [rw] message
8824
+ # @!attribute [rw] message
8825
+ # @return [String]
8826
+ #
8827
+ # @!attribute [rw] resource_type
8828
+ # The resource type for this request.
8829
+ # @return [String]
8830
+ #
8831
+ # @!attribute [rw] request_id
8832
+ # The AWS request ID for this request.
8833
+ # @return [String]
8834
+ #
8835
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourceUnavailableException AWS API Documentation
8836
+ #
8837
+ class ResourceUnavailableException < Struct.new(
8838
+ :message,
8839
+ :resource_type,
8840
+ :request_id)
8841
+ SENSITIVE = []
8842
+ include Aws::Structure
8843
+ end
8844
+
8845
+ # @note When making an API call, you may pass RestoreAnalysisRequest
8846
+ # data as a hash:
8847
+ #
8848
+ # {
8849
+ # aws_account_id: "AwsAccountId", # required
8850
+ # analysis_id: "RestrictiveResourceId", # required
8851
+ # }
8852
+ #
8853
+ # @!attribute [rw] aws_account_id
8854
+ # The ID of the AWS account that contains the analysis.
8855
+ # @return [String]
8856
+ #
8857
+ # @!attribute [rw] analysis_id
8858
+ # The ID of the analysis that you're restoring.
8859
+ # @return [String]
8860
+ #
8861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysisRequest AWS API Documentation
8862
+ #
8863
+ class RestoreAnalysisRequest < Struct.new(
8864
+ :aws_account_id,
8865
+ :analysis_id)
8866
+ SENSITIVE = []
8867
+ include Aws::Structure
8868
+ end
8869
+
8870
+ # @!attribute [rw] status
8871
+ # The HTTP status of the request.
8872
+ # @return [Integer]
8873
+ #
8874
+ # @!attribute [rw] arn
8875
+ # The Amazon Resource Name (ARN) of the analysis that you're
8876
+ # restoring.
8166
8877
  # @return [String]
8167
8878
  #
8168
- # @!attribute [rw] resource_type
8169
- # The resource type for this request.
8879
+ # @!attribute [rw] analysis_id
8880
+ # The ID of the analysis that you're restoring.
8170
8881
  # @return [String]
8171
8882
  #
8172
8883
  # @!attribute [rw] request_id
8173
- # The AWS request ID for this request.
8884
+ # The AWS request ID for this operation.
8174
8885
  # @return [String]
8175
8886
  #
8176
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ResourceUnavailableException AWS API Documentation
8887
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysisResponse AWS API Documentation
8177
8888
  #
8178
- class ResourceUnavailableException < Struct.new(
8179
- :message,
8180
- :resource_type,
8889
+ class RestoreAnalysisResponse < Struct.new(
8890
+ :status,
8891
+ :arn,
8892
+ :analysis_id,
8181
8893
  :request_id)
8182
8894
  SENSITIVE = []
8183
8895
  include Aws::Structure
@@ -8304,6 +9016,78 @@ module Aws::QuickSight
8304
9016
  include Aws::Structure
8305
9017
  end
8306
9018
 
9019
+ # @note When making an API call, you may pass SearchAnalysesRequest
9020
+ # data as a hash:
9021
+ #
9022
+ # {
9023
+ # aws_account_id: "AwsAccountId", # required
9024
+ # filters: [ # required
9025
+ # {
9026
+ # operator: "StringEquals", # accepts StringEquals
9027
+ # name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
9028
+ # value: "String",
9029
+ # },
9030
+ # ],
9031
+ # next_token: "String",
9032
+ # max_results: 1,
9033
+ # }
9034
+ #
9035
+ # @!attribute [rw] aws_account_id
9036
+ # The ID of the AWS account that contains the analyses that you're
9037
+ # searching for.
9038
+ # @return [String]
9039
+ #
9040
+ # @!attribute [rw] filters
9041
+ # The structure for the search filters that you want to apply to your
9042
+ # search.
9043
+ # @return [Array<Types::AnalysisSearchFilter>]
9044
+ #
9045
+ # @!attribute [rw] next_token
9046
+ # A pagination token that can be used in a subsequent request.
9047
+ # @return [String]
9048
+ #
9049
+ # @!attribute [rw] max_results
9050
+ # The maximum number of results to return.
9051
+ # @return [Integer]
9052
+ #
9053
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalysesRequest AWS API Documentation
9054
+ #
9055
+ class SearchAnalysesRequest < Struct.new(
9056
+ :aws_account_id,
9057
+ :filters,
9058
+ :next_token,
9059
+ :max_results)
9060
+ SENSITIVE = []
9061
+ include Aws::Structure
9062
+ end
9063
+
9064
+ # @!attribute [rw] analysis_summary_list
9065
+ # Metadata describing the analyses that you searched for.
9066
+ # @return [Array<Types::AnalysisSummary>]
9067
+ #
9068
+ # @!attribute [rw] next_token
9069
+ # A pagination token that can be used in a subsequent request.
9070
+ # @return [String]
9071
+ #
9072
+ # @!attribute [rw] status
9073
+ # The HTTP status of the request.
9074
+ # @return [Integer]
9075
+ #
9076
+ # @!attribute [rw] request_id
9077
+ # The AWS request ID for this operation.
9078
+ # @return [String]
9079
+ #
9080
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalysesResponse AWS API Documentation
9081
+ #
9082
+ class SearchAnalysesResponse < Struct.new(
9083
+ :analysis_summary_list,
9084
+ :next_token,
9085
+ :status,
9086
+ :request_id)
9087
+ SENSITIVE = []
9088
+ include Aws::Structure
9089
+ end
9090
+
8307
9091
  # @note When making an API call, you may pass SearchDashboardsRequest
8308
9092
  # data as a hash:
8309
9093
  #
@@ -8595,7 +9379,7 @@ module Aws::QuickSight
8595
9379
  include Aws::Structure
8596
9380
  end
8597
9381
 
8598
- # String parameter.
9382
+ # A string parameter.
8599
9383
  #
8600
9384
  # @note When making an API call, you may pass StringParameter
8601
9385
  # data as a hash:
@@ -8606,11 +9390,11 @@ module Aws::QuickSight
8606
9390
  # }
8607
9391
  #
8608
9392
  # @!attribute [rw] name
8609
- # A display name for the dataset.
9393
+ # A display name for a string parameter.
8610
9394
  # @return [String]
8611
9395
  #
8612
9396
  # @!attribute [rw] values
8613
- # Values.
9397
+ # The values of a string parameter.
8614
9398
  # @return [Array<String>]
8615
9399
  #
8616
9400
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/StringParameter AWS API Documentation
@@ -8737,7 +9521,7 @@ module Aws::QuickSight
8737
9521
  # A template object. A *template* is an entity in QuickSight that
8738
9522
  # encapsulates the metadata required to create an analysis and that you
8739
9523
  # can use to create a dashboard. A template adds a layer of abstraction
8740
- # by using placeholders to replace the dataset associated with the
9524
+ # by using placeholders to replace the dataset associated with an
8741
9525
  # analysis. You can use templates to create dashboards by replacing
8742
9526
  # dataset placeholders with datasets that follow the same schema that
8743
9527
  # was used to create the source analysis and template.
@@ -8967,11 +9751,11 @@ module Aws::QuickSight
8967
9751
  # @return [Time]
8968
9752
  #
8969
9753
  # @!attribute [rw] errors
8970
- # Errors associated with the template.
9754
+ # Errors associated with this template version.
8971
9755
  # @return [Array<Types::TemplateError>]
8972
9756
  #
8973
9757
  # @!attribute [rw] version_number
8974
- # The version number of the template.
9758
+ # The version number of the template version.
8975
9759
  # @return [Integer]
8976
9760
  #
8977
9761
  # @!attribute [rw] status
@@ -8979,9 +9763,9 @@ module Aws::QuickSight
8979
9763
  # @return [String]
8980
9764
  #
8981
9765
  # @!attribute [rw] data_set_configurations
8982
- # Schema of the dataset identified by the placeholder. The idea is
8983
- # that any dashboard created from the template should be bound to new
8984
- # datasets matching the same schema described through this API. .
9766
+ # Schema of the dataset identified by the placeholder. Any dashboard
9767
+ # created from this template should be bound to new datasets matching
9768
+ # the same schema described through this API operation.
8985
9769
  # @return [Array<Types::DataSetConfiguration>]
8986
9770
  #
8987
9771
  # @!attribute [rw] description
@@ -8989,10 +9773,14 @@ module Aws::QuickSight
8989
9773
  # @return [String]
8990
9774
  #
8991
9775
  # @!attribute [rw] source_entity_arn
8992
- # The Amazon Resource Name (ARN) of the analysis or template which was
9776
+ # The Amazon Resource Name (ARN) of an analysis or template that was
8993
9777
  # used to create this template.
8994
9778
  # @return [String]
8995
9779
  #
9780
+ # @!attribute [rw] theme_arn
9781
+ # The ARN of the theme associated with this version of the template.
9782
+ # @return [String]
9783
+ #
8996
9784
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TemplateVersion AWS API Documentation
8997
9785
  #
8998
9786
  class TemplateVersion < Struct.new(
@@ -9002,7 +9790,8 @@ module Aws::QuickSight
9002
9790
  :status,
9003
9791
  :data_set_configurations,
9004
9792
  :description,
9005
- :source_entity_arn)
9793
+ :source_entity_arn,
9794
+ :theme_arn)
9006
9795
  SENSITIVE = []
9007
9796
  include Aws::Structure
9008
9797
  end
@@ -9074,6 +9863,8 @@ module Aws::QuickSight
9074
9863
  include Aws::Structure
9075
9864
  end
9076
9865
 
9866
+ # Summary information about a theme.
9867
+ #
9077
9868
  # @!attribute [rw] arn
9078
9869
  # The Amazon Resource Name (ARN) of the theme.
9079
9870
  # @return [String]
@@ -9752,12 +10543,12 @@ module Aws::QuickSight
9752
10543
  # @return [String]
9753
10544
  #
9754
10545
  # @!attribute [rw] namespace
9755
- # The namespace associated with the customization that you're
9756
- # updating.
10546
+ # The namespace that you want to update QuickSight customizations for.
9757
10547
  # @return [String]
9758
10548
  #
9759
10549
  # @!attribute [rw] account_customization
9760
- # The customizations you want to update in QuickSight.
10550
+ # The QuickSight customizations you're updating in the current AWS
10551
+ # Region.
9761
10552
  # @return [Types::AccountCustomization]
9762
10553
  #
9763
10554
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
@@ -9781,7 +10572,8 @@ module Aws::QuickSight
9781
10572
  # @return [String]
9782
10573
  #
9783
10574
  # @!attribute [rw] account_customization
9784
- # The customizations associated with your QuickSight subscription.
10575
+ # The QuickSight customizations you're updating in the current AWS
10576
+ # Region.
9785
10577
  # @return [Types::AccountCustomization]
9786
10578
  #
9787
10579
  # @!attribute [rw] request_id
@@ -9814,7 +10606,7 @@ module Aws::QuickSight
9814
10606
  # }
9815
10607
  #
9816
10608
  # @!attribute [rw] aws_account_id
9817
- # The ID for the AWS account that contains the QuickSight namespaces
10609
+ # The ID for the AWS account that contains the QuickSight settings
9818
10610
  # that you want to list.
9819
10611
  # @return [String]
9820
10612
  #
@@ -9826,8 +10618,8 @@ module Aws::QuickSight
9826
10618
  # @return [String]
9827
10619
  #
9828
10620
  # @!attribute [rw] notification_email
9829
- # Email address used to send notifications regarding administration of
9830
- # QuickSight.
10621
+ # The email address that you want QuickSight to send notifications to
10622
+ # regarding your AWS account or QuickSight subscription.
9831
10623
  # @return [String]
9832
10624
  #
9833
10625
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsRequest AWS API Documentation
@@ -9857,6 +10649,216 @@ module Aws::QuickSight
9857
10649
  include Aws::Structure
9858
10650
  end
9859
10651
 
10652
+ # @note When making an API call, you may pass UpdateAnalysisPermissionsRequest
10653
+ # data as a hash:
10654
+ #
10655
+ # {
10656
+ # aws_account_id: "AwsAccountId", # required
10657
+ # analysis_id: "RestrictiveResourceId", # required
10658
+ # grant_permissions: [
10659
+ # {
10660
+ # principal: "Principal", # required
10661
+ # actions: ["String"], # required
10662
+ # },
10663
+ # ],
10664
+ # revoke_permissions: [
10665
+ # {
10666
+ # principal: "Principal", # required
10667
+ # actions: ["String"], # required
10668
+ # },
10669
+ # ],
10670
+ # }
10671
+ #
10672
+ # @!attribute [rw] aws_account_id
10673
+ # The ID of the AWS account that contains the analysis whose
10674
+ # permissions you're updating. You must be using the AWS account that
10675
+ # the analysis is in.
10676
+ # @return [String]
10677
+ #
10678
+ # @!attribute [rw] analysis_id
10679
+ # The ID of the analysis whose permissions you're updating. The ID is
10680
+ # part of the analysis URL.
10681
+ # @return [String]
10682
+ #
10683
+ # @!attribute [rw] grant_permissions
10684
+ # A structure that describes the permissions to add and the principal
10685
+ # to add them to.
10686
+ # @return [Array<Types::ResourcePermission>]
10687
+ #
10688
+ # @!attribute [rw] revoke_permissions
10689
+ # A structure that describes the permissions to remove and the
10690
+ # principal to remove them from.
10691
+ # @return [Array<Types::ResourcePermission>]
10692
+ #
10693
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissionsRequest AWS API Documentation
10694
+ #
10695
+ class UpdateAnalysisPermissionsRequest < Struct.new(
10696
+ :aws_account_id,
10697
+ :analysis_id,
10698
+ :grant_permissions,
10699
+ :revoke_permissions)
10700
+ SENSITIVE = []
10701
+ include Aws::Structure
10702
+ end
10703
+
10704
+ # @!attribute [rw] analysis_arn
10705
+ # The Amazon Resource Name (ARN) of the analysis that you updated.
10706
+ # @return [String]
10707
+ #
10708
+ # @!attribute [rw] analysis_id
10709
+ # The ID of the analysis that you updated permissions for.
10710
+ # @return [String]
10711
+ #
10712
+ # @!attribute [rw] permissions
10713
+ # A structure that describes the principals and the resource-level
10714
+ # permissions on an analysis.
10715
+ # @return [Array<Types::ResourcePermission>]
10716
+ #
10717
+ # @!attribute [rw] request_id
10718
+ # The AWS request ID for this operation.
10719
+ # @return [String]
10720
+ #
10721
+ # @!attribute [rw] status
10722
+ # The HTTP status of the request.
10723
+ # @return [Integer]
10724
+ #
10725
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissionsResponse AWS API Documentation
10726
+ #
10727
+ class UpdateAnalysisPermissionsResponse < Struct.new(
10728
+ :analysis_arn,
10729
+ :analysis_id,
10730
+ :permissions,
10731
+ :request_id,
10732
+ :status)
10733
+ SENSITIVE = []
10734
+ include Aws::Structure
10735
+ end
10736
+
10737
+ # @note When making an API call, you may pass UpdateAnalysisRequest
10738
+ # data as a hash:
10739
+ #
10740
+ # {
10741
+ # aws_account_id: "AwsAccountId", # required
10742
+ # analysis_id: "RestrictiveResourceId", # required
10743
+ # name: "AnalysisName", # required
10744
+ # parameters: {
10745
+ # string_parameters: [
10746
+ # {
10747
+ # name: "NonEmptyString", # required
10748
+ # values: ["String"], # required
10749
+ # },
10750
+ # ],
10751
+ # integer_parameters: [
10752
+ # {
10753
+ # name: "NonEmptyString", # required
10754
+ # values: [1], # required
10755
+ # },
10756
+ # ],
10757
+ # decimal_parameters: [
10758
+ # {
10759
+ # name: "NonEmptyString", # required
10760
+ # values: [1.0], # required
10761
+ # },
10762
+ # ],
10763
+ # date_time_parameters: [
10764
+ # {
10765
+ # name: "NonEmptyString", # required
10766
+ # values: [Time.now], # required
10767
+ # },
10768
+ # ],
10769
+ # },
10770
+ # source_entity: { # required
10771
+ # source_template: {
10772
+ # data_set_references: [ # required
10773
+ # {
10774
+ # data_set_placeholder: "NonEmptyString", # required
10775
+ # data_set_arn: "Arn", # required
10776
+ # },
10777
+ # ],
10778
+ # arn: "Arn", # required
10779
+ # },
10780
+ # },
10781
+ # theme_arn: "Arn",
10782
+ # }
10783
+ #
10784
+ # @!attribute [rw] aws_account_id
10785
+ # The ID of the AWS account that contains the analysis that you're
10786
+ # updating.
10787
+ # @return [String]
10788
+ #
10789
+ # @!attribute [rw] analysis_id
10790
+ # The ID for the analysis that you're updating. This ID displays in
10791
+ # the URL of the analysis.
10792
+ # @return [String]
10793
+ #
10794
+ # @!attribute [rw] name
10795
+ # A descriptive name for the analysis that you're updating. This name
10796
+ # displays for the analysis in the QuickSight console.
10797
+ # @return [String]
10798
+ #
10799
+ # @!attribute [rw] parameters
10800
+ # The parameter names and override values that you want to use. An
10801
+ # analysis can have any parameter type, and some parameters might
10802
+ # accept multiple values.
10803
+ # @return [Types::Parameters]
10804
+ #
10805
+ # @!attribute [rw] source_entity
10806
+ # A source entity to use for the analysis that you're updating. This
10807
+ # metadata structure contains details that describe a source template
10808
+ # and one or more datasets.
10809
+ # @return [Types::AnalysisSourceEntity]
10810
+ #
10811
+ # @!attribute [rw] theme_arn
10812
+ # The Amazon Resource Name (ARN) for the theme to apply to the
10813
+ # analysis that you're creating. To see the theme in the QuickSight
10814
+ # console, make sure that you have access to it.
10815
+ # @return [String]
10816
+ #
10817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisRequest AWS API Documentation
10818
+ #
10819
+ class UpdateAnalysisRequest < Struct.new(
10820
+ :aws_account_id,
10821
+ :analysis_id,
10822
+ :name,
10823
+ :parameters,
10824
+ :source_entity,
10825
+ :theme_arn)
10826
+ SENSITIVE = []
10827
+ include Aws::Structure
10828
+ end
10829
+
10830
+ # @!attribute [rw] arn
10831
+ # The ARN of the analysis that you're updating.
10832
+ # @return [String]
10833
+ #
10834
+ # @!attribute [rw] analysis_id
10835
+ # The ID of the analysis.
10836
+ # @return [String]
10837
+ #
10838
+ # @!attribute [rw] update_status
10839
+ # The update status of the last update that was made to the analysis.
10840
+ # @return [String]
10841
+ #
10842
+ # @!attribute [rw] status
10843
+ # The HTTP status of the request.
10844
+ # @return [Integer]
10845
+ #
10846
+ # @!attribute [rw] request_id
10847
+ # The AWS request ID for this operation.
10848
+ # @return [String]
10849
+ #
10850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisResponse AWS API Documentation
10851
+ #
10852
+ class UpdateAnalysisResponse < Struct.new(
10853
+ :arn,
10854
+ :analysis_id,
10855
+ :update_status,
10856
+ :status,
10857
+ :request_id)
10858
+ SENSITIVE = []
10859
+ include Aws::Structure
10860
+ end
10861
+
9860
10862
  # @note When making an API call, you may pass UpdateDashboardPermissionsRequest
9861
10863
  # data as a hash:
9862
10864
  #
@@ -10105,7 +11107,7 @@ module Aws::QuickSight
10105
11107
  #
10106
11108
  # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
10107
11109
  # either `ENABLED` or `DISABLED`. The visual option to export data
10108
- # to .csv format isn't enabled when this is set to `DISABLED`. This
11110
+ # to .CSV format isn't enabled when this is set to `DISABLED`. This
10109
11111
  # option is `ENABLED` by default.
10110
11112
  #
10111
11113
  # * `VisibilityState` for `SheetControlsOption` - This visibility
@@ -11544,8 +12546,8 @@ module Aws::QuickSight
11544
12546
  # @return [String]
11545
12547
  #
11546
12548
  # @!attribute [rw] role
11547
- # The Amazon QuickSight role of the user. The user role can be one of
11548
- # the following:
12549
+ # The Amazon QuickSight role of the user. The role can be one of the
12550
+ # following default security cohorts:
11549
12551
  #
11550
12552
  # * `READER`\: A user who has read-only access to dashboards.
11551
12553
  #
@@ -11554,14 +12556,39 @@ module Aws::QuickSight
11554
12556
  #
11555
12557
  # * `ADMIN`\: A user who is an author, who can also manage Amazon
11556
12558
  # QuickSight settings.
12559
+ #
12560
+ # The name of the QuickSight role is invisible to the user except for
12561
+ # the console screens dealing with permissions.
11557
12562
  # @return [String]
11558
12563
  #
11559
12564
  # @!attribute [rw] custom_permissions_name
11560
- # The name of the custom permissions profile that you want to assign
11561
- # to this user. Currently, custom permissions profile names are
11562
- # assigned to permissions profiles in the QuickSight console. You use
11563
- # this API to assign the named set of permissions to a QuickSight
11564
- # user.
12565
+ # (Enterprise edition only) The name of the custom permissions profile
12566
+ # that you want to assign to this user. Customized permissions allows
12567
+ # you to control a user's access by restricting access the following
12568
+ # operations:
12569
+ #
12570
+ # * Create and update data sources
12571
+ #
12572
+ # * Create and update datasets
12573
+ #
12574
+ # * Create and update email reports
12575
+ #
12576
+ # * Subscribe to email reports
12577
+ #
12578
+ # A set of custom permissions includes any combination of these
12579
+ # restrictions. Currently, you need to create the profile names for
12580
+ # custom permission sets by using the QuickSight console. Then, you
12581
+ # use the `RegisterUser` API operation to assign the named set of
12582
+ # permissions to a QuickSight user.
12583
+ #
12584
+ # QuickSight custom permissions are applied through IAM policies.
12585
+ # Therefore, they override the permissions typically granted by
12586
+ # assigning QuickSight users to one of the default security cohorts in
12587
+ # QuickSight (admin, author, reader).
12588
+ #
12589
+ # This feature is available only to QuickSight Enterprise edition
12590
+ # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
12591
+ # (SSO).
11565
12592
  # @return [String]
11566
12593
  #
11567
12594
  # @!attribute [rw] unapply_custom_permissions
@@ -11654,8 +12681,7 @@ module Aws::QuickSight
11654
12681
  include Aws::Structure
11655
12682
  end
11656
12683
 
11657
- # A registered user of Amazon QuickSight. Currently, an Amazon
11658
- # QuickSight subscription can't contain more than 20 million users.
12684
+ # A registered user of Amazon QuickSight.
11659
12685
  #
11660
12686
  # @!attribute [rw] arn
11661
12687
  # The Amazon Resource Name (ARN) for the user.