aws-sdk-quicksight 1.42.0 → 1.47.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -1444,6 +1444,7 @@ module Aws::QuickSight
1444
1444
  # namespace: "Namespace",
1445
1445
  # arn: "Arn", # required
1446
1446
  # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
1447
+ # format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
1447
1448
  # },
1448
1449
  # column_level_permission_rules: [
1449
1450
  # {
@@ -1807,10 +1808,12 @@ module Aws::QuickSight
1807
1808
  #
1808
1809
  # @!attribute [rw] type
1809
1810
  # The type of the data source. Currently, the supported types for this
1810
- # operation are: `ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL,
1811
- # POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER,
1812
- # TERADATA`. Use `ListDataSources` to return a list of all data
1813
- # sources.
1811
+ # operation are: `ATHENA, AURORA, AURORA_POSTGRESQL,
1812
+ # AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT,
1813
+ # S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA`. Use `ListDataSources` to
1814
+ # return a list of all data sources.
1815
+ #
1816
+ # `AMAZON_ELASTICSEARCH` is for Amazon managed Elasticsearch Service.
1814
1817
  # @return [String]
1815
1818
  #
1816
1819
  # @!attribute [rw] data_source_parameters
@@ -1893,6 +1896,166 @@ module Aws::QuickSight
1893
1896
  include Aws::Structure
1894
1897
  end
1895
1898
 
1899
+ # @note When making an API call, you may pass CreateFolderMembershipRequest
1900
+ # data as a hash:
1901
+ #
1902
+ # {
1903
+ # aws_account_id: "AwsAccountId", # required
1904
+ # folder_id: "RestrictiveResourceId", # required
1905
+ # member_id: "RestrictiveResourceId", # required
1906
+ # member_type: "DASHBOARD", # required, accepts DASHBOARD, ANALYSIS, DATASET
1907
+ # }
1908
+ #
1909
+ # @!attribute [rw] aws_account_id
1910
+ # The AWS Account ID.
1911
+ # @return [String]
1912
+ #
1913
+ # @!attribute [rw] folder_id
1914
+ # The folder ID.
1915
+ # @return [String]
1916
+ #
1917
+ # @!attribute [rw] member_id
1918
+ # The ID of the asset (the dashboard, analysis, or dataset).
1919
+ # @return [String]
1920
+ #
1921
+ # @!attribute [rw] member_type
1922
+ # The type of the member, including `DASHBOARD`, `ANALYSIS`, and
1923
+ # `DATASET`.
1924
+ # @return [String]
1925
+ #
1926
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderMembershipRequest AWS API Documentation
1927
+ #
1928
+ class CreateFolderMembershipRequest < Struct.new(
1929
+ :aws_account_id,
1930
+ :folder_id,
1931
+ :member_id,
1932
+ :member_type)
1933
+ SENSITIVE = []
1934
+ include Aws::Structure
1935
+ end
1936
+
1937
+ # @!attribute [rw] status
1938
+ # The status of the folder membership. If succeeded, the status is
1939
+ # `SC_OK (200)`.
1940
+ # @return [Integer]
1941
+ #
1942
+ # @!attribute [rw] folder_member
1943
+ # Information about the member in the folder.
1944
+ # @return [Types::FolderMember]
1945
+ #
1946
+ # @!attribute [rw] request_id
1947
+ # The request ID.
1948
+ # @return [String]
1949
+ #
1950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderMembershipResponse AWS API Documentation
1951
+ #
1952
+ class CreateFolderMembershipResponse < Struct.new(
1953
+ :status,
1954
+ :folder_member,
1955
+ :request_id)
1956
+ SENSITIVE = []
1957
+ include Aws::Structure
1958
+ end
1959
+
1960
+ # @note When making an API call, you may pass CreateFolderRequest
1961
+ # data as a hash:
1962
+ #
1963
+ # {
1964
+ # aws_account_id: "AwsAccountId", # required
1965
+ # folder_id: "RestrictiveResourceId", # required
1966
+ # name: "FolderName",
1967
+ # folder_type: "SHARED", # accepts SHARED
1968
+ # parent_folder_arn: "Arn",
1969
+ # permissions: [
1970
+ # {
1971
+ # principal: "Principal", # required
1972
+ # actions: ["String"], # required
1973
+ # },
1974
+ # ],
1975
+ # tags: [
1976
+ # {
1977
+ # key: "TagKey", # required
1978
+ # value: "TagValue", # required
1979
+ # },
1980
+ # ],
1981
+ # }
1982
+ #
1983
+ # @!attribute [rw] aws_account_id
1984
+ # The AWS Account ID.
1985
+ # @return [String]
1986
+ #
1987
+ # @!attribute [rw] folder_id
1988
+ # The folder ID.
1989
+ # @return [String]
1990
+ #
1991
+ # @!attribute [rw] name
1992
+ # The name of the folder.
1993
+ # @return [String]
1994
+ #
1995
+ # @!attribute [rw] folder_type
1996
+ # The type of folder. By default, `folderType` is `SHARED`.
1997
+ # @return [String]
1998
+ #
1999
+ # @!attribute [rw] parent_folder_arn
2000
+ # The Amazon Resource Name (ARN) for the parent folder.
2001
+ #
2002
+ # `ParentFolderArn` can be null. An empty `parentFolderArn` creates a
2003
+ # root-level folder.
2004
+ # @return [String]
2005
+ #
2006
+ # @!attribute [rw] permissions
2007
+ # A structure that describes the principals and the resource-level
2008
+ # permissions of a folder.
2009
+ #
2010
+ # To specify no permissions, omit `Permissions`.
2011
+ # @return [Array<Types::ResourcePermission>]
2012
+ #
2013
+ # @!attribute [rw] tags
2014
+ # Tags for the folder.
2015
+ # @return [Array<Types::Tag>]
2016
+ #
2017
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderRequest AWS API Documentation
2018
+ #
2019
+ class CreateFolderRequest < Struct.new(
2020
+ :aws_account_id,
2021
+ :folder_id,
2022
+ :name,
2023
+ :folder_type,
2024
+ :parent_folder_arn,
2025
+ :permissions,
2026
+ :tags)
2027
+ SENSITIVE = []
2028
+ include Aws::Structure
2029
+ end
2030
+
2031
+ # @!attribute [rw] status
2032
+ # The status of the newly created folder. If succeeded, the status is
2033
+ # `SC_OK (200)`.
2034
+ # @return [Integer]
2035
+ #
2036
+ # @!attribute [rw] arn
2037
+ # The Amazon Resource Name (ARN) for the newly created folder.
2038
+ # @return [String]
2039
+ #
2040
+ # @!attribute [rw] folder_id
2041
+ # The folder ID for the newly created folder.
2042
+ # @return [String]
2043
+ #
2044
+ # @!attribute [rw] request_id
2045
+ # The request ID for the newly created folder.
2046
+ # @return [String]
2047
+ #
2048
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateFolderResponse AWS API Documentation
2049
+ #
2050
+ class CreateFolderResponse < Struct.new(
2051
+ :status,
2052
+ :arn,
2053
+ :folder_id,
2054
+ :request_id)
2055
+ SENSITIVE = []
2056
+ include Aws::Structure
2057
+ end
2058
+
1896
2059
  # @note When making an API call, you may pass CreateGroupMembershipRequest
