aws-sdk-quicksight 1.23.0 → 1.28.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 916d33dfa324a02be3b0f59025cae2499c1c3a255eca4b88060a3440b7e6f12b
4
- data.tar.gz: e1a4603f15682d7cb5fc1b7966f1ac87fad9651547c8385730eb45f4e61b9de2
3
+ metadata.gz: b32d8920de8cedb139e55f011d16553fbccaaef823847085e97dc61ee007a6a4
4
+ data.tar.gz: 3c66b2c594ff0f6093f649fb310b2cc01934b3d19597c264ca8892988f0d05b2
5
5
  SHA512:
6
- metadata.gz: 0502fd9d822d7ba51266ac8c78c56c5b3dba31618d1f358ad8abd2e30d14fec6aff5645b67d8924bb1ce765cc4a7d2b969bb32f8519b843de43bb465541a3d8c
7
- data.tar.gz: 2a48c7ad168615b7efc553fd7e35813237b68b19e6a3df6c780156122b9eed953973cbd808ef3339506f5f055e14470977fdf2eb5e92064ef88c0e99a17bfd44
6
+ metadata.gz: de1007d0aee4ff06790d054e7aef2da0817697cdee865d5ec6532cb3d9e1796b40f70f8bcc18a562934c5548bbc15f68e89165e7217358499798d47dd8738b0e
7
+ data.tar.gz: 8d61b513f1a8c164fc8011c6afc6e3f4830d20e8294952ff7b56843ea1bd38c4ac9eaaf9d12a16c18342679af2aecbcd2afd0b811db61b305003288fe5501bb5
@@ -44,9 +44,9 @@ require_relative 'aws-sdk-quicksight/customizations'
44
44
  #
45
45
  # See {Errors} for more information.
46
46
  #
47
- # @service
47
+ # @!group service
48
48
  module Aws::QuickSight
49
49
 
50
- GEM_VERSION = '1.23.0'
50
+ GEM_VERSION = '1.28.0'
51
51
 
52
52
  end
@@ -85,13 +85,28 @@ module Aws::QuickSight
85
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
86
  # credentials.
87
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
88
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
103
  # from an EC2 IMDS on an EC2 instance.
90
104
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
93
107
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
95
110
  #
96
111
  # When `:credentials` are not configured directly, the following
97
112
  # locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::QuickSight
101
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
117
  # * `~/.aws/credentials`
103
118
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
108
123
  #
109
124
  # @option options [required, String] :region
110
125
  # The AWS region to connect to. The configured `:region` is
@@ -354,16 +369,214 @@ module Aws::QuickSight
354
369
  req.send_request(options)
355
370
  end
356
371
 
372
+ # Creates Amazon QuickSight customizations the current AWS Region.
373
+ # Currently, you can add a custom default theme by using the
374
+ # `CreateAccountCustomization` or `UpdateAccountCustomization` API
375
+ # operation. To further customize QuickSight by removing QuickSight
376
+ # sample assets and videos for all new users, see [Customizing
377
+ # QuickSight][1] in the Amazon QuickSight User Guide.
378
+ #
379
+ # You can create customizations for your AWS account or, if you specify
380
+ # a namespace, for a QuickSight namespace instead. Customizations that
381
+ # apply to a namespace always override customizations that apply to an
382
+ # AWS account. To find out which customizations apply, use the
383
+ # `DescribeAccountCustomization` API operation.
384
+ #
385
+ # Before you add a theme as the namespace default, make sure that you
386
+ # first share the theme with the namespace. If you don't share it with
387
+ # the namespace, the theme won't be visible to your users even if you
388
+ # use this API operation to make it the default theme.
389
+ #
390
+ #
391
+ #
392
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html
393
+ #
394
+ # @option params [required, String] :aws_account_id
395
+ # The ID for the AWS account that you want to customize QuickSight for.
396
+ #
397
+ # @option params [String] :namespace
398
+ # The QuickSight namespace that you want to add customizations to.
399
+ #
400
+ # @option params [required, Types::AccountCustomization] :account_customization
401
+ # The QuickSight customizations you're adding in the current AWS
402
+ # Region. You can add these to an AWS account and a QuickSight
403
+ # namespace.
404
+ #
405
+ # For example, you could add a default theme by setting
406
+ # `AccountCustomization` to the midnight theme: `"AccountCustomization":
407
+ # \{ "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" \}. `. Or,
408
+ # you could add a custom theme by specifying `"AccountCustomization": \{
409
+ # "DefaultTheme":
410
+ # "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
411
+ # \}`.
412
+ #
413
+ # @return [Types::CreateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
414
+ #
415
+ # * {Types::CreateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
416
+ # * {Types::CreateAccountCustomizationResponse#namespace #namespace} => String
417
+ # * {Types::CreateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
418
+ # * {Types::CreateAccountCustomizationResponse#request_id #request_id} => String
419
+ # * {Types::CreateAccountCustomizationResponse#status #status} => Integer
420
+ #
421
+ # @example Request syntax with placeholder values
422
+ #
423
+ # resp = client.create_account_customization({
424
+ # aws_account_id: "AwsAccountId", # required
425
+ # namespace: "Namespace",
426
+ # account_customization: { # required
427
+ # default_theme: "Arn",
428
+ # },
429
+ # })
430
+ #
431
+ # @example Response structure
432
+ #
433
+ # resp.aws_account_id #=> String
434
+ # resp.namespace #=> String
435
+ # resp.account_customization.default_theme #=> String
436
+ # resp.request_id #=> String
437
+ # resp.status #=> Integer
438
+ #
439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomization AWS API Documentation
440
+ #
441
+ # @overload create_account_customization(params = {})
442
+ # @param [Hash] params ({})
443
+ def create_account_customization(params = {}, options = {})
444
+ req = build_request(:create_account_customization, params)
445
+ req.send_request(options)
446
+ end
447
+
448
+ # Creates an analysis in Amazon QuickSight.
449
+ #
450
+ # @option params [required, String] :aws_account_id
451
+ # The ID of the AWS account where you are creating an analysis.
452
+ #
453
+ # @option params [required, String] :analysis_id
454
+ # The ID for the analysis that you're creating. This ID displays in the
455
+ # URL of the analysis.
456
+ #
457
+ # @option params [required, String] :name
458
+ # A descriptive name for the analysis that you're creating. This name
459
+ # displays for the analysis in the QuickSight console.
460
+ #
461
+ # @option params [Types::Parameters] :parameters
462
+ # The parameter names and override values that you want to use. An
463
+ # analysis can have any parameter type, and some parameters might accept
464
+ # multiple values.
465
+ #
466
+ # @option params [Array<Types::ResourcePermission>] :permissions
467
+ # A structure that describes the principals and the resource-level
468
+ # permissions on an analysis. You can use the `Permissions` structure to
469
+ # grant permissions by providing a list of AWS Identity and Access
470
+ # Management (IAM) action information for each principal listed by
471
+ # Amazon Resource Name (ARN).
472
+ #
473
+ # To specify no permissions, omit `Permissions`.
474
+ #
475
+ # @option params [required, Types::AnalysisSourceEntity] :source_entity
476
+ # A source entity to use for the analysis that you're creating. This
477
+ # metadata structure contains details that describe a source template
478
+ # and one or more datasets.
479
+ #
480
+ # @option params [String] :theme_arn
481
+ # The ARN for the theme to apply to the analysis that you're creating.
482
+ # To see the theme in the QuickSight console, make sure that you have
483
+ # access to it.
484
+ #
485
+ # @option params [Array<Types::Tag>] :tags
486
+ # Contains a map of the key-value pairs for the resource tag or tags
487
+ # assigned to the analysis.
488
+ #
489
+ # @return [Types::CreateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
490
+ #
491
+ # * {Types::CreateAnalysisResponse#arn #arn} => String
492
+ # * {Types::CreateAnalysisResponse#analysis_id #analysis_id} => String
493
+ # * {Types::CreateAnalysisResponse#creation_status #creation_status} => String
494
+ # * {Types::CreateAnalysisResponse#status #status} => Integer
495
+ # * {Types::CreateAnalysisResponse#request_id #request_id} => String
496
+ #
497
+ # @example Request syntax with placeholder values
498
+ #
499
+ # resp = client.create_analysis({
500
+ # aws_account_id: "AwsAccountId", # required
501
+ # analysis_id: "RestrictiveResourceId", # required
502
+ # name: "AnalysisName", # required
503
+ # parameters: {
504
+ # string_parameters: [
505
+ # {
506
+ # name: "NonEmptyString", # required
507
+ # values: ["String"], # required
508
+ # },
509
+ # ],
510
+ # integer_parameters: [
511
+ # {
512
+ # name: "NonEmptyString", # required
513
+ # values: [1], # required
514
+ # },
515
+ # ],
516
+ # decimal_parameters: [
517
+ # {
518
+ # name: "NonEmptyString", # required
519
+ # values: [1.0], # required
520
+ # },
521
+ # ],
522
+ # date_time_parameters: [
523
+ # {
524
+ # name: "NonEmptyString", # required
525
+ # values: [Time.now], # required
526
+ # },
527
+ # ],
528
+ # },
529
+ # permissions: [
530
+ # {
531
+ # principal: "Principal", # required
532
+ # actions: ["String"], # required
533
+ # },
534
+ # ],
535
+ # source_entity: { # required
536
+ # source_template: {
537
+ # data_set_references: [ # required
538
+ # {
539
+ # data_set_placeholder: "NonEmptyString", # required
540
+ # data_set_arn: "Arn", # required
541
+ # },
542
+ # ],
543
+ # arn: "Arn", # required
544
+ # },
545
+ # },
546
+ # theme_arn: "Arn",
547
+ # tags: [
548
+ # {
549
+ # key: "TagKey", # required
550
+ # value: "TagValue", # required
551
+ # },
552
+ # ],
553
+ # })
554
+ #
555
+ # @example Response structure
556
+ #
557
+ # resp.arn #=> String
558
+ # resp.analysis_id #=> String
559
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
560
+ # resp.status #=> Integer
561
+ # resp.request_id #=> String
562
+ #
563
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysis AWS API Documentation
564
+ #
565
+ # @overload create_analysis(params = {})
566
+ # @param [Hash] params ({})
567
+ def create_analysis(params = {}, options = {})
568
+ req = build_request(:create_analysis, params)
569
+ req.send_request(options)
570
+ end
571
+
357
572
  # Creates a dashboard from a template. To first create a template, see
358
- # the CreateTemplate API operation.
573
+ # the ` CreateTemplate ` API operation.
359
574
  #
360
575
  # A dashboard is an entity in QuickSight that identifies QuickSight
361
576
  # reports, created from analyses. You can share QuickSight dashboards.
362
577
  # With the right permissions, you can create scheduled email reports
363
- # from them. The `CreateDashboard`, `DescribeDashboard`, and
364
- # `ListDashboardsByUser` API operations act on the dashboard entity. If
365
- # you have the correct permissions, you can create a dashboard from a
366
- # template that exists in a different AWS account.
578
+ # from them. If you have the correct permissions, you can create a
579
+ # dashboard from a template that exists in a different AWS account.
367
580
  #
368
581
  # @option params [required, String] :aws_account_id
369
582
  # The ID of the AWS account where you want to create the dashboard.
@@ -375,27 +588,31 @@ module Aws::QuickSight
375
588
  # The display name of the dashboard.
376
589
  #
377
590
  # @option params [Types::Parameters] :parameters
378
- # A structure that contains the parameters of the dashboard. These are
379
- # parameter overrides for a dashboard. A dashboard can have any type of
380
- # parameters, and some parameters might accept multiple values. You can
381
- # use the dashboard permissions structure described following to
382
- # override two string parameters that accept multiple values.
591
+ # The parameters for the creation of the dashboard, which you want to
592
+ # use to override the default settings. A dashboard can have any type of
593
+ # parameters, and some parameters might accept multiple values.
383
594
  #
384
595
  # @option params [Array<Types::ResourcePermission>] :permissions
385
596
  # A structure that contains the permissions of the dashboard. You can
386
- # use this structure for granting permissions with principal and action
387
- # information.
597
+ # use this structure for granting permissions by providing a list of IAM
598
+ # action information for each principal ARN.
388
599
  #
389
- # @option params [required, Types::DashboardSourceEntity] :source_entity
390
- # The source entity from which the dashboard is created. The source
391
- # entity accepts the Amazon Resource Name (ARN) of the source template
392
- # or analysis and also references the replacement datasets for the
393
- # placeholders set when creating the template. The replacement datasets
394
- # need to follow the same schema as the datasets for which placeholders
395
- # were created when creating the template.
600
+ # To specify no permissions, omit the permissions list.
396
601
  #
397
- # If you are creating a dashboard from a source entity in a different
398
- # AWS account, use the ARN of the source template.
602
+ # @option params [required, Types::DashboardSourceEntity] :source_entity
603
+ # The entity that you are using as a source when you create the
604
+ # dashboard. In `SourceEntity`, you specify the type of object you're
605
+ # using as source. You can only create a dashboard from a template, so
606
+ # you use a `SourceTemplate` entity. If you need to create a dashboard
607
+ # from an analysis, first convert the analysis to a template by using
608
+ # the CreateTemplate API operation. For `SourceTemplate`, specify the
609
+ # Amazon Resource Name (ARN) of the source template. The
610
+ # `SourceTemplate`ARN can contain any AWS Account and any
611
+ # QuickSight-supported AWS Region.
612
+ #
613
+ # Use the `DataSetReferences` entity within `SourceTemplate` to list the
614
+ # replacement datasets for the placeholders listed in the original. The
615
+ # schema in each dataset must match its placeholder.
399
616
  #
400
617
  # @option params [Array<Types::Tag>] :tags
401
618
  # Contains a map of the key-value pairs for the resource tag or tags
@@ -415,13 +632,18 @@ module Aws::QuickSight
415
632
  #
416
633
  # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
417
634
  # either `ENABLED` or `DISABLED`. The visual option to export data to
418
- # .csv format isn't enabled when this is set to `DISABLED`. This
635
+ # .CSV format isn't enabled when this is set to `DISABLED`. This
419
636
  # option is `ENABLED` by default.
420
637
  #
421
638
  # * `VisibilityState` for `SheetControlsOption` - This visibility state
422
- # can be either `COLLAPSED` or `EXPANDED`. The sheet controls pane is
423
- # collapsed by default when set to true. This option is `COLLAPSED` by
424
- # default.
639
+ # can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
640
+ # by default.
641
+ #
642
+ # @option params [String] :theme_arn
643
+ # The Amazon Resource Name (ARN) of the theme that is being used for
644
+ # this dashboard. If you add a value for this field, it overrides the
645
+ # value that is used in the source entity. The theme ARN must exist in
646
+ # the same AWS account where you create the dashboard.
425
647
  #
426
648
  # @return [Types::CreateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
427
649
  #
@@ -499,6 +721,7 @@ module Aws::QuickSight
499
721
  # visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
500
722
  # },
501
723
  # },
724
+ # theme_arn: "Arn",
502
725
  # })
503
726
  #
504
727
  # @example Response structure
@@ -506,7 +729,7 @@ module Aws::QuickSight
506
729
  # resp.arn #=> String
507
730
  # resp.version_arn #=> String
508
731
  # resp.dashboard_id #=> String
509
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
732
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
510
733
  # resp.status #=> Integer
511
734
  # resp.request_id #=> String
512
735
  #
@@ -681,6 +904,7 @@ module Aws::QuickSight
681
904
  # },
682
905
  # ],
683
906
  # row_level_permission_data_set: {
907
+ # namespace: "Namespace",
684
908
  # arn: "Arn", # required
685
909
  # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
686
910
  # },
@@ -857,7 +1081,96 @@ module Aws::QuickSight
857
1081
  # credential_pair: {
858
1082
  # username: "Username", # required
859
1083
  # password: "Password", # required
1084
+ # alternate_data_source_parameters: [
1085
+ # {
1086
+ # amazon_elasticsearch_parameters: {
1087
+ # domain: "Domain", # required
1088
+ # },
1089
+ # athena_parameters: {
1090
+ # work_group: "WorkGroup",
1091
+ # },
1092
+ # aurora_parameters: {
1093
+ # host: "Host", # required
1094
+ # port: 1, # required
1095
+ # database: "Database", # required
1096
+ # },
1097
+ # aurora_postgre_sql_parameters: {
1098
+ # host: "Host", # required
1099
+ # port: 1, # required
1100
+ # database: "Database", # required
1101
+ # },
1102
+ # aws_iot_analytics_parameters: {
1103
+ # data_set_name: "DataSetName", # required
1104
+ # },
1105
+ # jira_parameters: {
1106
+ # site_base_url: "SiteBaseUrl", # required
1107
+ # },
1108
+ # maria_db_parameters: {
1109
+ # host: "Host", # required
1110
+ # port: 1, # required
1111
+ # database: "Database", # required
1112
+ # },
1113
+ # my_sql_parameters: {
1114
+ # host: "Host", # required
1115
+ # port: 1, # required
1116
+ # database: "Database", # required
1117
+ # },
1118
+ # postgre_sql_parameters: {
1119
+ # host: "Host", # required
1120
+ # port: 1, # required
1121
+ # database: "Database", # required
1122
+ # },
1123
+ # presto_parameters: {
1124
+ # host: "Host", # required
1125
+ # port: 1, # required
1126
+ # catalog: "Catalog", # required
1127
+ # },
1128
+ # rds_parameters: {
1129
+ # instance_id: "InstanceId", # required
1130
+ # database: "Database", # required
1131
+ # },
1132
+ # redshift_parameters: {
1133
+ # host: "Host",
1134
+ # port: 1,
1135
+ # database: "Database", # required
1136
+ # cluster_id: "ClusterId",
1137
+ # },
1138
+ # s3_parameters: {
1139
+ # manifest_file_location: { # required
1140
+ # bucket: "S3Bucket", # required
1141
+ # key: "S3Key", # required
1142
+ # },
1143
+ # },
1144
+ # service_now_parameters: {
1145
+ # site_base_url: "SiteBaseUrl", # required
1146
+ # },
1147
+ # snowflake_parameters: {
1148
+ # host: "Host", # required
1149
+ # database: "Database", # required
1150
+ # warehouse: "Warehouse", # required
1151
+ # },
1152
+ # spark_parameters: {
1153
+ # host: "Host", # required
1154
+ # port: 1, # required
1155
+ # },
1156
+ # sql_server_parameters: {
1157
+ # host: "Host", # required
1158
+ # port: 1, # required
1159
+ # database: "Database", # required
1160
+ # },
1161
+ # teradata_parameters: {
1162
+ # host: "Host", # required
1163
+ # port: 1, # required
1164
+ # database: "Database", # required
1165
+ # },
1166
+ # twitter_parameters: {
1167
+ # query: "Query", # required
1168
+ # max_rows: 1, # required
1169
+ # },
1170
+ # },
1171
+ # ],
860
1172
  # },
1173
+ # copy_source_arn: "CopySourceArn",
861
1174
  # },
862
1175
  # permissions: [
863
1176
  # {
@@ -883,7 +1196,7 @@ module Aws::QuickSight
883
1196
  #
884
1197
  # resp.arn #=> String
885
1198
  # resp.data_source_id #=> String
886
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
1199
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
887
1200
  # resp.request_id #=> String
888
1201
  # resp.status #=> Integer
889
1202
  #
@@ -1131,6 +1444,76 @@ module Aws::QuickSight
1131
1444
  req.send_request(options)
1132
1445
  end
1133
1446
 
