aws-sdk-quicksight 1.26.0 → 1.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8d80520b575a81b846237750af2db53859dc3efebfcbeb2afe45feab6ca3fe24
4
- data.tar.gz: 8983ea37cef08fbfd984c22fb9609a7864efd741f3c8631691d2d79fcd798e7b
3
+ metadata.gz: f25c203680ab75e3508f036909369c0c5fce3d70313ab6f34f3ee7ee123d6889
4
+ data.tar.gz: 2a4ce4e8c5c88cdcf24e8c85e52932eba553571796a97009aafdf67efb09b27f
5
5
  SHA512:
6
- metadata.gz: bf2786ff837b06a794e9184432a0849cd2b1c9158af22f566d05f4d519007b460e90e2db86853b6c0ecad67f170aba44cbfc04ab85c39491630e5e99ca783cf0
7
- data.tar.gz: afd4503c43cdb35401ea4e996d8ca8240f5c0dd69eb03891996686fffea308ecd17fd6284dcf99c3145d1ac4f52e7251c411642f0ff3b36f078f0722e7f2c924
6
+ metadata.gz: 5c4b503bff6217bd31bf2e886699b321b8489c06dc9169aafa65033505db6bf6bb4de022a2cca5ce4068eca466723772170f422a98b2745133f38afa173da5f5
7
+ data.tar.gz: 52ba45c2ba1aedeb56db2853a8fb879c1de6c7ee089e92b3e37192cdbf6821efea7bb1587a52036542d69c997d14083e4811c4b49591b1ff56fff06fc497d1f2
@@ -47,6 +47,6 @@ require_relative 'aws-sdk-quicksight/customizations'
47
47
  # @service
48
48
  module Aws::QuickSight
49
49
 
50
- GEM_VERSION = '1.26.0'
50
+ GEM_VERSION = '1.27.0'
51
51
 
52
52
  end
@@ -354,22 +354,46 @@ module Aws::QuickSight
354
354
  req.send_request(options)
355
355
  end
356
356
 
357
- # Creates a customization for the Amazon QuickSight subscription
358
- # associated with your AWS account.
357
+ # Creates Amazon QuickSight customizations the current AWS Region.
358
+ # Currently, you can add a custom default theme by using the
359
+ # `CreateAccountCustomization` or `UpdateAccountCustomization` API
360
+ # operation. To further customize QuickSight by removing QuickSight
361
+ # sample assets and videos for all new users, see [Customizing
362
+ # QuickSight][1] in the Amazon QuickSight User Guide.
363
+ #
364
+ # You can create customizations for your AWS account or, if you specify
365
+ # a namespace, for a QuickSight namespace instead. Customizations that
366
+ # apply to a namespace always override customizations that apply to an
367
+ # AWS account. To find out which customizations apply, use the
368
+ # `DescribeAccountCustomization` API operation.
369
+ #
370
+ # Before you add a theme as the namespace default, make sure that you
371
+ # first share the theme with the namespace. If you don't share it with
372
+ # the namespace, the theme won't be visible to your users even if you
373
+ # use this API operation to make it the default theme.
374
+ #
375
+ #
376
+ #
377
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html
359
378
  #
360
379
  # @option params [required, String] :aws_account_id
361
380
  # The ID for the AWS account that you want to customize QuickSight for.
362
381
  #
363
382
  # @option params [String] :namespace
364
- # The namespace associated with the customization that you're creating.
383
+ # The QuickSight namespace that you want to add customizations to.
365
384
  #
366
385
  # @option params [required, Types::AccountCustomization] :account_customization
367
- # The customizations you're adding to the QuickSight subscription for
368
- # the AWS account. For example, you could add a default theme by setting
369
- # `AccountCustomization` to the midnight theme
370
- # (`DefaultTheme="arn:aws:quicksight::aws:theme/MIDNIGHT"`) or to a
371
- # custom theme
372
- # (`DefaultTheme="arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"`).
386
+ # The QuickSight customizations you're adding in the current AWS
387
+ # Region. You can add these to an AWS account and a QuickSight
388
+ # namespace.
389
+ #
390
+ # For example, you could add a default theme by setting
391
+ # `AccountCustomization` to the midnight theme: `"AccountCustomization":
392
+ # \{ "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" \}. `. Or,
393
+ # you could add a custom theme by specifying `"AccountCustomization": \{
394
+ # "DefaultTheme":
395
+ # "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
396
+ # \}`.
373
397
  #
374
398
  # @return [Types::CreateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
375
399
  #
@@ -406,16 +430,138 @@ module Aws::QuickSight
406
430
  req.send_request(options)
407
431
  end
408
432
 
433
+ # Creates an analysis in Amazon QuickSight.
434
+ #
435
+ # @option params [required, String] :aws_account_id
436
+ # The ID of the AWS account where you are creating an analysis.
437
+ #
438
+ # @option params [required, String] :analysis_id
439
+ # The ID for the analysis that you're creating. This ID displays in the
440
+ # URL of the analysis.
441
+ #
442
+ # @option params [required, String] :name
443
+ # A descriptive name for the analysis that you're creating. This name
444
+ # displays for the analysis in the QuickSight console.
445
+ #
446
+ # @option params [Types::Parameters] :parameters
447
+ # The parameter names and override values that you want to use. An
448
+ # analysis can have any parameter type, and some parameters might accept
449
+ # multiple values.
450
+ #
451
+ # @option params [Array<Types::ResourcePermission>] :permissions
452
+ # A structure that describes the principals and the resource-level
453
+ # permissions on an analysis. You can use the `Permissions` structure to
454
+ # grant permissions by providing a list of AWS Identity and Access
455
+ # Management (IAM) action information for each principal listed by
456
+ # Amazon Resource Name (ARN).
457
+ #
458
+ # To specify no permissions, omit `Permissions`.
459
+ #
460
+ # @option params [required, Types::AnalysisSourceEntity] :source_entity
461
+ # A source entity to use for the analysis that you're creating. This
462
+ # metadata structure contains details that describe a source template
463
+ # and one or more datasets.
464
+ #
465
+ # @option params [String] :theme_arn
466
+ # The ARN for the theme to apply to the analysis that you're creating.
467
+ # To see the theme in the QuickSight console, make sure that you have
468
+ # access to it.
469
+ #
470
+ # @option params [Array<Types::Tag>] :tags
471
+ # Contains a map of the key-value pairs for the resource tag or tags
472
+ # assigned to the analysis.
473
+ #
474
+ # @return [Types::CreateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
475
+ #
476
+ # * {Types::CreateAnalysisResponse#arn #arn} => String
477
+ # * {Types::CreateAnalysisResponse#analysis_id #analysis_id} => String
478
+ # * {Types::CreateAnalysisResponse#creation_status #creation_status} => String
479
+ # * {Types::CreateAnalysisResponse#status #status} => Integer
480
+ # * {Types::CreateAnalysisResponse#request_id #request_id} => String
481
+ #
482
+ # @example Request syntax with placeholder values
483
+ #
484
+ # resp = client.create_analysis({
485
+ # aws_account_id: "AwsAccountId", # required
486
+ # analysis_id: "RestrictiveResourceId", # required
487
+ # name: "AnalysisName", # required
488
+ # parameters: {
489
+ # string_parameters: [
490
+ # {
491
+ # name: "NonEmptyString", # required
492
+ # values: ["String"], # required
493
+ # },
494
+ # ],
495
+ # integer_parameters: [
496
+ # {
497
+ # name: "NonEmptyString", # required
498
+ # values: [1], # required
499
+ # },
500
+ # ],
501
+ # decimal_parameters: [
502
+ # {
503
+ # name: "NonEmptyString", # required
504
+ # values: [1.0], # required
505
+ # },
506
+ # ],
507
+ # date_time_parameters: [
508
+ # {
509
+ # name: "NonEmptyString", # required
510
+ # values: [Time.now], # required
511
+ # },
512
+ # ],
513
+ # },
514
+ # permissions: [
515
+ # {
516
+ # principal: "Principal", # required
517
+ # actions: ["String"], # required
518
+ # },
519
+ # ],
520
+ # source_entity: { # required
521
+ # source_template: {
522
+ # data_set_references: [ # required
523
+ # {
524
+ # data_set_placeholder: "NonEmptyString", # required
525
+ # data_set_arn: "Arn", # required
526
+ # },
527
+ # ],
528
+ # arn: "Arn", # required
529
+ # },
530
+ # },
531
+ # theme_arn: "Arn",
532
+ # tags: [
533
+ # {
534
+ # key: "TagKey", # required
535
+ # value: "TagValue", # required
536
+ # },
537
+ # ],
538
+ # })
539
+ #
540
+ # @example Response structure
541
+ #
542
+ # resp.arn #=> String
543
+ # resp.analysis_id #=> String
544
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
545
+ # resp.status #=> Integer
546
+ # resp.request_id #=> String
547
+ #
548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysis AWS API Documentation
549
+ #
550
+ # @overload create_analysis(params = {})
551
+ # @param [Hash] params ({})
552
+ def create_analysis(params = {}, options = {})
553
+ req = build_request(:create_analysis, params)
554
+ req.send_request(options)
555
+ end
556
+
409
557
  # Creates a dashboard from a template. To first create a template, see