1897
2060
  # data as a hash:
1898
2061
  #
@@ -4254,6 +4417,116 @@ module Aws::QuickSight
4254
4417
  include Aws::Structure
4255
4418
  end
4256
4419
 
4420
+ # @note When making an API call, you may pass DeleteFolderMembershipRequest
4421
+ # data as a hash:
4422
+ #
4423
+ # {
4424
+ # aws_account_id: "AwsAccountId", # required
4425
+ # folder_id: "RestrictiveResourceId", # required
4426
+ # member_id: "RestrictiveResourceId", # required
4427
+ # member_type: "DASHBOARD", # required, accepts DASHBOARD, ANALYSIS, DATASET
4428
+ # }
4429
+ #
4430
+ # @!attribute [rw] aws_account_id
4431
+ # The AWS Account ID.
4432
+ # @return [String]
4433
+ #
4434
+ # @!attribute [rw] folder_id
4435
+ # The Folder ID.
4436
+ # @return [String]
4437
+ #
4438
+ # @!attribute [rw] member_id
4439
+ # The ID of the asset (the dashboard, analysis, or dataset) that you
4440
+ # want to delete.
4441
+ # @return [String]
4442
+ #
4443
+ # @!attribute [rw] member_type
4444
+ # The type of the member, including `DASHBOARD`, `ANALYSIS`, and
4445
+ # `DATASET`
4446
+ # @return [String]
4447
+ #
4448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderMembershipRequest AWS API Documentation
4449
+ #
4450
+ class DeleteFolderMembershipRequest < Struct.new(
4451
+ :aws_account_id,
4452
+ :folder_id,
4453
+ :member_id,
4454
+ :member_type)
4455
+ SENSITIVE = []
4456
+ include Aws::Structure
4457
+ end
4458
+
4459
+ # @!attribute [rw] status
4460
+ # The status of deleting the asset. If succeeded, the status is `SC_OK
4461
+ # (200)`.
4462
+ # @return [Integer]
4463
+ #
4464
+ # @!attribute [rw] request_id
4465
+ # The request ID.
4466
+ # @return [String]
4467
+ #
4468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderMembershipResponse AWS API Documentation
4469
+ #
4470
+ class DeleteFolderMembershipResponse < Struct.new(
4471
+ :status,
4472
+ :request_id)
4473
+ SENSITIVE = []
4474
+ include Aws::Structure
4475
+ end
4476
+
4477
+ # @note When making an API call, you may pass DeleteFolderRequest
4478
+ # data as a hash:
4479
+ #
4480
+ # {
4481
+ # aws_account_id: "AwsAccountId", # required
4482
+ # folder_id: "RestrictiveResourceId", # required
4483
+ # }
4484
+ #
4485
+ # @!attribute [rw] aws_account_id
4486
+ # The AWS Account ID for the folder.
4487
+ # @return [String]
4488
+ #
4489
+ # @!attribute [rw] folder_id
4490
+ # The folder ID.
4491
+ # @return [String]
4492
+ #
4493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderRequest AWS API Documentation
4494
+ #
4495
+ class DeleteFolderRequest < Struct.new(
4496
+ :aws_account_id,
4497
+ :folder_id)
4498
+ SENSITIVE = []
4499
+ include Aws::Structure
4500
+ end
4501
+
4502
+ # @!attribute [rw] status
4503
+ # The status of deleting the folder. If succeeded, the status is
4504
+ # `SC_OK (200)`.
4505
+ # @return [Integer]
4506
+ #
4507
+ # @!attribute [rw] arn
4508
+ # The Amazon Resource Name of the deleted folder.
4509
+ # @return [String]
4510
+ #
4511
+ # @!attribute [rw] folder_id
4512
+ # The folder ID.
4513
+ # @return [String]
4514
+ #
4515
+ # @!attribute [rw] request_id
4516
+ # The request ID.
4517
+ # @return [String]
4518
+ #
4519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteFolderResponse AWS API Documentation
4520
+ #
4521
+ class DeleteFolderResponse < Struct.new(
4522
+ :status,
4523
+ :arn,
4524
+ :folder_id,
4525
+ :request_id)
4526
+ SENSITIVE = []
4527
+ include Aws::Structure
4528
+ end
4529
+
4257
4530
  # @note When making an API call, you may pass DeleteGroupMembershipRequest
4258
4531
  # data as a hash:
4259
4532
  #
@@ -5382,6 +5655,167 @@ module Aws::QuickSight
5382
5655
  include Aws::Structure
5383
5656
  end
5384
5657
 