1447
+ # (Enterprise edition only) Creates a new namespace for you to use with
1448
+ # Amazon QuickSight.
1449
+ #
1450
+ # A namespace allows you to isolate the QuickSight users and groups that
1451
+ # are registered for that namespace. Users that access the namespace can
1452
+ # share assets only with other users or groups in the same namespace.
1453
+ # They can't see users and groups in other namespaces. You can create a
1454
+ # namespace after your AWS account is subscribed to QuickSight. The
1455
+ # namespace must be unique within the AWS account. By default, there is
1456
+ # a limit of 100 namespaces per AWS account. To increase your limit,
1457
+ # create a ticket with AWS Support.
1458
+ #
1459
+ # @option params [required, String] :aws_account_id
1460
+ # The ID for the AWS account that you want to create the QuickSight
1461
+ # namespace in.
1462
+ #
1463
+ # @option params [required, String] :namespace
1464
+ # The name that you want to use to describe the new namespace.
1465
+ #
1466
+ # @option params [required, String] :identity_store
1467
+ # Specifies the type of your user identity directory. Currently, this
1468
+ # supports users with an identity type of `QUICKSIGHT`.
1469
+ #
1470
+ # @option params [Array<Types::Tag>] :tags
1471
+ # The tags that you want to associate with the namespace that you're
1472
+ # creating.
1473
+ #
1474
+ # @return [Types::CreateNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1475
+ #
1476
+ # * {Types::CreateNamespaceResponse#arn #arn} => String
1477
+ # * {Types::CreateNamespaceResponse#name #name} => String
1478
+ # * {Types::CreateNamespaceResponse#capacity_region #capacity_region} => String
1479
+ # * {Types::CreateNamespaceResponse#creation_status #creation_status} => String
1480
+ # * {Types::CreateNamespaceResponse#identity_store #identity_store} => String
1481
+ # * {Types::CreateNamespaceResponse#request_id #request_id} => String
1482
+ # * {Types::CreateNamespaceResponse#status #status} => Integer
1483
+ #
1484
+ # @example Request syntax with placeholder values
1485
+ #
1486
+ # resp = client.create_namespace({
1487
+ # aws_account_id: "AwsAccountId", # required
1488
+ # namespace: "Namespace", # required
1489
+ # identity_store: "QUICKSIGHT", # required, accepts QUICKSIGHT
1490
+ # tags: [
1491
+ # {
1492
+ # key: "TagKey", # required
1493
+ # value: "TagValue", # required
1494
+ # },
1495
+ # ],
1496
+ # })
1497
+ #
1498
+ # @example Response structure
1499
+ #
1500
+ # resp.arn #=> String
1501
+ # resp.name #=> String
1502
+ # resp.capacity_region #=> String
1503
+ # resp.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
1504
+ # resp.identity_store #=> String, one of "QUICKSIGHT"
1505
+ # resp.request_id #=> String
1506
+ # resp.status #=> Integer
1507
+ #
1508
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateNamespace AWS API Documentation
1509
+ #
1510
+ # @overload create_namespace(params = {})
1511
+ # @param [Hash] params ({})
1512
+ def create_namespace(params = {}, options = {})
1513
+ req = build_request(:create_namespace, params)
1514
+ req.send_request(options)
1515
+ end
1516
+
1134
1517
  # Creates a template from an existing QuickSight analysis or template.
1135
1518
  # You can use the resulting template to create a dashboard.
1136
1519
  #
@@ -1158,10 +1541,19 @@ module Aws::QuickSight
1158
1541
  # A list of resource permissions to be set on the template.
1159
1542
  #
1160
1543
  # @option params [required, Types::TemplateSourceEntity] :source_entity
1161
- # The Amazon Resource Name (ARN) of the source entity from which this
1162
- # template is being created. Currently, you can create a template from
1163
- # an analysis or another template. If the ARN is for an analysis,
1164
- # include its dataset references.
1544
+ # The entity that you are using as a source when you create the
1545
+ # template. In `SourceEntity`, you specify the type of object you're
1546
+ # using as source: `SourceTemplate` for a template or `SourceAnalysis`
1547
+ # for an analysis. Both of these require an Amazon Resource Name (ARN).
1548
+ # For `SourceTemplate`, specify the ARN of the source template. For
1549
+ # `SourceAnalysis`, specify the ARN of the source analysis. The
1550
+ # `SourceTemplate` ARN can contain any AWS Account and any
1551
+ # QuickSight-supported AWS Region.
1552
+ #
1553
+ # Use the `DataSetReferences` entity within `SourceTemplate` or
1554
+ # `SourceAnalysis` to list the replacement datasets for the placeholders
1555
+ # listed in the original. The schema in each dataset must match its
1556
+ # placeholder.
1165
1557
  #
1166
1558
  # @option params [Array<Types::Tag>] :tags
1167
1559
  # Contains a map of the key-value pairs for the resource tag or tags
@@ -1223,7 +1615,7 @@ module Aws::QuickSight
1223
1615
  # resp.arn #=> String
1224
1616
  # resp.version_arn #=> String
1225
1617
  # resp.template_id #=> String
1226
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
1618
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
1227
1619
  # resp.status #=> Integer
1228
1620
  # resp.request_id #=> String
1229
1621
  #
@@ -1285,71 +1677,356 @@ module Aws::QuickSight
1285
1677
  req.send_request(options)
1286
1678
  end
1287
1679
 
1288
- # Deletes a dashboard.
1680
+ # Creates a theme.
1681
+ #
1682
+ # A *theme* is set of configuration options for color and layout. Themes
1683
+ # apply to analyses and dashboards. For more information, see [Using
1684
+ # Themes in Amazon QuickSight][1] in the *Amazon QuickSight User Guide*.
1685
+ #
1686
+ #
1687
+ #
1688
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html
1289
1689
  #
1290
1690
  # @option params [required, String] :aws_account_id
1291
- # The ID of the AWS account that contains the dashboard that you're
1292
- # deleting.
1691
+ # The ID of the AWS account where you want to store the new theme.
1293
1692
  #
1294
- # @option params [required, String] :dashboard_id
1295
- # The ID for the dashboard.
1693
+ # @option params [required, String] :theme_id
1694
+ # An ID for the theme that you want to create. The theme ID is unique
1695
+ # per AWS Region in each AWS account.
1296
1696
  #
1297
- # @option params [Integer] :version_number
1298
- # The version number of the dashboard. If the version number property is
1299
- # provided, only the specified version of the dashboard is deleted.
1697
+ # @option params [required, String] :name
1698
+ # A display name for the theme.
1300
1699
  #
1301
- # @return [Types::DeleteDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1700
+ # @option params [required, String] :base_theme_id
1701
+ # The ID of the theme that a custom theme will inherit from. All themes
1702
+ # inherit from one of the starting themes defined by Amazon QuickSight.
1703
+ # For a list of the starting themes, use `ListThemes` or choose
1704
+ # **Themes** from within a QuickSight analysis.
1302
1705
  #
1303
- # * {Types::DeleteDashboardResponse#status #status} => Integer
1304
- # * {Types::DeleteDashboardResponse#arn #arn} => String
1305
- # * {Types::DeleteDashboardResponse#dashboard_id #dashboard_id} => String
1306
- # * {Types::DeleteDashboardResponse#request_id #request_id} => String
1706
+ # @option params [String] :version_description
1707
+ # A description of the first version of the theme that you're creating.
1708
+ # Every time `UpdateTheme` is called, a new version is created. Each
1709
+ # version of the theme has a description of the version in the
1710
+ # `VersionDescription` field.
1711
+ #
1712
+ # @option params [required, Types::ThemeConfiguration] :configuration
1713
+ # The theme configuration, which contains the theme display properties.
1714
+ #
1715
+ # @option params [Array<Types::ResourcePermission>] :permissions
1716
+ # A valid grouping of resource permissions to apply to the new theme.
1717
+ #
1718
+ # @option params [Array<Types::Tag>] :tags
1719
+ # A map of the key-value pairs for the resource tag or tags that you
1720
+ # want to add to the resource.
1721
+ #
1722
+ # @return [Types::CreateThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1723
+ #
1724
+ # * {Types::CreateThemeResponse#arn #arn} => String
1725
+ # * {Types::CreateThemeResponse#version_arn #version_arn} => String
1726
+ # * {Types::CreateThemeResponse#theme_id #theme_id} => String
1727
+ # * {Types::CreateThemeResponse#creation_status #creation_status} => String
1728
+ # * {Types::CreateThemeResponse#status #status} => Integer
1729
+ # * {Types::CreateThemeResponse#request_id #request_id} => String
1307
1730
  #
1308
1731
  # @example Request syntax with placeholder values
1309
1732
  #
1310
- # resp = client.delete_dashboard({
1733
+ # resp = client.create_theme({
1311
1734
  # aws_account_id: "AwsAccountId", # required
1312
- # dashboard_id: "RestrictiveResourceId", # required
1313
- # version_number: 1,
1735
+ # theme_id: "RestrictiveResourceId", # required
1736
+ # name: "ThemeName", # required
1737
+ # base_theme_id: "RestrictiveResourceId", # required
1738
+ # version_description: "VersionDescription",
1739
+ # configuration: { # required
1740
+ # data_color_palette: {
1741
+ # colors: ["HexColor"],
1742
+ # min_max_gradient: ["HexColor"],
1743
+ # empty_fill_color: "HexColor",
1744
+ # },
1745
+ # ui_color_palette: {
1746
+ # primary_foreground: "HexColor",
1747
+ # primary_background: "HexColor",
1748
+ # secondary_foreground: "HexColor",
1749
+ # secondary_background: "HexColor",
1750
+ # accent: "HexColor",
1751
+ # accent_foreground: "HexColor",
1752
+ # danger: "HexColor",
1753
+ # danger_foreground: "HexColor",
1754
+ # warning: "HexColor",
1755
+ # warning_foreground: "HexColor",
1756
+ # success: "HexColor",
1757
+ # success_foreground: "HexColor",
1758
+ # dimension: "HexColor",
1759
+ # dimension_foreground: "HexColor",
1760
+ # measure: "HexColor",
1761
+ # measure_foreground: "HexColor",
1762
+ # },
1763
+ # sheet: {
1764
+ # tile: {
1765
+ # border: {
1766
+ # show: false,
1767
+ # },
1768
+ # },
1769
+ # tile_layout: {
1770
+ # gutter: {
1771
+ # show: false,
1772
+ # },
1773
+ # margin: {
1774
+ # show: false,
1775
+ # },
1776
+ # },
1777
+ # },
1778
+ # },
1779
+ # permissions: [
1780
+ # {
1781
+ # principal: "Principal", # required
1782
+ # actions: ["String"], # required
1783
+ # },
1784
+ # ],
1785
+ # tags: [
1786
+ # {
1787
+ # key: "TagKey", # required
1788
+ # value: "TagValue", # required
1789
+ # },
1790
+ # ],
1314
1791
  # })
1315
1792
  #
1316
1793
  # @example Response structure
1317
1794
  #
1318
- # resp.status #=> Integer
1319
1795
  # resp.arn #=> String
1320
- # resp.dashboard_id #=> String
1796
+ # resp.version_arn #=> String
1797
+ # resp.theme_id #=> String
1798
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
1799
+ # resp.status #=> Integer
1321
1800
  # resp.request_id #=> String
1322
1801
  #
1323
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDashboard AWS API Documentation
1802
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateTheme AWS API Documentation
1324
1803
  #
1325
- # @overload delete_dashboard(params = {})
1804
+ # @overload create_theme(params = {})
1326
1805
  # @param [Hash] params ({})
1327
- def delete_dashboard(params = {}, options = {})
1328
- req = build_request(:delete_dashboard, params)
1806
+ def create_theme(params = {}, options = {})
1807
+ req = build_request(:create_theme, params)
1329
1808
  req.send_request(options)
1330
1809
  end
1331
1810
 
1332
- # Deletes a dataset.
1811
+ # Creates a theme alias for a theme.
1333
1812
  #
1334
1813
  # @option params [required, String] :aws_account_id
1335
- # The AWS account ID.
1814
+ # The ID of the AWS account that contains the theme for the new theme
1815
+ # alias.
1336
1816
  #
1337
- # @option params [required, String] :data_set_id
1338
- # The ID for the dataset that you want to create. This ID is unique per
1339
- # AWS Region for each AWS account.
1817
+ # @option params [required, String] :theme_id
1818
+ # An ID for the theme alias.
1340
1819
  #
1341
- # @return [Types::DeleteDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1820
+ # @option params [required, String] :alias_name
1821
+ # The name that you want to give to the theme alias that you are
1822
+ # creating. The alias name can't begin with a `$`. Alias names that
1823
+ # start with `$` are reserved by Amazon QuickSight.
1342
1824
  #
1343
- # * {Types::DeleteDataSetResponse#arn #arn} => String
1344
- # * {Types::DeleteDataSetResponse#data_set_id #data_set_id} => String
1345
- # * {Types::DeleteDataSetResponse#request_id #request_id} => String
1346
- # * {Types::DeleteDataSetResponse#status #status} => Integer
1825
+ # @option params [required, Integer] :theme_version_number
1826
+ # The version number of the theme.
1827
+ #
1828
+ # @return [Types::CreateThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1829
+ #
1830
+ # * {Types::CreateThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
1831
+ # * {Types::CreateThemeAliasResponse#status #status} => Integer
1832
+ # * {Types::CreateThemeAliasResponse#request_id #request_id} => String
1347
1833
  #
1348
1834
  # @example Request syntax with placeholder values
1349
1835
  #
1350
- # resp = client.delete_data_set({
1836
+ # resp = client.create_theme_alias({
1351
1837
  # aws_account_id: "AwsAccountId", # required
1352
- # data_set_id: "ResourceId", # required
1838
+ # theme_id: "RestrictiveResourceId", # required
1839
+ # alias_name: "AliasName", # required
1840
+ # theme_version_number: 1, # required
1841
+ # })
1842
+ #
1843
+ # @example Response structure
1844
+ #
1845
+ # resp.theme_alias.arn #=> String
1846
+ # resp.theme_alias.alias_name #=> String
1847
+ # resp.theme_alias.theme_version_number #=> Integer
1848
+ # resp.status #=> Integer
1849
+ # resp.request_id #=> String
1850
+ #
1851
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateThemeAlias AWS API Documentation
1852
+ #
1853
+ # @overload create_theme_alias(params = {})
1854
+ # @param [Hash] params ({})
1855
+ def create_theme_alias(params = {}, options = {})
1856
+ req = build_request(:create_theme_alias, params)
1857
+ req.send_request(options)
1858
+ end
1859
+
1860
+ # Deletes all Amazon QuickSight customizations in this AWS Region for
1861
+ # the specified AWS Account and QuickSight namespace.
1862
+ #
1863
+ # @option params [required, String] :aws_account_id
1864
+ # The ID for the AWS account that you want to delete QuickSight
1865
+ # customizations from in this AWS Region.
1866
+ #
1867
+ # @option params [String] :namespace
1868
+ # The QuickSight namespace that you're deleting the customizations
1869
+ # from.
1870
+ #
1871
+ # @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1872
+ #
1873
+ # * {Types::DeleteAccountCustomizationResponse#request_id #request_id} => String
1874
+ # * {Types::DeleteAccountCustomizationResponse#status #status} => Integer
1875
+ #
1876
+ # @example Request syntax with placeholder values
1877
+ #
1878
+ # resp = client.delete_account_customization({
1879
+ # aws_account_id: "AwsAccountId", # required
1880
+ # namespace: "Namespace",
1881
+ # })
1882
+ #
1883
+ # @example Response structure
1884
+ #
1885
+ # resp.request_id #=> String
1886
+ # resp.status #=> Integer
1887
+ #
1888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomization AWS API Documentation
1889
+ #
1890
+ # @overload delete_account_customization(params = {})
1891
+ # @param [Hash] params ({})
1892
+ def delete_account_customization(params = {}, options = {})
1893
+ req = build_request(:delete_account_customization, params)
1894
+ req.send_request(options)
1895
+ end
1896
+
1897
+ # Deletes an analysis from Amazon QuickSight. You can optionally include
1898
+ # a recovery window during which you can restore the analysis. If you
1899
+ # don't specify a recovery window value, the operation defaults to 30
1900
+ # days. QuickSight attaches a `DeletionTime` stamp to the response that
1901
+ # specifies the end of the recovery window. At the end of the recovery
1902
+ # window, QuickSight deletes the analysis permanently.
1903
+ #
1904
+ # At any time before recovery window ends, you can use the
1905
+ # `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
1906
+ # cancel the deletion of the analysis. The analysis remains visible in
1907
+ # the API until it's deleted, so you can describe it but you can't
1908
+ # make a template from it.
1909
+ #
1910
+ # An analysis that's scheduled for deletion isn't accessible in the
1911
+ # QuickSight console. To access it in the console, restore it. Deleting
1912
+ # an analysis doesn't delete the dashboards that you publish from it.
1913
+ #
1914
+ # @option params [required, String] :aws_account_id
1915
+ # The ID of the AWS account where you want to delete an analysis.
1916
+ #
1917
+ # @option params [required, String] :analysis_id
1918
+ # The ID of the analysis that you're deleting.
1919
+ #
1920
+ # @option params [Integer] :recovery_window_in_days
1921
+ # A value that specifies the number of days that QuickSight waits before
1922
+ # it deletes the analysis. You can't use this parameter with the
1923
+ # `ForceDeleteWithoutRecovery` option in the same API call. The default
1924
+ # value is 30.
1925
+ #
1926
+ # @option params [Boolean] :force_delete_without_recovery
1927
+ # This option defaults to the value `NoForceDeleteWithoutRecovery`. To
1928
+ # immediately delete the analysis, add the `ForceDeleteWithoutRecovery`
1929
+ # option. You can't restore an analysis after it's deleted.
1930
+ #
1931
+ # @return [Types::DeleteAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1932
+ #
1933
+ # * {Types::DeleteAnalysisResponse#status #status} => Integer
1934
+ # * {Types::DeleteAnalysisResponse#arn #arn} => String
1935
+ # * {Types::DeleteAnalysisResponse#analysis_id #analysis_id} => String
1936
+ # * {Types::DeleteAnalysisResponse#deletion_time #deletion_time} => Time
1937
+ # * {Types::DeleteAnalysisResponse#request_id #request_id} => String
1938
+ #
1939
+ # @example Request syntax with placeholder values
1940
+ #
1941
+ # resp = client.delete_analysis({
1942
+ # aws_account_id: "AwsAccountId", # required
1943
+ # analysis_id: "RestrictiveResourceId", # required
1944
+ # recovery_window_in_days: 1,
1945
+ # force_delete_without_recovery: false,
1946
+ # })
1947
+ #
1948
+ # @example Response structure
1949
+ #
1950
+ # resp.status #=> Integer
1951
+ # resp.arn #=> String
1952
+ # resp.analysis_id #=> String
1953
+ # resp.deletion_time #=> Time
1954
+ # resp.request_id #=> String
1955
+ #
1956
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysis AWS API Documentation
1957
+ #
1958
+ # @overload delete_analysis(params = {})
1959
+ # @param [Hash] params ({})
1960
+ def delete_analysis(params = {}, options = {})
1961
+ req = build_request(:delete_analysis, params)
1962
+ req.send_request(options)
1963
+ end
1964
+
1965
+ # Deletes a dashboard.
1966
+ #
1967
+ # @option params [required, String] :aws_account_id
1968
+ # The ID of the AWS account that contains the dashboard that you're
1969
+ # deleting.
1970
+ #
1971
+ # @option params [required, String] :dashboard_id
1972
+ # The ID for the dashboard.
1973
+ #
1974
+ # @option params [Integer] :version_number
1975
+ # The version number of the dashboard. If the version number property is
1976
+ # provided, only the specified version of the dashboard is deleted.
1977
+ #
1978
+ # @return [Types::DeleteDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1979
+ #
1980
+ # * {Types::DeleteDashboardResponse#status #status} => Integer
1981
+ # * {Types::DeleteDashboardResponse#arn #arn} => String
1982
+ # * {Types::DeleteDashboardResponse#dashboard_id #dashboard_id} => String
1983
+ # * {Types::DeleteDashboardResponse#request_id #request_id} => String
1984
+ #
1985
+ # @example Request syntax with placeholder values
1986
+ #
1987
+ # resp = client.delete_dashboard({
1988
+ # aws_account_id: "AwsAccountId", # required
1989
+ # dashboard_id: "RestrictiveResourceId", # required
1990
+ # version_number: 1,
1991
+ # })
1992
+ #
1993
+ # @example Response structure
1994
+ #
1995
+ # resp.status #=> Integer
1996
+ # resp.arn #=> String
1997
+ # resp.dashboard_id #=> String
1998
+ # resp.request_id #=> String
1999
+ #
2000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteDashboard AWS API Documentation
2001
+ #
2002
+ # @overload delete_dashboard(params = {})
2003
+ # @param [Hash] params ({})
2004
+ def delete_dashboard(params = {}, options = {})
2005
+ req = build_request(:delete_dashboard, params)
2006
+ req.send_request(options)
2007
+ end
2008
+
2009
+ # Deletes a dataset.
2010
+ #
2011
+ # @option params [required, String] :aws_account_id
2012
+ # The AWS account ID.
2013
+ #
2014
+ # @option params [required, String] :data_set_id
2015
+ # The ID for the dataset that you want to create. This ID is unique per
2016
+ # AWS Region for each AWS account.
2017
+ #
2018
+ # @return [Types::DeleteDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2019
+ #
2020
+ # * {Types::DeleteDataSetResponse#arn #arn} => String
2021
+ # * {Types::DeleteDataSetResponse#data_set_id #data_set_id} => String
2022
+ # * {Types::DeleteDataSetResponse#request_id #request_id} => String
2023
+ # * {Types::DeleteDataSetResponse#status #status} => Integer
2024
+ #
2025
+ # @example Request syntax with placeholder values
2026
+ #
2027
+ # resp = client.delete_data_set({
2028
+ # aws_account_id: "AwsAccountId", # required
2029
+ # data_set_id: "ResourceId", # required
1353
2030
  # })
