aws-sdk-quicksight 1.25.0 → 1.26.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/lib/aws-sdk-quicksight/client.rb +574 -1
- data/lib/aws-sdk-quicksight/client_api.rb +353 -0
- data/lib/aws-sdk-quicksight/types.rb +860 -6
- metadata +2 -2
@@ -32,6 +32,57 @@ module Aws::QuickSight
|
|
32
32
|
include Aws::Structure
|
33
33
|
end
|
34
34
|
|
35
|
+
# The customizations associated with your AWS account for QuickSight.
|
36
|
+
#
|
37
|
+
# @note When making an API call, you may pass AccountCustomization
|
38
|
+
# data as a hash:
|
39
|
+
#
|
40
|
+
# {
|
41
|
+
# default_theme: "Arn",
|
42
|
+
# }
|
43
|
+
#
|
44
|
+
# @!attribute [rw] default_theme
|
45
|
+
# The default theme for this QuickSight subscription.
|
46
|
+
# @return [String]
|
47
|
+
#
|
48
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountCustomization AWS API Documentation
|
49
|
+
#
|
50
|
+
class AccountCustomization < Struct.new(
|
51
|
+
:default_theme)
|
52
|
+
SENSITIVE = []
|
53
|
+
include Aws::Structure
|
54
|
+
end
|
55
|
+
|
56
|
+
# The QuickSight settings associated with your AWS account.
|
57
|
+
#
|
58
|
+
# @!attribute [rw] account_name
|
59
|
+
# The name associated with the QuickSight subscription in your AWS
|
60
|
+
# account.
|
61
|
+
# @return [String]
|
62
|
+
#
|
63
|
+
# @!attribute [rw] edition
|
64
|
+
# The edition of QuickSight that you're currently subscribed to.
|
65
|
+
# @return [String]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] default_namespace
|
68
|
+
# The default QuickSight namespace for your AWS account.
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] notification_email
|
72
|
+
# The main notification email for your QuickSight subscription.
|
73
|
+
# @return [String]
|
74
|
+
#
|
75
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/AccountSettings AWS API Documentation
|
76
|
+
#
|
77
|
+
class AccountSettings < Struct.new(
|
78
|
+
:account_name,
|
79
|
+
:edition,
|
80
|
+
:default_namespace,
|
81
|
+
:notification_email)
|
82
|
+
SENSITIVE = []
|
83
|
+
include Aws::Structure
|
84
|
+
end
|
85
|
+
|
35
86
|
# The active AWS Identity and Access Management (IAM) policy assignment.
|
36
87
|
#
|
37
88
|
# @!attribute [rw] assignment_name
|
@@ -495,6 +546,80 @@ module Aws::QuickSight
|
|
495
546
|
include Aws::Structure
|
496
547
|
end
|
497
548
|
|
549
|
+
# @note When making an API call, you may pass CreateAccountCustomizationRequest
|
550
|
+
# data as a hash:
|
551
|
+
#
|
552
|
+
# {
|
553
|
+
# aws_account_id: "AwsAccountId", # required
|
554
|
+
# namespace: "Namespace",
|
555
|
+
# account_customization: { # required
|
556
|
+
# default_theme: "Arn",
|
557
|
+
# },
|
558
|
+
# }
|
559
|
+
#
|
560
|
+
# @!attribute [rw] aws_account_id
|
561
|
+
# The ID for the AWS account that you want to customize QuickSight
|
562
|
+
# for.
|
563
|
+
# @return [String]
|
564
|
+
#
|
565
|
+
# @!attribute [rw] namespace
|
566
|
+
# The namespace associated with the customization that you're
|
567
|
+
# creating.
|
568
|
+
# @return [String]
|
569
|
+
#
|
570
|
+
# @!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"`).
|
577
|
+
# @return [Types::AccountCustomization]
|
578
|
+
#
|
579
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomizationRequest AWS API Documentation
|
580
|
+
#
|
581
|
+
class CreateAccountCustomizationRequest < Struct.new(
|
582
|
+
:aws_account_id,
|
583
|
+
:namespace,
|
584
|
+
:account_customization)
|
585
|
+
SENSITIVE = []
|
586
|
+
include Aws::Structure
|
587
|
+
end
|
588
|
+
|
589
|
+
# @!attribute [rw] aws_account_id
|
590
|
+
# The ID for the AWS account that you want to customize QuickSight
|
591
|
+
# for.
|
592
|
+
# @return [String]
|
593
|
+
#
|
594
|
+
# @!attribute [rw] namespace
|
595
|
+
# The namespace associated with the customization you're creating.
|
596
|
+
# @return [String]
|
597
|
+
#
|
598
|
+
# @!attribute [rw] account_customization
|
599
|
+
# The customizations you're adding to the QuickSight subscription for
|
600
|
+
# the AWS account.
|
601
|
+
# @return [Types::AccountCustomization]
|
602
|
+
#
|
603
|
+
# @!attribute [rw] request_id
|
604
|
+
# The AWS request ID for this operation.
|
605
|
+
# @return [String]
|
606
|
+
#
|
607
|
+
# @!attribute [rw] status
|
608
|
+
# The HTTP status of the request.
|
609
|
+
# @return [Integer]
|
610
|
+
#
|
611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomizationResponse AWS API Documentation
|
612
|
+
#
|
613
|
+
class CreateAccountCustomizationResponse < Struct.new(
|
614
|
+
:aws_account_id,
|
615
|
+
:namespace,
|
616
|
+
:account_customization,
|
617
|
+
:request_id,
|
618
|
+
:status)
|
619
|
+
SENSITIVE = []
|
620
|
+
include Aws::Structure
|
621
|
+
end
|
622
|
+
|
498
623
|
# A transform operation that creates calculated columns. Columns created
|
499
624
|
# in one such operation form a lexical closure.
|
500
625
|
#
|
@@ -840,6 +965,7 @@ module Aws::QuickSight
|
|
840
965
|
# },
|
841
966
|
# ],
|
842
967
|
# row_level_permission_data_set: {
|
968
|
+
# namespace: "Namespace",
|
843
969
|
# arn: "Arn", # required
|
844
970
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
845
971
|
# },
|
@@ -1570,6 +1696,100 @@ module Aws::QuickSight
|
|
1570
1696
|
include Aws::Structure
|
1571
1697
|
end
|
1572
1698
|
|
1699
|
+
# @note When making an API call, you may pass CreateNamespaceRequest
|
1700
|
+
# data as a hash:
|
1701
|
+
#
|
1702
|
+
# {
|
1703
|
+
# aws_account_id: "AwsAccountId", # required
|
1704
|
+
# namespace: "Namespace", # required
|
1705
|
+
# identity_store: "QUICKSIGHT", # required, accepts QUICKSIGHT
|
1706
|
+
# tags: [
|
1707
|
+
# {
|
1708
|
+
# key: "TagKey", # required
|
1709
|
+
# value: "TagValue", # required
|
1710
|
+
# },
|
1711
|
+
# ],
|
1712
|
+
# }
|
1713
|
+
#
|
1714
|
+
# @!attribute [rw] aws_account_id
|
1715
|
+
# The ID for the AWS account that you want to create the QuickSight
|
1716
|
+
# namespace in.
|
1717
|
+
# @return [String]
|
1718
|
+
#
|
1719
|
+
# @!attribute [rw] namespace
|
1720
|
+
# The name that you want to use to describe the new namespace.
|
1721
|
+
# @return [String]
|
1722
|
+
#
|
1723
|
+
# @!attribute [rw] identity_store
|
1724
|
+
# Specifies the type of your user identity directory. Currently, this
|
1725
|
+
# supports users with an identity type of `QUICKSIGHT`.
|
1726
|
+
# @return [String]
|
1727
|
+
#
|
1728
|
+
# @!attribute [rw] tags
|
1729
|
+
# The tags that you want to associate with the namespace that you're
|
1730
|
+
# creating.
|
1731
|
+
# @return [Array<Types::Tag>]
|
1732
|
+
#
|
1733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateNamespaceRequest AWS API Documentation
|
1734
|
+
#
|
1735
|
+
class CreateNamespaceRequest < Struct.new(
|
1736
|
+
:aws_account_id,
|
1737
|
+
:namespace,
|
1738
|
+
:identity_store,
|
1739
|
+
:tags)
|
1740
|
+
SENSITIVE = []
|
1741
|
+
include Aws::Structure
|
1742
|
+
end
|
1743
|
+
|
1744
|
+
# @!attribute [rw] arn
|
1745
|
+
# The ARN of the QuickSight namespace you created.
|
1746
|
+
# @return [String]
|
1747
|
+
#
|
1748
|
+
# @!attribute [rw] name
|
1749
|
+
# The name of the new namespace that you created.
|
1750
|
+
# @return [String]
|
1751
|
+
#
|
1752
|
+
# @!attribute [rw] capacity_region
|
1753
|
+
# The AWS Region that you want to use for the free SPICE capacity for
|
1754
|
+
# the new namespace. This is set to the region that you run
|
1755
|
+
# CreateNamespace in.
|
1756
|
+
# @return [String]
|
1757
|
+
#
|
1758
|
+
# @!attribute [rw] creation_status
|
1759
|
+
# The status of the creation of the namespace. This is an asynchronous
|
1760
|
+
# process. A status of `CREATED` means that your namespace is ready to
|
1761
|
+
# use. If an error occurs, it indicates if the process is `retryable`
|
1762
|
+
# or `non-retryable`. In the case of a non-retryable error, refer to
|
1763
|
+
# the error message for follow-up actions.
|
1764
|
+
# @return [String]
|
1765
|
+
#
|
1766
|
+
# @!attribute [rw] identity_store
|
1767
|
+
# Specifies the type of your user identity directory. Currently, this
|
1768
|
+
# supports users with an identity type of `QUICKSIGHT`.
|
1769
|
+
# @return [String]
|
1770
|
+
#
|
1771
|
+
# @!attribute [rw] request_id
|
1772
|
+
# The AWS request ID for this operation.
|
1773
|
+
# @return [String]
|
1774
|
+
#
|
1775
|
+
# @!attribute [rw] status
|
1776
|
+
# The HTTP status of the request.
|
1777
|
+
# @return [Integer]
|
1778
|
+
#
|
1779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateNamespaceResponse AWS API Documentation
|
1780
|
+
#
|
1781
|
+
class CreateNamespaceResponse < Struct.new(
|
1782
|
+
:arn,
|
1783
|
+
:name,
|
1784
|
+
:capacity_region,
|
1785
|
+
:creation_status,
|
1786
|
+
:identity_store,
|
1787
|
+
:request_id,
|
1788
|
+
:status)
|
1789
|
+
SENSITIVE = []
|
1790
|
+
include Aws::Structure
|
1791
|
+
end
|
1792
|
+
|
1573
1793
|
# @note When making an API call, you may pass CreateTemplateAliasRequest
|
1574
1794
|
# data as a hash:
|
1575
1795
|
#
|
@@ -3191,6 +3411,50 @@ module Aws::QuickSight
|
|
3191
3411
|
include Aws::Structure
|
3192
3412
|
end
|
3193
3413
|
|
3414
|
+
# @note When making an API call, you may pass DeleteAccountCustomizationRequest
|
3415
|
+
# data as a hash:
|
3416
|
+
#
|
3417
|
+
# {
|
3418
|
+
# aws_account_id: "AwsAccountId", # required
|
3419
|
+
# namespace: "Namespace",
|
3420
|
+
# }
|
3421
|
+
#
|
3422
|
+
# @!attribute [rw] aws_account_id
|
3423
|
+
# The ID for the AWS account that you want to delete QuickSight
|
3424
|
+
# customizations from.
|
3425
|
+
# @return [String]
|
3426
|
+
#
|
3427
|
+
# @!attribute [rw] namespace
|
3428
|
+
# The namespace associated with the customization that you're
|
3429
|
+
# deleting.
|
3430
|
+
# @return [String]
|
3431
|
+
#
|
3432
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomizationRequest AWS API Documentation
|
3433
|
+
#
|
3434
|
+
class DeleteAccountCustomizationRequest < Struct.new(
|
3435
|
+
:aws_account_id,
|
3436
|
+
:namespace)
|
3437
|
+
SENSITIVE = []
|
3438
|
+
include Aws::Structure
|
3439
|
+
end
|
3440
|
+
|
3441
|
+
# @!attribute [rw] request_id
|
3442
|
+
# The AWS request ID for this operation.
|
3443
|
+
# @return [String]
|
3444
|
+
#
|
3445
|
+
# @!attribute [rw] status
|
3446
|
+
# The HTTP status of the request.
|
3447
|
+
# @return [Integer]
|
3448
|
+
#
|
3449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomizationResponse AWS API Documentation
|
3450
|
+
#
|
3451
|
+
class DeleteAccountCustomizationResponse < Struct.new(
|
3452
|
+
:request_id,
|
3453
|
+
:status)
|
3454
|
+
SENSITIVE = []
|
3455
|
+
include Aws::Structure
|
3456
|
+
end
|
3457
|
+
|
3194
3458
|
# @note When making an API call, you may pass DeleteDashboardRequest
|
3195
3459
|
# data as a hash:
|
3196
3460
|
#
|
@@ -3521,6 +3785,49 @@ module Aws::QuickSight
|
|
3521
3785
|
include Aws::Structure
|
3522
3786
|
end
|
3523
3787
|
|
3788
|
+
# @note When making an API call, you may pass DeleteNamespaceRequest
|
3789
|
+
# data as a hash:
|
3790
|
+
#
|
3791
|
+
# {
|
3792
|
+
# aws_account_id: "AwsAccountId", # required
|
3793
|
+
# namespace: "Namespace", # required
|
3794
|
+
# }
|
3795
|
+
#
|
3796
|
+
# @!attribute [rw] aws_account_id
|
3797
|
+
# The ID for the AWS account that you want to delete the QuickSight
|
3798
|
+
# namespace from.
|
3799
|
+
# @return [String]
|
3800
|
+
#
|
3801
|
+
# @!attribute [rw] namespace
|
3802
|
+
# The namespace that you want to delete.
|
3803
|
+
# @return [String]
|
3804
|
+
#
|
3805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteNamespaceRequest AWS API Documentation
|
3806
|
+
#
|
3807
|
+
class DeleteNamespaceRequest < Struct.new(
|
3808
|
+
:aws_account_id,
|
3809
|
+
:namespace)
|
3810
|
+
SENSITIVE = []
|
3811
|
+
include Aws::Structure
|
3812
|
+
end
|
3813
|
+
|
3814
|
+
# @!attribute [rw] request_id
|
3815
|
+
# The AWS request ID for this operation.
|
3816
|
+
# @return [String]
|
3817
|
+
#
|
3818
|
+
# @!attribute [rw] status
|
3819
|
+
# The HTTP status of the request.
|
3820
|
+
# @return [Integer]
|
3821
|
+
#
|
3822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteNamespaceResponse AWS API Documentation
|
3823
|
+
#
|
3824
|
+
class DeleteNamespaceResponse < Struct.new(
|
3825
|
+
:request_id,
|
3826
|
+
:status)
|
3827
|
+
SENSITIVE = []
|
3828
|
+
include Aws::Structure
|
3829
|
+
end
|
3830
|
+
|
3524
3831
|
# @note When making an API call, you may pass DeleteTemplateAliasRequest
|
3525
3832
|
# data as a hash:
|
3526
3833
|
#
|
@@ -3874,6 +4181,123 @@ module Aws::QuickSight
|
|
3874
4181
|
include Aws::Structure
|
3875
4182
|
end
|
3876
4183
|
|
4184
|
+
# @note When making an API call, you may pass DescribeAccountCustomizationRequest
|
4185
|
+
# data as a hash:
|
4186
|
+
#
|
4187
|
+
# {
|
4188
|
+
# aws_account_id: "AwsAccountId", # required
|
4189
|
+
# namespace: "Namespace",
|
4190
|
+
# resolved: false,
|
4191
|
+
# }
|
4192
|
+
#
|
4193
|
+
# @!attribute [rw] aws_account_id
|
4194
|
+
# The ID for the AWS account that you want to describe QuickSight
|
4195
|
+
# customizations for.
|
4196
|
+
# @return [String]
|
4197
|
+
#
|
4198
|
+
# @!attribute [rw] namespace
|
4199
|
+
# The namespace associated with the customization that you're
|
4200
|
+
# describing.
|
4201
|
+
# @return [String]
|
4202
|
+
#
|
4203
|
+
# @!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.
|
4207
|
+
# @return [Boolean]
|
4208
|
+
#
|
4209
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationRequest AWS API Documentation
|
4210
|
+
#
|
4211
|
+
class DescribeAccountCustomizationRequest < Struct.new(
|
4212
|
+
:aws_account_id,
|
4213
|
+
:namespace,
|
4214
|
+
:resolved)
|
4215
|
+
SENSITIVE = []
|
4216
|
+
include Aws::Structure
|
4217
|
+
end
|
4218
|
+
|
4219
|
+
# @!attribute [rw] aws_account_id
|
4220
|
+
# The ID for the AWS account that you want to describe QuickSight
|
4221
|
+
# customizations for.
|
4222
|
+
# @return [String]
|
4223
|
+
#
|
4224
|
+
# @!attribute [rw] namespace
|
4225
|
+
# The namespace associated with the customization that you're
|
4226
|
+
# describing.
|
4227
|
+
# @return [String]
|
4228
|
+
#
|
4229
|
+
# @!attribute [rw] account_customization
|
4230
|
+
# The customizations associated with QuickSight.
|
4231
|
+
# @return [Types::AccountCustomization]
|
4232
|
+
#
|
4233
|
+
# @!attribute [rw] request_id
|
4234
|
+
# The AWS request ID for this operation.
|
4235
|
+
# @return [String]
|
4236
|
+
#
|
4237
|
+
# @!attribute [rw] status
|
4238
|
+
# The HTTP status of the request.
|
4239
|
+
# @return [Integer]
|
4240
|
+
#
|
4241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomizationResponse AWS API Documentation
|
4242
|
+
#
|
4243
|
+
class DescribeAccountCustomizationResponse < Struct.new(
|
4244
|
+
:aws_account_id,
|
4245
|
+
:namespace,
|
4246
|
+
:account_customization,
|
4247
|
+
:request_id,
|
4248
|
+
:status)
|
4249
|
+
SENSITIVE = []
|
4250
|
+
include Aws::Structure
|
4251
|
+
end
|
4252
|
+
|
4253
|
+
# @note When making an API call, you may pass DescribeAccountSettingsRequest
|
4254
|
+
# data as a hash:
|
4255
|
+
#
|
4256
|
+
# {
|
4257
|
+
# aws_account_id: "AwsAccountId", # required
|
4258
|
+
# }
|
4259
|
+
#
|
4260
|
+
# @!attribute [rw] aws_account_id
|
4261
|
+
# The ID for the AWS account that contains the QuickSight namespaces
|
4262
|
+
# that you want to list.
|
4263
|
+
# @return [String]
|
4264
|
+
#
|
4265
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettingsRequest AWS API Documentation
|
4266
|
+
#
|
4267
|
+
class DescribeAccountSettingsRequest < Struct.new(
|
4268
|
+
:aws_account_id)
|
4269
|
+
SENSITIVE = []
|
4270
|
+
include Aws::Structure
|
4271
|
+
end
|
4272
|
+
|
4273
|
+
# @!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.
|
4281
|
+
# @return [Types::AccountSettings]
|
4282
|
+
#
|
4283
|
+
# @!attribute [rw] request_id
|
4284
|
+
# The AWS request ID for this operation.
|
4285
|
+
# @return [String]
|
4286
|
+
#
|
4287
|
+
# @!attribute [rw] status
|
4288
|
+
# The HTTP status of the request.
|
4289
|
+
# @return [Integer]
|
4290
|
+
#
|
4291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettingsResponse AWS API Documentation
|
4292
|
+
#
|
4293
|
+
class DescribeAccountSettingsResponse < Struct.new(
|
4294
|
+
:account_settings,
|
4295
|
+
:request_id,
|
4296
|
+
:status)
|
4297
|
+
SENSITIVE = []
|
4298
|
+
include Aws::Structure
|
4299
|
+
end
|
4300
|
+
|
3877
4301
|
# @note When making an API call, you may pass DescribeDashboardPermissionsRequest
|
3878
4302
|
# data as a hash:
|
3879
4303
|
#
|
@@ -4359,10 +4783,63 @@ module Aws::QuickSight
|
|
4359
4783
|
# The HTTP status of the request.
|
4360
4784
|
# @return [Integer]
|
4361
4785
|
#
|
4362
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIngestionResponse AWS API Documentation
|
4786
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeIngestionResponse AWS API Documentation
|
4787
|
+
#
|
4788
|
+
class DescribeIngestionResponse < Struct.new(
|
4789
|
+
:ingestion,
|
4790
|
+
:request_id,
|
4791
|
+
:status)
|
4792
|
+
SENSITIVE = []
|
4793
|
+
include Aws::Structure
|
4794
|
+
end
|
4795
|
+
|
4796
|
+
# @note When making an API call, you may pass DescribeNamespaceRequest
|
4797
|
+
# data as a hash:
|
4798
|
+
#
|
4799
|
+
# {
|
4800
|
+
# aws_account_id: "AwsAccountId", # required
|
4801
|
+
# namespace: "Namespace", # required
|
4802
|
+
# }
|
4803
|
+
#
|
4804
|
+
# @!attribute [rw] aws_account_id
|
4805
|
+
# The ID for the AWS account that contains the QuickSight namespace
|
4806
|
+
# that you want to describe.
|
4807
|
+
# @return [String]
|
4808
|
+
#
|
4809
|
+
# @!attribute [rw] namespace
|
4810
|
+
# The namespace that you want to describe.
|
4811
|
+
# @return [String]
|
4812
|
+
#
|
4813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeNamespaceRequest AWS API Documentation
|
4814
|
+
#
|
4815
|
+
class DescribeNamespaceRequest < Struct.new(
|
4816
|
+
:aws_account_id,
|
4817
|
+
:namespace)
|
4818
|
+
SENSITIVE = []
|
4819
|
+
include Aws::Structure
|
4820
|
+
end
|
4821
|
+
|
4822
|
+
# @!attribute [rw] namespace
|
4823
|
+
# The information about the namespace that you're describing. The
|
4824
|
+
# response includes the namespace ARN, name, AWS Region, creation
|
4825
|
+
# status, and identity store. `DescribeNamespace` also works for
|
4826
|
+
# 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.
|
4829
|
+
# @return [Types::NamespaceInfoV2]
|
4830
|
+
#
|
4831
|
+
# @!attribute [rw] request_id
|
4832
|
+
# The AWS request ID for this operation.
|
4833
|
+
# @return [String]
|
4834
|
+
#
|
4835
|
+
# @!attribute [rw] status
|
4836
|
+
# The HTTP status of the request.
|
4837
|
+
# @return [Integer]
|
4838
|
+
#
|
4839
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeNamespaceResponse AWS API Documentation
|
4363
4840
|
#
|
4364
|
-
class
|
4365
|
-
:
|
4841
|
+
class DescribeNamespaceResponse < Struct.new(
|
4842
|
+
:namespace,
|
4366
4843
|
:request_id,
|
4367
4844
|
:status)
|
4368
4845
|
SENSITIVE = []
|
@@ -4538,6 +5015,7 @@ module Aws::QuickSight
|
|
4538
5015
|
# @return [Integer]
|
4539
5016
|
#
|
4540
5017
|
# @!attribute [rw] request_id
|
5018
|
+
# The AWS request ID for this operation.
|
4541
5019
|
# @return [String]
|
4542
5020
|
#
|
4543
5021
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplateResponse AWS API Documentation
|
@@ -4993,6 +5471,81 @@ module Aws::QuickSight
|
|
4993
5471
|
include Aws::Structure
|
4994
5472
|
end
|
4995
5473
|
|
5474
|
+
# @note When making an API call, you may pass GetSessionEmbedUrlRequest
|
5475
|
+
# data as a hash:
|
5476
|
+
#
|
5477
|
+
# {
|
5478
|
+
# aws_account_id: "AwsAccountId", # required
|
5479
|
+
# entry_point: "EntryPoint",
|
5480
|
+
# session_lifetime_in_minutes: 1,
|
5481
|
+
# user_arn: "Arn",
|
5482
|
+
# }
|
5483
|
+
#
|
5484
|
+
# @!attribute [rw] aws_account_id
|
5485
|
+
# The ID for the AWS account that contains the QuickSight session that
|
5486
|
+
# you're embedding.
|
5487
|
+
# @return [String]
|
5488
|
+
#
|
5489
|
+
# @!attribute [rw] entry_point
|
5490
|
+
# The entry point for the embedded session.
|
5491
|
+
# @return [String]
|
5492
|
+
#
|
5493
|
+
# @!attribute [rw] session_lifetime_in_minutes
|
5494
|
+
# How many minutes the session is valid. The session lifetime must be
|
5495
|
+
# 15-600 minutes.
|
5496
|
+
# @return [Integer]
|
5497
|
+
#
|
5498
|
+
# @!attribute [rw] user_arn
|
5499
|
+
# 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:
|
5503
|
+
#
|
5504
|
+
# * Active Directory (AD) users or group members
|
5505
|
+
#
|
5506
|
+
# * Invited nonfederated users
|
5507
|
+
#
|
5508
|
+
# * IAM users and IAM role-based sessions authenticated through
|
5509
|
+
# Federated Single Sign-On using SAML, OpenID Connect, or IAM
|
5510
|
+
# federation.
|
5511
|
+
# @return [String]
|
5512
|
+
#
|
5513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrlRequest AWS API Documentation
|
5514
|
+
#
|
5515
|
+
class GetSessionEmbedUrlRequest < Struct.new(
|
5516
|
+
:aws_account_id,
|
5517
|
+
:entry_point,
|
5518
|
+
:session_lifetime_in_minutes,
|
5519
|
+
:user_arn)
|
5520
|
+
SENSITIVE = []
|
5521
|
+
include Aws::Structure
|
5522
|
+
end
|
5523
|
+
|
5524
|
+
# @!attribute [rw] embed_url
|
5525
|
+
# A single-use URL that you can put into your server-side web page to
|
5526
|
+
# 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.
|
5529
|
+
# @return [String]
|
5530
|
+
#
|
5531
|
+
# @!attribute [rw] status
|
5532
|
+
# The HTTP status of the request.
|
5533
|
+
# @return [Integer]
|
5534
|
+
#
|
5535
|
+
# @!attribute [rw] request_id
|
5536
|
+
# The AWS request ID for this operation.
|
5537
|
+
# @return [String]
|
5538
|
+
#
|
5539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrlResponse AWS API Documentation
|
5540
|
+
#
|
5541
|
+
class GetSessionEmbedUrlResponse < Struct.new(
|
5542
|
+
:embed_url,
|
5543
|
+
:status,
|
5544
|
+
:request_id)
|
5545
|
+
SENSITIVE = [:embed_url]
|
5546
|
+
include Aws::Structure
|
5547
|
+
end
|
5548
|
+
|
4996
5549
|
# A *group* in Amazon QuickSight consists of a set of users. You can use
|
4997
5550
|
# groups to make it easier to manage access and security. Currently, an
|
4998
5551
|
# Amazon QuickSight subscription can't contain more than 500 Amazon
|
@@ -5999,6 +6552,67 @@ module Aws::QuickSight
|
|
5999
6552
|
include Aws::Structure
|
6000
6553
|
end
|
6001
6554
|
|
6555
|
+
# @note When making an API call, you may pass ListNamespacesRequest
|
6556
|
+
# data as a hash:
|
6557
|
+
#
|
6558
|
+
# {
|
6559
|
+
# aws_account_id: "AwsAccountId", # required
|
6560
|
+
# next_token: "String",
|
6561
|
+
# max_results: 1,
|
6562
|
+
# }
|
6563
|
+
#
|
6564
|
+
# @!attribute [rw] aws_account_id
|
6565
|
+
# The ID for the AWS account that contains the QuickSight namespaces
|
6566
|
+
# that you want to list.
|
6567
|
+
# @return [String]
|
6568
|
+
#
|
6569
|
+
# @!attribute [rw] next_token
|
6570
|
+
# A pagination token that can be used in a subsequent request.
|
6571
|
+
# @return [String]
|
6572
|
+
#
|
6573
|
+
# @!attribute [rw] max_results
|
6574
|
+
# The maximum number of results to return.
|
6575
|
+
# @return [Integer]
|
6576
|
+
#
|
6577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListNamespacesRequest AWS API Documentation
|
6578
|
+
#
|
6579
|
+
class ListNamespacesRequest < Struct.new(
|
6580
|
+
:aws_account_id,
|
6581
|
+
:next_token,
|
6582
|
+
:max_results)
|
6583
|
+
SENSITIVE = []
|
6584
|
+
include Aws::Structure
|
6585
|
+
end
|
6586
|
+
|
6587
|
+
# @!attribute [rw] namespaces
|
6588
|
+
# The information about the namespaces in this AWS account. The
|
6589
|
+
# response includes the namespace ARN, name, AWS Region, notification
|
6590
|
+
# email address, creation status, and identity store.
|
6591
|
+
# @return [Array<Types::NamespaceInfoV2>]
|
6592
|
+
#
|
6593
|
+
# @!attribute [rw] next_token
|
6594
|
+
# A pagination token that can be used in a subsequent request.
|
6595
|
+
# @return [String]
|
6596
|
+
#
|
6597
|
+
# @!attribute [rw] request_id
|
6598
|
+
# The AWS request ID for this operation.
|
6599
|
+
# @return [String]
|
6600
|
+
#
|
6601
|
+
# @!attribute [rw] status
|
6602
|
+
# The HTTP status of the request.
|
6603
|
+
# @return [Integer]
|
6604
|
+
#
|
6605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListNamespacesResponse AWS API Documentation
|
6606
|
+
#
|
6607
|
+
class ListNamespacesResponse < Struct.new(
|
6608
|
+
:namespaces,
|
6609
|
+
:next_token,
|
6610
|
+
:request_id,
|
6611
|
+
:status)
|
6612
|
+
SENSITIVE = []
|
6613
|
+
include Aws::Structure
|
6614
|
+
end
|
6615
|
+
|
6002
6616
|
# @note When making an API call, you may pass ListTagsForResourceRequest
|
6003
6617
|
# data as a hash:
|
6004
6618
|
#
|
@@ -6815,6 +7429,65 @@ module Aws::QuickSight
|
|
6815
7429
|
include Aws::Structure
|
6816
7430
|
end
|
6817
7431
|
|
7432
|
+
# Errors that occur during namespace creation.
|
7433
|
+
#
|
7434
|
+
# @!attribute [rw] type
|
7435
|
+
# The error type.
|
7436
|
+
# @return [String]
|
7437
|
+
#
|
7438
|
+
# @!attribute [rw] message
|
7439
|
+
# The message for the error.
|
7440
|
+
# @return [String]
|
7441
|
+
#
|
7442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NamespaceError AWS API Documentation
|
7443
|
+
#
|
7444
|
+
class NamespaceError < Struct.new(
|
7445
|
+
:type,
|
7446
|
+
:message)
|
7447
|
+
SENSITIVE = []
|
7448
|
+
include Aws::Structure
|
7449
|
+
end
|
7450
|
+
|
7451
|
+
# The error type.
|
7452
|
+
#
|
7453
|
+
# @!attribute [rw] name
|
7454
|
+
# The name of the error.
|
7455
|
+
# @return [String]
|
7456
|
+
#
|
7457
|
+
# @!attribute [rw] arn
|
7458
|
+
# The namespace ARN.
|
7459
|
+
# @return [String]
|
7460
|
+
#
|
7461
|
+
# @!attribute [rw] capacity_region
|
7462
|
+
# The namespace AWS Region.
|
7463
|
+
# @return [String]
|
7464
|
+
#
|
7465
|
+
# @!attribute [rw] creation_status
|
7466
|
+
# The creation status of a namespace that is not yet completely
|
7467
|
+
# created.
|
7468
|
+
# @return [String]
|
7469
|
+
#
|
7470
|
+
# @!attribute [rw] identity_store
|
7471
|
+
# The identity store used for the namespace.
|
7472
|
+
# @return [String]
|
7473
|
+
#
|
7474
|
+
# @!attribute [rw] namespace_error
|
7475
|
+
# An error that occured when the namespace was created.
|
7476
|
+
# @return [Types::NamespaceError]
|
7477
|
+
#
|
7478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/NamespaceInfoV2 AWS API Documentation
|
7479
|
+
#
|
7480
|
+
class NamespaceInfoV2 < Struct.new(
|
7481
|
+
:name,
|
7482
|
+
:arn,
|
7483
|
+
:capacity_region,
|
7484
|
+
:creation_status,
|
7485
|
+
:identity_store,
|
7486
|
+
:namespace_error)
|
7487
|
+
SENSITIVE = []
|
7488
|
+
include Aws::Structure
|
7489
|
+
end
|
7490
|
+
|
6818
7491
|
# Output column.
|
6819
7492
|
#
|
6820
7493
|
# @!attribute [rw] name
|
@@ -7192,6 +7865,7 @@ module Aws::QuickSight
|
|
7192
7865
|
# aws_account_id: "AwsAccountId", # required
|
7193
7866
|
# namespace: "Namespace", # required
|
7194
7867
|
# user_name: "UserName",
|
7868
|
+
# custom_permissions_name: "RoleName",
|
7195
7869
|
# }
|
7196
7870
|
#
|
7197
7871
|
# @!attribute [rw] identity_type
|
@@ -7262,6 +7936,31 @@ module Aws::QuickSight
|
|
7262
7936
|
# you are registering.
|
7263
7937
|
# @return [String]
|
7264
7938
|
#
|
7939
|
+
# @!attribute [rw] custom_permissions_name
|
7940
|
+
# (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.
|
7945
|
+
#
|
7946
|
+
# Customizing permissions in the QuickSight UI allows you to control a
|
7947
|
+
# user's access to the following operations:
|
7948
|
+
#
|
7949
|
+
# *
|
7950
|
+
# *
|
7951
|
+
# *
|
7952
|
+
# *
|
7953
|
+
#
|
7954
|
+
# QuickSight custom permissions are applied through IAM policies.
|
7955
|
+
# 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.
|
7958
|
+
#
|
7959
|
+
# This feature is available only to QuickSight Enterprise edition
|
7960
|
+
# subscriptions that use SAML 2.0-Based Federation for Single Sign-On
|
7961
|
+
# (SSO).
|
7962
|
+
# @return [String]
|
7963
|
+
#
|
7265
7964
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUserRequest AWS API Documentation
|
7266
7965
|
#
|
7267
7966
|
class RegisterUserRequest < Struct.new(
|
@@ -7272,7 +7971,8 @@ module Aws::QuickSight
|
|
7272
7971
|
:session_name,
|
7273
7972
|
:aws_account_id,
|
7274
7973
|
:namespace,
|
7275
|
-
:user_name
|
7974
|
+
:user_name,
|
7975
|
+
:custom_permissions_name)
|
7276
7976
|
SENSITIVE = []
|
7277
7977
|
include Aws::Structure
|
7278
7978
|
end
|
@@ -7508,10 +8208,15 @@ module Aws::QuickSight
|
|
7508
8208
|
# data as a hash:
|
7509
8209
|
#
|
7510
8210
|
# {
|
8211
|
+
# namespace: "Namespace",
|
7511
8212
|
# arn: "Arn", # required
|
7512
8213
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
7513
8214
|
# }
|
7514
8215
|
#
|
8216
|
+
# @!attribute [rw] namespace
|
8217
|
+
# The namespace associated with the row-level permissions dataset.
|
8218
|
+
# @return [String]
|
8219
|
+
#
|
7515
8220
|
# @!attribute [rw] arn
|
7516
8221
|
# The Amazon Resource Name (ARN) of the permission dataset.
|
7517
8222
|
# @return [String]
|
@@ -7523,6 +8228,7 @@ module Aws::QuickSight
|
|
7523
8228
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionDataSet AWS API Documentation
|
7524
8229
|
#
|
7525
8230
|
class RowLevelPermissionDataSet < Struct.new(
|
8231
|
+
:namespace,
|
7526
8232
|
:arn,
|
7527
8233
|
:permission_policy)
|
7528
8234
|
SENSITIVE = []
|
@@ -9029,6 +9735,128 @@ module Aws::QuickSight
|
|
9029
9735
|
include Aws::Structure
|
9030
9736
|
end
|
9031
9737
|
|
9738
|
+
# @note When making an API call, you may pass UpdateAccountCustomizationRequest
|
9739
|
+
# data as a hash:
|
9740
|
+
#
|
9741
|
+
# {
|
9742
|
+
# aws_account_id: "AwsAccountId", # required
|
9743
|
+
# namespace: "Namespace",
|
9744
|
+
# account_customization: { # required
|
9745
|
+
# default_theme: "Arn",
|
9746
|
+
# },
|
9747
|
+
# }
|
9748
|
+
#
|
9749
|
+
# @!attribute [rw] aws_account_id
|
9750
|
+
# The ID for the AWS account that you want to update QuickSight
|
9751
|
+
# customizations for.
|
9752
|
+
# @return [String]
|
9753
|
+
#
|
9754
|
+
# @!attribute [rw] namespace
|
9755
|
+
# The namespace associated with the customization that you're
|
9756
|
+
# updating.
|
9757
|
+
# @return [String]
|
9758
|
+
#
|
9759
|
+
# @!attribute [rw] account_customization
|
9760
|
+
# The customizations you want to update in QuickSight.
|
9761
|
+
# @return [Types::AccountCustomization]
|
9762
|
+
#
|
9763
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationRequest AWS API Documentation
|
9764
|
+
#
|
9765
|
+
class UpdateAccountCustomizationRequest < Struct.new(
|
9766
|
+
:aws_account_id,
|
9767
|
+
:namespace,
|
9768
|
+
:account_customization)
|
9769
|
+
SENSITIVE = []
|
9770
|
+
include Aws::Structure
|
9771
|
+
end
|
9772
|
+
|
9773
|
+
# @!attribute [rw] aws_account_id
|
9774
|
+
# The ID for the AWS account that you want to update QuickSight
|
9775
|
+
# customizations for.
|
9776
|
+
# @return [String]
|
9777
|
+
#
|
9778
|
+
# @!attribute [rw] namespace
|
9779
|
+
# The namespace associated with the customization that you're
|
9780
|
+
# updating.
|
9781
|
+
# @return [String]
|
9782
|
+
#
|
9783
|
+
# @!attribute [rw] account_customization
|
9784
|
+
# The customizations associated with your QuickSight subscription.
|
9785
|
+
# @return [Types::AccountCustomization]
|
9786
|
+
#
|
9787
|
+
# @!attribute [rw] request_id
|
9788
|
+
# The AWS request ID for this operation.
|
9789
|
+
# @return [String]
|
9790
|
+
#
|
9791
|
+
# @!attribute [rw] status
|
9792
|
+
# The HTTP status of the request.
|
9793
|
+
# @return [Integer]
|
9794
|
+
#
|
9795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomizationResponse AWS API Documentation
|
9796
|
+
#
|
9797
|
+
class UpdateAccountCustomizationResponse < Struct.new(
|
9798
|
+
:aws_account_id,
|
9799
|
+
:namespace,
|
9800
|
+
:account_customization,
|
9801
|
+
:request_id,
|
9802
|
+
:status)
|
9803
|
+
SENSITIVE = []
|
9804
|
+
include Aws::Structure
|
9805
|
+
end
|
9806
|
+
|
9807
|
+
# @note When making an API call, you may pass UpdateAccountSettingsRequest
|
9808
|
+
# data as a hash:
|
9809
|
+
#
|
9810
|
+
# {
|
9811
|
+
# aws_account_id: "AwsAccountId", # required
|
9812
|
+
# default_namespace: "Namespace", # required
|
9813
|
+
# notification_email: "String",
|
9814
|
+
# }
|
9815
|
+
#
|
9816
|
+
# @!attribute [rw] aws_account_id
|
9817
|
+
# The ID for the AWS account that contains the QuickSight namespaces
|
9818
|
+
# that you want to list.
|
9819
|
+
# @return [String]
|
9820
|
+
#
|
9821
|
+
# @!attribute [rw] default_namespace
|
9822
|
+
# The default namespace for this AWS Account. Currently, the default
|
9823
|
+
# is `default`. IAM users who register for the first time with
|
9824
|
+
# QuickSight provide an email that becomes associated with the default
|
9825
|
+
# namespace.
|
9826
|
+
# @return [String]
|
9827
|
+
#
|
9828
|
+
# @!attribute [rw] notification_email
|
9829
|
+
# Email address used to send notifications regarding administration of
|
9830
|
+
# QuickSight.
|
9831
|
+
# @return [String]
|
9832
|
+
#
|
9833
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsRequest AWS API Documentation
|
9834
|
+
#
|
9835
|
+
class UpdateAccountSettingsRequest < Struct.new(
|
9836
|
+
:aws_account_id,
|
9837
|
+
:default_namespace,
|
9838
|
+
:notification_email)
|
9839
|
+
SENSITIVE = []
|
9840
|
+
include Aws::Structure
|
9841
|
+
end
|
9842
|
+
|
9843
|
+
# @!attribute [rw] request_id
|
9844
|
+
# The AWS request ID for this operation.
|
9845
|
+
# @return [String]
|
9846
|
+
#
|
9847
|
+
# @!attribute [rw] status
|
9848
|
+
# The HTTP status of the request.
|
9849
|
+
# @return [Integer]
|
9850
|
+
#
|
9851
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettingsResponse AWS API Documentation
|
9852
|
+
#
|
9853
|
+
class UpdateAccountSettingsResponse < Struct.new(
|
9854
|
+
:request_id,
|
9855
|
+
:status)
|
9856
|
+
SENSITIVE = []
|
9857
|
+
include Aws::Structure
|
9858
|
+
end
|
9859
|
+
|
9032
9860
|
# @note When making an API call, you may pass UpdateDashboardPermissionsRequest
|
9033
9861
|
# data as a hash:
|
9034
9862
|
#
|
@@ -9530,6 +10358,7 @@ module Aws::QuickSight
|
|
9530
10358
|
# },
|
9531
10359
|
# ],
|
9532
10360
|
# row_level_permission_data_set: {
|
10361
|
+
# namespace: "Namespace",
|
9533
10362
|
# arn: "Arn", # required
|
9534
10363
|
# permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
|
9535
10364
|
# },
|
@@ -10692,6 +11521,8 @@ module Aws::QuickSight
|
|
10692
11521
|
# namespace: "Namespace", # required
|
10693
11522
|
# email: "String", # required
|
10694
11523
|
# role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
|
11524
|
+
# custom_permissions_name: "RoleName",
|
11525
|
+
# unapply_custom_permissions: false,
|
10695
11526
|
# }
|
10696
11527
|
#
|
10697
11528
|
# @!attribute [rw] user_name
|
@@ -10725,6 +11556,22 @@ module Aws::QuickSight
|
|
10725
11556
|
# QuickSight settings.
|
10726
11557
|
# @return [String]
|
10727
11558
|
#
|
11559
|
+
# @!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.
|
11565
|
+
# @return [String]
|
11566
|
+
#
|
11567
|
+
# @!attribute [rw] unapply_custom_permissions
|
11568
|
+
# A flag that you use to indicate that you want to remove all custom
|
11569
|
+
# permissions from this user. Using this parameter resets the user to
|
11570
|
+
# the state it was in before a custom permissions profile was applied.
|
11571
|
+
# This parameter defaults to NULL and it doesn't accept any other
|
11572
|
+
# value.
|
11573
|
+
# @return [Boolean]
|
11574
|
+
#
|
10728
11575
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUserRequest AWS API Documentation
|
10729
11576
|
#
|
10730
11577
|
class UpdateUserRequest < Struct.new(
|
@@ -10732,7 +11579,9 @@ module Aws::QuickSight
|
|
10732
11579
|
:aws_account_id,
|
10733
11580
|
:namespace,
|
10734
11581
|
:email,
|
10735
|
-
:role
|
11582
|
+
:role,
|
11583
|
+
:custom_permissions_name,
|
11584
|
+
:unapply_custom_permissions)
|
10736
11585
|
SENSITIVE = []
|
10737
11586
|
include Aws::Structure
|
10738
11587
|
end
|
@@ -10853,6 +11702,10 @@ module Aws::QuickSight
|
|
10853
11702
|
# The principal ID of the user.
|
10854
11703
|
# @return [String]
|
10855
11704
|
#
|
11705
|
+
# @!attribute [rw] custom_permissions_name
|
11706
|
+
# The custom permissions profile associated with this user.
|
11707
|
+
# @return [String]
|
11708
|
+
#
|
10856
11709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/User AWS API Documentation
|
10857
11710
|
#
|
10858
11711
|
class User < Struct.new(
|
@@ -10862,7 +11715,8 @@ module Aws::QuickSight
|
|
10862
11715
|
:role,
|
10863
11716
|
:identity_type,
|
10864
11717
|
:active,
|
10865
|
-
:principal_id
|
11718
|
+
:principal_id,
|
11719
|
+
:custom_permissions_name)
|
10866
11720
|
SENSITIVE = []
|
10867
11721
|
include Aws::Structure
|
10868
11722
|
end
|