5658
+ # @note When making an API call, you may pass DescribeFolderPermissionsRequest
5659
+ # data as a hash:
5660
+ #
5661
+ # {
5662
+ # aws_account_id: "AwsAccountId", # required
5663
+ # folder_id: "RestrictiveResourceId", # required
5664
+ # }
5665
+ #
5666
+ # @!attribute [rw] aws_account_id
5667
+ # The AWS Account ID.
5668
+ # @return [String]
5669
+ #
5670
+ # @!attribute [rw] folder_id
5671
+ # The folder ID.
5672
+ # @return [String]
5673
+ #
5674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderPermissionsRequest AWS API Documentation
5675
+ #
5676
+ class DescribeFolderPermissionsRequest < Struct.new(
5677
+ :aws_account_id,
5678
+ :folder_id)
5679
+ SENSITIVE = []
5680
+ include Aws::Structure
5681
+ end
5682
+
5683
+ # @!attribute [rw] status
5684
+ # The status. If succeeded, the status is `SC_OK`.
5685
+ # @return [Integer]
5686
+ #
5687
+ # @!attribute [rw] folder_id
5688
+ # The folder ID.
5689
+ # @return [String]
5690
+ #
5691
+ # @!attribute [rw] arn
5692
+ # The Amazon Resource Name (ARN) for the folder.
5693
+ # @return [String]
5694
+ #
5695
+ # @!attribute [rw] permissions
5696
+ # Information about the permissions on the folder.
5697
+ # @return [Array<Types::ResourcePermission>]
5698
+ #
5699
+ # @!attribute [rw] request_id
5700
+ # The request ID.
5701
+ # @return [String]
5702
+ #
5703
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderPermissionsResponse AWS API Documentation
5704
+ #
5705
+ class DescribeFolderPermissionsResponse < Struct.new(
5706
+ :status,
5707
+ :folder_id,
5708
+ :arn,
5709
+ :permissions,
5710
+ :request_id)
5711
+ SENSITIVE = []
5712
+ include Aws::Structure
5713
+ end
5714
+
5715
+ # @note When making an API call, you may pass DescribeFolderRequest
5716
+ # data as a hash:
5717
+ #
5718
+ # {
5719
+ # aws_account_id: "AwsAccountId", # required
5720
+ # folder_id: "RestrictiveResourceId", # required
5721
+ # }
5722
+ #
5723
+ # @!attribute [rw] aws_account_id
5724
+ # The AWS account ID.
5725
+ # @return [String]
5726
+ #
5727
+ # @!attribute [rw] folder_id
5728
+ # The folder ID.
5729
+ # @return [String]
5730
+ #
5731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderRequest AWS API Documentation
5732
+ #
5733
+ class DescribeFolderRequest < Struct.new(
5734
+ :aws_account_id,
5735
+ :folder_id)
5736
+ SENSITIVE = []
5737
+ include Aws::Structure
5738
+ end
5739
+
5740
+ # @note When making an API call, you may pass DescribeFolderResolvedPermissionsRequest
5741
+ # data as a hash:
5742
+ #
5743
+ # {
5744
+ # aws_account_id: "AwsAccountId", # required
5745
+ # folder_id: "RestrictiveResourceId", # required
5746
+ # }
5747
+ #
5748
+ # @!attribute [rw] aws_account_id
5749
+ # The AWS account ID.
5750
+ # @return [String]
5751
+ #
5752
+ # @!attribute [rw] folder_id
5753
+ # The folder ID.
5754
+ # @return [String]
5755
+ #
5756
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResolvedPermissionsRequest AWS API Documentation
5757
+ #
5758
+ class DescribeFolderResolvedPermissionsRequest < Struct.new(
5759
+ :aws_account_id,
5760
+ :folder_id)
5761
+ SENSITIVE = []
5762
+ include Aws::Structure
5763
+ end
5764
+
5765
+ # @!attribute [rw] status
5766
+ # The status. If succeeded, the status is `SC_OK`
5767
+ # @return [Integer]
5768
+ #
5769
+ # @!attribute [rw] folder_id
5770
+ # The folder ID.
5771
+ # @return [String]
5772
+ #
5773
+ # @!attribute [rw] arn
5774
+ # The Amazon Resource Name (ARN).
5775
+ # @return [String]
5776
+ #
5777
+ # @!attribute [rw] permissions
5778
+ # Information about the permissions on the dashboard.
5779
+ # @return [Array<Types::ResourcePermission>]
5780
+ #
5781
+ # @!attribute [rw] request_id
5782
+ # The request ID.
5783
+ # @return [String]
5784
+ #
5785
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResolvedPermissionsResponse AWS API Documentation
5786
+ #
5787
+ class DescribeFolderResolvedPermissionsResponse < Struct.new(
5788
+ :status,
5789
+ :folder_id,
5790
+ :arn,
5791
+ :permissions,
5792
+ :request_id)
5793
+ SENSITIVE = []
5794
+ include Aws::Structure
5795
+ end
5796
+
5797
+ # @!attribute [rw] status
5798
+ # The status. If succeeded, the status is `SC_OK (200)`.
5799
+ # @return [Integer]
5800
+ #
5801
+ # @!attribute [rw] folder
5802
+ # Information about the folder.
5803
+ # @return [Types::Folder]
5804
+ #
5805
+ # @!attribute [rw] request_id
5806
+ # The request ID.
5807
+ # @return [String]
5808
+ #
5809
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeFolderResponse AWS API Documentation
5810
+ #
5811
+ class DescribeFolderResponse < Struct.new(
5812
+ :status,
5813
+ :folder,
5814
+ :request_id)
5815
+ SENSITIVE = []
5816
+ include Aws::Structure
5817
+ end
5818
+
5385
5819
  # @note When making an API call, you may pass DescribeGroupRequest
5386
5820
  # data as a hash:
5387
5821
  #
@@ -6122,6 +6556,145 @@ module Aws::QuickSight
6122
6556
  include Aws::Structure
6123
6557
  end
6124
6558
 
6559
+ # A folder.
6560
+ #
6561
+ # @!attribute [rw] folder_id
6562
+ # The folder ID.
6563
+ # @return [String]
6564
+ #
6565
+ # @!attribute [rw] arn
6566
+ # The folder Amazon Resource Name (ARN).
6567
+ # @return [String]
6568
+ #
6569
+ # @!attribute [rw] name
6570
+ # A display name for the folder.
6571
+ # @return [String]
6572
+ #
6573
+ # @!attribute [rw] folder_type
6574
+ # The type of the folder.
6575
+ # @return [String]
6576
+ #
6577
+ # @!attribute [rw] folder_path
6578
+ # An array of ancestor folder ARN strings.
6579
+ # @return [Array<String>]
6580
+ #
6581
+ # @!attribute [rw] created_time
6582
+ # The time that the folder was created.
6583
+ # @return [Time]
6584
+ #
6585
+ # @!attribute [rw] last_updated_time
6586
+ # The time that the folder was last updated.
6587
+ # @return [Time]
6588
+ #
6589
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Folder AWS API Documentation
6590
+ #
6591
+ class Folder < Struct.new(
6592
+ :folder_id,
6593
+ :arn,
6594
+ :name,
6595
+ :folder_type,
6596
+ :folder_path,
6597
+ :created_time,
6598
+ :last_updated_time)
6599
+ SENSITIVE = []
6600
+ include Aws::Structure
6601
+ end
6602
+
6603
+ # An asset in a folder, such as a dashboard, analysis, or dataset.
6604
+ #
6605
+ # @!attribute [rw] member_id
6606
+ # The ID of the asset.
6607
+ # @return [String]
6608
+ #
6609
+ # @!attribute [rw] member_type
6610
+ # The type of the asset.
6611
+ # @return [String]
6612
+ #
6613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FolderMember AWS API Documentation
6614
+ #
6615
+ class FolderMember < Struct.new(
6616
+ :member_id,
6617
+ :member_type)
6618
+ SENSITIVE = []
6619
+ include Aws::Structure
6620
+ end
6621
+
6622
+ # Searches a folder by a filter.
6623
+ #
6624
+ # @note When making an API call, you may pass FolderSearchFilter
6625
+ # data as a hash:
6626
+ #
6627
+ # {
6628
+ # operator: "StringEquals", # accepts StringEquals
6629
+ # name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN
6630
+ # value: "String",
6631
+ # }
6632
+ #
6633
+ # @!attribute [rw] operator
6634
+ # The comparison operator that you want to use as a filter. For
6635
+ # example, `"Operator": "StringEquals"`.
6636
+ # @return [String]
6637
+ #
6638
+ # @!attribute [rw] name
6639
+ # The name of the value that you want to use as a filter. For example,
6640
+ # `"Name": "PARENT_FOLDER_ARN"`.
6641
+ # @return [String]
6642
+ #
6643
+ # @!attribute [rw] value
6644
+ # The value of the named item (in this example, `PARENT_FOLDER_ARN`),
6645
+ # that you want to use as a filter. For example, `"Value":
6646
+ # "arn:aws:quicksight:us-east-1:1:folder/folderId"`.
6647
+ # @return [String]
6648
+ #
6649
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FolderSearchFilter AWS API Documentation
6650
+ #
6651
+ class FolderSearchFilter < Struct.new(
6652
+ :operator,
6653
+ :name,
6654
+ :value)
6655
+ SENSITIVE = []
6656
+ include Aws::Structure
6657
+ end
6658
+
6659
+ # A summary of the folder.
6660
+ #
6661
+ # @!attribute [rw] arn
6662
+ # The Amazon Resource Name (ARN).
6663
+ # @return [String]
6664
+ #
6665
+ # @!attribute [rw] folder_id
6666
+ # The folder ID.
6667
+ # @return [String]
6668
+ #
6669
+ # @!attribute [rw] name
6670
+ # The display name of the folder.
6671
+ # @return [String]
6672
+ #
6673
+ # @!attribute [rw] folder_type
6674
+ # The type of folder.
6675
+ # @return [String]
6676
+ #
6677
+ # @!attribute [rw] created_time
6678
+ # The time that the folder was created.
6679
+ # @return [Time]
6680
+ #
6681
+ # @!attribute [rw] last_updated_time
6682
+ # The time that the folder was last updated.
6683
+ # @return [Time]
6684
+ #
6685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/FolderSummary AWS API Documentation
6686
+ #
6687
+ class FolderSummary < Struct.new(
6688
+ :arn,
6689
+ :folder_id,
6690
+ :name,
6691
+ :folder_type,
6692
+ :created_time,
6693
+ :last_updated_time)
6694
+ SENSITIVE = []
6695
+ include Aws::Structure
6696
+ end
6697
+
6125
6698
  # Geospatial column group that denotes a hierarchy.
