aws-sdk-quicksight 1.23.0 → 1.24.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.
@@ -52,6 +52,7 @@ module Aws::QuickSight
52
52
  ColumnTagList = Shapes::ListShape.new(name: 'ColumnTagList')
53
53
  ConcurrentUpdatingException = Shapes::StructureShape.new(name: 'ConcurrentUpdatingException')
54
54
  ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
55
+ CopySourceArn = Shapes::StringShape.new(name: 'CopySourceArn')
55
56
  CreateColumnsOperation = Shapes::StructureShape.new(name: 'CreateColumnsOperation')
56
57
  CreateDashboardRequest = Shapes::StructureShape.new(name: 'CreateDashboardRequest')
57
58
  CreateDashboardResponse = Shapes::StructureShape.new(name: 'CreateDashboardResponse')
@@ -109,6 +110,7 @@ module Aws::QuickSight
109
110
  DataSourceErrorInfoType = Shapes::StringShape.new(name: 'DataSourceErrorInfoType')
110
111
  DataSourceList = Shapes::ListShape.new(name: 'DataSourceList')
111
112
  DataSourceParameters = Shapes::StructureShape.new(name: 'DataSourceParameters')
113
+ DataSourceParametersList = Shapes::ListShape.new(name: 'DataSourceParametersList')
112
114
  DataSourceType = Shapes::StringShape.new(name: 'DataSourceType')
113
115
  Database = Shapes::StringShape.new(name: 'Database')
114
116
  DateTimeParameter = Shapes::StructureShape.new(name: 'DateTimeParameter')
@@ -637,6 +639,7 @@ module Aws::QuickSight
637
639
 
638
640
  CredentialPair.add_member(:username, Shapes::ShapeRef.new(shape: Username, required: true, location_name: "Username"))
639
641
  CredentialPair.add_member(:password, Shapes::ShapeRef.new(shape: Password, required: true, location_name: "Password"))
642
+ CredentialPair.add_member(:alternate_data_source_parameters, Shapes::ShapeRef.new(shape: DataSourceParametersList, location_name: "AlternateDataSourceParameters"))
640
643
  CredentialPair.struct_class = Types::CredentialPair
641
644
 
642
645
  CustomSql.add_member(:data_source_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "DataSourceArn"))