410
- # the CreateTemplate API operation.
558
+ # the ` CreateTemplate ` API operation.
411
559
  #
412
560
  # A dashboard is an entity in QuickSight that identifies QuickSight
413
561
  # reports, created from analyses. You can share QuickSight dashboards.
414
562
  # With the right permissions, you can create scheduled email reports
415
- # from them. The `CreateDashboard`, `DescribeDashboard`, and
416
- # `ListDashboardsByUser` API operations act on the dashboard entity. If
417
- # you have the correct permissions, you can create a dashboard from a
418
- # template that exists in a different AWS account.
563
+ # from them. If you have the correct permissions, you can create a
564
+ # dashboard from a template that exists in a different AWS account.
419
565
  #
420
566
  # @option params [required, String] :aws_account_id
421
567
  # The ID of the AWS account where you want to create the dashboard.
@@ -433,8 +579,10 @@ module Aws::QuickSight
433
579
  #
434
580
  # @option params [Array<Types::ResourcePermission>] :permissions
435
581
  # A structure that contains the permissions of the dashboard. You can
436
- # use this structure for granting permissions with principal and action
437
- # information.
582
+ # use this structure for granting permissions by providing a list of IAM
583
+ # action information for each principal ARN.
584
+ #
585
+ # To specify no permissions, omit the permissions list.
438
586
  #
439
587
  # @option params [required, Types::DashboardSourceEntity] :source_entity
440
588
  # The entity that you are using as a source when you create the
@@ -469,7 +617,7 @@ module Aws::QuickSight
469
617
  #
470
618
  # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
471
619
  # either `ENABLED` or `DISABLED`. The visual option to export data to
472
- # .csv format isn't enabled when this is set to `DISABLED`. This
620
+ # .CSV format isn't enabled when this is set to `DISABLED`. This
473
621
  # option is `ENABLED` by default.
474
622
  #
475
623
  # * `VisibilityState` for `SheetControlsOption` - This visibility state
@@ -566,7 +714,7 @@ module Aws::QuickSight
566
714
  # resp.arn #=> String
567
715
  # resp.version_arn #=> String
568
716
  # resp.dashboard_id #=> String
569
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
717
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
570
718
  # resp.status #=> Integer
571
719
  # resp.request_id #=> String
572
720
  #
@@ -1033,7 +1181,7 @@ module Aws::QuickSight
1033
1181
  #
1034
1182
  # resp.arn #=> String
1035
1183
  # resp.data_source_id #=> String
1036
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
1184
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
1037
1185
  # resp.request_id #=> String
1038
1186
  # resp.status #=> Integer
1039
1187
  #
@@ -1452,7 +1600,7 @@ module Aws::QuickSight
1452
1600
  # resp.arn #=> String
1453
1601
  # resp.version_arn #=> String
1454
1602
  # resp.template_id #=> String
1455
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
1603
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
1456
1604
  # resp.status #=> Integer
1457
1605
  # resp.request_id #=> String
1458
1606
  #
@@ -1632,7 +1780,7 @@ module Aws::QuickSight
1632
1780
  # resp.arn #=> String
1633
1781
  # resp.version_arn #=> String
1634
1782
  # resp.theme_id #=> String
1635
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
1783
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
1636
1784
  # resp.status #=> Integer
1637
1785
  # resp.request_id #=> String
1638
1786
  #
@@ -1694,15 +1842,16 @@ module Aws::QuickSight
1694
1842
  req.send_request(options)
1695
1843
  end
1696
1844
 
1697
- # Deletes customizations for the QuickSight subscription on your AWS
1698
- # account.
1845
+ # Deletes all Amazon QuickSight customizations in this AWS Region for
1846
+ # the specified AWS Account and QuickSight namespace.
1699
1847
  #
1700
1848
  # @option params [required, String] :aws_account_id
1701
1849
  # The ID for the AWS account that you want to delete QuickSight
1702
- # customizations from.
1850
+ # customizations from in this AWS Region.
1703
1851
  #
1704
1852
  # @option params [String] :namespace
1705
- # The namespace associated with the customization that you're deleting.
1853
+ # The QuickSight namespace that you're deleting the customizations
1854
+ # from.
1706
1855
  #
1707
1856
  # @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1708
1857
  #
@@ -1730,6 +1879,74 @@ module Aws::QuickSight
1730
1879
  req.send_request(options)
1731
1880
  end
1732
1881
 
1882
+ # Deletes an analysis from Amazon QuickSight. You can optionally include
1883
+ # a recovery window during which you can restore the analysis. If you
1884
+ # don't specify a recovery window value, the operation defaults to 30
1885
+ # days. QuickSight attaches a `DeletionTime` stamp to the response that
1886
+ # specifies the end of the recovery window. At the end of the recovery
1887
+ # window, QuickSight deletes the analysis permanently.
1888
+ #
1889
+ # At any time before recovery window ends, you can use the
1890
+ # `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
1891
+ # cancel the deletion of the analysis. The analysis remains visible in
1892
+ # the API until it's deleted, so you can describe it but you can't
1893
+ # make a template from it.
1894
+ #
1895
+ # An analysis that's scheduled for deletion isn't accessible in the
1896
+ # QuickSight console. To access it in the console, restore it. Deleting
1897
+ # an analysis doesn't delete the dashboards that you publish from it.
1898
+ #
1899
+ # @option params [required, String] :aws_account_id
1900
+ # The ID of the AWS account where you want to delete an analysis.
1901
+ #
1902
+ # @option params [required, String] :analysis_id
1903
+ # The ID of the analysis that you're deleting.
1904
+ #
1905
+ # @option params [Integer] :recovery_window_in_days
1906
+ # A value that specifies the number of days that QuickSight waits before
1907
+ # it deletes the analysis. You can't use this parameter with the
1908
+ # `ForceDeleteWithoutRecovery` option in the same API call. The default
1909
+ # value is 30.
1910
+ #
1911
+ # @option params [Boolean] :force_delete_without_recovery
1912
+ # This option defaults to the value `NoForceDeleteWithoutRecovery`. To
1913
+ # immediately delete the analysis, add the `ForceDeleteWithoutRecovery`
1914
+ # option. You can't restore an analysis after it's deleted.
1915
+ #
1916
+ # @return [Types::DeleteAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1917
+ #
1918
+ # * {Types::DeleteAnalysisResponse#status #status} => Integer
1919
+ # * {Types::DeleteAnalysisResponse#arn #arn} => String
1920
+ # * {Types::DeleteAnalysisResponse#analysis_id #analysis_id} => String
1921
+ # * {Types::DeleteAnalysisResponse#deletion_time #deletion_time} => Time
1922
+ # * {Types::DeleteAnalysisResponse#request_id #request_id} => String
1923
+ #
1924
+ # @example Request syntax with placeholder values
1925
+ #
1926
+ # resp = client.delete_analysis({
1927
+ # aws_account_id: "AwsAccountId", # required
1928
+ # analysis_id: "RestrictiveResourceId", # required
1929
+ # recovery_window_in_days: 1,
1930
+ # force_delete_without_recovery: false,
1931
+ # })
1932
+ #
1933
+ # @example Response structure
1934
+ #
1935
+ # resp.status #=> Integer
1936
+ # resp.arn #=> String
1937
+ # resp.analysis_id #=> String
1938
+ # resp.deletion_time #=> Time
1939
+ # resp.request_id #=> String
1940
+ #
1941
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysis AWS API Documentation
1942
+ #
1943
+ # @overload delete_analysis(params = {})
1944
+ # @param [Hash] params ({})
1945
+ def delete_analysis(params = {}, options = {})
1946
+ req = build_request(:delete_analysis, params)
1947
+ req.send_request(options)
1948
+ end
1949
+
1733
1950
  # Deletes a dashboard.