6126
6699
  #
6127
6700
  # @note When making an API call, you may pass GeoSpatialColumnGroup
@@ -7016,11 +7589,132 @@ module Aws::QuickSight
7016
7589
  include Aws::Structure
7017
7590
  end
7018
7591
 
7019
- # @note When making an API call, you may pass ListDataSetsRequest
7592
+ # @note When making an API call, you may pass ListDataSetsRequest
7593
+ # data as a hash:
7594
+ #
7595
+ # {
7596
+ # aws_account_id: "AwsAccountId", # required
7597
+ # next_token: "String",
7598
+ # max_results: 1,
7599
+ # }
7600
+ #
7601
+ # @!attribute [rw] aws_account_id
7602
+ # The AWS account ID.
7603
+ # @return [String]
7604
+ #
7605
+ # @!attribute [rw] next_token
7606
+ # The token for the next set of results, or null if there are no more
7607
+ # results.
7608
+ # @return [String]
7609
+ #
7610
+ # @!attribute [rw] max_results
7611
+ # The maximum number of results to be returned per request.
7612
+ # @return [Integer]
7613
+ #
7614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDataSetsRequest AWS API Documentation
7615
+ #
7616
+ class ListDataSetsRequest < Struct.new(
7617
+ :aws_account_id,
7618
+ :next_token,
7619
+ :max_results)
7620
+ SENSITIVE = []
7621
+ include Aws::Structure
7622
+ end
7623
+
7624
+ # @!attribute [rw] data_set_summaries
7625
+ # The list of dataset summaries.
7626
+ # @return [Array<Types::DataSetSummary>]
7627
+ #
7628
+ # @!attribute [rw] next_token
7629
+ # The token for the next set of results, or null if there are no more
7630
+ # results.
7631
+ # @return [String]
7632
+ #
7633
+ # @!attribute [rw] request_id
7634
+ # The AWS request ID for this operation.
7635
+ # @return [String]
7636
+ #
7637
+ # @!attribute [rw] status
7638
+ # The HTTP status of the request.
7639
+ # @return [Integer]
7640
+ #
7641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDataSetsResponse AWS API Documentation
7642
+ #
7643
+ class ListDataSetsResponse < Struct.new(
7644
+ :data_set_summaries,
7645
+ :next_token,
7646
+ :request_id,
7647
+ :status)
7648
+ SENSITIVE = []
7649
+ include Aws::Structure
7650
+ end
7651
+
7652
+ # @note When making an API call, you may pass ListDataSourcesRequest
7653
+ # data as a hash:
7654
+ #
7655
+ # {
7656
+ # aws_account_id: "AwsAccountId", # required
7657
+ # next_token: "String",
7658
+ # max_results: 1,
7659
+ # }
7660
+ #
7661
+ # @!attribute [rw] aws_account_id
7662
+ # The AWS account ID.
7663
+ # @return [String]
7664
+ #
7665
+ # @!attribute [rw] next_token
7666
+ # The token for the next set of results, or null if there are no more
7667
+ # results.
7668
+ # @return [String]
7669
+ #
7670
+ # @!attribute [rw] max_results
7671
+ # The maximum number of results to be returned per request.
7672
+ # @return [Integer]
7673
+ #
7674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDataSourcesRequest AWS API Documentation
7675
+ #
7676
+ class ListDataSourcesRequest < Struct.new(
7677
+ :aws_account_id,
7678
+ :next_token,
7679
+ :max_results)
7680
+ SENSITIVE = []
7681
+ include Aws::Structure
7682
+ end
7683
+
7684
+ # @!attribute [rw] data_sources
7685
+ # A list of data sources.
7686
+ # @return [Array<Types::DataSource>]
7687
+ #
7688
+ # @!attribute [rw] next_token
7689
+ # The token for the next set of results, or null if there are no more
7690
+ # results.
7691
+ # @return [String]
7692
+ #
7693
+ # @!attribute [rw] request_id
7694
+ # The AWS request ID for this operation.
7695
+ # @return [String]
7696
+ #
7697
+ # @!attribute [rw] status
7698
+ # The HTTP status of the request.
7699
+ # @return [Integer]
7700
+ #
7701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDataSourcesResponse AWS API Documentation
7702
+ #
7703
+ class ListDataSourcesResponse < Struct.new(
7704
+ :data_sources,
7705
+ :next_token,
7706
+ :request_id,
7707
+ :status)
7708
+ SENSITIVE = []
7709
+ include Aws::Structure
7710
+ end
7711
+
7712
+ # @note When making an API call, you may pass ListFolderMembersRequest
7020
7713
  # data as a hash:
7021
7714
  #
7022
7715
  # {
7023
7716
  # aws_account_id: "AwsAccountId", # required
7717
+ # folder_id: "RestrictiveResourceId", # required
7024
7718
  # next_token: "String",
7025
7719
  # max_results: 1,
7026
7720
  # }
@@ -7029,6 +7723,10 @@ module Aws::QuickSight
7029
7723
  # The AWS account ID.
7030
7724
  # @return [String]
7031
7725
  #
7726
+ # @!attribute [rw] folder_id
7727
+ # The folder ID.
7728
+ # @return [String]
7729
+ #
7032
7730
  # @!attribute [rw] next_token
7033
7731
  # The token for the next set of results, or null if there are no more
7034
7732
  # results.
@@ -7038,19 +7736,25 @@ module Aws::QuickSight
7038
7736
  # The maximum number of results to be returned per request.
7039
7737
  # @return [Integer]
7040
7738
  #
7041
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDataSetsRequest AWS API Documentation
7739
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolderMembersRequest AWS API Documentation
7042
7740
  #
7043
- class ListDataSetsRequest < Struct.new(
7741
+ class ListFolderMembersRequest < Struct.new(
7044
7742
  :aws_account_id,
7743
+ :folder_id,
7045
7744
  :next_token,
7046
7745
  :max_results)
7047
7746
  SENSITIVE = []
7048
7747
  include Aws::Structure
7049
7748
  end
7050
7749
 
7051
- # @!attribute [rw] data_set_summaries
7052
- # The list of dataset summaries.
7053
- # @return [Array<Types::DataSetSummary>]
7750
+ # @!attribute [rw] status
7751
+ # The status. If succeeded, the status is `SC_OK`
7752
+ # @return [Integer]
7753
+ #
7754
+ # @!attribute [rw] folder_member_list
7755
+ # A structure that contains all of the folder members (dashboards,
7756
+ # analyses, and datasets) in the folder.
7757
+ # @return [Array<Types::MemberIdArnPair>]
7054
7758
  #
7055
7759
  # @!attribute [rw] next_token
7056
7760
  # The token for the next set of results, or null if there are no more
@@ -7058,25 +7762,21 @@ module Aws::QuickSight
7058
7762
  # @return [String]
7059
7763
  #
7060
7764
  # @!attribute [rw] request_id
7061
- # The AWS request ID for this operation.
7765
+ # The request ID.
7062
7766
  # @return [String]
7063
7767
  #
7064
- # @!attribute [rw] status
7065
- # The HTTP status of the request.
7066
- # @return [Integer]
7067
- #
7068
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDataSetsResponse AWS API Documentation
7768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFolderMembersResponse AWS API Documentation
7069
7769
  #
7070
- class ListDataSetsResponse < Struct.new(
7071
- :data_set_summaries,
7770
+ class ListFolderMembersResponse < Struct.new(
7771
+ :status,
7772
+ :folder_member_list,
7072
7773
  :next_token,
7073
- :request_id,
7074
- :status)
7774
+ :request_id)
7075
7775
  SENSITIVE = []
7076
7776
  include Aws::Structure
7077
7777
  end
7078
7778
 
7079
- # @note When making an API call, you may pass ListDataSourcesRequest
7779
+ # @note When making an API call, you may pass ListFoldersRequest
7080
7780
  # data as a hash:
7081
7781
  #
7082
7782
  # {
@@ -7098,9 +7798,9 @@ module Aws::QuickSight
7098
7798
  # The maximum number of results to be returned per request.
7099
7799
  # @return [Integer]
7100
7800
  #
7101
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDataSourcesRequest AWS API Documentation
7801
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFoldersRequest AWS API Documentation
7102
7802
  #
7103
- class ListDataSourcesRequest < Struct.new(
7803
+ class ListFoldersRequest < Struct.new(
7104
7804
  :aws_account_id,
7105
7805
  :next_token,
7106
7806
  :max_results)
@@ -7108,9 +7808,14 @@ module Aws::QuickSight
7108
7808
  include Aws::Structure
7109
7809
  end
7110
7810
 
7111
- # @!attribute [rw] data_sources
7112
- # A list of data sources.
7113
- # @return [Array<Types::DataSource>]
7811
+ # @!attribute [rw] status
7812
+ # The status. If succeeded, the status is `SC_OK`
7813
+ # @return [Integer]
7814
+ #
7815
+ # @!attribute [rw] folder_summary_list
7816
+ # A structure that contains all of the folders in your AWS account.
7817
+ # This structure provides basic information about the folders.
7818
+ # @return [Array<Types::FolderSummary>]
7114
7819
  #
7115
7820
  # @!attribute [rw] next_token
7116
7821
  # The token for the next set of results, or null if there are no more
@@ -7118,20 +7823,16 @@ module Aws::QuickSight
7118
7823
  # @return [String]
7119
7824
  #
7120
7825
  # @!attribute [rw] request_id
7121
- # The AWS request ID for this operation.
7826
+ # The request ID.
7122
7827
  # @return [String]
7123
7828
  #
7124
- # @!attribute [rw] status
7125
- # The HTTP status of the request.
7126
- # @return [Integer]
7127
- #
7128
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListDataSourcesResponse AWS API Documentation
7829
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListFoldersResponse AWS API Documentation
7129
7830
  #
7130
- class ListDataSourcesResponse < Struct.new(
7131
- :data_sources,
7831
+ class ListFoldersResponse < Struct.new(
7832
+ :status,
7833
+ :folder_summary_list,
7132
7834
  :next_token,
7133
- :request_id,
7134
- :status)
7835
+ :request_id)
7135
7836
  SENSITIVE = []
7136
7837
  include Aws::Structure
7137
7838
  end
@@ -8344,6 +9045,26 @@ module Aws::QuickSight
8344
9045
  include Aws::Structure
8345
9046
  end
8346
9047
 
9048
+ # An object that consists of the member Amazon Resource Name (ARN) and
9049
+ # member ID.
9050
+ #
9051
+ # @!attribute [rw] member_id
9052
+ # The ID of the member.
9053
+ # @return [String]
9054
+ #
9055
+ # @!attribute [rw] member_arn
9056
+ # The Amazon Resource Name (ARN) of the member.
9057
+ # @return [String]
9058
+ #
9059
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/MemberIdArnPair AWS API Documentation
9060
+ #
9061
+ class MemberIdArnPair < Struct.new(
9062
+ :member_id,
9063
+ :member_arn)
9064
+ SENSITIVE = []
9065
+ include Aws::Structure
9066
+ end
9067
+
8347
9068
  # MySQL parameters.
8348
9069
  #
8349
9070
  # @note When making an API call, you may pass MySqlParameters
@@ -8853,6 +9574,9 @@ module Aws::QuickSight
8853
9574
  # namespace: "Namespace", # required
8854
9575
  # user_name: "UserName",
8855
9576
  # custom_permissions_name: "RoleName",
9577
+ # external_login_federation_provider_type: "String",
9578
+ # custom_federation_provider_url: "String",
9579
+ # external_login_id: "String",
8856
9580
  # }
8857
9581
  #
8858
9582
  # @!attribute [rw] identity_type
@@ -8956,6 +9680,35 @@ module Aws::QuickSight
8956
9680
  # (SSO).
8957
9681
  # @return [String]
8958
9682
  #
9683
+ # @!attribute [rw] external_login_federation_provider_type
9684
+ # The type of supported external login provider that provides identity
9685
+ # to let a user federate into Amazon QuickSight with an associated AWS
9686
+ # Identity and Access Management (IAM) role. The type of supported
9687
+ # external login provider can be one of the following.
9688
+ #
9689
+ # * `COGNITO`\: Amazon Cognito. The provider URL is
9690
+ # cognito-identity.amazonaws.com. When choosing the `COGNITO`
9691
+ # provider type, don’t use the "CustomFederationProviderUrl"
9692
+ # parameter which is only needed when the external provider is
9693
+ # custom.
9694
+ #
9695
+ # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When
9696
+ # choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
9697
+ # parameter to provide the custom OIDC provider URL.
9698
+ # @return [String]
9699
+ #
9700
+ # @!attribute [rw] custom_federation_provider_url
9701
+ # The URL of the custom OpenID Connect (OIDC) provider that provides
9702
+ # identity to let a user federate into QuickSight with an associated
9703
+ # AWS Identity and Access Management (IAM) role. This parameter should
9704
+ # only be used when `ExternalLoginFederationProviderType` parameter is
9705
+ # set to `CUSTOM_OIDC`.
9706
+ # @return [String]
9707
+ #
9708
+ # @!attribute [rw] external_login_id
9709
+ # The identity ID for a user in the external login provider.
9710
+ # @return [String]
9711
+ #
8959
9712
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUserRequest AWS API Documentation
8960
9713
  #
8961
9714
  class RegisterUserRequest < Struct.new(
@@ -8967,7 +9720,10 @@ module Aws::QuickSight
8967
9720
  :aws_account_id,
8968
9721
  :namespace,
8969
9722
  :user_name,
8970
- :custom_permissions_name)
9723
+ :custom_permissions_name,
9724
+ :external_login_federation_provider_type,
9725
+ :custom_federation_provider_url,
9726
+ :external_login_id)
8971
9727
  SENSITIVE = []
8972
9728
  include Aws::Structure
8973
9729
  end
@@ -9259,7 +10015,18 @@ module Aws::QuickSight
9259
10015
  include Aws::Structure
9260
10016
  end
9261
10017
 
9262
- # The row-level security configuration for the dataset.
10018
+ # Information about a dataset that contains permissions for row-level
10019
+ # security (RLS). The permissions dataset maps fields to users or
10020
+ # groups. For more information, see [Using Row-Level Security (RLS) to
10021
+ # Restrict Access to a Dataset][1] in the *Amazon QuickSight User
10022
+ # Guide*.
10023
+ #
10024
+ # The option to deny permissions by setting `PermissionPolicy` to
10025
+ # `DENY_ACCESS` is not supported for new RLS datasets.
10026
+ #
10027
+ #
10028
+ #
10029
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html
9263
10030
  #
9264
10031
  # @note When making an API call, you may pass RowLevelPermissionDataSet
9265
10032
  # data as a hash:
@@ -9268,18 +10035,32 @@ module Aws::QuickSight
9268
10035
  # namespace: "Namespace",
9269
10036
  # arn: "Arn", # required
9270
10037
  # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
10038
+ # format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
9271
10039
  # }
9272
10040
  #
9273
10041
  # @!attribute [rw] namespace
9274
- # The namespace associated with the row-level permissions dataset.
10042
+ # The namespace associated with the dataset that contains permissions
10043
+ # for RLS.
9275
10044
  # @return [String]
9276
10045
  #
9277
10046
  # @!attribute [rw] arn
9278
- # The Amazon Resource Name (ARN) of the permission dataset.
10047
+ # The Amazon Resource Name (ARN) of the dataset that contains
10048
+ # permissions for RLS.
9279
10049
  # @return [String]
9280
10050
  #
9281
10051
  # @!attribute [rw] permission_policy
9282
- # Permission policy.
10052
+ # The type of permissions to use when interpretting the permissions
10053
+ # for RLS. `DENY_ACCESS` is included for backward compatibility only.
10054
+ # @return [String]
10055
+ #
10056
+ # @!attribute [rw] format_version
10057
+ # The user or group rules associated with the dataset that contains
10058
+ # permissions for RLS.
10059
+ #
10060
+ # By default, `FormatVersion` is `VERSION_1`. When `FormatVersion` is
10061
+ # `VERSION_1`, `UserName` and `GroupName` are required. When
10062
+ # `FormatVersion` is `VERSION_2`, `UserARN` and `GroupARN` are
10063
+ # required, and `Namespace` must not exist.
9283
10064
  # @return [String]
9284
10065
  #
9285
10066
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RowLevelPermissionDataSet AWS API Documentation
@@ -9287,7 +10068,8 @@ module Aws::QuickSight
9287
10068
  class RowLevelPermissionDataSet < Struct.new(
9288
10069
  :namespace,
9289
10070
  :arn,
9290
- :permission_policy)
10071
+ :permission_policy,
10072
+ :format_version)
9291
10073
  SENSITIVE = []