@@ -761,12 +764,14 @@ module Aws::QuickSight
761
764
  DataSource.add_member(:created_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedTime"))
762
765
  DataSource.add_member(:last_updated_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastUpdatedTime"))
763
766
  DataSource.add_member(:data_source_parameters, Shapes::ShapeRef.new(shape: DataSourceParameters, location_name: "DataSourceParameters"))
767
+ DataSource.add_member(:alternate_data_source_parameters, Shapes::ShapeRef.new(shape: DataSourceParametersList, location_name: "AlternateDataSourceParameters"))
764
768
  DataSource.add_member(:vpc_connection_properties, Shapes::ShapeRef.new(shape: VpcConnectionProperties, location_name: "VpcConnectionProperties"))
765
769
  DataSource.add_member(:ssl_properties, Shapes::ShapeRef.new(shape: SslProperties, location_name: "SslProperties"))
766
770
  DataSource.add_member(:error_info, Shapes::ShapeRef.new(shape: DataSourceErrorInfo, location_name: "ErrorInfo"))
767
771
  DataSource.struct_class = Types::DataSource
768
772
 
769
773
  DataSourceCredentials.add_member(:credential_pair, Shapes::ShapeRef.new(shape: CredentialPair, location_name: "CredentialPair"))
774
+ DataSourceCredentials.add_member(:copy_source_arn, Shapes::ShapeRef.new(shape: CopySourceArn, location_name: "CopySourceArn"))
770
775
  DataSourceCredentials.struct_class = Types::DataSourceCredentials
771
776
 
772
777
  DataSourceErrorInfo.add_member(:type, Shapes::ShapeRef.new(shape: DataSourceErrorInfoType, location_name: "Type"))
@@ -796,6 +801,8 @@ module Aws::QuickSight
796
801
  DataSourceParameters.add_member(:twitter_parameters, Shapes::ShapeRef.new(shape: TwitterParameters, location_name: "TwitterParameters"))
797
802
  DataSourceParameters.struct_class = Types::DataSourceParameters
798
803
 
804
+ DataSourceParametersList.member = Shapes::ShapeRef.new(shape: DataSourceParameters)
805
+
799
806
  DateTimeParameter.add_member(:name, Shapes::ShapeRef.new(shape: NonEmptyString, required: true, location_name: "Name"))
800
807
  DateTimeParameter.add_member(:values, Shapes::ShapeRef.new(shape: TimestampList, required: true, location_name: "Values"))
801
808
  DateTimeParameter.struct_class = Types::DateTimeParameter
@@ -415,7 +415,7 @@ module Aws::QuickSight
415
415
  include Aws::Structure
416
416
  end
417
417
 
418
- # A tag for a column in a `TagColumnOperation` structure. This is a
418
+ # A tag for a column in a TagColumnOperation structure. This is a
419
419
  # variant type structure. For this structure to be valid, only one of
420
420
  # the attributes can be non-null.
421
421
  #
@@ -587,9 +587,7 @@ module Aws::QuickSight
587
587
  # @!attribute [rw] parameters
588
588
  # A structure that contains the parameters of the dashboard. These are
589
589
  # parameter overrides for a dashboard. A dashboard can have any type
590
- # of parameters, and some parameters might accept multiple values. You
591
- # can use the dashboard permissions structure described following to
592
- # override two string parameters that accept multiple values.
590
+ # of parameters, and some parameters might accept multiple values.
593
591
  # @return [Types::Parameters]
594
592
  #
595
593
  # @!attribute [rw] permissions
@@ -599,15 +597,19 @@ module Aws::QuickSight
599
597
  # @return [Array<Types::ResourcePermission>]
600
598
  #
601
599
  # @!attribute [rw] source_entity
602
- # The source entity from which the dashboard is created. The source
603
- # entity accepts the Amazon Resource Name (ARN) of the source template
604
- # or analysis and also references the replacement datasets for the
605
- # placeholders set when creating the template. The replacement
606
- # datasets need to follow the same schema as the datasets for which
607
- # placeholders were created when creating the template.
608
- #
609
- # If you are creating a dashboard from a source entity in a different
610
- # AWS account, use the ARN of the source template.
600
+ # The entity that you are using as a source when you create the
601
+ # dashboard. In `SourceEntity`, you specify the type of object you're
602
+ # using as source. You can only create a dashboard from a template, so
603
+ # you use a `SourceTemplate` entity. If you need to create a dashboard
604
+ # from an analysis, first convert the analysis to a template by using
605
+ # the CreateTemplate API operation. For `SourceTemplate`, specify the
606
+ # Amazon Resource Name (ARN) of the source template. The
607
+ # `SourceTemplate`ARN can contain any AWS Account and any
608
+ # QuickSight-supported AWS Region.
609
+ #
610
+ # Use the `DataSetReferences` entity within `SourceTemplate` to list
611
+ # the replacement datasets for the placeholders listed in the
612
+ # original. The schema in each dataset must match its placeholder.
611
613
  # @return [Types::DashboardSourceEntity]
612
614
  #
613
615
  # @!attribute [rw] tags
@@ -634,8 +636,7 @@ module Aws::QuickSight
634
636
  # option is `ENABLED` by default.
635
637
  #
636
638
  # * `VisibilityState` for `SheetControlsOption` - This visibility
637
- # state can be either `COLLAPSED` or `EXPANDED`. The sheet controls
638
- # pane is collapsed by default when set to true. This option is
639
+ # state can be either `COLLAPSED` or `EXPANDED`. This option is
639
640
  # `COLLAPSED` by default.
640
641
  # @return [Types::DashboardPublishOptions]
641
642
  #
@@ -1021,7 +1022,96 @@ module Aws::QuickSight
1021
1022
  # credential_pair: {
1022
1023
  # username: "Username", # required
1023
1024
  # password: "Password", # required
1025
+ # alternate_data_source_parameters: [
1026
+ # {
1027
+ # amazon_elasticsearch_parameters: {
1028
+ # domain: "Domain", # required
1029
+ # },
1030
+ # athena_parameters: {
1031
+ # work_group: "WorkGroup",
1032
+ # },
1033
+ # aurora_parameters: {
1034
+ # host: "Host", # required
1035
+ # port: 1, # required
1036
+ # database: "Database", # required
1037
+ # },
1038
+ # aurora_postgre_sql_parameters: {
1039
+ # host: "Host", # required
1040
+ # port: 1, # required
1041
+ # database: "Database", # required
1042
+ # },
1043
+ # aws_iot_analytics_parameters: {
1044
+ # data_set_name: "DataSetName", # required
1045
+ # },
1046
+ # jira_parameters: {
1047
+ # site_base_url: "SiteBaseUrl", # required
1048
+ # },
1049
+ # maria_db_parameters: {
1050
+ # host: "Host", # required
1051
+ # port: 1, # required
1052
+ # database: "Database", # required
1053
+ # },
1054
+ # my_sql_parameters: {
1055
+ # host: "Host", # required
1056
+ # port: 1, # required
1057
+ # database: "Database", # required
1058
+ # },
1059
+ # postgre_sql_parameters: {
1060
+ # host: "Host", # required
1061
+ # port: 1, # required
1062
+ # database: "Database", # required
1063
+ # },
1064
+ # presto_parameters: {
1065
+ # host: "Host", # required
1066
+ # port: 1, # required
1067
+ # catalog: "Catalog", # required
1068
+ # },
1069
+ # rds_parameters: {
1070
+ # instance_id: "InstanceId", # required
1071
+ # database: "Database", # required
1072
+ # },
1073
+ # redshift_parameters: {
1074
+ # host: "Host",
1075
+ # port: 1,
1076
+ # database: "Database", # required
1077
+ # cluster_id: "ClusterId",
1078
+ # },
1079
+ # s3_parameters: {
1080
+ # manifest_file_location: { # required
1081
+ # bucket: "S3Bucket", # required
1082
+ # key: "S3Key", # required
1083
+ # },
1084
+ # },
1085
+ # service_now_parameters: {
1086
+ # site_base_url: "SiteBaseUrl", # required
1087
+ # },
1088
+ # snowflake_parameters: {
1089
+ # host: "Host", # required
1090
+ # database: "Database", # required
1091
+ # warehouse: "Warehouse", # required
1092
+ # },
1093
+ # spark_parameters: {
1094
+ # host: "Host", # required
1095
+ # port: 1, # required
1096
+ # },
1097
+ # sql_server_parameters: {
1098
+ # host: "Host", # required
1099
+ # port: 1, # required
1100
+ # database: "Database", # required
1101
+ # },
1102
+ # teradata_parameters: {
1103
+ # host: "Host", # required
1104
+ # port: 1, # required
1105
+ # database: "Database", # required
1106
+ # },
1107
+ # twitter_parameters: {
1108
+ # query: "Query", # required
1109
+ # max_rows: 1, # required
1110
+ # },
1111
+ # },
1112
+ # ],
1024
1113
  # },
1114
+ # copy_source_arn: "CopySourceArn",
1025
1115
  # },
1026
1116
  # permissions: [
1027
1117
  # {
@@ -1568,10 +1658,19 @@ module Aws::QuickSight
1568
1658
  # @return [Array<Types::ResourcePermission>]
1569
1659
  #
1570
1660
  # @!attribute [rw] source_entity
1571
- # The Amazon Resource Name (ARN) of the source entity from which this
1572
- # template is being created. Currently, you can create a template from
1573
- # an analysis or another template. If the ARN is for an analysis,
1574
- # include its dataset references.
1661
+ # The entity that you are using as a source when you create the
1662
+ # template. In `SourceEntity`, you specify the type of object you're
1663
+ # using as source: `SourceTemplate` for a template or `SourceAnalysis`
1664
+ # for an analysis. Both of these require an Amazon Resource Name
1665
+ # (ARN). For `SourceTemplate`, specify the ARN of the source template.
1666
+ # For `SourceAnalysis`, specify the ARN of the source analysis. The
1667
+ # `SourceTemplate` ARN can contain any AWS Account and any
1668
+ # QuickSight-supported AWS Region.
1669
+ #
1670
+ # Use the `DataSetReferences` entity within `SourceTemplate` or
1671
+ # `SourceAnalysis` to list the replacement datasets for the
1672
+ # placeholders listed in the original. The schema in each dataset must
1673
+ # match its placeholder.
1575
1674
  # @return [Types::TemplateSourceEntity]
1576
1675
  #
1577
1676
  # @!attribute [rw] tags
@@ -1648,6 +1747,94 @@ module Aws::QuickSight
1648
1747
  # {
1649
1748
  # username: "Username", # required
1650
1749
  # password: "Password", # required
1750
+ # alternate_data_source_parameters: [
1751
+ # {
1752
+ # amazon_elasticsearch_parameters: {
1753
+ # domain: "Domain", # required
1754
+ # },
1755
+ # athena_parameters: {
1756
+ # work_group: "WorkGroup",
1757
+ # },
1758
+ # aurora_parameters: {
1759
+ # host: "Host", # required
1760
+ # port: 1, # required
1761
+ # database: "Database", # required
1762
+ # },
1763
+ # aurora_postgre_sql_parameters: {
1764
+ # host: "Host", # required
1765
+ # port: 1, # required
1766
+ # database: "Database", # required
1767
+ # },
1768
+ # aws_iot_analytics_parameters: {
1769
+ # data_set_name: "DataSetName", # required
1770
+ # },
1771
+ # jira_parameters: {
1772
+ # site_base_url: "SiteBaseUrl", # required
1773
+ # },
1774
+ # maria_db_parameters: {
1775
+ # host: "Host", # required
1776
+ # port: 1, # required
1777
+ # database: "Database", # required
1778
+ # },
1779
+ # my_sql_parameters: {
1780
+ # host: "Host", # required
1781
+ # port: 1, # required
1782
+ # database: "Database", # required
1783
+ # },
1784
+ # postgre_sql_parameters: {
1785
+ # host: "Host", # required
1786
+ # port: 1, # required
1787
+ # database: "Database", # required
1788
+ # },
1789
+ # presto_parameters: {
1790
+ # host: "Host", # required
1791
+ # port: 1, # required
1792
+ # catalog: "Catalog", # required
1793
+ # },
1794
+ # rds_parameters: {
1795
+ # instance_id: "InstanceId", # required
1796
+ # database: "Database", # required
1797
+ # },
1798
+ # redshift_parameters: {
1799
+ # host: "Host",
1800
+ # port: 1,
1801
+ # database: "Database", # required
1802
+ # cluster_id: "ClusterId",
1803
+ # },
1804
+ # s3_parameters: {
1805
+ # manifest_file_location: { # required
1806
+ # bucket: "S3Bucket", # required
1807
+ # key: "S3Key", # required
1808
+ # },
1809
+ # },
1810
+ # service_now_parameters: {
1811
+ # site_base_url: "SiteBaseUrl", # required
1812
+ # },
1813
+ # snowflake_parameters: {
1814
+ # host: "Host", # required
1815
+ # database: "Database", # required
1816
+ # warehouse: "Warehouse", # required
1817
+ # },
1818
+ # spark_parameters: {
1819
+ # host: "Host", # required
1820
+ # port: 1, # required
1821
+ # },
1822
+ # sql_server_parameters: {
1823
+ # host: "Host", # required
1824
+ # port: 1, # required
1825
+ # database: "Database", # required
1826
+ # },
1827
+ # teradata_parameters: {
1828
+ # host: "Host", # required
1829
+ # port: 1, # required
1830
+ # database: "Database", # required
1831
+ # },
1832
+ # twitter_parameters: {
1833
+ # query: "Query", # required
1834
+ # max_rows: 1, # required
1835
+ # },
1836
+ # },
1837
+ # ],
1651
1838
  # }
1652
1839
  #
1653
1840
  # @!attribute [rw] username
@@ -1658,11 +1845,25 @@ module Aws::QuickSight
1658
1845
  # Password.
1659
1846
  # @return [String]
1660
1847
  #
1848
+ # @!attribute [rw] alternate_data_source_parameters
1849
+ # A set of alternate data source parameters that you want to share for
1850
+ # these credentials. The credentials are applied in tandem with the
1851
+ # data source parameters when you copy a data source by using a create
1852
+ # or update request. The API compares the `DataSourceParameters`
1853
+ # structure that's in the request with the structures in the
1854
+ # `AlternateDataSourceParameters` allowlist. If the structures are an
1855
+ # exact match, the request is allowed to use the new data source with
1856
+ # the existing credentials. If the `AlternateDataSourceParameters`
1857
+ # list is null, the `DataSourceParameters` originally used with these
1858
+ # `Credentials` is automatically allowed.
1859
+ # @return [Array<Types::DataSourceParameters>]
1860
+ #
1661
1861
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CredentialPair AWS API Documentation
1662
1862
  #
1663
1863
  class CredentialPair < Struct.new(
1664
1864
  :username,
1665
- :password)
1865
+ :password,
1866
+ :alternate_data_source_parameters)
1666
1867
  SENSITIVE = []
1667
1868
  include Aws::Structure
1668
1869
  end
@@ -1825,18 +2026,18 @@ module Aws::QuickSight
1825
2026
  # }
1826
2027
  #
1827
2028
  # @!attribute [rw] operator
1828
- # The comparison operator that you want to use as a filter. For
2029
+ # The comparison operator that you want to use as a filter, for
1829
2030
  # example, `"Operator": "StringEquals"`.
1830
2031
  # @return [String]
1831
2032
  #
1832
2033
  # @!attribute [rw] name
1833
- # The name of the value that you want to use as a filter. For example,
2034
+ # The name of the value that you want to use as a filter, for example,
1834
2035
  # `"Name": "QUICKSIGHT_USER"`.
1835
2036
  # @return [String]
1836
2037
  #
1837
2038
  # @!attribute [rw] value
1838
2039
  # The value of the named item, in this case `QUICKSIGHT_USER`, that
1839
- # you want to use as a filter. For example, `"Value":
2040
+ # you want to use as a filter, for example, `"Value":
1840
2041
  # "arn:aws:quicksight:us-east-1:1:user/default/UserName1"`.
1841
2042
  # @return [String]
1842
2043
  #
@@ -2265,6 +2466,20 @@ module Aws::QuickSight
2265
2466
  # structure to be valid, only one of the attributes can be non-null.
2266
2467
  # @return [Types::DataSourceParameters]
2267
2468
  #
2469
+ # @!attribute [rw] alternate_data_source_parameters
2470
+ # A set of alternate data source parameters that you want to share for
2471
+ # the credentials stored with this data source. The credentials are
2472
+ # applied in tandem with the data source parameters when you copy a
2473
+ # data source by using a create or update request. The API compares
2474
+ # the `DataSourceParameters` structure that's in the request with the
2475
+ # structures in the `AlternateDataSourceParameters` allowlist. If the
2476
+ # structures are an exact match, the request is allowed to use the
2477
+ # credentials from this existing data source. If the
2478
+ # `AlternateDataSourceParameters` list is null, the `Credentials`
2479
+ # originally used with this `DataSourceParameters` are automatically
2480
+ # allowed.
2481
+ # @return [Array<Types::DataSourceParameters>]
2482
+ #
2268
2483
  # @!attribute [rw] vpc_connection_properties
2269
2484
  # The VPC connection information. You need to use this parameter only
2270
2485
  # when you want QuickSight to use a VPC connection when connecting to
@@ -2292,6 +2507,7 @@ module Aws::QuickSight
2292
2507
  :created_time,
2293
2508
  :last_updated_time,
2294
2509
  :data_source_parameters,
2510
+ :alternate_data_source_parameters,
2295
2511
  :vpc_connection_properties,
2296
2512
  :ssl_properties,
2297
2513
  :error_info)