1734
1951
  #
1735
1952
  # @option params [required, String] :aws_account_id
@@ -1813,7 +2030,7 @@ module Aws::QuickSight
1813
2030
  req.send_request(options)
1814
2031
  end
1815
2032
 
1816
- # Deletes the data source permanently. This action breaks all the
2033
+ # Deletes the data source permanently. This operation breaks all the
1817
2034
  # datasets that reference the deleted data source.
1818
2035
  #
1819
2036
  # @option params [required, String] :aws_account_id
@@ -1982,7 +2199,8 @@ module Aws::QuickSight
1982
2199
  # Deletes a namespace and the users and groups that are associated with
1983
2200
  # the namespace. This is an asynchronous process. Assets including
1984
2201
  # dashboards, analyses, datasets and data sources are not deleted. To
1985
- # delete these assets, you use the APIs for the relevant asset.
2202
+ # delete these assets, you use the API operations for the relevant
2203
+ # asset.
1986
2204
  #
1987
2205
  # @option params [required, String] :aws_account_id
1988
2206
  # The ID for the AWS account that you want to delete the QuickSight
@@ -2284,20 +2502,75 @@ module Aws::QuickSight
2284
2502
  req.send_request(options)
2285
2503
  end
2286
2504
 
2287
- # Describes the customizations associated with your AWS account.
2505
+ # Describes the customizations associated with the provided AWS account
2506
+ # and Amazon QuickSight namespace in an AWS Region. The QuickSight
2507
+ # console evaluates which customizations to apply by running this API
2508
+ # operation with the `Resolved` flag included.
2509
+ #
2510
+ # To determine what customizations display when you run this command, it
2511
+ # can help to visualize the relationship of the entities involved.
2512
+ #
2513
+ # * `AWS Account` - The AWS account exists at the top of the hierarchy.
2514
+ # It has the potential to use all of the AWS Regions and AWS Services.
2515
+ # When you subscribe to QuickSight, you choose one AWS Region to use
2516
+ # as your home region. That's where your free SPICE capacity is
2517
+ # located. You can use QuickSight in any supported AWS Region.
2518
+ #
2519
+ # * `AWS Region` - In each AWS Region where you sign in to QuickSight at
2520
+ # least once, QuickSight acts as a separate instance of the same
2521
+ # service. If you have a user directory, it resides in us-east-1,
2522
+ # which is the US East (N. Virginia). Generally speaking, these users
2523
+ # have access to QuickSight in any AWS Region, unless they are
2524
+ # constrained to a namespace.
2525
+ #
2526
+ # To run the command in a different AWS Region, you change your region
2527
+ # settings. If you're using the AWS CLI, you can use one of the
2528
+ # following options:
2529
+ #
2530
+ # * Use [command line options][1].
2531
+ #
2532
+ # * Use [named profiles][2].
2533
+ #
2534
+ # * Run `aws configure` to change your default AWS Region. Use Enter
2535
+ # to key the same settings for your keys. For more information, see
2536
+ # [Configuring the AWS CLI][3].
2537
+ #
2538
+ # * `Namespace` - A QuickSight namespace is a partition that contains
2539
+ # users and assets (data sources, datasets, dashboards, and so on). To
2540
+ # access assets that are in a specific namespace, users and groups
2541
+ # must also be part of the same namespace. People who share a
2542
+ # namespace are completely isolated from users and assets in other
2543
+ # namespaces, even if they are in the same AWS account and AWS Region.
2544
+ #
2545
+ # * `Applied customizations` - Within an AWS Region, a set of QuickSight
2546
+ # customizations can apply to an AWS account or to a namespace.
2547
+ # Settings that you apply to a namespace override settings that you
2548
+ # apply to an AWS Account. All settings are isolated to a single AWS
2549
+ # Region. To apply them in other AWS Regions, run the
2550
+ # `CreateAccountCustomization` command in each AWS Region where you
2551
+ # want to apply the same customizations.
2552
+ #
2553
+ #
2554
+ #
2555
+ # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html
2556
+ # [2]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html
2557
+ # [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
2288
2558
  #
2289
2559
  # @option params [required, String] :aws_account_id
2290
2560
  # The ID for the AWS account that you want to describe QuickSight
2291
2561
  # customizations for.
2292
2562
  #
2293
2563
  # @option params [String] :namespace
2294
- # The namespace associated with the customization that you're
2295
- # describing.
2564
+ # The QuickSight namespace that you want to describe QuickSight
2565
+ # customizations for.
2296
2566
  #
2297
2567
  # @option params [Boolean] :resolved
2298
- # The status of the creation of the customization. This is an
2299
- # asynchronous process. A status of `CREATED` means that your
2300
- # customization is ready to use.
2568
+ # The `Resolved` flag works with the other parameters to determine which
2569
+ # view of QuickSight customizations is returned. You can add this flag
2570
+ # to your command to use the same view that QuickSight uses to identify
2571
+ # which customizations to apply to the console. Omit this flag, or set
2572
+ # it to `no-resolved`, to reveal customizations that are configured at
2573
+ # different levels.
2301
2574
  #
2302
2575
  # @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2303
2576
  #
@@ -2336,8 +2609,8 @@ module Aws::QuickSight
2336
2609
  # subscription was first created in this AWS Account.
2337
2610
  #
2338
2611
  # @option params [required, String] :aws_account_id
2339
- # The ID for the AWS account that contains the QuickSight namespaces
2340
- # that you want to list.
2612
+ # The ID for the AWS account that contains the settings that you want to
2613
+ # list.
2341
2614
  #
2342
2615
  # @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2343
2616
  #
@@ -2369,6 +2642,101 @@ module Aws::QuickSight
2369
2642
  req.send_request(options)
2370
2643
  end
2371
2644
 