1354
2031
  #
1355
2032
  # @example Response structure
@@ -1368,7 +2045,7 @@ module Aws::QuickSight
1368
2045
  req.send_request(options)
1369
2046
  end
1370
2047
 
1371
- # Deletes the data source permanently. This action breaks all the
2048
+ # Deletes the data source permanently. This operation breaks all the
1372
2049
  # datasets that reference the deleted data source.
1373
2050
  #
1374
2051
  # @option params [required, String] :aws_account_id
@@ -1534,6 +2211,45 @@ module Aws::QuickSight
1534
2211
  req.send_request(options)
1535
2212
  end
1536
2213
 
2214
+ # Deletes a namespace and the users and groups that are associated with
2215
+ # the namespace. This is an asynchronous process. Assets including
2216
+ # dashboards, analyses, datasets and data sources are not deleted. To
2217
+ # delete these assets, you use the API operations for the relevant
2218
+ # asset.
2219
+ #
2220
+ # @option params [required, String] :aws_account_id
2221
+ # The ID for the AWS account that you want to delete the QuickSight
2222
+ # namespace from.
2223
+ #
2224
+ # @option params [required, String] :namespace
2225
+ # The namespace that you want to delete.
2226
+ #
2227
+ # @return [Types::DeleteNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2228
+ #
2229
+ # * {Types::DeleteNamespaceResponse#request_id #request_id} => String
2230
+ # * {Types::DeleteNamespaceResponse#status #status} => Integer
2231
+ #
2232
+ # @example Request syntax with placeholder values
2233
+ #
2234
+ # resp = client.delete_namespace({
2235
+ # aws_account_id: "AwsAccountId", # required
2236
+ # namespace: "Namespace", # required
2237
+ # })
2238
+ #
2239
+ # @example Response structure
2240
+ #
2241
+ # resp.request_id #=> String
2242
+ # resp.status #=> Integer
2243
+ #
2244
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteNamespace AWS API Documentation
2245
+ #
2246
+ # @overload delete_namespace(params = {})
2247
+ # @param [Hash] params ({})
2248
+ def delete_namespace(params = {}, options = {})
2249
+ req = build_request(:delete_namespace, params)
2250
+ req.send_request(options)
2251
+ end
2252
+
1537
2253
  # Deletes a template.
1538
2254
  #
1539
2255
  # @option params [required, String] :aws_account_id
@@ -1590,10 +2306,10 @@ module Aws::QuickSight
1590
2306
  # The ID for the template that the specified alias is for.
1591
2307
  #
1592
2308
  # @option params [required, String] :alias_name
1593
- # The name for the template alias. If you name a specific alias, you
1594
- # delete the version that the alias points to. You can specify the
1595
- # latest version of the template by providing the keyword `$LATEST` in
1596
- # the `AliasName` parameter.
2309
+ # The name for the template alias. To delete a specific alias, you
2310
+ # delete the version that the alias points to. You can specify the alias
2311
+ # name, or specify the latest version of the template by providing the
2312
+ # keyword `$LATEST` in the `AliasName` parameter.
1597
2313
  #
1598
2314
  # @return [Types::DeleteTemplateAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1599
2315
  #
@@ -1628,6 +2344,98 @@ module Aws::QuickSight
1628
2344
  req.send_request(options)
1629
2345
  end
1630
2346
 
2347
+ # Deletes a theme.
2348
+ #
2349
+ # @option params [required, String] :aws_account_id
2350
+ # The ID of the AWS account that contains the theme that you're
2351
+ # deleting.
2352
+ #
2353
+ # @option params [required, String] :theme_id
2354
+ # An ID for the theme that you want to delete.
2355
+ #
2356
+ # @option params [Integer] :version_number
2357
+ # The version of the theme that you want to delete.
2358
+ #
2359
+ # **Note:** If you don't provide a version number, you're using this
2360
+ # call to `DeleteTheme` to delete all versions of the theme.
2361
+ #
2362
+ # @return [Types::DeleteThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2363
+ #
2364
+ # * {Types::DeleteThemeResponse#arn #arn} => String
2365
+ # * {Types::DeleteThemeResponse#request_id #request_id} => String
2366
+ # * {Types::DeleteThemeResponse#status #status} => Integer
2367
+ # * {Types::DeleteThemeResponse#theme_id #theme_id} => String
2368
+ #
2369
+ # @example Request syntax with placeholder values
2370
+ #
2371
+ # resp = client.delete_theme({
2372
+ # aws_account_id: "AwsAccountId", # required
2373
+ # theme_id: "RestrictiveResourceId", # required
2374
+ # version_number: 1,
2375
+ # })
2376
+ #
2377
+ # @example Response structure
2378
+ #
2379
+ # resp.arn #=> String
2380
+ # resp.request_id #=> String
2381
+ # resp.status #=> Integer
2382
+ # resp.theme_id #=> String
2383
+ #
2384
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteTheme AWS API Documentation
2385
+ #
2386
+ # @overload delete_theme(params = {})
2387
+ # @param [Hash] params ({})
2388
+ def delete_theme(params = {}, options = {})
2389
+ req = build_request(:delete_theme, params)
2390
+ req.send_request(options)
2391
+ end
2392
+
2393
+ # Deletes the version of the theme that the specified theme alias points
2394
+ # to. If you provide a specific alias, you delete the version of the
2395
+ # theme that the alias points to.
2396
+ #
2397
+ # @option params [required, String] :aws_account_id
2398
+ # The ID of the AWS account that contains the theme alias to delete.
2399
+ #
2400
+ # @option params [required, String] :theme_id
2401
+ # The ID for the theme that the specified alias is for.
2402
+ #
2403
+ # @option params [required, String] :alias_name
2404
+ # The unique name for the theme alias to delete.
2405
+ #
2406
+ # @return [Types::DeleteThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2407
+ #
2408
+ # * {Types::DeleteThemeAliasResponse#alias_name #alias_name} => String
2409
+ # * {Types::DeleteThemeAliasResponse#arn #arn} => String
2410
+ # * {Types::DeleteThemeAliasResponse#request_id #request_id} => String
2411
+ # * {Types::DeleteThemeAliasResponse#status #status} => Integer
2412
+ # * {Types::DeleteThemeAliasResponse#theme_id #theme_id} => String
2413
+ #
2414
+ # @example Request syntax with placeholder values
2415
+ #
2416
+ # resp = client.delete_theme_alias({
2417
+ # aws_account_id: "AwsAccountId", # required
2418
+ # theme_id: "RestrictiveResourceId", # required
2419
+ # alias_name: "AliasName", # required
2420
+ # })
2421
+ #
2422
+ # @example Response structure
2423
+ #
2424
+ # resp.alias_name #=> String
2425
+ # resp.arn #=> String
2426
+ # resp.request_id #=> String
2427
+ # resp.status #=> Integer
2428
+ # resp.theme_id #=> String
2429
+ #
2430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteThemeAlias AWS API Documentation
2431
+ #
2432
+ # @overload delete_theme_alias(params = {})
2433
+ # @param [Hash] params ({})
2434
+ def delete_theme_alias(params = {}, options = {})
2435
+ req = build_request(:delete_theme_alias, params)
2436
+ req.send_request(options)
2437
+ end
2438
+
1631
2439
  # Deletes the Amazon QuickSight user that is associated with the
1632
2440
  # identity of the AWS Identity and Access Management (IAM) user or role
1633
2441
  # that's making the call. The IAM user isn't deleted as a result of
@@ -1709,6 +2517,241 @@ module Aws::QuickSight
1709
2517
  req.send_request(options)
1710
2518
  end
1711
2519
 
2520
+ # Describes the customizations associated with the provided AWS account
2521
+ # and Amazon QuickSight namespace in an AWS Region. The QuickSight
2522
+ # console evaluates which customizations to apply by running this API
2523
+ # operation with the `Resolved` flag included.
2524
+ #
2525
+ # To determine what customizations display when you run this command, it
2526
+ # can help to visualize the relationship of the entities involved.
2527
+ #
2528
+ # * `AWS Account` - The AWS account exists at the top of the hierarchy.
2529
+ # It has the potential to use all of the AWS Regions and AWS Services.
2530
+ # When you subscribe to QuickSight, you choose one AWS Region to use
2531
+ # as your home region. That's where your free SPICE capacity is
2532
+ # located. You can use QuickSight in any supported AWS Region.
2533
+ #
2534
+ # * `AWS Region` - In each AWS Region where you sign in to QuickSight at
2535
+ # least once, QuickSight acts as a separate instance of the same
2536
+ # service. If you have a user directory, it resides in us-east-1,
2537
+ # which is the US East (N. Virginia). Generally speaking, these users
2538
+ # have access to QuickSight in any AWS Region, unless they are
2539
+ # constrained to a namespace.
2540
+ #
2541
+ # To run the command in a different AWS Region, you change your region
2542
+ # settings. If you're using the AWS CLI, you can use one of the
2543
+ # following options:
2544
+ #
2545
+ # * Use [command line options][1].
2546
+ #
2547
+ # * Use [named profiles][2].
2548
+ #
2549
+ # * Run `aws configure` to change your default AWS Region. Use Enter
2550
+ # to key the same settings for your keys. For more information, see
2551
+ # [Configuring the AWS CLI][3].
2552
+ #
2553
+ # * `Namespace` - A QuickSight namespace is a partition that contains
2554
+ # users and assets (data sources, datasets, dashboards, and so on). To
2555
+ # access assets that are in a specific namespace, users and groups
2556
+ # must also be part of the same namespace. People who share a
2557
+ # namespace are completely isolated from users and assets in other
2558
+ # namespaces, even if they are in the same AWS account and AWS Region.
2559
+ #
2560
+ # * `Applied customizations` - Within an AWS Region, a set of QuickSight
2561
+ # customizations can apply to an AWS account or to a namespace.
2562
+ # Settings that you apply to a namespace override settings that you
2563
+ # apply to an AWS Account. All settings are isolated to a single AWS
2564
+ # Region. To apply them in other AWS Regions, run the
2565
+ # `CreateAccountCustomization` command in each AWS Region where you
2566
+ # want to apply the same customizations.
2567
+ #
2568
+ #
2569
+ #
2570
+ # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html
2571
+ # [2]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html
2572
+ # [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
2573
+ #
2574
+ # @option params [required, String] :aws_account_id
2575
+ # The ID for the AWS account that you want to describe QuickSight
2576
+ # customizations for.
2577
+ #
2578
+ # @option params [String] :namespace
2579
+ # The QuickSight namespace that you want to describe QuickSight
2580
+ # customizations for.
2581
+ #
2582
+ # @option params [Boolean] :resolved
2583
+ # The `Resolved` flag works with the other parameters to determine which
2584
+ # view of QuickSight customizations is returned. You can add this flag
2585
+ # to your command to use the same view that QuickSight uses to identify
2586
+ # which customizations to apply to the console. Omit this flag, or set
2587
+ # it to `no-resolved`, to reveal customizations that are configured at
2588
+ # different levels.
2589
+ #
2590
+ # @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2591
+ #
2592
+ # * {Types::DescribeAccountCustomizationResponse#aws_account_id #aws_account_id} => String
2593
+ # * {Types::DescribeAccountCustomizationResponse#namespace #namespace} => String
2594
+ # * {Types::DescribeAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
2595
+ # * {Types::DescribeAccountCustomizationResponse#request_id #request_id} => String
2596
+ # * {Types::DescribeAccountCustomizationResponse#status #status} => Integer
2597
+ #
2598
+ # @example Request syntax with placeholder values
2599
+ #
2600
+ # resp = client.describe_account_customization({
2601
+ # aws_account_id: "AwsAccountId", # required
2602
+ # namespace: "Namespace",
2603
+ # resolved: false,
2604
+ # })
2605
+ #
2606
+ # @example Response structure
2607
+ #
2608
+ # resp.aws_account_id #=> String
2609
+ # resp.namespace #=> String
2610
+ # resp.account_customization.default_theme #=> String
2611
+ # resp.request_id #=> String
2612
+ # resp.status #=> Integer
2613
+ #
2614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomization AWS API Documentation
2615
+ #
2616
+ # @overload describe_account_customization(params = {})
2617
+ # @param [Hash] params ({})
2618
+ def describe_account_customization(params = {}, options = {})
2619
+ req = build_request(:describe_account_customization, params)
2620
+ req.send_request(options)
2621
+ end
2622
+
2623
+ # Describes the settings that were used when your QuickSight
2624
+ # subscription was first created in this AWS Account.
2625
+ #
2626
+ # @option params [required, String] :aws_account_id
2627
+ # The ID for the AWS account that contains the settings that you want to
2628
+ # list.
2629
+ #
2630
+ # @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2631
+ #
2632
+ # * {Types::DescribeAccountSettingsResponse#account_settings #account_settings} => Types::AccountSettings
2633
+ # * {Types::DescribeAccountSettingsResponse#request_id #request_id} => String
2634
+ # * {Types::DescribeAccountSettingsResponse#status #status} => Integer
2635
+ #
2636
+ # @example Request syntax with placeholder values
2637
+ #
2638
+ # resp = client.describe_account_settings({
2639
+ # aws_account_id: "AwsAccountId", # required
2640
+ # })
2641
+ #
2642
+ # @example Response structure
2643
+ #
2644
+ # resp.account_settings.account_name #=> String
2645
+ # resp.account_settings.edition #=> String, one of "STANDARD", "ENTERPRISE"
2646
+ # resp.account_settings.default_namespace #=> String
2647
+ # resp.account_settings.notification_email #=> String
2648
+ # resp.request_id #=> String
2649
+ # resp.status #=> Integer
2650
+ #
2651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettings AWS API Documentation
2652
+ #
2653
+ # @overload describe_account_settings(params = {})
2654
+ # @param [Hash] params ({})
2655
+ def describe_account_settings(params = {}, options = {})
2656
+ req = build_request(:describe_account_settings, params)
2657
+ req.send_request(options)
2658
+ end
2659
+
2660
+ # Provides a summary of the metadata for an analysis.
2661
+ #
2662
+ # @option params [required, String] :aws_account_id
2663
+ # The ID of the AWS account that contains the analysis. You must be
2664
+ # using the AWS account that the analysis is in.
2665
+ #
2666
+ # @option params [required, String] :analysis_id
2667
+ # The ID of the analysis that you're describing. The ID is part of the
2668
+ # URL of the analysis.
2669
+ #
2670
+ # @return [Types::DescribeAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2671
+ #
2672
+ # * {Types::DescribeAnalysisResponse#analysis #analysis} => Types::Analysis
2673
+ # * {Types::DescribeAnalysisResponse#status #status} => Integer
2674
+ # * {Types::DescribeAnalysisResponse#request_id #request_id} => String
2675
+ #
2676
+ # @example Request syntax with placeholder values
2677
+ #
2678
+ # resp = client.describe_analysis({
2679
+ # aws_account_id: "AwsAccountId", # required
2680
+ # analysis_id: "RestrictiveResourceId", # required
2681
+ # })
2682
+ #
2683
+ # @example Response structure
2684
+ #
2685
+ # resp.analysis.analysis_id #=> String
2686
+ # resp.analysis.arn #=> String
2687
+ # resp.analysis.name #=> String
2688
+ # resp.analysis.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2689
+ # resp.analysis.errors #=> Array
2690
+ # resp.analysis.errors[0].type #=> String, one of "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING"
2691
+ # resp.analysis.errors[0].message #=> String
2692
+ # resp.analysis.data_set_arns #=> Array
2693
+ # resp.analysis.data_set_arns[0] #=> String
2694
+ # resp.analysis.theme_arn #=> String
2695
+ # resp.analysis.created_time #=> Time
2696
+ # resp.analysis.last_updated_time #=> Time
2697
+ # resp.status #=> Integer
2698
+ # resp.request_id #=> String
2699
+ #
2700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysis AWS API Documentation
2701
+ #
2702
+ # @overload describe_analysis(params = {})
2703
+ # @param [Hash] params ({})
2704
+ def describe_analysis(params = {}, options = {})
2705
+ req = build_request(:describe_analysis, params)
2706
+ req.send_request(options)
2707
+ end
2708
+
2709
+ # Provides the read and write permissions for an analysis.
2710
+ #
2711
+ # @option params [required, String] :aws_account_id
2712
+ # The ID of the AWS account that contains the analysis whose permissions
2713
+ # you're describing. You must be using the AWS account that the
2714
+ # analysis is in.
2715
+ #
2716
+ # @option params [required, String] :analysis_id
2717
+ # The ID of the analysis whose permissions you're describing. The ID is
2718
+ # part of the analysis URL.
2719
+ #
2720
+ # @return [Types::DescribeAnalysisPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2721
+ #
2722
+ # * {Types::DescribeAnalysisPermissionsResponse#analysis_id #analysis_id} => String
2723
+ # * {Types::DescribeAnalysisPermissionsResponse#analysis_arn #analysis_arn} => String
2724
+ # * {Types::DescribeAnalysisPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
2725
+ # * {Types::DescribeAnalysisPermissionsResponse#status #status} => Integer
2726
+ # * {Types::DescribeAnalysisPermissionsResponse#request_id #request_id} => String
2727
+ #
2728
+ # @example Request syntax with placeholder values
2729
+ #
2730
+ # resp = client.describe_analysis_permissions({
2731
+ # aws_account_id: "AwsAccountId", # required
2732
+ # analysis_id: "RestrictiveResourceId", # required
2733
+ # })
2734
+ #
2735
+ # @example Response structure
2736
+ #
2737
+ # resp.analysis_id #=> String
2738
+ # resp.analysis_arn #=> String
2739
+ # resp.permissions #=> Array
2740
+ # resp.permissions[0].principal #=> String
2741
+ # resp.permissions[0].actions #=> Array
2742
+ # resp.permissions[0].actions[0] #=> String
2743
+ # resp.status #=> Integer
2744
+ # resp.request_id #=> String
2745
+ #
2746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissions AWS API Documentation
2747
+ #
2748
+ # @overload describe_analysis_permissions(params = {})
2749
+ # @param [Hash] params ({})
2750
+ def describe_analysis_permissions(params = {}, options = {})
2751
+ req = build_request(:describe_analysis_permissions, params)
2752
+ req.send_request(options)
2753
+ end
2754
+
1712
2755
  # Provides a summary for a dashboard.
1713
2756
  #
1714
2757
  # @option params [required, String] :aws_account_id
@@ -1750,12 +2793,13 @@ module Aws::QuickSight
1750
2793
  # resp.dashboard.version.errors[0].type #=> String, one of "ACCESS_DENIED", "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "PARAMETER_VALUE_INCOMPATIBLE", "PARAMETER_TYPE_INVALID", "PARAMETER_NOT_FOUND", "COLUMN_TYPE_MISMATCH", "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "COLUMN_REPLACEMENT_MISSING"
1751
2794
  # resp.dashboard.version.errors[0].message #=> String
1752
2795
  # resp.dashboard.version.version_number #=> Integer
1753
- # resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
2796
+ # resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
1754
2797
  # resp.dashboard.version.arn #=> String
1755
2798
  # resp.dashboard.version.source_entity_arn #=> String
1756
2799
  # resp.dashboard.version.data_set_arns #=> Array
1757
2800
  # resp.dashboard.version.data_set_arns[0] #=> String
1758
2801
  # resp.dashboard.version.description #=> String
2802
+ # resp.dashboard.version.theme_arn #=> String
1759
2803
  # resp.dashboard.created_time #=> Time
1760
2804
  # resp.dashboard.last_published_time #=> Time
1761
2805
  # resp.dashboard.last_updated_time #=> Time
@@ -1899,6 +2943,7 @@ module Aws::QuickSight
1899
2943
  # resp.data_set.column_groups[0].geo_spatial_column_group.country_code #=> String, one of "US"
1900
2944
  # resp.data_set.column_groups[0].geo_spatial_column_group.columns #=> Array
1901
2945
  # resp.data_set.column_groups[0].geo_spatial_column_group.columns[0] #=> String
2946
+ # resp.data_set.row_level_permission_data_set.namespace #=> String
1902
2947
  # resp.data_set.row_level_permission_data_set.arn #=> String
1903
2948
  # resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
1904
2949
  # resp.request_id #=> String
@@ -1988,7 +3033,7 @@ module Aws::QuickSight
1988
3033
  # resp.data_source.data_source_id #=> String
1989
3034
  # resp.data_source.name #=> String
1990
3035
  # resp.data_source.type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER"
1991
- # resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
3036
+ # resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
1992
3037
  # resp.data_source.created_time #=> Time
1993
3038
  # resp.data_source.last_updated_time #=> Time