@@ -2299,7 +2515,8 @@ module Aws::QuickSight
2299
2515
  include Aws::Structure
2300
2516
  end
2301
2517
 
2302
- # Data source credentials.
2518
+ # Data source credentials. This is a variant type structure. For this
2519
+ # structure to be valid, only one of the attributes can be non-null.
2303
2520
  #
2304
2521
  # @note When making an API call, you may pass DataSourceCredentials
2305
2522
  # data as a hash:
@@ -2308,17 +2525,114 @@ module Aws::QuickSight
2308
2525
  # credential_pair: {
2309
2526
  # username: "Username", # required
2310
2527
  # password: "Password", # required
2528
+ # alternate_data_source_parameters: [
2529
+ # {
2530
+ # amazon_elasticsearch_parameters: {
2531
+ # domain: "Domain", # required
2532
+ # },
2533
+ # athena_parameters: {
2534
+ # work_group: "WorkGroup",
2535
+ # },
2536
+ # aurora_parameters: {
2537
+ # host: "Host", # required
2538
+ # port: 1, # required
2539
+ # database: "Database", # required
2540
+ # },
2541
+ # aurora_postgre_sql_parameters: {
2542
+ # host: "Host", # required
2543
+ # port: 1, # required
2544
+ # database: "Database", # required
2545
+ # },
2546
+ # aws_iot_analytics_parameters: {
2547
+ # data_set_name: "DataSetName", # required
2548
+ # },
2549
+ # jira_parameters: {
2550
+ # site_base_url: "SiteBaseUrl", # required
2551
+ # },
2552
+ # maria_db_parameters: {
2553
+ # host: "Host", # required
2554
+ # port: 1, # required
2555
+ # database: "Database", # required
2556
+ # },
2557
+ # my_sql_parameters: {
2558
+ # host: "Host", # required
2559
+ # port: 1, # required
2560
+ # database: "Database", # required
2561
+ # },
2562
+ # postgre_sql_parameters: {
2563
+ # host: "Host", # required
2564
+ # port: 1, # required
2565
+ # database: "Database", # required
2566
+ # },
2567
+ # presto_parameters: {
2568
+ # host: "Host", # required
2569
+ # port: 1, # required
2570
+ # catalog: "Catalog", # required
2571
+ # },
2572
+ # rds_parameters: {
2573
+ # instance_id: "InstanceId", # required
2574
+ # database: "Database", # required
2575
+ # },
2576
+ # redshift_parameters: {
2577
+ # host: "Host",
2578
+ # port: 1,
2579
+ # database: "Database", # required
2580
+ # cluster_id: "ClusterId",
2581
+ # },
2582
+ # s3_parameters: {
2583
+ # manifest_file_location: { # required
2584
+ # bucket: "S3Bucket", # required
2585
+ # key: "S3Key", # required
2586
+ # },
2587
+ # },
2588
+ # service_now_parameters: {
2589
+ # site_base_url: "SiteBaseUrl", # required
2590
+ # },
2591
+ # snowflake_parameters: {
2592
+ # host: "Host", # required
2593
+ # database: "Database", # required
2594
+ # warehouse: "Warehouse", # required
2595
+ # },
2596
+ # spark_parameters: {
2597
+ # host: "Host", # required
2598
+ # port: 1, # required
2599
+ # },
2600
+ # sql_server_parameters: {
2601
+ # host: "Host", # required
2602
+ # port: 1, # required
2603
+ # database: "Database", # required
2604
+ # },
2605
+ # teradata_parameters: {
2606
+ # host: "Host", # required
2607
+ # port: 1, # required
2608
+ # database: "Database", # required
2609
+ # },
2610
+ # twitter_parameters: {
2611
+ # query: "Query", # required
2612
+ # max_rows: 1, # required
2613
+ # },
2614
+ # },
2615
+ # ],
2311
2616
  # },