9292
10074
  include Aws::Structure
9293
10075
  end
@@ -9317,7 +10099,7 @@ module Aws::QuickSight
9317
10099
  include Aws::Structure
9318
10100
  end
9319
10101
 
9320
- # A physical table type for as S3 data source.
10102
+ # A physical table type for an S3 data source.
9321
10103
  #
9322
10104
  # @note When making an API call, you may pass S3Source
9323
10105
  # data as a hash:
@@ -9340,7 +10122,7 @@ module Aws::QuickSight
9340
10122
  # }
9341
10123
  #
9342
10124
  # @!attribute [rw] data_source_arn
9343
- # The amazon Resource Name (ARN) for the data source.
10125
+ # The Amazon Resource Name (ARN) for the data source.
9344
10126
  # @return [String]
9345
10127
  #
9346
10128
  # @!attribute [rw] upload_settings
@@ -9348,7 +10130,12 @@ module Aws::QuickSight
9348
10130
  # @return [Types::UploadSettings]
9349
10131
  #
9350
10132
  # @!attribute [rw] input_columns
9351
- # A physical table type for as S3 data source.
10133
+ # A physical table type for an S3 data source.
10134
+ #
10135
+ # <note markdown="1"> For non-JSON files, only `STRING` data types are supported in input
10136
+ # columns.
10137
+ #
10138
+ # </note>
9352
10139
  # @return [Array<Types::InputColumn>]