1994
3039
  # resp.data_source.data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
@@ -2035,9 +3080,54 @@ module Aws::QuickSight
2035
3080
  # resp.data_source.data_source_parameters.teradata_parameters.database #=> String
2036
3081
  # resp.data_source.data_source_parameters.twitter_parameters.query #=> String
2037
3082
  # resp.data_source.data_source_parameters.twitter_parameters.max_rows #=> Integer
3083
+ # resp.data_source.alternate_data_source_parameters #=> Array
3084
+ # resp.data_source.alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
3085
+ # resp.data_source.alternate_data_source_parameters[0].athena_parameters.work_group #=> String
3086
+ # resp.data_source.alternate_data_source_parameters[0].aurora_parameters.host #=> String
3087
+ # resp.data_source.alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
3088
+ # resp.data_source.alternate_data_source_parameters[0].aurora_parameters.database #=> String
3089
+ # resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
3090
+ # resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
3091
+ # resp.data_source.alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
3092
+ # resp.data_source.alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
3093
+ # resp.data_source.alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
3094
+ # resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.host #=> String
3095
+ # resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
3096
+ # resp.data_source.alternate_data_source_parameters[0].maria_db_parameters.database #=> String
3097
+ # resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.host #=> String
3098
+ # resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
3099
+ # resp.data_source.alternate_data_source_parameters[0].my_sql_parameters.database #=> String
3100
+ # resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
3101
+ # resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
3102
+ # resp.data_source.alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
3103
+ # resp.data_source.alternate_data_source_parameters[0].presto_parameters.host #=> String
3104
+ # resp.data_source.alternate_data_source_parameters[0].presto_parameters.port #=> Integer
3105
+ # resp.data_source.alternate_data_source_parameters[0].presto_parameters.catalog #=> String
3106
+ # resp.data_source.alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
3107
+ # resp.data_source.alternate_data_source_parameters[0].rds_parameters.database #=> String
3108
+ # resp.data_source.alternate_data_source_parameters[0].redshift_parameters.host #=> String
3109
+ # resp.data_source.alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
3110
+ # resp.data_source.alternate_data_source_parameters[0].redshift_parameters.database #=> String
3111
+ # resp.data_source.alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
3112
+ # resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
3113
+ # resp.data_source.alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
3114
+ # resp.data_source.alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
3115
+ # resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.host #=> String
3116
+ # resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.database #=> String
3117
+ # resp.data_source.alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
3118
+ # resp.data_source.alternate_data_source_parameters[0].spark_parameters.host #=> String
3119
+ # resp.data_source.alternate_data_source_parameters[0].spark_parameters.port #=> Integer
3120
+ # resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.host #=> String
3121
+ # resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
3122
+ # resp.data_source.alternate_data_source_parameters[0].sql_server_parameters.database #=> String
3123
+ # resp.data_source.alternate_data_source_parameters[0].teradata_parameters.host #=> String
3124
+ # resp.data_source.alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
3125
+ # resp.data_source.alternate_data_source_parameters[0].teradata_parameters.database #=> String
3126
+ # resp.data_source.alternate_data_source_parameters[0].twitter_parameters.query #=> String
3127
+ # resp.data_source.alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
2038
3128
  # resp.data_source.vpc_connection_properties.vpc_connection_arn #=> String
2039
3129
  # resp.data_source.ssl_properties.disable_ssl #=> Boolean
2040
- # resp.data_source.error_info.type #=> String, one of "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
3130
+ # resp.data_source.error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
2041
3131
  # resp.data_source.error_info.message #=> String
2042
3132
  # resp.request_id #=> String
2043
3133
  # resp.status #=> Integer
@@ -2243,6 +3333,49 @@ module Aws::QuickSight
2243
3333
  req.send_request(options)
2244
3334
  end
2245
3335
 
3336
+ # Describes the current namespace.
3337
+ #
3338
+ # @option params [required, String] :aws_account_id
3339
+ # The ID for the AWS account that contains the QuickSight namespace that
3340
+ # you want to describe.
3341
+ #
3342
+ # @option params [required, String] :namespace
3343
+ # The namespace that you want to describe.
3344
+ #
3345
+ # @return [Types::DescribeNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3346
+ #
3347
+ # * {Types::DescribeNamespaceResponse#namespace #namespace} => Types::NamespaceInfoV2
3348
+ # * {Types::DescribeNamespaceResponse#request_id #request_id} => String
3349
+ # * {Types::DescribeNamespaceResponse#status #status} => Integer
3350
+ #
3351
+ # @example Request syntax with placeholder values
3352
+ #
3353
+ # resp = client.describe_namespace({
3354
+ # aws_account_id: "AwsAccountId", # required
3355
+ # namespace: "Namespace", # required
3356
+ # })
3357
+ #
3358
+ # @example Response structure
3359
+ #
3360
+ # resp.namespace.name #=> String
3361
+ # resp.namespace.arn #=> String
3362
+ # resp.namespace.capacity_region #=> String
3363
+ # resp.namespace.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
3364
+ # resp.namespace.identity_store #=> String, one of "QUICKSIGHT"
3365
+ # resp.namespace.namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
3366
+ # resp.namespace.namespace_error.message #=> String
3367
+ # resp.request_id #=> String
3368
+ # resp.status #=> Integer
3369
+ #
3370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeNamespace AWS API Documentation
3371
+ #
3372
+ # @overload describe_namespace(params = {})
3373
+ # @param [Hash] params ({})
3374
+ def describe_namespace(params = {}, options = {})
3375
+ req = build_request(:describe_namespace, params)
3376
+ req.send_request(options)
3377
+ end
3378
+
2246
3379
  # Describes a template's metadata.
2247
3380
  #
2248
3381
  # @option params [required, String] :aws_account_id
@@ -2268,6 +3401,7 @@ module Aws::QuickSight
2268
3401
  #
2269
3402
  # * {Types::DescribeTemplateResponse#template #template} => Types::Template
2270
3403
  # * {Types::DescribeTemplateResponse#status #status} => Integer
3404
+ # * {Types::DescribeTemplateResponse#request_id #request_id} => String
2271
3405
  #
2272
3406
  # @example Request syntax with placeholder values
2273
3407
  #
@@ -2284,10 +3418,10 @@ module Aws::QuickSight
2284
3418
  # resp.template.name #=> String
2285
3419
  # resp.template.version.created_time #=> Time
2286
3420
  # resp.template.version.errors #=> Array
2287
- # resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE"
3421
+ # resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "ACCESS_DENIED"
2288
3422
  # resp.template.version.errors[0].message #=> String
2289
3423
  # resp.template.version.version_number #=> Integer
2290
- # resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
3424
+ # resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2291
3425
  # resp.template.version.data_set_configurations #=> Array
2292
3426
  # resp.template.version.data_set_configurations[0].placeholder #=> String
2293
3427
  # resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list #=> Array
@@ -2300,10 +3434,12 @@ module Aws::QuickSight
2300
3434
  # resp.template.version.data_set_configurations[0].column_group_schema_list[0].column_group_column_schema_list[0].name #=> String
2301
3435
  # resp.template.version.description #=> String
2302
3436
  # resp.template.version.source_entity_arn #=> String
3437
+ # resp.template.version.theme_arn #=> String
2303
3438
  # resp.template.template_id #=> String
2304
3439
  # resp.template.last_updated_time #=> Time
2305
3440
  # resp.template.created_time #=> Time
2306
3441
  # resp.status #=> Integer
3442
+ # resp.request_id #=> String
2307
3443
  #
2308
3444
  # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTemplate AWS API Documentation
2309
3445
  #
@@ -2405,6 +3541,182 @@ module Aws::QuickSight
2405
3541
  req.send_request(options)
2406
3542
  end
2407
3543
 
3544
+ # Describes a theme.
3545
+ #
3546
+ # @option params [required, String] :aws_account_id
3547
+ # The ID of the AWS account that contains the theme that you're
3548
+ # describing.
3549
+ #
3550
+ # @option params [required, String] :theme_id
3551
+ # The ID for the theme.
3552
+ #
3553
+ # @option params [Integer] :version_number
3554
+ # The version number for the version to describe. If a `VersionNumber`
3555
+ # parameter value isn't provided, the latest version of the theme is
3556
+ # described.
3557
+ #
3558
+ # @option params [String] :alias_name
3559
+ # The alias of the theme that you want to describe. If you name a
3560
+ # specific alias, you describe the version that the alias points to. You
3561
+ # can specify the latest version of the theme by providing the keyword
3562
+ # `$LATEST` in the `AliasName` parameter. The keyword `$PUBLISHED`
3563
+ # doesn't apply to themes.
3564
+ #
3565
+ # @return [Types::DescribeThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3566
+ #
3567
+ # * {Types::DescribeThemeResponse#theme #theme} => Types::Theme
3568
+ # * {Types::DescribeThemeResponse#status #status} => Integer
3569
+ # * {Types::DescribeThemeResponse#request_id #request_id} => String
3570
+ #
3571
+ # @example Request syntax with placeholder values
3572
+ #
3573
+ # resp = client.describe_theme({
3574
+ # aws_account_id: "AwsAndAccountId", # required
3575
+ # theme_id: "RestrictiveResourceId", # required
3576
+ # version_number: 1,
3577
+ # alias_name: "AliasName",
3578
+ # })
3579
+ #
3580
+ # @example Response structure
3581
+ #
3582
+ # resp.theme.arn #=> String
3583
+ # resp.theme.name #=> String
3584
+ # resp.theme.theme_id #=> String
3585
+ # resp.theme.version.version_number #=> Integer
3586
+ # resp.theme.version.arn #=> String
3587
+ # resp.theme.version.description #=> String
3588
+ # resp.theme.version.base_theme_id #=> String
3589
+ # resp.theme.version.created_time #=> Time
3590
+ # resp.theme.version.configuration.data_color_palette.colors #=> Array
3591
+ # resp.theme.version.configuration.data_color_palette.colors[0] #=> String
3592
+ # resp.theme.version.configuration.data_color_palette.min_max_gradient #=> Array
3593
+ # resp.theme.version.configuration.data_color_palette.min_max_gradient[0] #=> String
3594
+ # resp.theme.version.configuration.data_color_palette.empty_fill_color #=> String
3595
+ # resp.theme.version.configuration.ui_color_palette.primary_foreground #=> String
3596
+ # resp.theme.version.configuration.ui_color_palette.primary_background #=> String
3597
+ # resp.theme.version.configuration.ui_color_palette.secondary_foreground #=> String
3598
+ # resp.theme.version.configuration.ui_color_palette.secondary_background #=> String
3599
+ # resp.theme.version.configuration.ui_color_palette.accent #=> String
3600
+ # resp.theme.version.configuration.ui_color_palette.accent_foreground #=> String
3601
+ # resp.theme.version.configuration.ui_color_palette.danger #=> String
3602
+ # resp.theme.version.configuration.ui_color_palette.danger_foreground #=> String
3603
+ # resp.theme.version.configuration.ui_color_palette.warning #=> String
3604
+ # resp.theme.version.configuration.ui_color_palette.warning_foreground #=> String
3605
+ # resp.theme.version.configuration.ui_color_palette.success #=> String
3606
+ # resp.theme.version.configuration.ui_color_palette.success_foreground #=> String
3607
+ # resp.theme.version.configuration.ui_color_palette.dimension #=> String
3608
+ # resp.theme.version.configuration.ui_color_palette.dimension_foreground #=> String
3609
+ # resp.theme.version.configuration.ui_color_palette.measure #=> String
3610
+ # resp.theme.version.configuration.ui_color_palette.measure_foreground #=> String
3611
+ # resp.theme.version.configuration.sheet.tile.border.show #=> Boolean
3612
+ # resp.theme.version.configuration.sheet.tile_layout.gutter.show #=> Boolean
3613
+ # resp.theme.version.configuration.sheet.tile_layout.margin.show #=> Boolean
3614
+ # resp.theme.version.errors #=> Array
3615
+ # resp.theme.version.errors[0].type #=> String, one of "INTERNAL_FAILURE"
3616
+ # resp.theme.version.errors[0].message #=> String
3617
+ # resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3618
+ # resp.theme.created_time #=> Time
3619
+ # resp.theme.last_updated_time #=> Time
3620
+ # resp.theme.type #=> String, one of "QUICKSIGHT", "CUSTOM", "ALL"
3621
+ # resp.status #=> Integer
3622
+ # resp.request_id #=> String
3623
+ #
3624
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeTheme AWS API Documentation
3625
+ #
3626
+ # @overload describe_theme(params = {})
3627
+ # @param [Hash] params ({})
3628
+ def describe_theme(params = {}, options = {})
3629
+ req = build_request(:describe_theme, params)
3630
+ req.send_request(options)
3631
+ end
3632
+
3633
+ # Describes the alias for a theme.
3634
+ #
3635
+ # @option params [required, String] :aws_account_id
3636
+ # The ID of the AWS account that contains the theme alias that you're
3637
+ # describing.
3638
+ #
3639
+ # @option params [required, String] :theme_id
3640
+ # The ID for the theme.
3641
+ #
3642
+ # @option params [required, String] :alias_name
3643
+ # The name of the theme alias that you want to describe.
3644
+ #
3645
+ # @return [Types::DescribeThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3646
+ #
3647
+ # * {Types::DescribeThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
3648
+ # * {Types::DescribeThemeAliasResponse#status #status} => Integer
3649
+ # * {Types::DescribeThemeAliasResponse#request_id #request_id} => String
3650
+ #
3651
+ # @example Request syntax with placeholder values
3652
+ #
3653
+ # resp = client.describe_theme_alias({
3654
+ # aws_account_id: "AwsAccountId", # required
3655
+ # theme_id: "RestrictiveResourceId", # required
3656
+ # alias_name: "AliasName", # required
3657
+ # })
3658
+ #
3659
+ # @example Response structure
3660
+ #
3661
+ # resp.theme_alias.arn #=> String
3662
+ # resp.theme_alias.alias_name #=> String
3663
+ # resp.theme_alias.theme_version_number #=> Integer
3664
+ # resp.status #=> Integer
3665
+ # resp.request_id #=> String
3666
+ #
3667
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemeAlias AWS API Documentation
3668
+ #
3669
+ # @overload describe_theme_alias(params = {})
3670
+ # @param [Hash] params ({})
3671
+ def describe_theme_alias(params = {}, options = {})
3672
+ req = build_request(:describe_theme_alias, params)
3673
+ req.send_request(options)
3674
+ end
3675
+
3676
+ # Describes the read and write permissions for a theme.
3677
+ #
3678
+ # @option params [required, String] :aws_account_id
3679
+ # The ID of the AWS account that contains the theme that you're
3680
+ # describing.
3681
+ #
3682
+ # @option params [required, String] :theme_id
3683
+ # The ID for the theme that you want to describe permissions for.
3684
+ #
3685
+ # @return [Types::DescribeThemePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3686
+ #
3687
+ # * {Types::DescribeThemePermissionsResponse#theme_id #theme_id} => String
3688
+ # * {Types::DescribeThemePermissionsResponse#theme_arn #theme_arn} => String
3689
+ # * {Types::DescribeThemePermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
3690
+ # * {Types::DescribeThemePermissionsResponse#request_id #request_id} => String
3691
+ # * {Types::DescribeThemePermissionsResponse#status #status} => Integer
3692
+ #
3693
+ # @example Request syntax with placeholder values
3694
+ #
3695
+ # resp = client.describe_theme_permissions({
3696
+ # aws_account_id: "AwsAccountId", # required
3697
+ # theme_id: "RestrictiveResourceId", # required
3698
+ # })
3699
+ #
3700
+ # @example Response structure
3701
+ #
3702
+ # resp.theme_id #=> String
3703
+ # resp.theme_arn #=> String
3704
+ # resp.permissions #=> Array
3705
+ # resp.permissions[0].principal #=> String
3706
+ # resp.permissions[0].actions #=> Array
3707
+ # resp.permissions[0].actions[0] #=> String
3708
+ # resp.request_id #=> String
3709
+ # resp.status #=> Integer
3710
+ #
3711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeThemePermissions AWS API Documentation
3712
+ #
3713
+ # @overload describe_theme_permissions(params = {})
3714
+ # @param [Hash] params ({})
3715
+ def describe_theme_permissions(params = {}, options = {})
3716
+ req = build_request(:describe_theme_permissions, params)
3717
+ req.send_request(options)
3718
+ end
3719
+
2408
3720
  # Returns information about a user, given the user name.
2409
3721
  #
2410
3722
  # @option params [required, String] :user_name
@@ -2440,6 +3752,7 @@ module Aws::QuickSight
2440
3752
  # resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
2441
3753
  # resp.user.active #=> Boolean
2442
3754
  # resp.user.principal_id #=> String
3755
+ # resp.user.custom_permissions_name #=> String
2443
3756
  # resp.request_id #=> String
2444
3757
  # resp.status #=> Integer
2445
3758
  #
@@ -2452,72 +3765,178 @@ module Aws::QuickSight
2452
3765
  req.send_request(options)
2453
3766
  end
2454
3767
 
2455
- # Generates a server-side embeddable URL and authorization code. For
2456
- # this process to work properly, first configure the dashboards and user
2457
- # permissions. For more information, see [Embedding Amazon QuickSight
2458
- # Dashboards][1] in the *Amazon QuickSight User Guide* or [Embedding
2459
- # Amazon QuickSight Dashboards][2] in the *Amazon QuickSight API
2460
- # Reference*.
3768
+ # Generates a session URL and authorization code that you can use to
3769
+ # embed an Amazon QuickSight read-only dashboard in your web server
3770
+ # code. Before you use this command, make sure that you have configured
3771
+ # the dashboards and permissions.
2461
3772
  #
2462
3773
  # Currently, you can use `GetDashboardEmbedURL` only from the server,
2463
- # not from the users browser.
3774
+ # not from the user's browser. The following rules apply to the
3775
+ # combination of URL and authorization code:
3776
+ #
3777
+ # * They must be used together.
3778
+ #
3779
+ # * They can be used one time only.
3780
+ #
3781
+ # * They are valid for 5 minutes after you run this command.
3782
+ #
3783
+ # * The resulting user session is valid for 10 hours.
3784
+ #
3785
+ # For more information, see [Embedding Amazon QuickSight][1] in the
3786
+ # *Amazon QuickSight User Guide* .
2464
3787
  #
2465
3788
  #
2466
3789
  #
2467
3790
  # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html
2468
- # [2]: https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html
2469
3791
  #
2470
3792
  # @option params [required, String] :aws_account_id
2471
3793
  # The ID for the AWS account that contains the dashboard that you're
2472
3794
  # embedding.
2473
3795
  #