2617
+ # copy_source_arn: "CopySourceArn",
2312
2618
  # }
2313
2619
  #
2314
2620
  # @!attribute [rw] credential_pair
2315
- # Credential pair.
2621
+ # Credential pair. For more information, see CredentialPair.
2316
2622
  # @return [Types::CredentialPair]
2317
2623
  #
2624
+ # @!attribute [rw] copy_source_arn
2625
+ # The Amazon Resource Name (ARN) of a data source that has the
2626
+ # credential pair that you want to use. When `CopySourceArn` is not
2627
+ # null, the credential pair from the data source in the ARN is used as
2628
+ # the credentials for the `DataSourceCredentials` structure.
2629
+ # @return [String]
2630
+ #
2318
2631
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DataSourceCredentials AWS API Documentation
2319
2632
  #
2320
2633
  class DataSourceCredentials < Struct.new(
2321
- :credential_pair)
2634
+ :credential_pair,
2635
+ :copy_source_arn)
2322
2636
  SENSITIVE = []
2323
2637
  include Aws::Structure
2324
2638
  end
@@ -2940,10 +3254,10 @@ module Aws::QuickSight
2940
3254
  # @return [String]
2941
3255
  #
2942
3256
  # @!attribute [rw] alias_name
2943
- # The name for the template alias. If you name a specific alias, you
3257
+ # The name for the template alias. To delete a specific alias, you
2944
3258
  # delete the version that the alias points to. You can specify the