2645
+ # Provides a summary of the metadata for an analysis.
2646
+ #
2647
+ # @option params [required, String] :aws_account_id
2648
+ # The ID of the AWS account that contains the analysis. You must be
2649
+ # using the AWS account that the analysis is in.
2650
+ #
2651
+ # @option params [required, String] :analysis_id
2652
+ # The ID of the analysis that you're describing. The ID is part of the
2653
+ # URL of the analysis.
2654
+ #
2655
+ # @return [Types::DescribeAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2656
+ #
2657
+ # * {Types::DescribeAnalysisResponse#analysis #analysis} => Types::Analysis
2658
+ # * {Types::DescribeAnalysisResponse#status #status} => Integer
2659
+ # * {Types::DescribeAnalysisResponse#request_id #request_id} => String
2660
+ #
2661
+ # @example Request syntax with placeholder values
2662
+ #
2663
+ # resp = client.describe_analysis({
2664
+ # aws_account_id: "AwsAccountId", # required
2665
+ # analysis_id: "RestrictiveResourceId", # required
2666
+ # })
2667
+ #
2668
+ # @example Response structure
2669
+ #
2670
+ # resp.analysis.analysis_id #=> String
2671
+ # resp.analysis.arn #=> String
2672
+ # resp.analysis.name #=> String
2673
+ # resp.analysis.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2674
+ # resp.analysis.errors #=> Array
2675
+ # 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"
2676
+ # resp.analysis.errors[0].message #=> String
2677
+ # resp.analysis.data_set_arns #=> Array
2678
+ # resp.analysis.data_set_arns[0] #=> String
2679
+ # resp.analysis.theme_arn #=> String
2680
+ # resp.analysis.created_time #=> Time
2681
+ # resp.analysis.last_updated_time #=> Time
2682
+ # resp.status #=> Integer
2683
+ # resp.request_id #=> String
2684
+ #
2685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysis AWS API Documentation
2686
+ #
2687
+ # @overload describe_analysis(params = {})
2688
+ # @param [Hash] params ({})
2689
+ def describe_analysis(params = {}, options = {})
2690
+ req = build_request(:describe_analysis, params)
2691
+ req.send_request(options)
2692
+ end
2693
+
2694
+ # Provides the read and write permissions for an analysis.
2695
+ #
2696
+ # @option params [required, String] :aws_account_id
2697
+ # The ID of the AWS account that contains the analysis whose permissions
2698
+ # you're describing. You must be using the AWS account that the
2699
+ # analysis is in.
2700
+ #
2701
+ # @option params [required, String] :analysis_id
2702
+ # The ID of the analysis whose permissions you're describing. The ID is
2703
+ # part of the analysis URL.
2704
+ #
2705
+ # @return [Types::DescribeAnalysisPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2706
+ #
2707
+ # * {Types::DescribeAnalysisPermissionsResponse#analysis_id #analysis_id} => String
2708
+ # * {Types::DescribeAnalysisPermissionsResponse#analysis_arn #analysis_arn} => String
2709
+ # * {Types::DescribeAnalysisPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
2710
+ # * {Types::DescribeAnalysisPermissionsResponse#status #status} => Integer
2711
+ # * {Types::DescribeAnalysisPermissionsResponse#request_id #request_id} => String
2712
+ #
2713
+ # @example Request syntax with placeholder values
2714
+ #
2715
+ # resp = client.describe_analysis_permissions({
2716
+ # aws_account_id: "AwsAccountId", # required
2717
+ # analysis_id: "RestrictiveResourceId", # required
2718
+ # })
2719
+ #
2720
+ # @example Response structure
2721
+ #
2722
+ # resp.analysis_id #=> String
2723
+ # resp.analysis_arn #=> String
2724
+ # resp.permissions #=> Array
2725
+ # resp.permissions[0].principal #=> String
2726
+ # resp.permissions[0].actions #=> Array
2727
+ # resp.permissions[0].actions[0] #=> String
2728
+ # resp.status #=> Integer
2729
+ # resp.request_id #=> String
2730
+ #
2731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissions AWS API Documentation
2732
+ #
2733
+ # @overload describe_analysis_permissions(params = {})
2734
+ # @param [Hash] params ({})
2735
+ def describe_analysis_permissions(params = {}, options = {})
2736
+ req = build_request(:describe_analysis_permissions, params)
2737
+ req.send_request(options)
2738
+ end
2739
+
2372
2740
  # Provides a summary for a dashboard.
2373
2741
  #
2374
2742
  # @option params [required, String] :aws_account_id
@@ -2410,12 +2778,13 @@ module Aws::QuickSight
2410
2778
  # 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"
2411
2779
  # resp.dashboard.version.errors[0].message #=> String
2412
2780
  # resp.dashboard.version.version_number #=> Integer
2413
- # resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
2781
+ # resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2414
2782
  # resp.dashboard.version.arn #=> String
2415
2783
  # resp.dashboard.version.source_entity_arn #=> String
2416
2784
  # resp.dashboard.version.data_set_arns #=> Array
2417
2785
  # resp.dashboard.version.data_set_arns[0] #=> String
2418
2786
  # resp.dashboard.version.description #=> String
2787
+ # resp.dashboard.version.theme_arn #=> String
2419
2788
  # resp.dashboard.created_time #=> Time
2420
2789
  # resp.dashboard.last_published_time #=> Time
2421
2790
  # resp.dashboard.last_updated_time #=> Time
@@ -2649,7 +3018,7 @@ module Aws::QuickSight
2649
3018
  # resp.data_source.data_source_id #=> String
2650
3019
  # resp.data_source.name #=> String
2651
3020
  # 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"
2652
- # resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
3021
+ # resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2653
3022
  # resp.data_source.created_time #=> Time
2654
3023
  # resp.data_source.last_updated_time #=> Time
2655
3024
  # resp.data_source.data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
@@ -3034,10 +3403,10 @@ module Aws::QuickSight
3034
3403
  # resp.template.name #=> String
3035
3404
  # resp.template.version.created_time #=> Time
3036
3405
  # resp.template.version.errors #=> Array
3037
- # resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE"
3406
+ # resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "ACCESS_DENIED"
3038
3407
  # resp.template.version.errors[0].message #=> String
3039
3408
  # resp.template.version.version_number #=> Integer
3040
- # resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
3409
+ # resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3041
3410
  # resp.template.version.data_set_configurations #=> Array
3042
3411
  # resp.template.version.data_set_configurations[0].placeholder #=> String
3043
3412
  # resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list #=> Array
@@ -3050,6 +3419,7 @@ module Aws::QuickSight
3050
3419
  # resp.template.version.data_set_configurations[0].column_group_schema_list[0].column_group_column_schema_list[0].name #=> String
3051
3420
  # resp.template.version.description #=> String
3052
3421
  # resp.template.version.source_entity_arn #=> String
3422
+ # resp.template.version.theme_arn #=> String
3053
3423
  # resp.template.template_id #=> String
3054
3424
  # resp.template.last_updated_time #=> Time
3055
3425
  # resp.template.created_time #=> Time
@@ -3229,7 +3599,7 @@ module Aws::QuickSight
3229
3599
  # resp.theme.version.errors #=> Array
3230
3600
  # resp.theme.version.errors[0].type #=> String, one of "INTERNAL_FAILURE"
3231
3601
  # resp.theme.version.errors[0].message #=> String
3232
- # resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
3602
+ # resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3233
3603
  # resp.theme.created_time #=> Time
3234
3604
  # resp.theme.last_updated_time #=> Time
3235
3605
  # resp.theme.type #=> String, one of "QUICKSIGHT", "CUSTOM", "ALL"
@@ -3380,9 +3750,10 @@ module Aws::QuickSight
3380
3750
  req.send_request(options)
3381
3751
  end
3382
3752
 
3383
- # Generates a URL and authorization code that you can embed in your web
3384
- # server code. Before you use this command, make sure that you have
3385
- # configured the dashboards and permissions.
3753
+ # Generates a session URL and authorization code that you can use to
3754
+ # embed an Amazon QuickSight read-only dashboard in your web server
3755
+ # code. Before you use this command, make sure that you have configured
3756
+ # the dashboards and permissions.
3386
3757
  #