2474
- # @option params [required, String] :dashboard_id
2475
- # The ID for the dashboard, also added to the IAM policy.
3796
+ # @option params [required, String] :dashboard_id
3797
+ # The ID for the dashboard, also added to the IAM policy.
3798
+ #
3799
+ # @option params [required, String] :identity_type
3800
+ # The authentication method that the user uses to sign in.
3801
+ #
3802
+ # @option params [Integer] :session_lifetime_in_minutes
3803
+ # How many minutes the session is valid. The session lifetime must be
3804
+ # 15-600 minutes.
3805
+ #
3806
+ # @option params [Boolean] :undo_redo_disabled
3807
+ # Remove the undo/redo button on the embedded dashboard. The default is
3808
+ # FALSE, which enables the undo/redo button.
3809
+ #
3810
+ # @option params [Boolean] :reset_disabled
3811
+ # Remove the reset button on the embedded dashboard. The default is
3812
+ # FALSE, which enables the reset button.
3813
+ #
3814
+ # @option params [String] :user_arn
3815
+ # The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
3816
+ # `QUICKSIGHT` identity type. You can use this for any Amazon QuickSight
3817
+ # users in your account (readers, authors, or admins) authenticated as
3818
+ # one of the following:
3819
+ #
3820
+ # * Active Directory (AD) users or group members
3821
+ #
3822
+ # * Invited nonfederated users
3823
+ #
3824
+ # * IAM users and IAM role-based sessions authenticated through
3825
+ # Federated Single Sign-On using SAML, OpenID Connect, or IAM
3826
+ # federation.
3827
+ #
3828
+ # Omit this parameter for users in the third group – IAM users and IAM
3829
+ # role-based sessions.
3830
+ #
3831
+ # @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3832
+ #
3833
+ # * {Types::GetDashboardEmbedUrlResponse#embed_url #embed_url} => String
3834
+ # * {Types::GetDashboardEmbedUrlResponse#status #status} => Integer
3835
+ # * {Types::GetDashboardEmbedUrlResponse#request_id #request_id} => String
3836
+ #
3837
+ # @example Request syntax with placeholder values
3838
+ #
3839
+ # resp = client.get_dashboard_embed_url({
3840
+ # aws_account_id: "AwsAccountId", # required
3841
+ # dashboard_id: "RestrictiveResourceId", # required
3842
+ # identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
3843
+ # session_lifetime_in_minutes: 1,
3844
+ # undo_redo_disabled: false,
3845
+ # reset_disabled: false,
3846
+ # user_arn: "Arn",
3847
+ # })
3848
+ #
3849
+ # @example Response structure
3850
+ #
3851
+ # resp.embed_url #=> String
3852
+ # resp.status #=> Integer
3853
+ # resp.request_id #=> String
3854
+ #
3855
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrl AWS API Documentation
3856
+ #
3857
+ # @overload get_dashboard_embed_url(params = {})
3858
+ # @param [Hash] params ({})
3859
+ def get_dashboard_embed_url(params = {}, options = {})
3860
+ req = build_request(:get_dashboard_embed_url, params)
3861
+ req.send_request(options)
3862
+ end
3863
+
3864
+ # Generates a session URL and authorization code that you can use to
3865
+ # embed the Amazon QuickSight console in your web server code. Use
3866
+ # `GetSessionEmbedUrl` where you want to provide an authoring portal
3867
+ # that allows users to create data sources, datasets, analyses, and
3868
+ # dashboards. The users who access an embedded QuickSight console need
3869
+ # belong to the author or admin security cohort. If you want to restrict
3870
+ # permissions to some of these features, add a custom permissions
3871
+ # profile to the user with the ` UpdateUser ` API operation. Use `
3872
+ # RegisterUser ` API operation to add a new user with a custom
3873
+ # permission profile attached. For more information, see the following
3874
+ # sections in the *Amazon QuickSight User Guide*\:
3875
+ #
3876
+ # * [Embedding the Amazon QuickSight Console][1]
3877
+ #
3878
+ # * [Customizing Access to the Amazon QuickSight Console][2]
3879
+ #
3880
+ #
3881
+ #
3882
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-the-quicksight-console.html
3883
+ # [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
3884
+ #
3885
+ # @option params [required, String] :aws_account_id
3886
+ # The ID for the AWS account associated with your QuickSight
3887
+ # subscription.
3888
+ #
3889
+ # @option params [String] :entry_point
3890
+ # The URL you use to access the embedded session. The entry point URL is
3891
+ # constrained to the following paths:
3892
+ #
3893
+ # * `/start`
3894
+ #
3895
+ # * `/start/analyses`
3896
+ #
3897
+ # * `/start/dashboards`
2476
3898
  #
2477
- # @option params [required, String] :identity_type
2478
- # The authentication method that the user uses to sign in.
3899
+ # * `/start/favorites`
3900
+ #
3901
+ # * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
3902
+ # key from the QuickSight console URL of the dashboard
3903
+ #
3904
+ # * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
3905
+ # from the QuickSight console URL of the analysis
2479
3906
  #
2480
3907
  # @option params [Integer] :session_lifetime_in_minutes
2481
3908
  # How many minutes the session is valid. The session lifetime must be
2482
3909
  # 15-600 minutes.
2483
3910
  #
2484
- # @option params [Boolean] :undo_redo_disabled
2485
- # Remove the undo/redo button on the embedded dashboard. The default is
2486
- # FALSE, which enables the undo/redo button.
2487
- #
2488
- # @option params [Boolean] :reset_disabled
2489
- # Remove the reset button on the embedded dashboard. The default is
2490
- # FALSE, which enables the reset button.
2491
- #
2492
3911
  # @option params [String] :user_arn
2493
3912
  # The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
2494
- # `QUICKSIGHT` identity type. You can use this for any Amazon QuickSight
2495
- # users in your account (readers, authors, or admins) authenticated as
2496
- # one of the following:
3913
+ # `QUICKSIGHT` identity type. You can use this for any type of Amazon
3914
+ # QuickSight users in your account (readers, authors, or admins). They
3915
+ # need to be authenticated as one of the following:
2497
3916
  #
2498
- # * Active Directory (AD) users or group members
3917
+ # 1. Active Directory (AD) users or group members
2499
3918
  #
2500
- # * Invited nonfederated users
3919
+ # 2. Invited nonfederated users
2501
3920
  #
2502
- # * IAM users and IAM role-based sessions authenticated through
2503
- # Federated Single Sign-On using SAML, OpenID Connect, or IAM
2504
- # federation.
3921
+ # 3. IAM users and IAM role-based sessions authenticated through
3922
+ # Federated Single Sign-On using SAML, OpenID Connect, or IAM
3923
+ # federation
2505
3924
  #
2506
- # @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3925
+ # Omit this parameter for users in the third group IAM users and IAM
3926
+ # role-based sessions.
2507
3927
  #
2508
- # * {Types::GetDashboardEmbedUrlResponse#embed_url #embed_url} => String
2509
- # * {Types::GetDashboardEmbedUrlResponse#status #status} => Integer
2510
- # * {Types::GetDashboardEmbedUrlResponse#request_id #request_id} => String
3928
+ # @return [Types::GetSessionEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3929
+ #
3930
+ # * {Types::GetSessionEmbedUrlResponse#embed_url #embed_url} => String
3931
+ # * {Types::GetSessionEmbedUrlResponse#status #status} => Integer
3932
+ # * {Types::GetSessionEmbedUrlResponse#request_id #request_id} => String
2511
3933
  #
2512
3934
  # @example Request syntax with placeholder values
2513
3935
  #
2514
- # resp = client.get_dashboard_embed_url({
3936
+ # resp = client.get_session_embed_url({
2515
3937
  # aws_account_id: "AwsAccountId", # required
2516
- # dashboard_id: "RestrictiveResourceId", # required
2517
- # identity_type: "IAM", # required, accepts IAM, QUICKSIGHT
3938
+ # entry_point: "EntryPoint",
2518
3939
  # session_lifetime_in_minutes: 1,
2519
- # undo_redo_disabled: false,
2520
- # reset_disabled: false,
2521
3940
  # user_arn: "Arn",
2522
3941
  # })
2523
3942
  #
@@ -2527,12 +3946,63 @@ module Aws::QuickSight
2527
3946
  # resp.status #=> Integer
2528
3947
  # resp.request_id #=> String
2529
3948
  #
2530
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrl AWS API Documentation
3949
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrl AWS API Documentation
2531
3950
  #
2532
- # @overload get_dashboard_embed_url(params = {})
3951
+ # @overload get_session_embed_url(params = {})
2533
3952
  # @param [Hash] params ({})
2534
- def get_dashboard_embed_url(params = {}, options = {})
2535
- req = build_request(:get_dashboard_embed_url, params)
3953
+ def get_session_embed_url(params = {}, options = {})
3954
+ req = build_request(:get_session_embed_url, params)
3955
+ req.send_request(options)
3956
+ end
3957
+
3958
+ # Lists Amazon QuickSight analyses that exist in the specified AWS
3959
+ # account.
3960
+ #
3961
+ # @option params [required, String] :aws_account_id
3962
+ # The ID of the AWS account that contains the analyses.
3963
+ #
3964
+ # @option params [String] :next_token
3965
+ # A pagination token that can be used in a subsequent request.
3966
+ #
3967
+ # @option params [Integer] :max_results
3968
+ # The maximum number of results to return.
3969
+ #
3970
+ # @return [Types::ListAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3971
+ #
3972
+ # * {Types::ListAnalysesResponse#analysis_summary_list #analysis_summary_list} => Array&lt;Types::AnalysisSummary&gt;
3973
+ # * {Types::ListAnalysesResponse#next_token #next_token} => String
3974
+ # * {Types::ListAnalysesResponse#status #status} => Integer
3975
+ # * {Types::ListAnalysesResponse#request_id #request_id} => String
3976
+ #
3977
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3978
+ #
3979
+ # @example Request syntax with placeholder values
3980
+ #
3981
+ # resp = client.list_analyses({
3982
+ # aws_account_id: "AwsAccountId", # required
3983
+ # next_token: "String",
3984
+ # max_results: 1,
3985
+ # })
3986
+ #
3987
+ # @example Response structure
3988
+ #
3989
+ # resp.analysis_summary_list #=> Array
3990
+ # resp.analysis_summary_list[0].arn #=> String
3991
+ # resp.analysis_summary_list[0].analysis_id #=> String
3992
+ # resp.analysis_summary_list[0].name #=> String
3993
+ # resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3994
+ # resp.analysis_summary_list[0].created_time #=> Time
3995
+ # resp.analysis_summary_list[0].last_updated_time #=> Time
3996
+ # resp.next_token #=> String
3997
+ # resp.status #=> Integer
3998
+ # resp.request_id #=> String
3999
+ #
4000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalyses AWS API Documentation
4001
+ #
4002
+ # @overload list_analyses(params = {})
4003
+ # @param [Hash] params ({})
4004
+ def list_analyses(params = {}, options = {})
4005
+ req = build_request(:list_analyses, params)
2536
4006
  req.send_request(options)
2537
4007
  end
2538
4008
 
@@ -2577,7 +4047,7 @@ module Aws::QuickSight
2577
4047
  # resp.dashboard_version_summary_list[0].arn #=> String
2578
4048
  # resp.dashboard_version_summary_list[0].created_time #=> Time
2579
4049
  # resp.dashboard_version_summary_list[0].version_number #=> Integer
2580
- # resp.dashboard_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
4050
+ # resp.dashboard_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2581
4051
  # resp.dashboard_version_summary_list[0].source_entity_arn #=> String
2582
4052
  # resp.dashboard_version_summary_list[0].description #=> String
2583
4053
  # resp.next_token #=> String
@@ -2688,6 +4158,7 @@ module Aws::QuickSight
2688
4158
  # resp.data_set_summaries[0].created_time #=> Time
2689
4159
  # resp.data_set_summaries[0].last_updated_time #=> Time
2690
4160
  # resp.data_set_summaries[0].import_mode #=> String, one of "SPICE", "DIRECT_QUERY"
4161
+ # resp.data_set_summaries[0].row_level_permission_data_set.namespace #=> String
2691
4162
  # resp.data_set_summaries[0].row_level_permission_data_set.arn #=> String
2692
4163
  # resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
2693
4164
  # resp.next_token #=> String
@@ -2740,7 +4211,7 @@ module Aws::QuickSight
2740
4211
  # resp.data_sources[0].data_source_id #=> String
2741
4212
  # resp.data_sources[0].name #=> String
2742
4213
  # resp.data_sources[0].type #=> String, one of "ADOBE_ANALYTICS", "AMAZON_ELASTICSEARCH", "ATHENA", "AURORA", "AURORA_POSTGRESQL", "AWS_IOT_ANALYTICS", "GITHUB", "JIRA", "MARIADB", "MYSQL", "POSTGRESQL", "PRESTO", "REDSHIFT", "S3", "SALESFORCE", "SERVICENOW", "SNOWFLAKE", "SPARK", "SQLSERVER", "TERADATA", "TWITTER"
2743
- # resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
4214
+ # resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2744
4215
  # resp.data_sources[0].created_time #=> Time
2745
4216
  # resp.data_sources[0].last_updated_time #=> Time
2746
4217
  # resp.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
@@ -2787,9 +4258,54 @@ module Aws::QuickSight
2787
4258
  # resp.data_sources[0].data_source_parameters.teradata_parameters.database #=> String
2788
4259
  # resp.data_sources[0].data_source_parameters.twitter_parameters.query #=> String
2789
4260
  # resp.data_sources[0].data_source_parameters.twitter_parameters.max_rows #=> Integer
4261
+ # resp.data_sources[0].alternate_data_source_parameters #=> Array
4262
+ # resp.data_sources[0].alternate_data_source_parameters[0].amazon_elasticsearch_parameters.domain #=> String
4263
+ # resp.data_sources[0].alternate_data_source_parameters[0].athena_parameters.work_group #=> String
4264
+ # resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.host #=> String
4265
+ # resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.port #=> Integer
4266
+ # resp.data_sources[0].alternate_data_source_parameters[0].aurora_parameters.database #=> String
4267
+ # resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.host #=> String
4268
+ # resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.port #=> Integer
4269
+ # resp.data_sources[0].alternate_data_source_parameters[0].aurora_postgre_sql_parameters.database #=> String
4270
+ # resp.data_sources[0].alternate_data_source_parameters[0].aws_iot_analytics_parameters.data_set_name #=> String
4271
+ # resp.data_sources[0].alternate_data_source_parameters[0].jira_parameters.site_base_url #=> String
4272
+ # resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.host #=> String
4273
+ # resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.port #=> Integer
4274
+ # resp.data_sources[0].alternate_data_source_parameters[0].maria_db_parameters.database #=> String
4275
+ # resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.host #=> String
4276
+ # resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.port #=> Integer
4277
+ # resp.data_sources[0].alternate_data_source_parameters[0].my_sql_parameters.database #=> String
4278
+ # resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.host #=> String
4279
+ # resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.port #=> Integer
4280
+ # resp.data_sources[0].alternate_data_source_parameters[0].postgre_sql_parameters.database #=> String
4281
+ # resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.host #=> String
4282
+ # resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.port #=> Integer
4283
+ # resp.data_sources[0].alternate_data_source_parameters[0].presto_parameters.catalog #=> String
4284
+ # resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.instance_id #=> String
4285
+ # resp.data_sources[0].alternate_data_source_parameters[0].rds_parameters.database #=> String
4286
+ # resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.host #=> String
4287
+ # resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.port #=> Integer
4288
+ # resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.database #=> String
4289
+ # resp.data_sources[0].alternate_data_source_parameters[0].redshift_parameters.cluster_id #=> String
4290
+ # resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.bucket #=> String
4291
+ # resp.data_sources[0].alternate_data_source_parameters[0].s3_parameters.manifest_file_location.key #=> String
4292
+ # resp.data_sources[0].alternate_data_source_parameters[0].service_now_parameters.site_base_url #=> String
4293
+ # resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.host #=> String
4294
+ # resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.database #=> String
4295
+ # resp.data_sources[0].alternate_data_source_parameters[0].snowflake_parameters.warehouse #=> String
4296
+ # resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.host #=> String
4297
+ # resp.data_sources[0].alternate_data_source_parameters[0].spark_parameters.port #=> Integer
4298
+ # resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.host #=> String
4299
+ # resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.port #=> Integer
4300
+ # resp.data_sources[0].alternate_data_source_parameters[0].sql_server_parameters.database #=> String
4301
+ # resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.host #=> String
4302
+ # resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.port #=> Integer
4303
+ # resp.data_sources[0].alternate_data_source_parameters[0].teradata_parameters.database #=> String
4304
+ # resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.query #=> String
4305
+ # resp.data_sources[0].alternate_data_source_parameters[0].twitter_parameters.max_rows #=> Integer
2790
4306
  # resp.data_sources[0].vpc_connection_properties.vpc_connection_arn #=> String
2791
4307
  # resp.data_sources[0].ssl_properties.disable_ssl #=> Boolean
2792
- # resp.data_sources[0].error_info.type #=> String, one of "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
4308
+ # resp.data_sources[0].error_info.type #=> String, one of "ACCESS_DENIED", "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", "GENERIC_SQL_FAILURE", "CONFLICT", "UNKNOWN"
2793
4309
  # resp.data_sources[0].error_info.message #=> String
2794
4310
  # resp.next_token #=> String
2795
4311
  # resp.request_id #=> String
@@ -3081,6 +4597,58 @@ module Aws::QuickSight
3081
4597
  req.send_request(options)
3082
4598
  end
3083
4599
 
4600
+ # Lists the namespaces for the specified AWS account.
4601
+ #
4602
+ # @option params [required, String] :aws_account_id
4603
+ # The ID for the AWS account that contains the QuickSight namespaces
4604
+ # that you want to list.
4605
+ #
4606
+ # @option params [String] :next_token
4607
+ # A pagination token that can be used in a subsequent request.
4608
+ #
4609
+ # @option params [Integer] :max_results
4610
+ # The maximum number of results to return.
4611
+ #
4612
+ # @return [Types::ListNamespacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4613
+ #
4614
+ # * {Types::ListNamespacesResponse#namespaces #namespaces} => Array&lt;Types::NamespaceInfoV2&gt;
4615
+ # * {Types::ListNamespacesResponse#next_token #next_token} => String
4616
+ # * {Types::ListNamespacesResponse#request_id #request_id} => String
4617
+ # * {Types::ListNamespacesResponse#status #status} => Integer
4618
+ #
4619
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4620
+ #
4621
+ # @example Request syntax with placeholder values
4622
+ #
4623
+ # resp = client.list_namespaces({
4624
+ # aws_account_id: "AwsAccountId", # required
4625
+ # next_token: "String",
4626
+ # max_results: 1,
4627
+ # })
4628
+ #
4629
+ # @example Response structure
4630
+ #
4631
+ # resp.namespaces #=> Array
4632
+ # resp.namespaces[0].name #=> String
4633
+ # resp.namespaces[0].arn #=> String
4634
+ # resp.namespaces[0].capacity_region #=> String
4635
+ # resp.namespaces[0].creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
4636
+ # resp.namespaces[0].identity_store #=> String, one of "QUICKSIGHT"
4637
+ # resp.namespaces[0].namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
4638
+ # resp.namespaces[0].namespace_error.message #=> String
4639
+ # resp.next_token #=> String
4640
+ # resp.request_id #=> String
4641
+ # resp.status #=> Integer
4642
+ #
4643
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListNamespaces AWS API Documentation
4644
+ #
4645
+ # @overload list_namespaces(params = {})
4646
+ # @param [Hash] params ({})
4647
+ def list_namespaces(params = {}, options = {})
4648
+ req = build_request(:list_namespaces, params)
4649
+ req.send_request(options)
4650
+ end
4651
+
3084
4652
  # Lists the tags assigned to a resource.
3085
4653
  #
3086
4654
  # @option params [required, String] :resource_arn
@@ -3122,8 +4690,169 @@ module Aws::QuickSight
3122
4690
  # The ID of the AWS account that contains the template aliases that
3123
4691
  # you're listing.
3124
4692
  #