2945
- # latest version of the template by providing the keyword `$LATEST` in
2946
- # the `AliasName` parameter.
3259
+ # alias name, or specify the latest version of the template by
3260
+ # providing the keyword `$LATEST` in the `AliasName` parameter.
2947
3261
  # @return [String]
2948
3262
  #
2949
3263
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTemplateAliasRequest AWS API Documentation
@@ -2969,7 +3283,7 @@ module Aws::QuickSight
2969
3283
  # @return [String]
2970
3284
  #
2971
3285
  # @!attribute [rw] arn
2972
- # The Amazon Resource Name (ARN) of the resource.
3286
+ # The Amazon Resource Name (ARN) of the template you want to delete.
2973
3287
  # @return [String]
2974
3288
  #
2975
3289
  # @!attribute [rw] request_id
@@ -4062,10 +4376,10 @@ module Aws::QuickSight
4062
4376
  end
4063
4377
 
4064
4378
  # @!attribute [rw] embed_url
4065
- # An URL that you can put into your server-side webpage to embed your
4066
- # dashboard. This URL is valid for 5 minutes, and the resulting
4067
- # session is valid for 10 hours. The API provides the URL with an
4068
- # `auth_code` value that enables a single sign-on session.
4379
+ # A single-use URL that you can put into your server-side webpage to
4380
+ # embed your dashboard. This URL is valid for 5 minutes. The API
4381
+ # provides the URL with an `auth_code` value that enables one (and
4382
+ # only one) sign-on to a user session that is valid for 10 hours.
4069
4383
  # @return [String]