3387
3758
  # Currently, you can use `GetDashboardEmbedURL` only from the server,
3388
3759
  # not from the user's browser. The following rules apply to the
@@ -3396,14 +3767,12 @@ module Aws::QuickSight
3396
3767
  #
3397
3768
  # * The resulting user session is valid for 10 hours.
3398
3769
  #
3399
- # For more information, see [Embedding Amazon QuickSight Dashboards][1]
3400
- # in the *Amazon QuickSight User Guide* or [Embedding Amazon QuickSight
3401
- # Dashboards][2] in the *Amazon QuickSight API Reference*.
3770
+ # For more information, see [Embedding Amazon QuickSight][1] in the
3771
+ # *Amazon QuickSight User Guide* .
3402
3772
  #
3403
3773
  #
3404
3774
  #
3405
3775
  # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html
3406
- # [2]: https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html
3407
3776
  #
3408
3777
  # @option params [required, String] :aws_account_id
3409
3778
  # The ID for the AWS account that contains the dashboard that you're
@@ -3441,6 +3810,9 @@ module Aws::QuickSight
3441
3810
  # Federated Single Sign-On using SAML, OpenID Connect, or IAM
3442
3811
  # federation.
3443
3812
  #
3813
+ # Omit this parameter for users in the third group – IAM users and IAM
3814
+ # role-based sessions.
3815
+ #
3444
3816
  # @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3445
3817
  #
3446
3818
  # * {Types::GetDashboardEmbedUrlResponse#embed_url #embed_url} => String
@@ -3474,15 +3846,48 @@ module Aws::QuickSight
3474
3846
  req.send_request(options)
3475
3847
  end
3476
3848
 
3477
- # Generates a session URL and authorization code that you can embed in
3478
- # your web server code.
3849
+ # Generates a session URL and authorization code that you can use to
3850
+ # embed the Amazon QuickSight console in your web server code. Use
3851
+ # `GetSessionEmbedUrl` where you want to provide an authoring portal
3852
+ # that allows users to create data sources, datasets, analyses, and
3853
+ # dashboards. The users who access an embedded QuickSight console need
3854
+ # belong to the author or admin security cohort. If you want to restrict
3855
+ # permissions to some of these features, add a custom permissions
3856
+ # profile to the user with the ` UpdateUser ` API operation. Use `
3857
+ # RegisterUser ` API operation to add a new user with a custom
3858
+ # permission profile attached. For more information, see the following
3859
+ # sections in the *Amazon QuickSight User Guide*\:
3860
+ #
3861
+ # * [Embedding the Amazon QuickSight Console][1]
3862
+ #
3863
+ # * [Customizing Access to the Amazon QuickSight Console][2]
3864
+ #
3865
+ #
3866
+ #
3867
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-the-quicksight-console.html
3868
+ # [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
3479
3869
  #
3480
3870
  # @option params [required, String] :aws_account_id
3481
- # The ID for the AWS account that contains the QuickSight session that
3482
- # you're embedding.
3871
+ # The ID for the AWS account associated with your QuickSight
3872
+ # subscription.
3483
3873
  #
3484
3874
  # @option params [String] :entry_point
3485
- # The entry point for the embedded session.
3875
+ # The URL you use to access the embedded session. The entry point URL is
3876
+ # constrained to the following paths:
3877
+ #
3878
+ # * `/start`
3879
+ #
3880
+ # * `/start/analyses`
3881
+ #
3882
+ # * `/start/dashboards`
3883
+ #
3884
+ # * `/start/favorites`
3885
+ #
3886
+ # * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
3887
+ # key from the QuickSight console URL of the dashboard
3888
+ #
3889
+ # * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
3890
+ # from the QuickSight console URL of the analysis
3486
3891
  #
3487
3892
  # @option params [Integer] :session_lifetime_in_minutes
3488
3893
  # How many minutes the session is valid. The session lifetime must be
@@ -3490,17 +3895,20 @@ module Aws::QuickSight
3490
3895
  #
3491
3896
  # @option params [String] :user_arn
3492
3897
  # The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
3493
- # `QUICKSIGHT` identity type. You can use this for any Amazon QuickSight
3494
- # users in your account (readers, authors, or admins) authenticated as
3495
- # one of the following:
3898
+ # `QUICKSIGHT` identity type. You can use this for any type of Amazon
3899
+ # QuickSight users in your account (readers, authors, or admins). They
3900
+ # need to be authenticated as one of the following:
3496
3901
  #
3497
- # * Active Directory (AD) users or group members
3902
+ # 1. Active Directory (AD) users or group members
3498
3903
  #
3499
- # * Invited nonfederated users
3904
+ # 2. Invited nonfederated users
3500
3905
  #
3501
- # * IAM users and IAM role-based sessions authenticated through
3502
- # Federated Single Sign-On using SAML, OpenID Connect, or IAM
3503
- # federation.
3906
+ # 3. IAM users and IAM role-based sessions authenticated through
3907
+ # Federated Single Sign-On using SAML, OpenID Connect, or IAM
3908
+ # federation
3909
+ #
3910
+ # Omit this parameter for users in the third group – IAM users and IAM
3911
+ # role-based sessions.
3504
3912
  #
3505
3913
  # @return [Types::GetSessionEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3506
3914
  #
@@ -3532,6 +3940,57 @@ module Aws::QuickSight
3532
3940
  req.send_request(options)
3533
3941
  end
3534
3942
 
3943
+ # Lists Amazon QuickSight analyses that exist in the specified AWS
3944
+ # account.
3945
+ #
3946
+ # @option params [required, String] :aws_account_id
3947
+ # The ID of the AWS account that contains the analyses.
3948
+ #
3949
+ # @option params [String] :next_token
3950
+ # A pagination token that can be used in a subsequent request.
3951
+ #
3952
+ # @option params [Integer] :max_results
3953
+ # The maximum number of results to return.
3954
+ #
3955
+ # @return [Types::ListAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3956
+ #
3957
+ # * {Types::ListAnalysesResponse#analysis_summary_list #analysis_summary_list} => Array&lt;Types::AnalysisSummary&gt;
3958
+ # * {Types::ListAnalysesResponse#next_token #next_token} => String
3959
+ # * {Types::ListAnalysesResponse#status #status} => Integer
3960
+ # * {Types::ListAnalysesResponse#request_id #request_id} => String
3961
+ #
3962
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3963
+ #
3964
+ # @example Request syntax with placeholder values
3965
+ #
3966
+ # resp = client.list_analyses({
3967
+ # aws_account_id: "AwsAccountId", # required
3968
+ # next_token: "String",
3969
+ # max_results: 1,
3970
+ # })
3971
+ #
3972
+ # @example Response structure
3973
+ #
3974
+ # resp.analysis_summary_list #=> Array
3975
+ # resp.analysis_summary_list[0].arn #=> String
3976
+ # resp.analysis_summary_list[0].analysis_id #=> String
3977
+ # resp.analysis_summary_list[0].name #=> String
3978
+ # resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3979
+ # resp.analysis_summary_list[0].created_time #=> Time
3980
+ # resp.analysis_summary_list[0].last_updated_time #=> Time
3981
+ # resp.next_token #=> String
3982
+ # resp.status #=> Integer
3983
+ # resp.request_id #=> String
3984
+ #
3985
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalyses AWS API Documentation
3986
+ #
3987
+ # @overload list_analyses(params = {})
3988
+ # @param [Hash] params ({})
3989
+ def list_analyses(params = {}, options = {})
3990
+ req = build_request(:list_analyses, params)
3991
+ req.send_request(options)
3992
+ end
3993
+
3535
3994
  # Lists all the versions of the dashboards in the QuickSight
3536
3995
  # subscription.
3537
3996
  #