3125
- # @option params [required, String] :template_id
3126
- # The ID for the template.
4693
+ # @option params [required, String] :template_id
4694
+ # The ID for the template.
4695
+ #
4696
+ # @option params [String] :next_token
4697
+ # The token for the next set of results, or null if there are no more
4698
+ # results.
4699
+ #
4700
+ # @option params [Integer] :max_results
4701
+ # The maximum number of results to be returned per request.
4702
+ #
4703
+ # @return [Types::ListTemplateAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4704
+ #
4705
+ # * {Types::ListTemplateAliasesResponse#template_alias_list #template_alias_list} => Array&lt;Types::TemplateAlias&gt;
4706
+ # * {Types::ListTemplateAliasesResponse#status #status} => Integer
4707
+ # * {Types::ListTemplateAliasesResponse#request_id #request_id} => String
4708
+ # * {Types::ListTemplateAliasesResponse#next_token #next_token} => String
4709
+ #
4710
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4711
+ #
4712
+ # @example Request syntax with placeholder values
4713
+ #
4714
+ # resp = client.list_template_aliases({
4715
+ # aws_account_id: "AwsAccountId", # required
4716
+ # template_id: "RestrictiveResourceId", # required
4717
+ # next_token: "String",
4718
+ # max_results: 1,
4719
+ # })
4720
+ #
4721
+ # @example Response structure
4722
+ #
4723
+ # resp.template_alias_list #=> Array
4724
+ # resp.template_alias_list[0].alias_name #=> String
4725
+ # resp.template_alias_list[0].arn #=> String
4726
+ # resp.template_alias_list[0].template_version_number #=> Integer
4727
+ # resp.status #=> Integer
4728
+ # resp.request_id #=> String
4729
+ # resp.next_token #=> String
4730
+ #
4731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateAliases AWS API Documentation
4732
+ #
4733
+ # @overload list_template_aliases(params = {})
4734
+ # @param [Hash] params ({})
4735
+ def list_template_aliases(params = {}, options = {})
4736
+ req = build_request(:list_template_aliases, params)
4737
+ req.send_request(options)
4738
+ end
4739
+
4740
+ # Lists all the versions of the templates in the current Amazon
4741
+ # QuickSight account.
4742
+ #
4743
+ # @option params [required, String] :aws_account_id
4744
+ # The ID of the AWS account that contains the templates that you're
4745
+ # listing.
4746
+ #
4747
+ # @option params [required, String] :template_id
4748
+ # The ID for the template.
4749
+ #
4750
+ # @option params [String] :next_token
4751
+ # The token for the next set of results, or null if there are no more
4752
+ # results.
4753
+ #
4754
+ # @option params [Integer] :max_results
4755
+ # The maximum number of results to be returned per request.
4756
+ #
4757
+ # @return [Types::ListTemplateVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4758
+ #
4759
+ # * {Types::ListTemplateVersionsResponse#template_version_summary_list #template_version_summary_list} => Array&lt;Types::TemplateVersionSummary&gt;
4760
+ # * {Types::ListTemplateVersionsResponse#next_token #next_token} => String
4761
+ # * {Types::ListTemplateVersionsResponse#status #status} => Integer
4762
+ # * {Types::ListTemplateVersionsResponse#request_id #request_id} => String
4763
+ #
4764
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4765
+ #
4766
+ # @example Request syntax with placeholder values
4767
+ #
4768
+ # resp = client.list_template_versions({
4769
+ # aws_account_id: "AwsAccountId", # required
4770
+ # template_id: "RestrictiveResourceId", # required
4771
+ # next_token: "String",
4772
+ # max_results: 1,
4773
+ # })
4774
+ #
4775
+ # @example Response structure
4776
+ #
4777
+ # resp.template_version_summary_list #=> Array
4778
+ # resp.template_version_summary_list[0].arn #=> String
4779
+ # resp.template_version_summary_list[0].version_number #=> Integer
4780
+ # resp.template_version_summary_list[0].created_time #=> Time
4781
+ # resp.template_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
4782
+ # resp.template_version_summary_list[0].description #=> String
4783
+ # resp.next_token #=> String
4784
+ # resp.status #=> Integer
4785
+ # resp.request_id #=> String
4786
+ #
4787
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateVersions AWS API Documentation
4788
+ #
4789
+ # @overload list_template_versions(params = {})
4790
+ # @param [Hash] params ({})
4791
+ def list_template_versions(params = {}, options = {})
4792
+ req = build_request(:list_template_versions, params)
4793
+ req.send_request(options)
4794
+ end
4795
+
4796
+ # Lists all the templates in the current Amazon QuickSight account.
4797
+ #
4798
+ # @option params [required, String] :aws_account_id
4799
+ # The ID of the AWS account that contains the templates that you're
4800
+ # listing.
4801
+ #
4802
+ # @option params [String] :next_token
4803
+ # The token for the next set of results, or null if there are no more
4804
+ # results.
4805
+ #
4806
+ # @option params [Integer] :max_results
4807
+ # The maximum number of results to be returned per request.
4808
+ #
4809
+ # @return [Types::ListTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4810
+ #
4811
+ # * {Types::ListTemplatesResponse#template_summary_list #template_summary_list} => Array&lt;Types::TemplateSummary&gt;
4812
+ # * {Types::ListTemplatesResponse#next_token #next_token} => String
4813
+ # * {Types::ListTemplatesResponse#status #status} => Integer
4814
+ # * {Types::ListTemplatesResponse#request_id #request_id} => String
4815
+ #
4816
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4817
+ #
4818
+ # @example Request syntax with placeholder values
4819
+ #
4820
+ # resp = client.list_templates({
4821
+ # aws_account_id: "AwsAccountId", # required
4822
+ # next_token: "String",
4823
+ # max_results: 1,
4824
+ # })
4825
+ #
4826
+ # @example Response structure
4827
+ #
4828
+ # resp.template_summary_list #=> Array
4829
+ # resp.template_summary_list[0].arn #=> String
4830
+ # resp.template_summary_list[0].template_id #=> String
4831
+ # resp.template_summary_list[0].name #=> String
4832
+ # resp.template_summary_list[0].latest_version_number #=> Integer
4833
+ # resp.template_summary_list[0].created_time #=> Time
4834
+ # resp.template_summary_list[0].last_updated_time #=> Time
4835
+ # resp.next_token #=> String
4836
+ # resp.status #=> Integer
4837
+ # resp.request_id #=> String
4838
+ #
4839
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplates AWS API Documentation
4840
+ #
4841
+ # @overload list_templates(params = {})
4842
+ # @param [Hash] params ({})
4843
+ def list_templates(params = {}, options = {})
4844
+ req = build_request(:list_templates, params)
4845
+ req.send_request(options)
4846
+ end
4847
+
4848
+ # Lists all the aliases of a theme.
4849
+ #
4850
+ # @option params [required, String] :aws_account_id
4851
+ # The ID of the AWS account that contains the theme aliases that you're
4852
+ # listing.
4853
+ #
4854
+ # @option params [required, String] :theme_id
4855
+ # The ID for the theme.
3127
4856
  #
3128
4857
  # @option params [String] :next_token
3129
4858
  # The token for the next set of results, or null if there are no more
@@ -3132,52 +4861,49 @@ module Aws::QuickSight
3132
4861
  # @option params [Integer] :max_results
3133
4862
  # The maximum number of results to be returned per request.
3134
4863
  #
3135
- # @return [Types::ListTemplateAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3136
- #
3137
- # * {Types::ListTemplateAliasesResponse#template_alias_list #template_alias_list} => Array&lt;Types::TemplateAlias&gt;
3138
- # * {Types::ListTemplateAliasesResponse#status #status} => Integer
3139
- # * {Types::ListTemplateAliasesResponse#request_id #request_id} => String
3140
- # * {Types::ListTemplateAliasesResponse#next_token #next_token} => String
4864
+ # @return [Types::ListThemeAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3141
4865
  #
3142
- # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4866
+ # * {Types::ListThemeAliasesResponse#theme_alias_list #theme_alias_list} => Array&lt;Types::ThemeAlias&gt;
4867
+ # * {Types::ListThemeAliasesResponse#status #status} => Integer
4868
+ # * {Types::ListThemeAliasesResponse#request_id #request_id} => String
4869
+ # * {Types::ListThemeAliasesResponse#next_token #next_token} => String
3143
4870
  #
3144
4871
  # @example Request syntax with placeholder values
3145
4872
  #
3146
- # resp = client.list_template_aliases({
4873
+ # resp = client.list_theme_aliases({
3147
4874
  # aws_account_id: "AwsAccountId", # required
3148
- # template_id: "RestrictiveResourceId", # required
4875
+ # theme_id: "RestrictiveResourceId", # required
3149
4876
  # next_token: "String",
3150
4877
  # max_results: 1,
3151
4878
  # })
3152
4879
  #
3153
4880
  # @example Response structure
3154
4881
  #
3155
- # resp.template_alias_list #=> Array
3156
- # resp.template_alias_list[0].alias_name #=> String
3157
- # resp.template_alias_list[0].arn #=> String
3158
- # resp.template_alias_list[0].template_version_number #=> Integer
4882
+ # resp.theme_alias_list #=> Array
4883
+ # resp.theme_alias_list[0].arn #=> String
4884
+ # resp.theme_alias_list[0].alias_name #=> String
4885
+ # resp.theme_alias_list[0].theme_version_number #=> Integer
3159
4886
  # resp.status #=> Integer
3160
4887
  # resp.request_id #=> String
3161
4888
  # resp.next_token #=> String
3162
4889
  #
3163
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateAliases AWS API Documentation
4890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeAliases AWS API Documentation
3164
4891
  #
3165
- # @overload list_template_aliases(params = {})
4892
+ # @overload list_theme_aliases(params = {})
3166
4893
  # @param [Hash] params ({})
3167
- def list_template_aliases(params = {}, options = {})
3168
- req = build_request(:list_template_aliases, params)
4894
+ def list_theme_aliases(params = {}, options = {})
4895
+ req = build_request(:list_theme_aliases, params)
3169
4896
  req.send_request(options)
3170
4897
  end
3171
4898
 
3172
- # Lists all the versions of the templates in the current Amazon
3173
- # QuickSight account.
4899
+ # Lists all the versions of the themes in the current AWS account.
3174
4900
  #
3175
4901
  # @option params [required, String] :aws_account_id
3176
- # The ID of the AWS account that contains the templates that you're
4902
+ # The ID of the AWS account that contains the themes that you're
3177
4903
  # listing.
3178
4904
  #
3179
- # @option params [required, String] :template_id
3180
- # The ID for the template.
4905
+ # @option params [required, String] :theme_id
4906
+ # The ID for the theme.
3181
4907
  #
3182
4908
  # @option params [String] :next_token
3183
4909
  # The token for the next set of results, or null if there are no more
@@ -3186,49 +4912,47 @@ module Aws::QuickSight
3186
4912
  # @option params [Integer] :max_results
3187
4913
  # The maximum number of results to be returned per request.
3188
4914
  #
3189
- # @return [Types::ListTemplateVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3190
- #
3191
- # * {Types::ListTemplateVersionsResponse#template_version_summary_list #template_version_summary_list} => Array&lt;Types::TemplateVersionSummary&gt;
3192
- # * {Types::ListTemplateVersionsResponse#next_token #next_token} => String
3193
- # * {Types::ListTemplateVersionsResponse#status #status} => Integer
3194
- # * {Types::ListTemplateVersionsResponse#request_id #request_id} => String
4915
+ # @return [Types::ListThemeVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3195
4916
  #
3196
- # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4917
+ # * {Types::ListThemeVersionsResponse#theme_version_summary_list #theme_version_summary_list} => Array&lt;Types::ThemeVersionSummary&gt;
4918
+ # * {Types::ListThemeVersionsResponse#next_token #next_token} => String
4919
+ # * {Types::ListThemeVersionsResponse#status #status} => Integer
4920
+ # * {Types::ListThemeVersionsResponse#request_id #request_id} => String
3197
4921
  #
3198
4922
  # @example Request syntax with placeholder values
3199
4923
  #
3200
- # resp = client.list_template_versions({
4924
+ # resp = client.list_theme_versions({
3201
4925
  # aws_account_id: "AwsAccountId", # required
3202
- # template_id: "RestrictiveResourceId", # required
4926
+ # theme_id: "RestrictiveResourceId", # required
3203
4927
  # next_token: "String",
3204
4928
  # max_results: 1,
3205
4929
  # })
3206
4930
  #
3207
4931
  # @example Response structure
3208
4932
  #
3209
- # resp.template_version_summary_list #=> Array
3210
- # resp.template_version_summary_list[0].arn #=> String
3211
- # resp.template_version_summary_list[0].version_number #=> Integer
3212
- # resp.template_version_summary_list[0].created_time #=> Time
3213
- # resp.template_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
3214
- # resp.template_version_summary_list[0].description #=> String
4933
+ # resp.theme_version_summary_list #=> Array
4934
+ # resp.theme_version_summary_list[0].version_number #=> Integer
4935
+ # resp.theme_version_summary_list[0].arn #=> String
4936
+ # resp.theme_version_summary_list[0].description #=> String
4937
+ # resp.theme_version_summary_list[0].created_time #=> Time
4938
+ # resp.theme_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3215
4939
  # resp.next_token #=> String
3216
4940
  # resp.status #=> Integer
3217
4941
  # resp.request_id #=> String
3218
4942
  #
3219
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplateVersions AWS API Documentation
4943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemeVersions AWS API Documentation
3220
4944
  #
3221
- # @overload list_template_versions(params = {})
4945
+ # @overload list_theme_versions(params = {})
3222
4946
  # @param [Hash] params ({})
3223
- def list_template_versions(params = {}, options = {})
3224
- req = build_request(:list_template_versions, params)
4947
+ def list_theme_versions(params = {}, options = {})
4948
+ req = build_request(:list_theme_versions, params)
3225
4949
  req.send_request(options)
3226
4950
  end
3227
4951
 
3228
- # Lists all the templates in the current Amazon QuickSight account.
4952
+ # Lists all the themes in the current AWS account.
3229
4953
  #
3230
4954
  # @option params [required, String] :aws_account_id
3231
- # The ID of the AWS account that contains the templates that you're
4955
+ # The ID of the AWS account that contains the themes that you're
3232
4956
  # listing.
3233
4957
  #
3234
4958
  # @option params [String] :next_token
@@ -3238,42 +4962,53 @@ module Aws::QuickSight
3238
4962
  # @option params [Integer] :max_results
3239
4963
  # The maximum number of results to be returned per request.
3240
4964
  #
3241
- # @return [Types::ListTemplatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4965
+ # @option params [String] :type
4966
+ # The type of themes that you want to list. Valid options include the
4967
+ # following:
3242
4968
  #
3243
- # * {Types::ListTemplatesResponse#template_summary_list #template_summary_list} => Array&lt;Types::TemplateSummary&gt;
3244
- # * {Types::ListTemplatesResponse#next_token #next_token} => String
3245
- # * {Types::ListTemplatesResponse#status #status} => Integer
3246
- # * {Types::ListTemplatesResponse#request_id #request_id} => String
4969
+ # * `ALL (default)`- Display all existing themes.
3247
4970
  #
3248
- # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4971
+ # * `CUSTOM` - Display only the themes created by people using Amazon
4972
+ # QuickSight.
4973
+ #
4974
+ # * `QUICKSIGHT` - Display only the starting themes defined by
4975
+ # QuickSight.
4976
+ #
4977
+ # @return [Types::ListThemesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4978
+ #
4979
+ # * {Types::ListThemesResponse#theme_summary_list #theme_summary_list} => Array&lt;Types::ThemeSummary&gt;
4980
+ # * {Types::ListThemesResponse#next_token #next_token} => String
4981
+ # * {Types::ListThemesResponse#status #status} => Integer
4982
+ # * {Types::ListThemesResponse#request_id #request_id} => String
3249
4983
  #
3250
4984
  # @example Request syntax with placeholder values
3251
4985
  #
3252
- # resp = client.list_templates({
4986
+ # resp = client.list_themes({
3253
4987
  # aws_account_id: "AwsAccountId", # required
3254
4988
  # next_token: "String",
3255
4989
  # max_results: 1,
4990
+ # type: "QUICKSIGHT", # accepts QUICKSIGHT, CUSTOM, ALL
3256
4991
  # })
3257
4992
  #
3258
4993
  # @example Response structure
3259
4994
  #
3260
- # resp.template_summary_list #=> Array
3261
- # resp.template_summary_list[0].arn #=> String
3262
- # resp.template_summary_list[0].template_id #=> String
3263
- # resp.template_summary_list[0].name #=> String
3264
- # resp.template_summary_list[0].latest_version_number #=> Integer
3265
- # resp.template_summary_list[0].created_time #=> Time
3266
- # resp.template_summary_list[0].last_updated_time #=> Time
4995
+ # resp.theme_summary_list #=> Array
4996
+ # resp.theme_summary_list[0].arn #=> String
4997
+ # resp.theme_summary_list[0].name #=> String
4998
+ # resp.theme_summary_list[0].theme_id #=> String
4999
+ # resp.theme_summary_list[0].latest_version_number #=> Integer
5000
+ # resp.theme_summary_list[0].created_time #=> Time
5001
+ # resp.theme_summary_list[0].last_updated_time #=> Time
3267
5002
  # resp.next_token #=> String
3268
5003
  # resp.status #=> Integer
3269
5004
  # resp.request_id #=> String
3270
5005
  #
3271
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListTemplates AWS API Documentation
5006
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListThemes AWS API Documentation
3272
5007
  #
3273
- # @overload list_templates(params = {})
5008
+ # @overload list_themes(params = {})
3274
5009
  # @param [Hash] params ({})
3275
- def list_templates(params = {}, options = {})
3276
- req = build_request(:list_templates, params)
5010
+ def list_themes(params = {}, options = {})
5011
+ req = build_request(:list_themes, params)
3277
5012
  req.send_request(options)
3278
5013
  end
3279
5014
 
@@ -3376,6 +5111,7 @@ module Aws::QuickSight
3376
5111
  # resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT"
3377
5112
  # resp.user_list[0].active #=> Boolean
3378
5113
  # resp.user_list[0].principal_id #=> String
5114
+ # resp.user_list[0].custom_permissions_name #=> String
3379
5115
  # resp.next_token #=> String
3380
5116
  # resp.request_id #=> String
3381
5117
  # resp.status #=> Integer
@@ -3449,6 +5185,38 @@ module Aws::QuickSight
3449
5185
  # The Amazon QuickSight user name that you want to create for the user
3450
5186
  # you are registering.
3451
5187
  #
5188
+ # @option params [String] :custom_permissions_name
5189
+ # (Enterprise edition only) The name of the custom permissions profile
5190
+ # that you want to assign to this user. Customized permissions allows
5191
+ # you to control a user's access by restricting access the following
5192
+ # operations:
5193
+ #
5194
+ # * Create and update data sources
5195
+ #
5196
+ # * Create and update datasets
5197
+ #
5198
+ # * Create and update email reports
5199
+ #
5200
+ # * Subscribe to email reports
5201
+ #
5202
+ # To add custom permissions to an existing user, use ` UpdateUser `
5203
+ # instead.
5204
+ #
5205
+ # A set of custom permissions includes any combination of these
5206
+ # restrictions. Currently, you need to create the profile names for
5207
+ # custom permission sets by using the QuickSight console. Then, you use
5208
+ # the `RegisterUser` API operation to assign the named set of
5209
+ # permissions to a QuickSight user.
5210
+ #
5211
+ # QuickSight custom permissions are applied through IAM policies.
5212
+ # Therefore, they override the permissions typically granted by
5213
+ # assigning QuickSight users to one of the default security cohorts in
5214
+ # QuickSight (admin, author, reader).
5215
+ #
5216
+ # This feature is available only to QuickSight Enterprise edition
5217
+ # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
5218
+ # (SSO).
5219
+ #
3452
5220
  # @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3453
5221
  #
3454
5222
  # * {Types::RegisterUserResponse#user #user} => Types::User
@@ -3467,6 +5235,7 @@ module Aws::QuickSight
3467
5235
  # aws_account_id: "AwsAccountId", # required
3468
5236
  # namespace: "Namespace", # required
3469
5237
  # user_name: "UserName",
5238
+ # custom_permissions_name: "RoleName",
3470
5239
  # })
3471
5240
  #
3472
5241
  # @example Response structure
@@ -3478,6 +5247,7 @@ module Aws::QuickSight
3478
5247
  # resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
3479
5248
  # resp.user.active #=> Boolean
3480
5249
  # resp.user.principal_id #=> String
5250
+ # resp.user.custom_permissions_name #=> String
3481
5251
  # resp.user_invitation_url #=> String
3482
5252
  # resp.request_id #=> String
3483
5253
  # resp.status #=> Integer
@@ -3491,7 +5261,107 @@ module Aws::QuickSight
3491
5261
  req.send_request(options)
3492
5262
  end
3493
5263
 
3494
- # Searchs for dashboards that belong to a user.
5264
+ # Restores an analysis.
5265
+ #
5266
+ # @option params [required, String] :aws_account_id
5267
+ # The ID of the AWS account that contains the analysis.
5268
+ #
5269
+ # @option params [required, String] :analysis_id
5270
+ # The ID of the analysis that you're restoring.
5271
+ #
5272
+ # @return [Types::RestoreAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5273
+ #
5274
+ # * {Types::RestoreAnalysisResponse#status #status} => Integer
5275
+ # * {Types::RestoreAnalysisResponse#arn #arn} => String
5276
+ # * {Types::RestoreAnalysisResponse#analysis_id #analysis_id} => String
5277
+ # * {Types::RestoreAnalysisResponse#request_id #request_id} => String
5278
+ #
5279
+ # @example Request syntax with placeholder values
5280
+ #
5281
+ # resp = client.restore_analysis({
5282
+ # aws_account_id: "AwsAccountId", # required
5283
+ # analysis_id: "RestrictiveResourceId", # required
5284
+ # })
5285
+ #
5286
+ # @example Response structure
5287
+ #
5288
+ # resp.status #=> Integer
5289
+ # resp.arn #=> String
5290
+ # resp.analysis_id #=> String
5291
+ # resp.request_id #=> String
5292
+ #
5293
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysis AWS API Documentation
5294
+ #
5295
+ # @overload restore_analysis(params = {})
5296
+ # @param [Hash] params ({})
5297
+ def restore_analysis(params = {}, options = {})
5298
+ req = build_request(:restore_analysis, params)
5299
+ req.send_request(options)
5300
+ end
5301
+
5302
+ # Searches for analyses that belong to the user specified in the filter.
5303
+ #
5304
+ # @option params [required, String] :aws_account_id
5305
+ # The ID of the AWS account that contains the analyses that you're
5306
+ # searching for.
5307
+ #
5308
+ # @option params [required, Array<Types::AnalysisSearchFilter>] :filters
5309
+ # The structure for the search filters that you want to apply to your
5310
+ # search.
5311
+ #
5312
+ # @option params [String] :next_token
5313
+ # A pagination token that can be used in a subsequent request.
5314
+ #
5315
+ # @option params [Integer] :max_results
5316
+ # The maximum number of results to return.
5317
+ #
5318
+ # @return [Types::SearchAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5319
+ #
5320
+ # * {Types::SearchAnalysesResponse#analysis_summary_list #analysis_summary_list} => Array&lt;Types::AnalysisSummary&gt;
5321
+ # * {Types::SearchAnalysesResponse#next_token #next_token} => String
5322
+ # * {Types::SearchAnalysesResponse#status #status} => Integer
5323
+ # * {Types::SearchAnalysesResponse#request_id #request_id} => String
5324
+ #
5325
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5326
+ #
5327
+ # @example Request syntax with placeholder values
5328
+ #
5329
+ # resp = client.search_analyses({
5330
+ # aws_account_id: "AwsAccountId", # required
5331
+ # filters: [ # required
5332
+ # {
5333
+ # operator: "StringEquals", # accepts StringEquals
5334
+ # name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
5335
+ # value: "String",
5336
+ # },
5337
+ # ],
5338
+ # next_token: "String",
5339
+ # max_results: 1,
5340
+ # })
5341
+ #
5342
+ # @example Response structure
5343
+ #
5344
+ # resp.analysis_summary_list #=> Array
5345
+ # resp.analysis_summary_list[0].arn #=> String
5346
+ # resp.analysis_summary_list[0].analysis_id #=> String
5347
+ # resp.analysis_summary_list[0].name #=> String
5348
+ # resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5349
+ # resp.analysis_summary_list[0].created_time #=> Time
5350
+ # resp.analysis_summary_list[0].last_updated_time #=> Time
5351
+ # resp.next_token #=> String
5352
+ # resp.status #=> Integer
5353
+ # resp.request_id #=> String
5354
+ #
5355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalyses AWS API Documentation
5356
+ #
5357
+ # @overload search_analyses(params = {})
5358
+ # @param [Hash] params ({})
5359
+ def search_analyses(params = {}, options = {})
5360
+ req = build_request(:search_analyses, params)
5361
+ req.send_request(options)
5362
+ end
5363
+
5364
+ # Searches for dashboards that belong to a user.
3495
5365
  #