4070
4384
  #
4071
4385
  # @!attribute [rw] status
@@ -6223,7 +6537,7 @@ module Aws::QuickSight
6223
6537
  # @return [String]
6224
6538
  #
6225
6539
  # @!attribute [rw] resource_type
6226
- # The AWS request ID for this request.
6540
+ # The resource type for this request.
6227
6541
  # @return [String]
6228
6542
  #
6229
6543
  # @!attribute [rw] request_id
@@ -6246,7 +6560,7 @@ module Aws::QuickSight
6246
6560
  # @return [String]
6247
6561
  #
6248
6562
  # @!attribute [rw] resource_type
6249
- # The AWS request ID for this request.
6563
+ # The resource type for this request.
6250
6564
  # @return [String]
6251
6565
  #
6252
6566
  # @!attribute [rw] request_id
@@ -6455,7 +6769,7 @@ module Aws::QuickSight
6455
6769
  #
6456
6770
  # @!attribute [rw] filters
6457
6771
  # The filters to apply to the search. Currently, you can search only
6458
- # by user name. For example, `"Filters": [ \{ "Name":
6772
+ # by user name, for example, `"Filters": [ \{ "Name":
6459
6773
  # "QUICKSIGHT_USER", "Operator": "StringEquals", "Value":
6460
6774
  # "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]`