9353
10140
  #
9354
10141
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/S3Source AWS API Documentation
@@ -9510,6 +10297,82 @@ module Aws::QuickSight
9510
10297
  include Aws::Structure
9511
10298
  end
9512
10299
 
10300
+ # @note When making an API call, you may pass SearchFoldersRequest
10301
+ # data as a hash:
10302
+ #
10303
+ # {
10304
+ # aws_account_id: "AwsAccountId", # required
10305
+ # filters: [ # required
10306
+ # {
10307
+ # operator: "StringEquals", # accepts StringEquals
10308
+ # name: "PARENT_FOLDER_ARN", # accepts PARENT_FOLDER_ARN
10309
+ # value: "String",
10310
+ # },
10311
+ # ],
10312
+ # next_token: "String",
10313
+ # max_results: 1,
10314
+ # }
10315
+ #
10316
+ # @!attribute [rw] aws_account_id
10317
+ # The AWS account ID.
10318
+ # @return [String]
10319
+ #
10320
+ # @!attribute [rw] filters
10321
+ # The filters to apply to the search. Currently, you can search only
10322
+ # by the parent folder ARN. For example, `"Filters": [ \{ "Name":
10323
+ # "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value":
10324
+ # "arn:aws:quicksight:us-east-1:1:folder/folderId" \} ]`.
10325
+ # @return [Array<Types::FolderSearchFilter>]
10326
+ #
10327
+ # @!attribute [rw] next_token
10328
+ # The token for the next set of results, or null if there are no more
10329
+ # results.
10330
+ # @return [String]
10331
+ #
10332
+ # @!attribute [rw] max_results
10333
+ # The maximum number of results to be returned per request.
10334
+ # @return [Integer]
10335
+ #
10336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchFoldersRequest AWS API Documentation
10337
+ #
10338
+ class SearchFoldersRequest < Struct.new(
10339
+ :aws_account_id,
10340
+ :filters,
10341
+ :next_token,
10342
+ :max_results)
10343
+ SENSITIVE = []
10344
+ include Aws::Structure
10345
+ end
10346
+
10347
+ # @!attribute [rw] status
10348
+ # The status. If succeeded, the status is `SC_OK`.
10349
+ # @return [Integer]
10350
+ #
10351
+ # @!attribute [rw] folder_summary_list
10352
+ # A structure that contains all of the folders in your AWS account.
10353
+ # This structure provides basic information about the folders.
10354
+ # @return [Array<Types::FolderSummary>]
10355
+ #
10356
+ # @!attribute [rw] next_token
10357
+ # The token for the next set of results, or null if there are no more
10358
+ # results.
10359
+ # @return [String]
10360
+ #
10361
+ # @!attribute [rw] request_id
10362
+ # The request ID.
10363
+ # @return [String]
10364
+ #
10365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchFoldersResponse AWS API Documentation
10366
+ #
10367
+ class SearchFoldersResponse < Struct.new(
10368
+ :status,
10369
+ :folder_summary_list,
10370
+ :next_token,
10371
+ :request_id)
10372
+ SENSITIVE = []
10373
+ include Aws::Structure
10374
+ end
10375
+
9513
10376
  # ServiceNow parameters.
9514
10377
  #
9515
10378
  # @note When making an API call, you may pass ServiceNowParameters
@@ -11792,6 +12655,7 @@ module Aws::QuickSight
11792
12655
  # namespace: "Namespace",
11793
12656
  # arn: "Arn", # required
11794
12657
  # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
12658
+ # format_version: "VERSION_1", # accepts VERSION_1, VERSION_2
11795
12659
  # },
11796
12660
  # column_level_permission_rules: [
11797
12661
  # {
@@ -12269,6 +13133,143 @@ module Aws::QuickSight
12269
13133
  include Aws::Structure
12270
13134
  end
12271
13135
 
13136
+ # @note When making an API call, you may pass UpdateFolderPermissionsRequest
13137
+ # data as a hash:
13138
+ #
13139
+ # {
13140
+ # aws_account_id: "AwsAccountId", # required
13141
+ # folder_id: "RestrictiveResourceId", # required
13142
+ # grant_permissions: [
13143
+ # {
13144
+ # principal: "Principal", # required
13145
+ # actions: ["String"], # required
13146
+ # },
13147
+ # ],
13148
+ # revoke_permissions: [
13149
+ # {
13150
+ # principal: "Principal", # required
13151
+ # actions: ["String"], # required
13152
+ # },
13153
+ # ],
13154
+ # }
13155
+ #
13156
+ # @!attribute [rw] aws_account_id
13157
+ # The AWS account ID.
13158
+ # @return [String]
13159
+ #
13160
+ # @!attribute [rw] folder_id
13161
+ # The folder ID.
13162
+ # @return [String]
13163
+ #
13164
+ # @!attribute [rw] grant_permissions
13165
+ # The permissions that you want to grant on a resource.
13166
+ # @return [Array<Types::ResourcePermission>]
13167
+ #
13168
+ # @!attribute [rw] revoke_permissions
13169
+ # The permissions that you want to revoke from a resource.
13170
+ # @return [Array<Types::ResourcePermission>]
13171
+ #
13172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderPermissionsRequest AWS API Documentation
13173
+ #
13174
+ class UpdateFolderPermissionsRequest < Struct.new(
13175
+ :aws_account_id,
13176
+ :folder_id,
13177
+ :grant_permissions,
13178
+ :revoke_permissions)
13179
+ SENSITIVE = []
13180
+ include Aws::Structure
13181
+ end
13182
+
13183
+ # @!attribute [rw] status
13184
+ # The status. If succeeded, the status is `SC_OK`.
13185
+ # @return [Integer]
13186
+ #
13187
+ # @!attribute [rw] arn
13188
+ # The Amazon Resource Name (ARN).
13189
+ # @return [String]
13190
+ #
13191
+ # @!attribute [rw] folder_id
13192
+ # The folder ID.
13193
+ # @return [String]
13194
+ #
13195
+ # @!attribute [rw] permissions
13196
+ # Information about the permissions on the dashboard.
13197
+ # @return [Array<Types::ResourcePermission>]
13198
+ #
13199
+ # @!attribute [rw] request_id
13200
+ # The request ID.
13201
+ # @return [String]
13202
+ #
13203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderPermissionsResponse AWS API Documentation
13204
+ #
13205
+ class UpdateFolderPermissionsResponse < Struct.new(
13206
+ :status,
13207
+ :arn,
13208
+ :folder_id,
13209
+ :permissions,
13210
+ :request_id)
13211
+ SENSITIVE = []
13212
+ include Aws::Structure
13213
+ end
13214
+
13215
+ # @note When making an API call, you may pass UpdateFolderRequest
13216
+ # data as a hash:
13217
+ #
13218
+ # {
13219
+ # aws_account_id: "AwsAccountId", # required
13220
+ # folder_id: "RestrictiveResourceId", # required
13221
+ # name: "FolderName", # required
13222
+ # }
13223
+ #
13224
+ # @!attribute [rw] aws_account_id
13225
+ # The AWS account ID.
13226
+ # @return [String]
13227
+ #
13228
+ # @!attribute [rw] folder_id
13229
+ # The folder ID.
13230
+ # @return [String]
13231
+ #
13232
+ # @!attribute [rw] name
13233
+ # The name of the folder.
13234
+ # @return [String]
13235
+ #
13236
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderRequest AWS API Documentation
13237
+ #
13238
+ class UpdateFolderRequest < Struct.new(
13239
+ :aws_account_id,
13240
+ :folder_id,
13241
+ :name)
13242
+ SENSITIVE = []
13243
+ include Aws::Structure
13244
+ end
13245
+
13246
+ # @!attribute [rw] status
13247
+ # The status. If succeeded, the status is `SC_OK`.
13248
+ # @return [Integer]
13249
+ #
13250
+ # @!attribute [rw] arn
13251
+ # The Amazon Resource Name (ARN).
13252
+ # @return [String]
13253
+ #
13254
+ # @!attribute [rw] folder_id
13255
+ # The folder ID.
13256
+ # @return [String]
13257
+ #
13258
+ # @!attribute [rw] request_id
13259
+ # The request ID.
13260
+ # @return [String]
13261
+ #
13262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateFolderResponse AWS API Documentation
13263
+ #
13264
+ class UpdateFolderResponse < Struct.new(
13265
+ :status,
13266
+ :arn,
13267
+ :folder_id,
13268
+ :request_id)
13269
+ SENSITIVE = []
13270
+ include Aws::Structure
13271
+ end
13272
+
12272
13273
  # @note When making an API call, you may pass UpdateGroupRequest