3496
5366
  # @option params [required, String] :aws_account_id
3497
5367
  # The ID of the AWS account that contains the user whose dashboards
@@ -3499,7 +5369,7 @@ module Aws::QuickSight
3499
5369
  #
3500
5370
  # @option params [required, Array<Types::DashboardSearchFilter>] :filters
3501
5371
  # The filters to apply to the search. Currently, you can search only by
3502
- # user name. For example, `"Filters": [ \{ "Name": "QUICKSIGHT_USER",
5372
+ # user name, for example, `"Filters": [ \{ "Name": "QUICKSIGHT_USER",
3503
5373
  # "Operator": "StringEquals", "Value":
3504
5374
  # "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \} ]`
3505
5375
  #
@@ -3589,69 +5459,332 @@ module Aws::QuickSight
3589
5459
  # Contains a map of the key-value pairs for the resource tag or tags
3590
5460
  # assigned to the resource.
3591
5461
  #
3592
- # @return [Types::TagResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5462
+ # @return [Types::TagResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5463
+ #
5464
+ # * {Types::TagResourceResponse#request_id #request_id} => String
5465
+ # * {Types::TagResourceResponse#status #status} => Integer
5466
+ #
5467
+ # @example Request syntax with placeholder values
5468
+ #
5469
+ # resp = client.tag_resource({
5470
+ # resource_arn: "Arn", # required
5471
+ # tags: [ # required
5472
+ # {
5473
+ # key: "TagKey", # required
5474
+ # value: "TagValue", # required
5475
+ # },
5476
+ # ],
5477
+ # })
5478
+ #
5479
+ # @example Response structure
5480
+ #
5481
+ # resp.request_id #=> String
5482
+ # resp.status #=> Integer
5483
+ #
5484
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TagResource AWS API Documentation
5485
+ #
5486
+ # @overload tag_resource(params = {})
5487
+ # @param [Hash] params ({})
5488
+ def tag_resource(params = {}, options = {})
5489
+ req = build_request(:tag_resource, params)
5490
+ req.send_request(options)
5491
+ end
5492
+
5493
+ # Removes a tag or tags from a resource.
5494
+ #
5495
+ # @option params [required, String] :resource_arn
5496
+ # The Amazon Resource Name (ARN) of the resource that you want to untag.
5497
+ #
5498
+ # @option params [required, Array<String>] :tag_keys
5499
+ # The keys of the key-value pairs for the resource tag or tags assigned
5500
+ # to the resource.
5501
+ #
5502
+ # @return [Types::UntagResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5503
+ #
5504
+ # * {Types::UntagResourceResponse#request_id #request_id} => String
5505
+ # * {Types::UntagResourceResponse#status #status} => Integer
5506
+ #
5507
+ # @example Request syntax with placeholder values
5508
+ #
5509
+ # resp = client.untag_resource({
5510
+ # resource_arn: "Arn", # required
5511
+ # tag_keys: ["TagKey"], # required
5512
+ # })
5513
+ #
5514
+ # @example Response structure
5515
+ #
5516
+ # resp.request_id #=> String
5517
+ # resp.status #=> Integer
5518
+ #
5519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagResource AWS API Documentation
5520
+ #
5521
+ # @overload untag_resource(params = {})
5522
+ # @param [Hash] params ({})
5523
+ def untag_resource(params = {}, options = {})
5524
+ req = build_request(:untag_resource, params)
5525
+ req.send_request(options)
5526
+ end
5527
+
5528
+ # Updates Amazon QuickSight customizations the current AWS Region.
5529
+ # Currently, the only customization you can use is a theme.
5530
+ #
5531
+ # You can use customizations for your AWS account or, if you specify a
5532
+ # namespace, for a QuickSight namespace instead. Customizations that
5533
+ # apply to a namespace override customizations that apply to an AWS
5534
+ # account. To find out which customizations apply, use the
5535
+ # `DescribeAccountCustomization` API operation.
5536
+ #
5537
+ # @option params [required, String] :aws_account_id
5538
+ # The ID for the AWS account that you want to update QuickSight
5539
+ # customizations for.
5540
+ #
5541
+ # @option params [String] :namespace
5542
+ # The namespace that you want to update QuickSight customizations for.
5543
+ #
5544
+ # @option params [required, Types::AccountCustomization] :account_customization
5545
+ # The QuickSight customizations you're updating in the current AWS
5546
+ # Region.
5547
+ #
5548
+ # @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5549
+ #
5550
+ # * {Types::UpdateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
5551
+ # * {Types::UpdateAccountCustomizationResponse#namespace #namespace} => String
5552
+ # * {Types::UpdateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
5553
+ # * {Types::UpdateAccountCustomizationResponse#request_id #request_id} => String
5554
+ # * {Types::UpdateAccountCustomizationResponse#status #status} => Integer
5555
+ #
5556
+ # @example Request syntax with placeholder values
5557
+ #
5558
+ # resp = client.update_account_customization({
5559
+ # aws_account_id: "AwsAccountId", # required
5560
+ # namespace: "Namespace",
5561
+ # account_customization: { # required
5562
+ # default_theme: "Arn",
5563
+ # },
5564
+ # })
5565
+ #
5566
+ # @example Response structure
5567
+ #
5568
+ # resp.aws_account_id #=> String
5569
+ # resp.namespace #=> String
5570
+ # resp.account_customization.default_theme #=> String
5571
+ # resp.request_id #=> String
5572
+ # resp.status #=> Integer
5573
+ #
5574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomization AWS API Documentation
5575
+ #
5576
+ # @overload update_account_customization(params = {})
5577
+ # @param [Hash] params ({})
5578
+ def update_account_customization(params = {}, options = {})
5579
+ req = build_request(:update_account_customization, params)
5580
+ req.send_request(options)
5581
+ end
5582
+
5583
+ # Updates the Amazon QuickSight settings in your AWS Account.
5584
+ #
5585
+ # @option params [required, String] :aws_account_id
5586
+ # The ID for the AWS account that contains the QuickSight settings that
5587
+ # you want to list.
5588
+ #
5589
+ # @option params [required, String] :default_namespace
5590
+ # The default namespace for this AWS Account. Currently, the default is
5591
+ # `default`. IAM users who register for the first time with QuickSight
5592
+ # provide an email that becomes associated with the default namespace.
5593
+ #
5594
+ # @option params [String] :notification_email
5595
+ # The email address that you want QuickSight to send notifications to
5596
+ # regarding your AWS account or QuickSight subscription.
5597
+ #
5598
+ # @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5599
+ #
5600
+ # * {Types::UpdateAccountSettingsResponse#request_id #request_id} => String
5601
+ # * {Types::UpdateAccountSettingsResponse#status #status} => Integer
5602
+ #
5603
+ # @example Request syntax with placeholder values
5604
+ #
5605
+ # resp = client.update_account_settings({
5606
+ # aws_account_id: "AwsAccountId", # required
5607
+ # default_namespace: "Namespace", # required
5608
+ # notification_email: "String",
5609
+ # })
5610
+ #
5611
+ # @example Response structure
5612
+ #
5613
+ # resp.request_id #=> String
5614
+ # resp.status #=> Integer
5615
+ #
5616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettings AWS API Documentation
5617
+ #
5618
+ # @overload update_account_settings(params = {})
5619
+ # @param [Hash] params ({})
5620
+ def update_account_settings(params = {}, options = {})
5621
+ req = build_request(:update_account_settings, params)
5622
+ req.send_request(options)
5623
+ end
5624
+
5625
+ # Updates an analysis in Amazon QuickSight
5626
+ #
5627
+ # @option params [required, String] :aws_account_id
5628
+ # The ID of the AWS account that contains the analysis that you're
5629
+ # updating.
5630
+ #
5631
+ # @option params [required, String] :analysis_id
5632
+ # The ID for the analysis that you're updating. This ID displays in the
5633
+ # URL of the analysis.
5634
+ #
5635
+ # @option params [required, String] :name
5636
+ # A descriptive name for the analysis that you're updating. This name
5637
+ # displays for the analysis in the QuickSight console.
5638
+ #
5639
+ # @option params [Types::Parameters] :parameters
5640
+ # The parameter names and override values that you want to use. An
5641
+ # analysis can have any parameter type, and some parameters might accept
5642
+ # multiple values.
5643
+ #
5644
+ # @option params [required, Types::AnalysisSourceEntity] :source_entity
5645
+ # A source entity to use for the analysis that you're updating. This
5646
+ # metadata structure contains details that describe a source template
5647
+ # and one or more datasets.
3593
5648
  #
3594
- # * {Types::TagResourceResponse#request_id #request_id} => String
3595
- # * {Types::TagResourceResponse#status #status} => Integer
5649
+ # @option params [String] :theme_arn
5650
+ # The Amazon Resource Name (ARN) for the theme to apply to the analysis
5651
+ # that you're creating. To see the theme in the QuickSight console,
5652
+ # make sure that you have access to it.
5653
+ #
5654
+ # @return [Types::UpdateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5655
+ #
5656
+ # * {Types::UpdateAnalysisResponse#arn #arn} => String
5657
+ # * {Types::UpdateAnalysisResponse#analysis_id #analysis_id} => String
5658
+ # * {Types::UpdateAnalysisResponse#update_status #update_status} => String
5659
+ # * {Types::UpdateAnalysisResponse#status #status} => Integer
5660
+ # * {Types::UpdateAnalysisResponse#request_id #request_id} => String
3596
5661
  #
3597
5662
  # @example Request syntax with placeholder values
3598
5663
  #
3599
- # resp = client.tag_resource({
3600
- # resource_arn: "Arn", # required
3601
- # tags: [ # required
3602
- # {
3603
- # key: "TagKey", # required
3604
- # value: "TagValue", # required
5664
+ # resp = client.update_analysis({
5665
+ # aws_account_id: "AwsAccountId", # required
5666
+ # analysis_id: "RestrictiveResourceId", # required
5667
+ # name: "AnalysisName", # required
5668
+ # parameters: {
5669
+ # string_parameters: [
5670
+ # {
5671
+ # name: "NonEmptyString", # required
5672
+ # values: ["String"], # required
5673
+ # },
5674
+ # ],
5675
+ # integer_parameters: [
5676
+ # {
5677
+ # name: "NonEmptyString", # required
5678
+ # values: [1], # required
5679
+ # },
5680
+ # ],
5681
+ # decimal_parameters: [
5682
+ # {
5683
+ # name: "NonEmptyString", # required
5684
+ # values: [1.0], # required
5685
+ # },
5686
+ # ],
5687
+ # date_time_parameters: [
5688
+ # {
5689
+ # name: "NonEmptyString", # required
5690
+ # values: [Time.now], # required
5691
+ # },
5692
+ # ],
5693
+ # },
5694
+ # source_entity: { # required
5695
+ # source_template: {
5696
+ # data_set_references: [ # required
5697
+ # {
5698
+ # data_set_placeholder: "NonEmptyString", # required
5699
+ # data_set_arn: "Arn", # required
5700
+ # },
5701
+ # ],
5702
+ # arn: "Arn", # required
3605
5703
  # },
3606
- # ],
5704
+ # },
5705
+ # theme_arn: "Arn",
3607
5706
  # })
3608
5707
  #
3609
5708
  # @example Response structure
3610
5709
  #
3611
- # resp.request_id #=> String
5710
+ # resp.arn #=> String
5711
+ # resp.analysis_id #=> String
5712
+ # resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3612
5713
  # resp.status #=> Integer
5714
+ # resp.request_id #=> String
3613
5715
  #
3614
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/TagResource AWS API Documentation
5716
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysis AWS API Documentation
3615
5717
  #
3616
- # @overload tag_resource(params = {})
5718
+ # @overload update_analysis(params = {})
3617
5719
  # @param [Hash] params ({})
3618
- def tag_resource(params = {}, options = {})
3619
- req = build_request(:tag_resource, params)
5720
+ def update_analysis(params = {}, options = {})
5721
+ req = build_request(:update_analysis, params)
3620
5722
  req.send_request(options)
3621
5723
  end
3622
5724
 
3623
- # Removes a tag or tags from a resource.
5725
+ # Updates the read and write permissions for an analysis.
3624
5726
  #
3625
- # @option params [required, String] :resource_arn
3626
- # The Amazon Resource Name (ARN) of the resource that you want to untag.
5727
+ # @option params [required, String] :aws_account_id
5728
+ # The ID of the AWS account that contains the analysis whose permissions
5729
+ # you're updating. You must be using the AWS account that the analysis
5730
+ # is in.
3627
5731
  #
3628
- # @option params [required, Array<String>] :tag_keys
3629
- # The keys of the key-value pairs for the resource tag or tags assigned
3630
- # to the resource.
5732
+ # @option params [required, String] :analysis_id
5733
+ # The ID of the analysis whose permissions you're updating. The ID is
5734
+ # part of the analysis URL.
3631
5735
  #
3632
- # @return [Types::UntagResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5736
+ # @option params [Array<Types::ResourcePermission>] :grant_permissions
5737
+ # A structure that describes the permissions to add and the principal to
5738
+ # add them to.
3633
5739
  #
3634
- # * {Types::UntagResourceResponse#request_id #request_id} => String
3635
- # * {Types::UntagResourceResponse#status #status} => Integer
5740
+ # @option params [Array<Types::ResourcePermission>] :revoke_permissions
5741
+ # A structure that describes the permissions to remove and the principal
5742
+ # to remove them from.
5743
+ #
5744
+ # @return [Types::UpdateAnalysisPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5745
+ #
5746
+ # * {Types::UpdateAnalysisPermissionsResponse#analysis_arn #analysis_arn} => String
5747
+ # * {Types::UpdateAnalysisPermissionsResponse#analysis_id #analysis_id} => String
5748
+ # * {Types::UpdateAnalysisPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
5749
+ # * {Types::UpdateAnalysisPermissionsResponse#request_id #request_id} => String
5750
+ # * {Types::UpdateAnalysisPermissionsResponse#status #status} => Integer
3636
5751
  #
3637
5752
  # @example Request syntax with placeholder values
3638
5753
  #
3639
- # resp = client.untag_resource({
3640
- # resource_arn: "Arn", # required
3641
- # tag_keys: ["TagKey"], # required
5754
+ # resp = client.update_analysis_permissions({
5755
+ # aws_account_id: "AwsAccountId", # required
5756
+ # analysis_id: "RestrictiveResourceId", # required
5757
+ # grant_permissions: [
5758
+ # {
5759
+ # principal: "Principal", # required
5760
+ # actions: ["String"], # required
5761
+ # },
5762
+ # ],
5763
+ # revoke_permissions: [
5764
+ # {
5765
+ # principal: "Principal", # required
5766
+ # actions: ["String"], # required
5767
+ # },
5768
+ # ],
3642
5769
  # })
3643
5770
  #
3644
5771
  # @example Response structure
3645
5772
  #
5773
+ # resp.analysis_arn #=> String
5774
+ # resp.analysis_id #=> String
5775
+ # resp.permissions #=> Array
5776
+ # resp.permissions[0].principal #=> String
5777
+ # resp.permissions[0].actions #=> Array
5778
+ # resp.permissions[0].actions[0] #=> String
3646
5779
  # resp.request_id #=> String
3647
5780
  # resp.status #=> Integer
3648
5781
  #
3649
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UntagResource AWS API Documentation
5782
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissions AWS API Documentation
3650
5783
  #
3651
- # @overload untag_resource(params = {})
5784
+ # @overload update_analysis_permissions(params = {})
3652
5785
  # @param [Hash] params ({})
3653
- def untag_resource(params = {}, options = {})
3654
- req = build_request(:untag_resource, params)
5786
+ def update_analysis_permissions(params = {}, options = {})
5787
+ req = build_request(:update_analysis_permissions, params)
3655
5788
  req.send_request(options)
3656
5789
  end
3657
5790
 
@@ -3668,15 +5801,24 @@ module Aws::QuickSight
3668
5801
  # The display name of the dashboard.
3669
5802
  #
3670
5803
  # @option params [required, Types::DashboardSourceEntity] :source_entity
3671
- # The template or analysis from which the dashboard is created. The
3672
- # `SouceTemplate` entity accepts the Amazon Resource Name (ARN) of the
3673
- # template and also references to replacement datasets for the
3674
- # placeholders set when creating the template. The replacement datasets
3675
- # need to follow the same schema as the datasets for which placeholders
3676
- # were created when creating the template.
5804
+ # The entity that you are using as a source when you update the
5805
+ # dashboard. In `SourceEntity`, you specify the type of object you're
5806
+ # using as source. You can only update a dashboard from a template, so
5807
+ # you use a `SourceTemplate` entity. If you need to update a dashboard
5808
+ # from an analysis, first convert the analysis to a template by using
5809
+ # the CreateTemplate API operation. For `SourceTemplate`, specify the
5810
+ # Amazon Resource Name (ARN) of the source template. The
5811
+ # `SourceTemplate` ARN can contain any AWS Account and any
5812
+ # QuickSight-supported AWS Region.
5813
+ #
5814
+ # Use the `DataSetReferences` entity within `SourceTemplate` to list the
5815
+ # replacement datasets for the placeholders listed in the original. The
5816
+ # schema in each dataset must match its placeholder.
3677
5817
  #
3678
5818
  # @option params [Types::Parameters] :parameters
3679
- # A structure that contains the parameters of the dashboard.
5819
+ # A structure that contains the parameters of the dashboard. These are
5820
+ # parameter overrides for a dashboard. A dashboard can have any type of
5821
+ # parameters, and some parameters might accept multiple values.
3680
5822
  #
3681
5823
  # @option params [String] :version_description
3682
5824
  # A description for the first version of the dashboard being created.
@@ -3692,13 +5834,18 @@ module Aws::QuickSight
3692
5834
  #
3693
5835
  # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
3694
5836
  # either `ENABLED` or `DISABLED`. The visual option to export data to
3695
- # .csv format isn't enabled when this is set to `DISABLED`. This
5837
+ # .CSV format isn't enabled when this is set to `DISABLED`. This
3696
5838
  # option is `ENABLED` by default.
3697
5839
  #
3698
5840
  # * `VisibilityState` for `SheetControlsOption` - This visibility state
3699
- # can be either `COLLAPSED` or `EXPANDED`. The sheet controls pane is
3700
- # collapsed by default when set to true. This option is `COLLAPSED` by
3701
- # default.
5841
+ # can be either `COLLAPSED` or `EXPANDED`. This option is `COLLAPSED`
5842
+ # by default.
5843
+ #
5844
+ # @option params [String] :theme_arn
5845
+ # The Amazon Resource Name (ARN) of the theme that is being used for
5846
+ # this dashboard. If you add a value for this field, it overrides the
5847
+ # value that was originally associated with the entity. The theme ARN
5848
+ # must exist in the same AWS account where you create the dashboard.
3702
5849
  #
3703
5850
  # @return [Types::UpdateDashboardResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3704
5851
  #