6461
6775
  # @return [Array<Types::DashboardSearchFilter>]
@@ -7567,16 +7881,25 @@ module Aws::QuickSight
7567
7881
  # @return [String]
7568
7882
  #
7569
7883
  # @!attribute [rw] source_entity
7570
- # The template or analysis from which the dashboard is created. The
7571
- # `SouceTemplate` entity accepts the Amazon Resource Name (ARN) of the
7572
- # template and also references to replacement datasets for the
7573
- # placeholders set when creating the template. The replacement
7574
- # datasets need to follow the same schema as the datasets for which
7575
- # placeholders were created when creating the template.
7884
+ # The entity that you are using as a source when you update the
7885
+ # dashboard. In `SourceEntity`, you specify the type of object you're
7886
+ # using as source. You can only update a dashboard from a template, so
7887
+ # you use a `SourceTemplate` entity. If you need to update a dashboard
7888
+ # from an analysis, first convert the analysis to a template by using
7889
+ # the CreateTemplate API operation. For `SourceTemplate`, specify the
7890
+ # Amazon Resource Name (ARN) of the source template. The
7891
+ # `SourceTemplate` ARN can contain any AWS Account and any
7892
+ # QuickSight-supported AWS Region.
7893
+ #
7894
+ # Use the `DataSetReferences` entity within `SourceTemplate` to list
7895
+ # the replacement datasets for the placeholders listed in the
7896
+ # original. The schema in each dataset must match its placeholder.
7576
7897
  # @return [Types::DashboardSourceEntity]
7577
7898
  #
7578
7899
  # @!attribute [rw] parameters
7579
- # A structure that contains the parameters of the dashboard.
7900
+ # A structure that contains the parameters of the dashboard. These are
7901
+ # parameter overrides for a dashboard. A dashboard can have any type
7902
+ # of parameters, and some parameters might accept multiple values.
7580
7903
  # @return [Types::Parameters]
7581
7904
  #
7582
7905
  # @!attribute [rw] version_description
@@ -7598,8 +7921,7 @@ module Aws::QuickSight
7598
7921
  # option is `ENABLED` by default.
7599
7922
  #
7600
7923
  # * `VisibilityState` for `SheetControlsOption` - This visibility
7601
- # state can be either `COLLAPSED` or `EXPANDED`. The sheet controls
7602
- # pane is collapsed by default when set to true. This option is
7924
+ # state can be either `COLLAPSED` or `EXPANDED`. This option is
7603
7925
  # `COLLAPSED` by default.
7604
7926
  # @return [Types::DashboardPublishOptions]
7605
7927
  #
@@ -8112,7 +8434,96 @@ module Aws::QuickSight
8112
8434
  # credential_pair: {
8113
8435
  # username: "Username", # required
8114
8436
  # password: "Password", # required