@@ -3573,7 +4032,7 @@ module Aws::QuickSight
3573
4032
  # resp.dashboard_version_summary_list[0].arn #=> String
3574
4033
  # resp.dashboard_version_summary_list[0].created_time #=> Time
3575
4034
  # resp.dashboard_version_summary_list[0].version_number #=> Integer
3576
- # resp.dashboard_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
4035
+ # 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"
3577
4036
  # resp.dashboard_version_summary_list[0].source_entity_arn #=> String
3578
4037
  # resp.dashboard_version_summary_list[0].description #=> String
3579
4038
  # resp.next_token #=> String
@@ -3737,7 +4196,7 @@ module Aws::QuickSight
3737
4196
  # resp.data_sources[0].data_source_id #=> String
3738
4197
  # resp.data_sources[0].name #=> String
3739
4198
  # 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"
3740
- # resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
4199
+ # resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3741
4200
  # resp.data_sources[0].created_time #=> Time
3742
4201
  # resp.data_sources[0].last_updated_time #=> Time
3743
4202
  # resp.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
@@ -4304,7 +4763,7 @@ module Aws::QuickSight
4304
4763
  # resp.template_version_summary_list[0].arn #=> String
4305
4764
  # resp.template_version_summary_list[0].version_number #=> Integer
4306
4765
  # resp.template_version_summary_list[0].created_time #=> Time
4307
- # resp.template_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
4766
+ # 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"
4308
4767
  # resp.template_version_summary_list[0].description #=> String
4309
4768
  # resp.next_token #=> String
4310
4769
  # resp.status #=> Integer
@@ -4461,7 +4920,7 @@ module Aws::QuickSight
4461
4920
  # resp.theme_version_summary_list[0].arn #=> String
4462
4921
  # resp.theme_version_summary_list[0].description #=> String
4463
4922
  # resp.theme_version_summary_list[0].created_time #=> Time
4464
- # resp.theme_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
4923
+ # 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"
4465
4924
  # resp.next_token #=> String
4466
4925
  # resp.status #=> Integer
4467
4926
  # resp.request_id #=> String
@@ -4713,23 +5172,31 @@ module Aws::QuickSight
4713
5172
  #
4714
5173
  # @option params [String] :custom_permissions_name
4715
5174
  # (Enterprise edition only) The name of the custom permissions profile
4716
- # that you want to assign to this user. Currently, custom permissions
4717
- # profile names are assigned to permissions profiles in the QuickSight
4718
- # console. You use this API to assign the named set of permissions to a
4719
- # QuickSight user.
5175
+ # that you want to assign to this user. Customized permissions allows
5176
+ # you to control a user's access by restricting access the following
5177
+ # operations:
5178
+ #
5179
+ # * Create and update data sources
5180
+ #
5181
+ # * Create and update datasets
4720
5182
  #
4721
- # Customizing permissions in the QuickSight UI allows you to control a
4722
- # user's access to the following operations:
5183
+ # * Create and update email reports
4723
5184
  #
4724
- # *
4725
- # *
4726
- # *
4727
- # *
5185
+ # * Subscribe to email reports
5186
+ #
5187
+ # To add custom permissions to an existing user, use ` UpdateUser `
5188
+ # instead.
5189
+ #
5190
+ # A set of custom permissions includes any combination of these
5191
+ # restrictions. Currently, you need to create the profile names for
5192
+ # custom permission sets by using the QuickSight console. Then, you use
5193
+ # the `RegisterUser` API operation to assign the named set of
5194
+ # permissions to a QuickSight user.
4728
5195
  #
4729
5196
  # QuickSight custom permissions are applied through IAM policies.
4730
5197
  # Therefore, they override the permissions typically granted by
4731
- # assigning QuickSight users to one of the default security cohorts
4732
- # (admin, author, reader) in QuickSight.
5198
+ # assigning QuickSight users to one of the default security cohorts in
5199
+ # QuickSight (admin, author, reader).
4733
5200
  #
4734
5201
  # This feature is available only to QuickSight Enterprise edition
4735
5202
  # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
@@ -4779,7 +5246,107 @@ module Aws::QuickSight
4779
5246
  req.send_request(options)
4780
5247
  end
4781
5248
 
4782
- # Searchs for dashboards that belong to a user.
5249
+ # Restores an analysis.
5250
+ #
5251
+ # @option params [required, String] :aws_account_id
5252
+ # The ID of the AWS account that contains the analysis.
5253
+ #
5254
+ # @option params [required, String] :analysis_id
5255
+ # The ID of the analysis that you're restoring.
5256
+ #
5257
+ # @return [Types::RestoreAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5258
+ #
5259
+ # * {Types::RestoreAnalysisResponse#status #status} => Integer
5260
+ # * {Types::RestoreAnalysisResponse#arn #arn} => String
5261
+ # * {Types::RestoreAnalysisResponse#analysis_id #analysis_id} => String
5262
+ # * {Types::RestoreAnalysisResponse#request_id #request_id} => String
5263
+ #
5264
+ # @example Request syntax with placeholder values
5265
+ #
5266
+ # resp = client.restore_analysis({
5267
+ # aws_account_id: "AwsAccountId", # required
5268
+ # analysis_id: "RestrictiveResourceId", # required
5269
+ # })
5270
+ #
5271
+ # @example Response structure
5272
+ #
5273
+ # resp.status #=> Integer
5274
+ # resp.arn #=> String
5275
+ # resp.analysis_id #=> String
5276
+ # resp.request_id #=> String
5277
+ #
5278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysis AWS API Documentation
5279
+ #
5280
+ # @overload restore_analysis(params = {})
5281
+ # @param [Hash] params ({})
5282
+ def restore_analysis(params = {}, options = {})
5283
+ req = build_request(:restore_analysis, params)
5284
+ req.send_request(options)
5285
+ end
5286
+
5287
+ # Searches for analyses that belong to the user specified in the filter.
5288
+ #
5289
+ # @option params [required, String] :aws_account_id
5290
+ # The ID of the AWS account that contains the analyses that you're
5291
+ # searching for.
5292
+ #
5293
+ # @option params [required, Array<Types::AnalysisSearchFilter>] :filters
5294
+ # The structure for the search filters that you want to apply to your
5295
+ # search.
5296
+ #
5297
+ # @option params [String] :next_token
5298
+ # A pagination token that can be used in a subsequent request.
5299
+ #
5300
+ # @option params [Integer] :max_results
5301
+ # The maximum number of results to return.
5302
+ #
5303
+ # @return [Types::SearchAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5304
+ #
5305
+ # * {Types::SearchAnalysesResponse#analysis_summary_list #analysis_summary_list} => Array&lt;Types::AnalysisSummary&gt;
5306
+ # * {Types::SearchAnalysesResponse#next_token #next_token} => String
5307
+ # * {Types::SearchAnalysesResponse#status #status} => Integer
5308
+ # * {Types::SearchAnalysesResponse#request_id #request_id} => String
5309
+ #
5310
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5311
+ #
5312
+ # @example Request syntax with placeholder values
5313
+ #
5314
+ # resp = client.search_analyses({
5315
+ # aws_account_id: "AwsAccountId", # required
5316
+ # filters: [ # required
5317
+ # {
5318
+ # operator: "StringEquals", # accepts StringEquals
5319
+ # name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
5320
+ # value: "String",
5321
+ # },
5322
+ # ],
5323
+ # next_token: "String",
5324
+ # max_results: 1,
5325
+ # })
5326
+ #
5327
+ # @example Response structure
5328
+ #
5329
+ # resp.analysis_summary_list #=> Array
5330
+ # resp.analysis_summary_list[0].arn #=> String
5331
+ # resp.analysis_summary_list[0].analysis_id #=> String
5332
+ # resp.analysis_summary_list[0].name #=> String
5333
+ # resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5334
+ # resp.analysis_summary_list[0].created_time #=> Time
5335
+ # resp.analysis_summary_list[0].last_updated_time #=> Time
5336
+ # resp.next_token #=> String
5337
+ # resp.status #=> Integer
5338
+ # resp.request_id #=> String
5339
+ #
5340
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalyses AWS API Documentation
5341
+ #
5342
+ # @overload search_analyses(params = {})
5343
+ # @param [Hash] params ({})
5344
+ def search_analyses(params = {}, options = {})
5345
+ req = build_request(:search_analyses, params)
5346
+ req.send_request(options)
5347
+ end
5348
+
5349
+ # Searches for dashboards that belong to a user.
4783
5350
  #