@@ -3764,6 +5911,7 @@ module Aws::QuickSight
3764
5911
  # visibility_state: "EXPANDED", # accepts EXPANDED, COLLAPSED
3765
5912
  # },
3766
5913
  # },
5914
+ # theme_arn: "Arn",
3767
5915
  # })
3768
5916
  #
3769
5917
  # @example Response structure
@@ -3771,7 +5919,7 @@ module Aws::QuickSight
3771
5919
  # resp.arn #=> String
3772
5920
  # resp.version_arn #=> String
3773
5921
  # resp.dashboard_id #=> String
3774
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
5922
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3775
5923
  # resp.status #=> Integer
3776
5924
  # resp.request_id #=> String
3777
5925
  #
@@ -4037,6 +6185,7 @@ module Aws::QuickSight
4037
6185
  # },
4038
6186
  # ],
4039
6187
  # row_level_permission_data_set: {
6188
+ # namespace: "Namespace",
4040
6189
  # arn: "Arn", # required
4041
6190
  # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
4042
6191
  # },
@@ -4253,7 +6402,96 @@ module Aws::QuickSight
4253
6402
  # credential_pair: {
4254
6403
  # username: "Username", # required
4255
6404
  # password: "Password", # required
6405
+ # alternate_data_source_parameters: [
6406
+ # {
6407
+ # amazon_elasticsearch_parameters: {
6408
+ # domain: "Domain", # required
6409
+ # },
6410
+ # athena_parameters: {
6411
+ # work_group: "WorkGroup",
6412
+ # },
6413
+ # aurora_parameters: {
6414
+ # host: "Host", # required
6415
+ # port: 1, # required
6416
+ # database: "Database", # required
6417
+ # },
6418
+ # aurora_postgre_sql_parameters: {
6419
+ # host: "Host", # required
6420
+ # port: 1, # required
6421
+ # database: "Database", # required
6422
+ # },
6423
+ # aws_iot_analytics_parameters: {
6424
+ # data_set_name: "DataSetName", # required
6425
+ # },
6426
+ # jira_parameters: {
6427
+ # site_base_url: "SiteBaseUrl", # required
6428
+ # },
6429
+ # maria_db_parameters: {
6430
+ # host: "Host", # required
6431
+ # port: 1, # required
6432
+ # database: "Database", # required
6433
+ # },
6434
+ # my_sql_parameters: {
6435
+ # host: "Host", # required
6436
+ # port: 1, # required
6437
+ # database: "Database", # required
6438
+ # },
6439
+ # postgre_sql_parameters: {
6440
+ # host: "Host", # required
6441
+ # port: 1, # required
6442
+ # database: "Database", # required
6443
+ # },
6444
+ # presto_parameters: {
6445
+ # host: "Host", # required
6446
+ # port: 1, # required
6447
+ # catalog: "Catalog", # required
6448
+ # },
6449
+ # rds_parameters: {
6450
+ # instance_id: "InstanceId", # required
6451
+ # database: "Database", # required
6452
+ # },
6453
+ # redshift_parameters: {
6454
+ # host: "Host",
6455
+ # port: 1,
6456
+ # database: "Database", # required
6457
+ # cluster_id: "ClusterId",
6458
+ # },
6459
+ # s3_parameters: {
6460
+ # manifest_file_location: { # required
6461
+ # bucket: "S3Bucket", # required
6462
+ # key: "S3Key", # required
6463
+ # },
6464
+ # },
6465
+ # service_now_parameters: {
6466
+ # site_base_url: "SiteBaseUrl", # required
6467
+ # },
6468
+ # snowflake_parameters: {
6469
+ # host: "Host", # required
6470
+ # database: "Database", # required
6471
+ # warehouse: "Warehouse", # required
6472
+ # },
6473
+ # spark_parameters: {
6474
+ # host: "Host", # required
6475
+ # port: 1, # required
6476
+ # },
6477
+ # sql_server_parameters: {
6478
+ # host: "Host", # required
6479
+ # port: 1, # required
6480
+ # database: "Database", # required
6481
+ # },
6482
+ # teradata_parameters: {
6483
+ # host: "Host", # required
6484
+ # port: 1, # required
6485
+ # database: "Database", # required
6486
+ # },
6487
+ # twitter_parameters: {
6488
+ # query: "Query", # required
6489
+ # max_rows: 1, # required
6490
+ # },
6491
+ # },
6492
+ # ],
4256
6493
  # },
6494
+ # copy_source_arn: "CopySourceArn",
4257
6495
  # },
4258
6496
  # vpc_connection_properties: {
4259
6497
  # vpc_connection_arn: "Arn", # required
@@ -4267,7 +6505,7 @@ module Aws::QuickSight
4267
6505
  #
4268
6506
  # resp.arn #=> String
4269
6507
  # resp.data_source_id #=> String
4270
- # resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
6508
+ # resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
4271
6509
  # resp.request_id #=> String
4272
6510
  # resp.status #=> Integer
4273
6511
  #
@@ -4477,9 +6715,19 @@ module Aws::QuickSight
4477
6715
  # The ID for the template.
4478
6716
  #
4479
6717
  # @option params [required, Types::TemplateSourceEntity] :source_entity
4480
- # The source QuickSight entity from which this template is being
4481
- # updated. You can currently update templates from an Analysis or
4482
- # another template.
6718
+ # The entity that you are using as a source when you update the
6719
+ # template. In `SourceEntity`, you specify the type of object you're
6720
+ # using as source: `SourceTemplate` for a template or `SourceAnalysis`
6721
+ # for an analysis. Both of these require an Amazon Resource Name (ARN).
6722
+ # For `SourceTemplate`, specify the ARN of the source template. For
6723
+ # `SourceAnalysis`, specify the ARN of the source analysis. The
6724
+ # `SourceTemplate` ARN can contain any AWS Account and any
6725
+ # QuickSight-supported AWS Region.
6726
+ #
6727
+ # Use the `DataSetReferences` entity within `SourceTemplate` or
6728
+ # `SourceAnalysis` to list the replacement datasets for the placeholders
6729
+ # listed in the original. The schema in each dataset must match its
6730
+ # placeholder.
4483
6731
  #
4484
6732
  # @option params [String] :version_description
4485
6733
  # A description of the current template version that is being updated.
@@ -4527,7 +6775,7 @@ module Aws::QuickSight
4527
6775
  # resp.template_id #=> String
4528
6776
  # resp.arn #=> String
4529
6777
  # resp.version_arn #=> String
4530
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
6778
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
4531
6779
  # resp.status #=> Integer
4532
6780
  # resp.request_id #=> String
4533
6781
  #
@@ -4652,6 +6900,259 @@ module Aws::QuickSight
4652
6900
  req.send_request(options)
4653
6901
  end
4654
6902
 
6903
+ # Updates a theme.
6904
+ #
6905
+ # @option params [required, String] :aws_account_id
6906
+ # The ID of the AWS account that contains the theme that you're
6907
+ # updating.
6908
+ #
6909
+ # @option params [required, String] :theme_id
6910
+ # The ID for the theme.
6911
+ #
6912
+ # @option params [String] :name
6913
+ # The name for the theme.
6914
+ #
6915
+ # @option params [required, String] :base_theme_id
6916
+ # The theme ID, defined by Amazon QuickSight, that a custom theme
6917
+ # inherits from. All themes initially inherit from a default QuickSight
6918
+ # theme.
6919
+ #
6920
+ # @option params [String] :version_description
6921
+ # A description of the theme version that you're updating Every time
6922
+ # that you call `UpdateTheme`, you create a new version of the theme.
6923
+ # Each version of the theme maintains a description of the version in
6924
+ # `VersionDescription`.
6925
+ #
6926
+ # @option params [Types::ThemeConfiguration] :configuration
6927
+ # The theme configuration, which contains the theme display properties.
6928
+ #
6929
+ # @return [Types::UpdateThemeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6930
+ #
6931
+ # * {Types::UpdateThemeResponse#theme_id #theme_id} => String
6932
+ # * {Types::UpdateThemeResponse#arn #arn} => String
6933
+ # * {Types::UpdateThemeResponse#version_arn #version_arn} => String
6934
+ # * {Types::UpdateThemeResponse#creation_status #creation_status} => String
6935
+ # * {Types::UpdateThemeResponse#status #status} => Integer
6936
+ # * {Types::UpdateThemeResponse#request_id #request_id} => String
6937
+ #
6938
+ # @example Request syntax with placeholder values
6939
+ #
6940
+ # resp = client.update_theme({
6941
+ # aws_account_id: "AwsAccountId", # required
6942
+ # theme_id: "RestrictiveResourceId", # required
6943
+ # name: "ThemeName",
6944
+ # base_theme_id: "RestrictiveResourceId", # required
6945
+ # version_description: "VersionDescription",
6946
+ # configuration: {
6947
+ # data_color_palette: {
6948
+ # colors: ["HexColor"],
6949
+ # min_max_gradient: ["HexColor"],
6950
+ # empty_fill_color: "HexColor",
6951
+ # },
6952
+ # ui_color_palette: {
6953
+ # primary_foreground: "HexColor",
6954
+ # primary_background: "HexColor",
6955
+ # secondary_foreground: "HexColor",
6956
+ # secondary_background: "HexColor",
6957
+ # accent: "HexColor",
6958
+ # accent_foreground: "HexColor",
6959
+ # danger: "HexColor",
6960
+ # danger_foreground: "HexColor",
6961
+ # warning: "HexColor",
6962
+ # warning_foreground: "HexColor",
6963
+ # success: "HexColor",
6964
+ # success_foreground: "HexColor",
6965
+ # dimension: "HexColor",
6966
+ # dimension_foreground: "HexColor",
6967
+ # measure: "HexColor",
6968
+ # measure_foreground: "HexColor",
6969
+ # },
6970
+ # sheet: {
6971
+ # tile: {
6972
+ # border: {
6973
+ # show: false,
6974
+ # },
6975
+ # },
6976
+ # tile_layout: {
6977
+ # gutter: {
6978
+ # show: false,
6979
+ # },
6980
+ # margin: {
6981
+ # show: false,
6982
+ # },
6983
+ # },
6984
+ # },
6985
+ # },
6986
+ # })
6987
+ #
6988
+ # @example Response structure
6989
+ #
6990
+ # resp.theme_id #=> String
6991
+ # resp.arn #=> String
6992
+ # resp.version_arn #=> String
6993
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
6994
+ # resp.status #=> Integer
6995
+ # resp.request_id #=> String
6996
+ #
6997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateTheme AWS API Documentation
6998
+ #
6999
+ # @overload update_theme(params = {})
7000
+ # @param [Hash] params ({})
7001
+ def update_theme(params = {}, options = {})
7002
+ req = build_request(:update_theme, params)
7003
+ req.send_request(options)
7004
+ end
7005
+
7006
+ # Updates an alias of a theme.
7007
+ #
7008
+ # @option params [required, String] :aws_account_id
7009
+ # The ID of the AWS account that contains the theme alias that you're
7010
+ # updating.
7011
+ #
7012
+ # @option params [required, String] :theme_id
7013
+ # The ID for the theme.
7014
+ #
7015
+ # @option params [required, String] :alias_name
7016
+ # The name of the theme alias that you want to update.
7017
+ #
7018
+ # @option params [required, Integer] :theme_version_number
7019
+ # The version number of the theme that the alias should reference.
7020
+ #
7021
+ # @return [Types::UpdateThemeAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7022
+ #
7023
+ # * {Types::UpdateThemeAliasResponse#theme_alias #theme_alias} => Types::ThemeAlias
7024
+ # * {Types::UpdateThemeAliasResponse#status #status} => Integer
7025
+ # * {Types::UpdateThemeAliasResponse#request_id #request_id} => String
7026
+ #
7027
+ # @example Request syntax with placeholder values
7028
+ #
7029
+ # resp = client.update_theme_alias({
7030
+ # aws_account_id: "AwsAccountId", # required
7031
+ # theme_id: "RestrictiveResourceId", # required
7032
+ # alias_name: "AliasName", # required
7033
+ # theme_version_number: 1, # required
7034
+ # })
7035
+ #
7036
+ # @example Response structure
7037
+ #
7038
+ # resp.theme_alias.arn #=> String
7039
+ # resp.theme_alias.alias_name #=> String
7040
+ # resp.theme_alias.theme_version_number #=> Integer
7041
+ # resp.status #=> Integer
7042
+ # resp.request_id #=> String
7043
+ #
7044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemeAlias AWS API Documentation
7045
+ #
7046
+ # @overload update_theme_alias(params = {})
7047
+ # @param [Hash] params ({})
7048
+ def update_theme_alias(params = {}, options = {})
7049
+ req = build_request(:update_theme_alias, params)
7050
+ req.send_request(options)
7051
+ end
7052
+
7053
+ # Updates the resource permissions for a theme. Permissions apply to the
7054
+ # action to grant or revoke permissions on, for example
7055
+ # `"quicksight:DescribeTheme"`.
7056
+ #
7057
+ # Theme permissions apply in groupings. Valid groupings include the
7058
+ # following for the three levels of permissions, which are user, owner,
7059
+ # or no permissions:
7060
+ #
7061
+ # * User
7062
+ #
7063
+ # * `"quicksight:DescribeTheme"`
7064
+ #
7065
+ # * `"quicksight:DescribeThemeAlias"`
7066
+ #
7067
+ # * `"quicksight:ListThemeAliases"`
7068
+ #
7069
+ # * `"quicksight:ListThemeVersions"`
7070
+ #
7071
+ # * Owner
7072
+ #
7073
+ # * `"quicksight:DescribeTheme"`
7074
+ #
7075
+ # * `"quicksight:DescribeThemeAlias"`
7076
+ #
7077
+ # * `"quicksight:ListThemeAliases"`
7078
+ #
7079
+ # * `"quicksight:ListThemeVersions"`
7080
+ #
7081
+ # * `"quicksight:DeleteTheme"`
7082
+ #
7083
+ # * `"quicksight:UpdateTheme"`
7084
+ #
7085
+ # * `"quicksight:CreateThemeAlias"`
7086
+ #
7087
+ # * `"quicksight:DeleteThemeAlias"`
7088
+ #
7089
+ # * `"quicksight:UpdateThemeAlias"`
7090
+ #
7091
+ # * `"quicksight:UpdateThemePermissions"`
7092
+ #
7093
+ # * `"quicksight:DescribeThemePermissions"`
7094
+ #
7095
+ # * To specify no permissions, omit the permissions list.
7096
+ #
7097
+ # @option params [required, String] :aws_account_id
7098
+ # The ID of the AWS account that contains the theme.
7099
+ #
7100
+ # @option params [required, String] :theme_id
7101
+ # The ID for the theme.
7102
+ #
7103
+ # @option params [Array<Types::ResourcePermission>] :grant_permissions
7104
+ # A list of resource permissions to be granted for the theme.
7105
+ #
7106
+ # @option params [Array<Types::ResourcePermission>] :revoke_permissions
7107
+ # A list of resource permissions to be revoked from the theme.
7108
+ #
7109
+ # @return [Types::UpdateThemePermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7110
+ #
7111
+ # * {Types::UpdateThemePermissionsResponse#theme_id #theme_id} => String
7112
+ # * {Types::UpdateThemePermissionsResponse#theme_arn #theme_arn} => String
7113
+ # * {Types::UpdateThemePermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
7114
+ # * {Types::UpdateThemePermissionsResponse#request_id #request_id} => String
7115
+ # * {Types::UpdateThemePermissionsResponse#status #status} => Integer
7116
+ #
7117
+ # @example Request syntax with placeholder values
7118
+ #
7119
+ # resp = client.update_theme_permissions({
7120
+ # aws_account_id: "AwsAccountId", # required
7121
+ # theme_id: "RestrictiveResourceId", # required
7122
+ # grant_permissions: [
7123
+ # {
7124
+ # principal: "Principal", # required
7125
+ # actions: ["String"], # required
7126
+ # },
7127
+ # ],
7128
+ # revoke_permissions: [
7129
+ # {
7130
+ # principal: "Principal", # required
7131
+ # actions: ["String"], # required
7132
+ # },
7133
+ # ],
7134
+ # })
7135
+ #
7136
+ # @example Response structure
7137
+ #
7138
+ # resp.theme_id #=> String
7139
+ # resp.theme_arn #=> String
7140
+ # resp.permissions #=> Array
7141
+ # resp.permissions[0].principal #=> String
7142
+ # resp.permissions[0].actions #=> Array
7143
+ # resp.permissions[0].actions[0] #=> String
7144
+ # resp.request_id #=> String
7145
+ # resp.status #=> Integer
7146
+ #
7147
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateThemePermissions AWS API Documentation
7148
+ #
7149
+ # @overload update_theme_permissions(params = {})
7150
+ # @param [Hash] params ({})
7151
+ def update_theme_permissions(params = {}, options = {})
7152
+ req = build_request(:update_theme_permissions, params)
7153
+ req.send_request(options)
7154
+ end
7155
+
4655
7156
  # Updates an Amazon QuickSight user.
4656
7157
  #
4657
7158
  # @option params [required, String] :user_name
@@ -4668,8 +7169,8 @@ module Aws::QuickSight
4668
7169
  # The email address of the user that you want to update.
4669
7170
  #
4670
7171
  # @option params [required, String] :role
4671
- # The Amazon QuickSight role of the user. The user role can be one of
4672
- # the following:
7172
+ # The Amazon QuickSight role of the user. The role can be one of the
7173
+ # following default security cohorts:
4673
7174
  #
4674
7175
  # * `READER`\: A user who has read-only access to dashboards.
4675
7176
  #
@@ -4679,6 +7180,45 @@ module Aws::QuickSight
4679
7180
  # * `ADMIN`\: A user who is an author, who can also manage Amazon
4680
7181
  # QuickSight settings.
4681
7182
  #
7183
+ # The name of the QuickSight role is invisible to the user except for
7184
+ # the console screens dealing with permissions.
7185
+ #
7186
+ # @option params [String] :custom_permissions_name
7187
+ # (Enterprise edition only) The name of the custom permissions profile
7188
+ # that you want to assign to this user. Customized permissions allows
7189
+ # you to control a user's access by restricting access the following
7190
+ # operations:
7191
+ #
7192
+ # * Create and update data sources
7193
+ #
7194
+ # * Create and update datasets
7195
+ #
7196
+ # * Create and update email reports
7197
+ #
7198
+ # * Subscribe to email reports
7199
+ #
7200
+ # A set of custom permissions includes any combination of these
7201
+ # restrictions. Currently, you need to create the profile names for
7202
+ # custom permission sets by using the QuickSight console. Then, you use
7203
+ # the `RegisterUser` API operation to assign the named set of
7204
+ # permissions to a QuickSight user.
7205
+ #
7206
+ # QuickSight custom permissions are applied through IAM policies.
7207
+ # Therefore, they override the permissions typically granted by
7208
+ # assigning QuickSight users to one of the default security cohorts in
7209
+ # QuickSight (admin, author, reader).
7210
+ #
7211
+ # This feature is available only to QuickSight Enterprise edition
7212
+ # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
7213
+ # (SSO).
7214
+ #
7215
+ # @option params [Boolean] :unapply_custom_permissions
7216
+ # A flag that you use to indicate that you want to remove all custom
7217
+ # permissions from this user. Using this parameter resets the user to
7218
+ # the state it was in before a custom permissions profile was applied.
7219
+ # This parameter defaults to NULL and it doesn't accept any other
7220
+ # value.
7221
+ #
4682
7222
  # @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4683
7223
  #
4684
7224
  # * {Types::UpdateUserResponse#user #user} => Types::User
@@ -4693,6 +7233,8 @@ module Aws::QuickSight
4693
7233
  # namespace: "Namespace", # required
4694
7234
  # email: "String", # required
4695
7235
  # role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
7236
+ # custom_permissions_name: "RoleName",
7237
+ # unapply_custom_permissions: false,
4696
7238
  # })
4697
7239
  #
4698
7240
  # @example Response structure
@@ -4704,6 +7246,7 @@ module Aws::QuickSight
4704
7246
  # resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
4705
7247
  # resp.user.active #=> Boolean
4706
7248
  # resp.user.principal_id #=> String
7249
+ # resp.user.custom_permissions_name #=> String
4707
7250
  # resp.request_id #=> String
4708
7251
  # resp.status #=> Integer
4709
7252
  #
@@ -4729,7 +7272,7 @@ module Aws::QuickSight
4729
7272
  params: params,
4730
7273
  config: config)
4731
7274
  context[:gem_name] = 'aws-sdk-quicksight'
4732
- context[:gem_version] = '1.23.0'
7275
+ context[:gem_version] = '1.28.0'
4733
7276
  Seahorse::Client::Request.new(handlers, context)
4734
7277
  end
4735
7278