8437
+ # alternate_data_source_parameters: [
8438
+ # {
8439
+ # amazon_elasticsearch_parameters: {
8440
+ # domain: "Domain", # required
8441
+ # },
8442
+ # athena_parameters: {
8443
+ # work_group: "WorkGroup",
8444
+ # },
8445
+ # aurora_parameters: {
8446
+ # host: "Host", # required
8447
+ # port: 1, # required
8448
+ # database: "Database", # required
8449
+ # },
8450
+ # aurora_postgre_sql_parameters: {
8451
+ # host: "Host", # required
8452
+ # port: 1, # required
8453
+ # database: "Database", # required
8454
+ # },
8455
+ # aws_iot_analytics_parameters: {
8456
+ # data_set_name: "DataSetName", # required
8457
+ # },
8458
+ # jira_parameters: {
8459
+ # site_base_url: "SiteBaseUrl", # required
8460
+ # },
8461
+ # maria_db_parameters: {
8462
+ # host: "Host", # required
8463
+ # port: 1, # required
8464
+ # database: "Database", # required
8465
+ # },
8466
+ # my_sql_parameters: {
8467
+ # host: "Host", # required
8468
+ # port: 1, # required
8469
+ # database: "Database", # required
8470
+ # },
8471
+ # postgre_sql_parameters: {
8472
+ # host: "Host", # required
8473
+ # port: 1, # required
8474
+ # database: "Database", # required
8475
+ # },
8476
+ # presto_parameters: {
8477
+ # host: "Host", # required
8478
+ # port: 1, # required
8479
+ # catalog: "Catalog", # required
8480
+ # },
8481
+ # rds_parameters: {
8482
+ # instance_id: "InstanceId", # required
8483
+ # database: "Database", # required
8484
+ # },
8485
+ # redshift_parameters: {
8486
+ # host: "Host",
8487
+ # port: 1,
8488
+ # database: "Database", # required
8489
+ # cluster_id: "ClusterId",
8490
+ # },
8491
+ # s3_parameters: {
8492
+ # manifest_file_location: { # required
8493
+ # bucket: "S3Bucket", # required
8494
+ # key: "S3Key", # required
8495
+ # },
8496
+ # },
8497
+ # service_now_parameters: {
8498
+ # site_base_url: "SiteBaseUrl", # required
8499
+ # },
8500
+ # snowflake_parameters: {
8501
+ # host: "Host", # required
8502
+ # database: "Database", # required
8503
+ # warehouse: "Warehouse", # required
8504
+ # },
8505
+ # spark_parameters: {
8506
+ # host: "Host", # required
8507
+ # port: 1, # required
8508
+ # },
8509
+ # sql_server_parameters: {
8510
+ # host: "Host", # required
8511
+ # port: 1, # required
8512
+ # database: "Database", # required
8513
+ # },
8514
+ # teradata_parameters: {
8515
+ # host: "Host", # required
8516
+ # port: 1, # required
8517
+ # database: "Database", # required
8518
+ # },
8519
+ # twitter_parameters: {
8520
+ # query: "Query", # required
8521
+ # max_rows: 1, # required
8522
+ # },
8523
+ # },
8524
+ # ],
8115
8525
  # },
8526
+ # copy_source_arn: "CopySourceArn",
8116
8527
  # },
8117
8528
  # vpc_connection_properties: {
8118
8529
  # vpc_connection_arn: "Arn", # required
@@ -8557,9 +8968,19 @@ module Aws::QuickSight
8557
8968
  # @return [String]
8558
8969
  #
8559
8970
  # @!attribute [rw] source_entity
8560
- # The source QuickSight entity from which this template is being
8561
- # updated. You can currently update templates from an Analysis or
8562
- # another template.
8971
+ # The entity that you are using as a source when you update the
8972
+ # template. In `SourceEntity`, you specify the type of object you're
8973
+ # using as source: `SourceTemplate` for a template or `SourceAnalysis`
8974
+ # for an analysis. Both of these require an Amazon Resource Name
8975
+ # (ARN). For `SourceTemplate`, specify the ARN of the source template.
8976
+ # For `SourceAnalysis`, specify the ARN of the source analysis. The
8977
+ # `SourceTemplate` ARN can contain any AWS Account and any
8978
+ # QuickSight-supported AWS Region.
8979
+ #
8980
+ # Use the `DataSetReferences` entity within `SourceTemplate` or
8981
+ # `SourceAnalysis` to list the replacement datasets for the
8982
+ # placeholders listed in the original. The schema in each dataset must
8983
+ # match its placeholder.
8563
8984
  # @return [Types::TemplateSourceEntity]
8564
8985
  #
8565
8986
  # @!attribute [rw] version_description