4784
5351
  # @option params [required, String] :aws_account_id
4785
5352
  # The ID of the AWS account that contains the user whose dashboards
@@ -4943,18 +5510,25 @@ module Aws::QuickSight
4943
5510
  req.send_request(options)
4944
5511
  end
4945
5512
 
4946
- # Updates customizations associated with the QuickSight subscription on
4947
- # your AWS account.
5513
+ # Updates Amazon QuickSight customizations the current AWS Region.
5514
+ # Currently, the only customization you can use is a theme.
5515
+ #
5516
+ # You can use customizations for your AWS account or, if you specify a
5517
+ # namespace, for a QuickSight namespace instead. Customizations that
5518
+ # apply to a namespace override customizations that apply to an AWS
5519
+ # account. To find out which customizations apply, use the
5520
+ # `DescribeAccountCustomization` API operation.
4948
5521
  #
4949
5522
  # @option params [required, String] :aws_account_id
4950
5523
  # The ID for the AWS account that you want to update QuickSight
4951
5524
  # customizations for.
4952
5525
  #
4953
5526
  # @option params [String] :namespace
4954
- # The namespace associated with the customization that you're updating.
5527
+ # The namespace that you want to update QuickSight customizations for.
4955
5528
  #
4956
5529
  # @option params [required, Types::AccountCustomization] :account_customization
4957
- # The customizations you want to update in QuickSight.
5530
+ # The QuickSight customizations you're updating in the current AWS
5531
+ # Region.
4958
5532
  #
4959
5533
  # @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4960
5534
  #
@@ -4991,12 +5565,11 @@ module Aws::QuickSight
4991
5565
  req.send_request(options)
4992
5566
  end
4993
5567
 
4994
- # Updates the settings for the Amazon QuickSight subscription in your
4995
- # AWS Account.
5568
+ # Updates the Amazon QuickSight settings in your AWS Account.
4996
5569
  #
4997
5570
  # @option params [required, String] :aws_account_id
4998
- # The ID for the AWS account that contains the QuickSight namespaces
4999
- # that you want to list.
5571
+ # The ID for the AWS account that contains the QuickSight settings that
5572
+ # you want to list.
5000
5573
  #
5001
5574
  # @option params [required, String] :default_namespace
5002
5575
  # The default namespace for this AWS Account. Currently, the default is
@@ -5004,8 +5577,8 @@ module Aws::QuickSight
5004
5577
  # provide an email that becomes associated with the default namespace.
5005
5578
  #
5006
5579
  # @option params [String] :notification_email
5007
- # Email address used to send notifications regarding administration of
5008
- # QuickSight.
5580
+ # The email address that you want QuickSight to send notifications to
5581
+ # regarding your AWS account or QuickSight subscription.
5009
5582
  #
5010
5583
  # @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5011
5584
  #
@@ -5034,6 +5607,172 @@ module Aws::QuickSight
5034
5607
  req.send_request(options)
5035
5608
  end
5036
5609
 
5610
+ # Updates an analysis in Amazon QuickSight
5611
+ #
5612
+ # @option params [required, String] :aws_account_id
5613
+ # The ID of the AWS account that contains the analysis that you're
5614
+ # updating.
5615
+ #
5616
+ # @option params [required, String] :analysis_id
5617
+ # The ID for the analysis that you're updating. This ID displays in the
5618
+ # URL of the analysis.
5619
+ #
5620
+ # @option params [required, String] :name
5621
+ # A descriptive name for the analysis that you're updating. This name
5622
+ # displays for the analysis in the QuickSight console.
5623
+ #
5624
+ # @option params [Types::Parameters] :parameters
5625
+ # The parameter names and override values that you want to use. An
5626
+ # analysis can have any parameter type, and some parameters might accept
5627
+ # multiple values.
5628
+ #
5629
+ # @option params [required, Types::AnalysisSourceEntity] :source_entity
5630
+ # A source entity to use for the analysis that you're updating. This
5631
+ # metadata structure contains details that describe a source template
5632
+ # and one or more datasets.
5633
+ #
5634
+ # @option params [String] :theme_arn
5635
+ # The Amazon Resource Name (ARN) for the theme to apply to the analysis
5636
+ # that you're creating. To see the theme in the QuickSight console,
5637
+ # make sure that you have access to it.
5638
+ #
5639
+ # @return [Types::UpdateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5640
+ #
5641
+ # * {Types::UpdateAnalysisResponse#arn #arn} => String
5642
+ # * {Types::UpdateAnalysisResponse#analysis_id #analysis_id} => String
5643
+ # * {Types::UpdateAnalysisResponse#update_status #update_status} => String
5644
+ # * {Types::UpdateAnalysisResponse#status #status} => Integer
5645
+ # * {Types::UpdateAnalysisResponse#request_id #request_id} => String
5646
+ #
5647
+ # @example Request syntax with placeholder values
5648
+ #
5649
+ # resp = client.update_analysis({
5650
+ # aws_account_id: "AwsAccountId", # required
5651
+ # analysis_id: "RestrictiveResourceId", # required
5652
+ # name: "AnalysisName", # required
5653
+ # parameters: {
5654
+ # string_parameters: [
5655
+ # {
5656
+ # name: "NonEmptyString", # required
5657
+ # values: ["String"], # required
5658
+ # },
5659
+ # ],
5660
+ # integer_parameters: [
5661
+ # {
5662
+ # name: "NonEmptyString", # required
5663
+ # values: [1], # required
5664
+ # },
5665
+ # ],
5666
+ # decimal_parameters: [
5667
+ # {
5668
+ # name: "NonEmptyString", # required
5669
+ # values: [1.0], # required
5670
+ # },
5671
+ # ],
5672
+ # date_time_parameters: [
5673
+ # {
5674
+ # name: "NonEmptyString", # required
5675
+ # values: [Time.now], # required
5676
+ # },
5677
+ # ],
5678
+ # },
5679
+ # source_entity: { # required
5680
+ # source_template: {
5681
+ # data_set_references: [ # required
5682
+ # {
5683
+ # data_set_placeholder: "NonEmptyString", # required
5684
+ # data_set_arn: "Arn", # required
5685
+ # },
5686
+ # ],
5687
+ # arn: "Arn", # required
5688
+ # },
5689
+ # },
5690
+ # theme_arn: "Arn",
5691
+ # })
5692
+ #
5693
+ # @example Response structure
5694
+ #
5695
+ # resp.arn #=> String
5696
+ # resp.analysis_id #=> String
5697
+ # resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5698
+ # resp.status #=> Integer
5699
+ # resp.request_id #=> String
5700
+ #
5701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysis AWS API Documentation
5702
+ #
5703
+ # @overload update_analysis(params = {})
5704
+ # @param [Hash] params ({})
5705
+ def update_analysis(params = {}, options = {})
5706
+ req = build_request(:update_analysis, params)
5707
+ req.send_request(options)
5708
+ end
5709
+
5710
+ # Updates the read and write permissions for an analysis.
5711
+ #
5712
+ # @option params [required, String] :aws_account_id
5713
+ # The ID of the AWS account that contains the analysis whose permissions
5714
+ # you're updating. You must be using the AWS account that the analysis
5715
+ # is in.
5716
+ #
5717
+ # @option params [required, String] :analysis_id
5718
+ # The ID of the analysis whose permissions you're updating. The ID is
5719
+ # part of the analysis URL.
5720
+ #
5721
+ # @option params [Array<Types::ResourcePermission>] :grant_permissions
5722
+ # A structure that describes the permissions to add and the principal to
5723
+ # add them to.
5724
+ #
5725
+ # @option params [Array<Types::ResourcePermission>] :revoke_permissions
5726
+ # A structure that describes the permissions to remove and the principal
5727
+ # to remove them from.
5728
+ #
5729
+ # @return [Types::UpdateAnalysisPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5730
+ #
5731
+ # * {Types::UpdateAnalysisPermissionsResponse#analysis_arn #analysis_arn} => String
5732
+ # * {Types::UpdateAnalysisPermissionsResponse#analysis_id #analysis_id} => String
5733
+ # * {Types::UpdateAnalysisPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
5734
+ # * {Types::UpdateAnalysisPermissionsResponse#request_id #request_id} => String
5735
+ # * {Types::UpdateAnalysisPermissionsResponse#status #status} => Integer
5736
+ #
5737
+ # @example Request syntax with placeholder values
5738
+ #
5739
+ # resp = client.update_analysis_permissions({
5740
+ # aws_account_id: "AwsAccountId", # required
5741
+ # analysis_id: "RestrictiveResourceId", # required
5742
+ # grant_permissions: [
5743
+ # {
5744
+ # principal: "Principal", # required
5745
+ # actions: ["String"], # required
5746
+ # },
5747
+ # ],
5748
+ # revoke_permissions: [
5749
+ # {
5750
+ # principal: "Principal", # required
5751
+ # actions: ["String"], # required
5752
+ # },
5753
+ # ],
5754
+ # })
5755
+ #
5756
+ # @example Response structure
5757
+ #
5758
+ # resp.analysis_arn #=> String
5759
+ # resp.analysis_id #=> String
5760
+ # resp.permissions #=> Array
5761
+ # resp.permissions[0].principal #=> String
5762
+ # resp.permissions[0].actions #=> Array
5763
+ # resp.permissions[0].actions[0] #=> String
5764
+ # resp.request_id #=> String
5765
+ # resp.status #=> Integer
5766
+ #
5767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissions AWS API Documentation
5768
+ #
5769
+ # @overload update_analysis_permissions(params = {})
5770
+ # @param [Hash] params ({})
5771
+ def update_analysis_permissions(params = {}, options = {})
5772
+ req = build_request(:update_analysis_permissions, params)
5773
+ req.send_request(options)
5774
+ end
5775
+
5037
5776
  # Updates a dashboard in an AWS account.