12273
13274
  # data as a hash:
12274
13275
  #
@@ -12981,6 +13982,9 @@ module Aws::QuickSight
12981
13982
  # role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
12982
13983
  # custom_permissions_name: "RoleName",
12983
13984
  # unapply_custom_permissions: false,
13985
+ # external_login_federation_provider_type: "String",
13986
+ # custom_federation_provider_url: "String",
13987
+ # external_login_id: "String",
12984
13988
  # }
12985
13989
  #
12986
13990
  # @!attribute [rw] user_name
@@ -13055,6 +14059,39 @@ module Aws::QuickSight
13055
14059
  # value.
13056
14060
  # @return [Boolean]
13057
14061
  #
14062
+ # @!attribute [rw] external_login_federation_provider_type
14063
+ # The type of supported external login provider that provides identity
14064
+ # to let a user federate into QuickSight with an associated AWS
14065
+ # Identity and Access Management (IAM) role. The type of supported
14066
+ # external login provider can be one of the following.
14067
+ #
14068
+ # * `COGNITO`\: Amazon Cognito. The provider URL is
14069
+ # cognito-identity.amazonaws.com. When choosing the `COGNITO`
14070
+ # provider type, don’t use the "CustomFederationProviderUrl"
14071
+ # parameter which is only needed when the external provider is
14072
+ # custom.
14073
+ #
14074
+ # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider. When
14075
+ # choosing `CUSTOM_OIDC` type, use the `CustomFederationProviderUrl`
14076
+ # parameter to provide the custom OIDC provider URL.
14077
+ #
14078
+ # * `NONE`\: This clears all the previously saved external login
14079
+ # information for a user. Use ` DescribeUser ` API to check the
14080
+ # external login information.
14081
+ # @return [String]
14082
+ #
14083
+ # @!attribute [rw] custom_federation_provider_url
14084
+ # The URL of the custom OpenID Connect (OIDC) provider that provides
14085
+ # identity to let a user federate into QuickSight with an associated
14086
+ # AWS Identity and Access Management (IAM) role. This parameter should
14087
+ # only be used when `ExternalLoginFederationProviderType` parameter is
14088
+ # set to `CUSTOM_OIDC`.
14089
+ # @return [String]
14090
+ #
14091
+ # @!attribute [rw] external_login_id
14092
+ # The identity ID for a user in the external login provider.
14093
+ # @return [String]
14094
+ #
13058
14095
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUserRequest AWS API Documentation
13059
14096
  #
13060
14097
  class UpdateUserRequest < Struct.new(
@@ -13064,7 +14101,10 @@ module Aws::QuickSight
13064
14101
  :email,
13065
14102
  :role,
13066
14103
  :custom_permissions_name,
13067
- :unapply_custom_permissions)
14104
+ :unapply_custom_permissions,
14105
+ :external_login_federation_provider_type,
14106
+ :custom_federation_provider_url,
14107
+ :external_login_id)
13068
14108
  SENSITIVE = []
13069
14109
  include Aws::Structure
13070
14110
  end
@@ -13188,6 +14228,25 @@ module Aws::QuickSight
13188
14228
  # The custom permissions profile associated with this user.
13189
14229
  # @return [String]
13190
14230
  #
14231
+ # @!attribute [rw] external_login_federation_provider_type
14232
+ # The type of supported external login provider that provides identity
14233
+ # to let the user federate into Amazon QuickSight with an associated
14234
+ # IAM role. The type can be one of the following.
14235
+ #
14236
+ # * `COGNITO`\: Amazon Cognito. The provider URL is
14237
+ # cognito-identity.amazonaws.com.
14238
+ #
14239
+ # * `CUSTOM_OIDC`\: Custom OpenID Connect (OIDC) provider.
14240
+ # @return [String]
14241
+ #
14242
+ # @!attribute [rw] external_login_federation_provider_url
14243
+ # The URL of the external login provider.
14244
+ # @return [String]
14245
+ #
14246
+ # @!attribute [rw] external_login_id
14247
+ # The identity ID for the user in the external login provider.
14248
+ # @return [String]
14249
+ #
13191
14250
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/User AWS API Documentation
13192
14251
  #
13193
14252
  class User < Struct.new(
@@ -13198,7 +14257,10 @@ module Aws::QuickSight
13198
14257
  :identity_type,
13199
14258
  :active,
13200
14259
  :principal_id,
13201
- :custom_permissions_name)
14260
+ :custom_permissions_name,
14261
+ :external_login_federation_provider_type,
14262
+ :external_login_federation_provider_url,
14263
+ :external_login_id)
13202
14264
  SENSITIVE = []
13203
14265
  include Aws::Structure
13204
14266
  end