5038
5777
  #
5039
5778
  # @option params [required, String] :aws_account_id
@@ -5080,7 +5819,7 @@ module Aws::QuickSight
5080
5819
  #
5081
5820
  # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
5082
5821
  # either `ENABLED` or `DISABLED`. The visual option to export data to
5083
- # .csv format isn't enabled when this is set to `DISABLED`. This
5822
+ # .CSV format isn't enabled when this is set to `DISABLED`. This
5084
5823
  # option is `ENABLED` by default.
5085
5824
  #
5086
5825
  # * `VisibilityState` for `SheetControlsOption` - This visibility state
@@ -5165,7 +5904,7 @@ module Aws::QuickSight
5165
5904
  # resp.arn #=> String
5166
5905
  # resp.version_arn #=> String
5167
5906
  # resp.dashboard_id #=> String
5168
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
5907
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5169
5908
  # resp.status #=> Integer
5170
5909
  # resp.request_id #=> String
5171
5910
  #
@@ -5751,7 +6490,7 @@ module Aws::QuickSight
5751
6490
  #
5752
6491
  # resp.arn #=> String
5753
6492
  # resp.data_source_id #=> String
5754
- # resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
6493
+ # resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5755
6494
  # resp.request_id #=> String
5756
6495
  # resp.status #=> Integer
5757
6496
  #
@@ -6021,7 +6760,7 @@ module Aws::QuickSight
6021
6760
  # resp.template_id #=> String
6022
6761
  # resp.arn #=> String
6023
6762
  # resp.version_arn #=> String
6024
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
6763
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
6025
6764
  # resp.status #=> Integer
6026
6765
  # resp.request_id #=> String
6027
6766
  #
@@ -6236,7 +6975,7 @@ module Aws::QuickSight
6236
6975
  # resp.theme_id #=> String
6237
6976
  # resp.arn #=> String
6238
6977
  # resp.version_arn #=> String
6239
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
6978
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
6240
6979
  # resp.status #=> Integer
6241
6980
  # resp.request_id #=> String
6242
6981
  #
@@ -6415,8 +7154,8 @@ module Aws::QuickSight
6415
7154
  # The email address of the user that you want to update.
6416
7155
  #
6417
7156
  # @option params [required, String] :role
6418
- # The Amazon QuickSight role of the user. The user role can be one of
6419
- # the following:
7157
+ # The Amazon QuickSight role of the user. The role can be one of the
7158
+ # following default security cohorts:
6420
7159
  #
6421
7160
  # * `READER`\: A user who has read-only access to dashboards.
6422
7161
  #
@@ -6426,11 +7165,37 @@ module Aws::QuickSight
6426
7165
  # * `ADMIN`\: A user who is an author, who can also manage Amazon
6427
7166
  # QuickSight settings.
6428
7167
  #
7168
+ # The name of the QuickSight role is invisible to the user except for
7169
+ # the console screens dealing with permissions.
7170
+ #
6429
7171
  # @option params [String] :custom_permissions_name
6430
- # The name of the custom permissions profile that you want to assign to
6431
- # this user. Currently, custom permissions profile names are assigned to
6432
- # permissions profiles in the QuickSight console. You use this API to
6433
- # assign the named set of permissions to a QuickSight user.
7172
+ # (Enterprise edition only) The name of the custom permissions profile
7173
+ # that you want to assign to this user. Customized permissions allows
7174
+ # you to control a user's access by restricting access the following
7175
+ # operations:
7176
+ #
7177
+ # * Create and update data sources
7178
+ #
7179
+ # * Create and update datasets
7180
+ #
7181
+ # * Create and update email reports
7182
+ #
7183
+ # * Subscribe to email reports
7184
+ #
7185
+ # A set of custom permissions includes any combination of these
7186
+ # restrictions. Currently, you need to create the profile names for
7187
+ # custom permission sets by using the QuickSight console. Then, you use
7188
+ # the `RegisterUser` API operation to assign the named set of
7189
+ # permissions to a QuickSight user.
7190
+ #
7191
+ # QuickSight custom permissions are applied through IAM policies.
7192
+ # Therefore, they override the permissions typically granted by
7193
+ # assigning QuickSight users to one of the default security cohorts in
7194
+ # QuickSight (admin, author, reader).
7195
+ #
7196
+ # This feature is available only to QuickSight Enterprise edition
7197
+ # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
7198
+ # (SSO).
6434
7199
  #
6435
7200
  # @option params [Boolean] :unapply_custom_permissions
6436
7201
  # A flag that you use to indicate that you want to remove all custom
@@ -6492,7 +7257,7 @@ module Aws::QuickSight
6492
7257
  params: params,
6493
7258
  config: config)
6494
7259
  context[:gem_name] = 'aws-sdk-quicksight'
6495
- context[:gem_version] = '1.26.0'
7260
+ context[:gem_version] = '1.27.0'
6496
7261
  Seahorse::Client::Request.new(handlers, context)
6497
7262
  end
6498
7263