aws-sdk-quicksight 1.26.0 → 1.31.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: a8626a35f42d5e6416e9f80e40f931073b2ee5568b94ece979be9f9592420642
4
+ data.tar.gz: 1232aa89da854da6c9de05bb5f11a0ae2497fb49ba20b647565f485a3828bd8e
5
5
  SHA512:
6
- metadata.gz: bf2786ff837b06a794e9184432a0849cd2b1c9158af22f566d05f4d519007b460e90e2db86853b6c0ecad67f170aba44cbfc04ab85c39491630e5e99ca783cf0
7
- data.tar.gz: afd4503c43cdb35401ea4e996d8ca8240f5c0dd69eb03891996686fffea308ecd17fd6284dcf99c3145d1ac4f52e7251c411642f0ff3b36f078f0722e7f2c924
6
+ metadata.gz: 0ccb1c615ddc68f605bb7cd8b2bbe31d9ffdf18b80afe61fc079c703fd252414f086c0f2c60de2950dfadc94fd3503c2ffb14c6b537137ee8faa7d09eebd2bcb
7
+ data.tar.gz: 35cd8226e471c50d32ae069581dab7db3e2586179ddcd5f43bd47685fd786d505f332e946b415ad6b0b011ec982fbc73815091326f2c1af073a0b783ad0370f0
@@ -7,6 +7,7 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-quicksight/customizations'
44
45
  #
45
46
  # See {Errors} for more information.
46
47
  #
47
- # @service
48
+ # @!group service
48
49
  module Aws::QuickSight
49
50
 
50
- GEM_VERSION = '1.26.0'
51
+ GEM_VERSION = '1.31.0'
51
52
 
52
53
  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,25 +369,57 @@ module Aws::QuickSight
354
369
  req.send_request(options)
355
370
  end
356
371
 
357
- # Creates a customization for the Amazon QuickSight subscription
358
- # associated with your AWS account.
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 use the `CreateAccountCustomization` API operation to add a
386
+ # theme as the namespace default, make sure that you first share the
387
+ # theme with the namespace. If you don't share it with the namespace,
388
+ # the theme isn't visible to your users even if you make it the default
389
+ # theme. To check if the theme is shared, view the current permissions
390
+ # by using the ` DescribeThemePermissions ` API operation. To share the
391
+ # theme, grant permissions by using the ` UpdateThemePermissions ` API
392
+ # operation.
393
+ #
394
+ #
395
+ #
396
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html
359
397
  #
360
398
  # @option params [required, String] :aws_account_id
361
399
  # The ID for the AWS account that you want to customize QuickSight for.
362
400
  #
363
401
  # @option params [String] :namespace
364
- # The namespace associated with the customization that you're creating.
402
+ # The QuickSight namespace that you want to add customizations to.
365
403
  #
366
404
  # @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"`).
405
+ # The QuickSight customizations you're adding in the current AWS
406
+ # Region. You can add these to an AWS account and a QuickSight
407
+ # namespace.
408
+ #
409
+ # For example, you can add a default theme by setting
410
+ # `AccountCustomization` to the midnight theme: `"AccountCustomization":
411
+ # \{ "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" \}`. Or,
412
+ # you can add a custom theme by specifying `"AccountCustomization": \{
413
+ # "DefaultTheme":
414
+ # "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
415
+ # \}`.
416
+ #
417
+ # @option params [Array<Types::Tag>] :tags
418
+ # A list of the tags that you want to attach to this resource.
373
419
  #
374
420
  # @return [Types::CreateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
375
421
  #
422
+ # * {Types::CreateAccountCustomizationResponse#arn #arn} => String
376
423
  # * {Types::CreateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
377
424
  # * {Types::CreateAccountCustomizationResponse#namespace #namespace} => String
378
425
  # * {Types::CreateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
@@ -387,10 +434,17 @@ module Aws::QuickSight
387
434
  # account_customization: { # required
388
435
  # default_theme: "Arn",
389
436
  # },
437
+ # tags: [
438
+ # {
439
+ # key: "TagKey", # required
440
+ # value: "TagValue", # required
441
+ # },
442
+ # ],
390
443
  # })
391
444
  #
392
445
  # @example Response structure
393
446
  #
447
+ # resp.arn #=> String
394
448
  # resp.aws_account_id #=> String
395
449
  # resp.namespace #=> String
396
450
  # resp.account_customization.default_theme #=> String
@@ -406,16 +460,138 @@ module Aws::QuickSight
406
460
  req.send_request(options)
407
461
  end
408
462
 
463
+ # Creates an analysis in Amazon QuickSight.
464
+ #
465
+ # @option params [required, String] :aws_account_id
466
+ # The ID of the AWS account where you are creating an analysis.
467
+ #
468
+ # @option params [required, String] :analysis_id
469
+ # The ID for the analysis that you're creating. This ID displays in the
470
+ # URL of the analysis.
471
+ #
472
+ # @option params [required, String] :name
473
+ # A descriptive name for the analysis that you're creating. This name
474
+ # displays for the analysis in the QuickSight console.
475
+ #
476
+ # @option params [Types::Parameters] :parameters
477
+ # The parameter names and override values that you want to use. An
478
+ # analysis can have any parameter type, and some parameters might accept
479
+ # multiple values.
480
+ #
481
+ # @option params [Array<Types::ResourcePermission>] :permissions
482
+ # A structure that describes the principals and the resource-level
483
+ # permissions on an analysis. You can use the `Permissions` structure to
484
+ # grant permissions by providing a list of AWS Identity and Access
485
+ # Management (IAM) action information for each principal listed by
486
+ # Amazon Resource Name (ARN).
487
+ #
488
+ # To specify no permissions, omit `Permissions`.
489
+ #
490
+ # @option params [required, Types::AnalysisSourceEntity] :source_entity
491
+ # A source entity to use for the analysis that you're creating. This
492
+ # metadata structure contains details that describe a source template
493
+ # and one or more datasets.
494
+ #
495
+ # @option params [String] :theme_arn
496
+ # The ARN for the theme to apply to the analysis that you're creating.
497
+ # To see the theme in the QuickSight console, make sure that you have
498
+ # access to it.
499
+ #
500
+ # @option params [Array<Types::Tag>] :tags
501
+ # Contains a map of the key-value pairs for the resource tag or tags
502
+ # assigned to the analysis.
503
+ #
504
+ # @return [Types::CreateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
505
+ #
506
+ # * {Types::CreateAnalysisResponse#arn #arn} => String
507
+ # * {Types::CreateAnalysisResponse#analysis_id #analysis_id} => String
508
+ # * {Types::CreateAnalysisResponse#creation_status #creation_status} => String
509
+ # * {Types::CreateAnalysisResponse#status #status} => Integer
510
+ # * {Types::CreateAnalysisResponse#request_id #request_id} => String
511
+ #
512
+ # @example Request syntax with placeholder values
513
+ #
514
+ # resp = client.create_analysis({
515
+ # aws_account_id: "AwsAccountId", # required
516
+ # analysis_id: "RestrictiveResourceId", # required
517
+ # name: "AnalysisName", # required
518
+ # parameters: {
519
+ # string_parameters: [
520
+ # {
521
+ # name: "NonEmptyString", # required
522
+ # values: ["String"], # required
523
+ # },
524
+ # ],
525
+ # integer_parameters: [
526
+ # {
527
+ # name: "NonEmptyString", # required
528
+ # values: [1], # required
529
+ # },
530
+ # ],
531
+ # decimal_parameters: [
532
+ # {
533
+ # name: "NonEmptyString", # required
534
+ # values: [1.0], # required
535
+ # },
536
+ # ],
537
+ # date_time_parameters: [
538
+ # {
539
+ # name: "NonEmptyString", # required
540
+ # values: [Time.now], # required
541
+ # },
542
+ # ],
543
+ # },
544
+ # permissions: [
545
+ # {
546
+ # principal: "Principal", # required
547
+ # actions: ["String"], # required
548
+ # },
549
+ # ],
550
+ # source_entity: { # required
551
+ # source_template: {
552
+ # data_set_references: [ # required
553
+ # {
554
+ # data_set_placeholder: "NonEmptyString", # required
555
+ # data_set_arn: "Arn", # required
556
+ # },
557
+ # ],
558
+ # arn: "Arn", # required
559
+ # },
560
+ # },
561
+ # theme_arn: "Arn",
562
+ # tags: [
563
+ # {
564
+ # key: "TagKey", # required
565
+ # value: "TagValue", # required
566
+ # },
567
+ # ],
568
+ # })
569
+ #
570
+ # @example Response structure
571
+ #
572
+ # resp.arn #=> String
573
+ # resp.analysis_id #=> String
574
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
575
+ # resp.status #=> Integer
576
+ # resp.request_id #=> String
577
+ #
578
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysis AWS API Documentation
579
+ #
580
+ # @overload create_analysis(params = {})
581
+ # @param [Hash] params ({})
582
+ def create_analysis(params = {}, options = {})
583
+ req = build_request(:create_analysis, params)
584
+ req.send_request(options)
585
+ end
586
+
409
587
  # Creates a dashboard from a template. To first create a template, see
410
- # the CreateTemplate API operation.
588
+ # the ` CreateTemplate ` API operation.
411
589
  #
412
590
  # A dashboard is an entity in QuickSight that identifies QuickSight
413
591
  # reports, created from analyses. You can share QuickSight dashboards.
414
592
  # 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.
593
+ # from them. If you have the correct permissions, you can create a
594
+ # dashboard from a template that exists in a different AWS account.
419
595
  #
420
596
  # @option params [required, String] :aws_account_id
421
597
  # The ID of the AWS account where you want to create the dashboard.
@@ -433,8 +609,10 @@ module Aws::QuickSight
433
609
  #
434
610
  # @option params [Array<Types::ResourcePermission>] :permissions
435
611
  # A structure that contains the permissions of the dashboard. You can
436
- # use this structure for granting permissions with principal and action
437
- # information.
612
+ # use this structure for granting permissions by providing a list of IAM
613
+ # action information for each principal ARN.
614
+ #
615
+ # To specify no permissions, omit the permissions list.
438
616
  #
439
617
  # @option params [required, Types::DashboardSourceEntity] :source_entity
440
618
  # The entity that you are using as a source when you create the
@@ -469,7 +647,7 @@ module Aws::QuickSight
469
647
  #
470
648
  # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
471
649
  # either `ENABLED` or `DISABLED`. The visual option to export data to
472
- # .csv format isn't enabled when this is set to `DISABLED`. This
650
+ # .CSV format isn't enabled when this is set to `DISABLED`. This
473
651
  # option is `ENABLED` by default.
474
652
  #
475
653
  # * `VisibilityState` for `SheetControlsOption` - This visibility state
@@ -566,7 +744,7 @@ module Aws::QuickSight
566
744
  # resp.arn #=> String
567
745
  # resp.version_arn #=> String
568
746
  # 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"
747
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
570
748
  # resp.status #=> Integer
571
749
  # resp.request_id #=> String
572
750
  #
@@ -1033,7 +1211,7 @@ module Aws::QuickSight
1033
1211
  #
1034
1212
  # resp.arn #=> String
1035
1213
  # 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"
1214
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
1037
1215
  # resp.request_id #=> String
1038
1216
  # resp.status #=> Integer
1039
1217
  #
@@ -1452,7 +1630,7 @@ module Aws::QuickSight
1452
1630
  # resp.arn #=> String
1453
1631
  # resp.version_arn #=> String
1454
1632
  # 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"
1633
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
1456
1634
  # resp.status #=> Integer
1457
1635
  # resp.request_id #=> String
1458
1636
  #
@@ -1632,7 +1810,7 @@ module Aws::QuickSight
1632
1810
  # resp.arn #=> String
1633
1811
  # resp.version_arn #=> String
1634
1812
  # 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"
1813
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
1636
1814
  # resp.status #=> Integer
1637
1815
  # resp.request_id #=> String
1638
1816
  #
@@ -1694,15 +1872,16 @@ module Aws::QuickSight
1694
1872
  req.send_request(options)
1695
1873
  end
1696
1874
 
1697
- # Deletes customizations for the QuickSight subscription on your AWS
1698
- # account.
1875
+ # Deletes all Amazon QuickSight customizations in this AWS Region for
1876
+ # the specified AWS account and QuickSight namespace.
1699
1877
  #
1700
1878
  # @option params [required, String] :aws_account_id
1701
1879
  # The ID for the AWS account that you want to delete QuickSight
1702
- # customizations from.
1880
+ # customizations from in this AWS Region.
1703
1881
  #
1704
1882
  # @option params [String] :namespace
1705
- # The namespace associated with the customization that you're deleting.
1883
+ # The QuickSight namespace that you're deleting the customizations
1884
+ # from.
1706
1885
  #
1707
1886
  # @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1708
1887
  #
@@ -1730,6 +1909,74 @@ module Aws::QuickSight
1730
1909
  req.send_request(options)
1731
1910
  end
1732
1911
 
1912
+ # Deletes an analysis from Amazon QuickSight. You can optionally include
1913
+ # a recovery window during which you can restore the analysis. If you
1914
+ # don't specify a recovery window value, the operation defaults to 30
1915
+ # days. QuickSight attaches a `DeletionTime` stamp to the response that
1916
+ # specifies the end of the recovery window. At the end of the recovery
1917
+ # window, QuickSight deletes the analysis permanently.
1918
+ #
1919
+ # At any time before recovery window ends, you can use the
1920
+ # `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
1921
+ # cancel the deletion of the analysis. The analysis remains visible in
1922
+ # the API until it's deleted, so you can describe it but you can't
1923
+ # make a template from it.
1924
+ #
1925
+ # An analysis that's scheduled for deletion isn't accessible in the
1926
+ # QuickSight console. To access it in the console, restore it. Deleting
1927
+ # an analysis doesn't delete the dashboards that you publish from it.
1928
+ #
1929
+ # @option params [required, String] :aws_account_id
1930
+ # The ID of the AWS account where you want to delete an analysis.
1931
+ #
1932
+ # @option params [required, String] :analysis_id
1933
+ # The ID of the analysis that you're deleting.
1934
+ #
1935
+ # @option params [Integer] :recovery_window_in_days
1936
+ # A value that specifies the number of days that QuickSight waits before
1937
+ # it deletes the analysis. You can't use this parameter with the
1938
+ # `ForceDeleteWithoutRecovery` option in the same API call. The default
1939
+ # value is 30.
1940
+ #
1941
+ # @option params [Boolean] :force_delete_without_recovery
1942
+ # This option defaults to the value `NoForceDeleteWithoutRecovery`. To
1943
+ # immediately delete the analysis, add the `ForceDeleteWithoutRecovery`
1944
+ # option. You can't restore an analysis after it's deleted.
1945
+ #
1946
+ # @return [Types::DeleteAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1947
+ #
1948
+ # * {Types::DeleteAnalysisResponse#status #status} => Integer
1949
+ # * {Types::DeleteAnalysisResponse#arn #arn} => String
1950
+ # * {Types::DeleteAnalysisResponse#analysis_id #analysis_id} => String
1951
+ # * {Types::DeleteAnalysisResponse#deletion_time #deletion_time} => Time
1952
+ # * {Types::DeleteAnalysisResponse#request_id #request_id} => String
1953
+ #
1954
+ # @example Request syntax with placeholder values
1955
+ #
1956
+ # resp = client.delete_analysis({
1957
+ # aws_account_id: "AwsAccountId", # required
1958
+ # analysis_id: "RestrictiveResourceId", # required
1959
+ # recovery_window_in_days: 1,
1960
+ # force_delete_without_recovery: false,
1961
+ # })
1962
+ #
1963
+ # @example Response structure
1964
+ #
1965
+ # resp.status #=> Integer
1966
+ # resp.arn #=> String
1967
+ # resp.analysis_id #=> String
1968
+ # resp.deletion_time #=> Time
1969
+ # resp.request_id #=> String
1970
+ #
1971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysis AWS API Documentation
1972
+ #
1973
+ # @overload delete_analysis(params = {})
1974
+ # @param [Hash] params ({})
1975
+ def delete_analysis(params = {}, options = {})
1976
+ req = build_request(:delete_analysis, params)
1977
+ req.send_request(options)
1978
+ end
1979
+
1733
1980
  # Deletes a dashboard.
1734
1981
  #
1735
1982
  # @option params [required, String] :aws_account_id
@@ -1813,7 +2060,7 @@ module Aws::QuickSight
1813
2060
  req.send_request(options)
1814
2061
  end
1815
2062
 
1816
- # Deletes the data source permanently. This action breaks all the
2063
+ # Deletes the data source permanently. This operation breaks all the
1817
2064
  # datasets that reference the deleted data source.
1818
2065
  #
1819
2066
  # @option params [required, String] :aws_account_id
@@ -1982,7 +2229,8 @@ module Aws::QuickSight
1982
2229
  # Deletes a namespace and the users and groups that are associated with
1983
2230
  # the namespace. This is an asynchronous process. Assets including
1984
2231
  # dashboards, analyses, datasets and data sources are not deleted. To
1985
- # delete these assets, you use the APIs for the relevant asset.
2232
+ # delete these assets, you use the API operations for the relevant
2233
+ # asset.
1986
2234
  #
1987
2235
  # @option params [required, String] :aws_account_id
1988
2236
  # The ID for the AWS account that you want to delete the QuickSight
@@ -2284,23 +2532,79 @@ module Aws::QuickSight
2284
2532
  req.send_request(options)
2285
2533
  end
2286
2534
 
2287
- # Describes the customizations associated with your AWS account.
2535
+ # Describes the customizations associated with the provided AWS account
2536
+ # and Amazon QuickSight namespace in an AWS Region. The QuickSight
2537
+ # console evaluates which customizations to apply by running this API
2538
+ # operation with the `Resolved` flag included.
2539
+ #
2540
+ # To determine what customizations display when you run this command, it
2541
+ # can help to visualize the relationship of the entities involved.
2542
+ #
2543
+ # * `AWS Account` - The AWS account exists at the top of the hierarchy.
2544
+ # It has the potential to use all of the AWS Regions and AWS Services.
2545
+ # When you subscribe to QuickSight, you choose one AWS Region to use
2546
+ # as your home Region. That's where your free SPICE capacity is
2547
+ # located. You can use QuickSight in any supported AWS Region.
2548
+ #
2549
+ # * `AWS Region` - In each AWS Region where you sign in to QuickSight at
2550
+ # least once, QuickSight acts as a separate instance of the same
2551
+ # service. If you have a user directory, it resides in us-east-1,
2552
+ # which is the US East (N. Virginia). Generally speaking, these users
2553
+ # have access to QuickSight in any AWS Region, unless they are
2554
+ # constrained to a namespace.
2555
+ #
2556
+ # To run the command in a different AWS Region, you change your Region
2557
+ # settings. If you're using the AWS CLI, you can use one of the
2558
+ # following options:
2559
+ #
2560
+ # * Use [command line options][1].
2561
+ #
2562
+ # * Use [named profiles][2].
2563
+ #
2564
+ # * Run `aws configure` to change your default AWS Region. Use Enter
2565
+ # to key the same settings for your keys. For more information, see
2566
+ # [Configuring the AWS CLI][3].
2567
+ #
2568
+ # * `Namespace` - A QuickSight namespace is a partition that contains
2569
+ # users and assets (data sources, datasets, dashboards, and so on). To
2570
+ # access assets that are in a specific namespace, users and groups
2571
+ # must also be part of the same namespace. People who share a
2572
+ # namespace are completely isolated from users and assets in other
2573
+ # namespaces, even if they are in the same AWS account and AWS Region.
2574
+ #
2575
+ # * `Applied customizations` - Within an AWS Region, a set of QuickSight
2576
+ # customizations can apply to an AWS account or to a namespace.
2577
+ # Settings that you apply to a namespace override settings that you
2578
+ # apply to an AWS account. All settings are isolated to a single AWS
2579
+ # Region. To apply them in other AWS Regions, run the
2580
+ # `CreateAccountCustomization` command in each AWS Region where you
2581
+ # want to apply the same customizations.
2582
+ #
2583
+ #
2584
+ #
2585
+ # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html
2586
+ # [2]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html
2587
+ # [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
2288
2588
  #
2289
2589
  # @option params [required, String] :aws_account_id
2290
2590
  # The ID for the AWS account that you want to describe QuickSight
2291
2591
  # customizations for.
2292
2592
  #
2293
2593
  # @option params [String] :namespace
2294
- # The namespace associated with the customization that you're
2295
- # describing.
2594
+ # The QuickSight namespace that you want to describe QuickSight
2595
+ # customizations for.
2296
2596
  #
2297
2597
  # @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.
2598
+ # The `Resolved` flag works with the other parameters to determine which
2599
+ # view of QuickSight customizations is returned. You can add this flag
2600
+ # to your command to use the same view that QuickSight uses to identify
2601
+ # which customizations to apply to the console. Omit this flag, or set
2602
+ # it to `no-resolved`, to reveal customizations that are configured at
2603
+ # different levels.
2301
2604
  #
2302
2605
  # @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2303
2606
  #
2607
+ # * {Types::DescribeAccountCustomizationResponse#arn #arn} => String
2304
2608
  # * {Types::DescribeAccountCustomizationResponse#aws_account_id #aws_account_id} => String
2305
2609
  # * {Types::DescribeAccountCustomizationResponse#namespace #namespace} => String
2306
2610
  # * {Types::DescribeAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
@@ -2317,6 +2621,7 @@ module Aws::QuickSight
2317
2621
  #
2318
2622
  # @example Response structure
2319
2623
  #
2624
+ # resp.arn #=> String
2320
2625
  # resp.aws_account_id #=> String
2321
2626
  # resp.namespace #=> String
2322
2627
  # resp.account_customization.default_theme #=> String
@@ -2333,11 +2638,11 @@ module Aws::QuickSight
2333
2638
  end
2334
2639
 
2335
2640
  # Describes the settings that were used when your QuickSight
2336
- # subscription was first created in this AWS Account.
2641
+ # subscription was first created in this AWS account.
2337
2642
  #
2338
2643
  # @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.
2644
+ # The ID for the AWS account that contains the settings that you want to
2645
+ # list.
2341
2646
  #
2342
2647
  # @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2343
2648
  #
@@ -2369,6 +2674,104 @@ module Aws::QuickSight
2369
2674
  req.send_request(options)
2370
2675
  end
2371
2676
 
2677
+ # Provides a summary of the metadata for an analysis.
2678
+ #
2679
+ # @option params [required, String] :aws_account_id
2680
+ # The ID of the AWS account that contains the analysis. You must be
2681
+ # using the AWS account that the analysis is in.
2682
+ #
2683
+ # @option params [required, String] :analysis_id
2684
+ # The ID of the analysis that you're describing. The ID is part of the
2685
+ # URL of the analysis.
2686
+ #
2687
+ # @return [Types::DescribeAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2688
+ #
2689
+ # * {Types::DescribeAnalysisResponse#analysis #analysis} => Types::Analysis
2690
+ # * {Types::DescribeAnalysisResponse#status #status} => Integer
2691
+ # * {Types::DescribeAnalysisResponse#request_id #request_id} => String
2692
+ #
2693
+ # @example Request syntax with placeholder values
2694
+ #
2695
+ # resp = client.describe_analysis({
2696
+ # aws_account_id: "AwsAccountId", # required
2697
+ # analysis_id: "RestrictiveResourceId", # required
2698
+ # })
2699
+ #
2700
+ # @example Response structure
2701
+ #
2702
+ # resp.analysis.analysis_id #=> String
2703
+ # resp.analysis.arn #=> String
2704
+ # resp.analysis.name #=> String
2705
+ # resp.analysis.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2706
+ # resp.analysis.errors #=> Array
2707
+ # 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"
2708
+ # resp.analysis.errors[0].message #=> String
2709
+ # resp.analysis.data_set_arns #=> Array
2710
+ # resp.analysis.data_set_arns[0] #=> String
2711
+ # resp.analysis.theme_arn #=> String
2712
+ # resp.analysis.created_time #=> Time
2713
+ # resp.analysis.last_updated_time #=> Time
2714
+ # resp.analysis.sheets #=> Array
2715
+ # resp.analysis.sheets[0].sheet_id #=> String
2716
+ # resp.analysis.sheets[0].name #=> String
2717
+ # resp.status #=> Integer
2718
+ # resp.request_id #=> String
2719
+ #
2720
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysis AWS API Documentation
2721
+ #
2722
+ # @overload describe_analysis(params = {})
2723
+ # @param [Hash] params ({})
2724
+ def describe_analysis(params = {}, options = {})
2725
+ req = build_request(:describe_analysis, params)
2726
+ req.send_request(options)
2727
+ end
2728
+
2729
+ # Provides the read and write permissions for an analysis.
2730
+ #
2731
+ # @option params [required, String] :aws_account_id
2732
+ # The ID of the AWS account that contains the analysis whose permissions
2733
+ # you're describing. You must be using the AWS account that the
2734
+ # analysis is in.
2735
+ #
2736
+ # @option params [required, String] :analysis_id
2737
+ # The ID of the analysis whose permissions you're describing. The ID is
2738
+ # part of the analysis URL.
2739
+ #
2740
+ # @return [Types::DescribeAnalysisPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2741
+ #
2742
+ # * {Types::DescribeAnalysisPermissionsResponse#analysis_id #analysis_id} => String
2743
+ # * {Types::DescribeAnalysisPermissionsResponse#analysis_arn #analysis_arn} => String
2744
+ # * {Types::DescribeAnalysisPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
2745
+ # * {Types::DescribeAnalysisPermissionsResponse#status #status} => Integer
2746
+ # * {Types::DescribeAnalysisPermissionsResponse#request_id #request_id} => String
2747
+ #
2748
+ # @example Request syntax with placeholder values
2749
+ #
2750
+ # resp = client.describe_analysis_permissions({
2751
+ # aws_account_id: "AwsAccountId", # required
2752
+ # analysis_id: "RestrictiveResourceId", # required
2753
+ # })
2754
+ #
2755
+ # @example Response structure
2756
+ #
2757
+ # resp.analysis_id #=> String
2758
+ # resp.analysis_arn #=> String
2759
+ # resp.permissions #=> Array
2760
+ # resp.permissions[0].principal #=> String
2761
+ # resp.permissions[0].actions #=> Array
2762
+ # resp.permissions[0].actions[0] #=> String
2763
+ # resp.status #=> Integer
2764
+ # resp.request_id #=> String
2765
+ #
2766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissions AWS API Documentation
2767
+ #
2768
+ # @overload describe_analysis_permissions(params = {})
2769
+ # @param [Hash] params ({})
2770
+ def describe_analysis_permissions(params = {}, options = {})
2771
+ req = build_request(:describe_analysis_permissions, params)
2772
+ req.send_request(options)
2773
+ end
2774
+
2372
2775
  # Provides a summary for a dashboard.
2373
2776
  #
2374
2777
  # @option params [required, String] :aws_account_id
@@ -2410,12 +2813,16 @@ module Aws::QuickSight
2410
2813
  # 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
2814
  # resp.dashboard.version.errors[0].message #=> String
2412
2815
  # 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"
2816
+ # resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2414
2817
  # resp.dashboard.version.arn #=> String
2415
2818
  # resp.dashboard.version.source_entity_arn #=> String
2416
2819
  # resp.dashboard.version.data_set_arns #=> Array
2417
2820
  # resp.dashboard.version.data_set_arns[0] #=> String
2418
2821
  # resp.dashboard.version.description #=> String
2822
+ # resp.dashboard.version.theme_arn #=> String
2823
+ # resp.dashboard.version.sheets #=> Array
2824
+ # resp.dashboard.version.sheets[0].sheet_id #=> String
2825
+ # resp.dashboard.version.sheets[0].name #=> String
2419
2826
  # resp.dashboard.created_time #=> Time
2420
2827
  # resp.dashboard.last_published_time #=> Time
2421
2828
  # resp.dashboard.last_updated_time #=> Time
@@ -2649,7 +3056,7 @@ module Aws::QuickSight
2649
3056
  # resp.data_source.data_source_id #=> String
2650
3057
  # resp.data_source.name #=> String
2651
3058
  # 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"
3059
+ # resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2653
3060
  # resp.data_source.created_time #=> Time
2654
3061
  # resp.data_source.last_updated_time #=> Time
2655
3062
  # resp.data_source.data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
@@ -3034,10 +3441,10 @@ module Aws::QuickSight
3034
3441
  # resp.template.name #=> String
3035
3442
  # resp.template.version.created_time #=> Time
3036
3443
  # resp.template.version.errors #=> Array
3037
- # resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE"
3444
+ # resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "ACCESS_DENIED"
3038
3445
  # resp.template.version.errors[0].message #=> String
3039
3446
  # 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"
3447
+ # resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3041
3448
  # resp.template.version.data_set_configurations #=> Array
3042
3449
  # resp.template.version.data_set_configurations[0].placeholder #=> String
3043
3450
  # resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list #=> Array
@@ -3050,6 +3457,10 @@ module Aws::QuickSight
3050
3457
  # resp.template.version.data_set_configurations[0].column_group_schema_list[0].column_group_column_schema_list[0].name #=> String
3051
3458
  # resp.template.version.description #=> String
3052
3459
  # resp.template.version.source_entity_arn #=> String
3460
+ # resp.template.version.theme_arn #=> String
3461
+ # resp.template.version.sheets #=> Array
3462
+ # resp.template.version.sheets[0].sheet_id #=> String
3463
+ # resp.template.version.sheets[0].name #=> String
3053
3464
  # resp.template.template_id #=> String
3054
3465
  # resp.template.last_updated_time #=> Time
3055
3466
  # resp.template.created_time #=> Time
@@ -3229,7 +3640,7 @@ module Aws::QuickSight
3229
3640
  # resp.theme.version.errors #=> Array
3230
3641
  # resp.theme.version.errors[0].type #=> String, one of "INTERNAL_FAILURE"
3231
3642
  # 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"
3643
+ # resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3233
3644
  # resp.theme.created_time #=> Time
3234
3645
  # resp.theme.last_updated_time #=> Time
3235
3646
  # resp.theme.type #=> String, one of "QUICKSIGHT", "CUSTOM", "ALL"
@@ -3380,9 +3791,10 @@ module Aws::QuickSight
3380
3791
  req.send_request(options)
3381
3792
  end
3382
3793
 
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.
3794
+ # Generates a session URL and authorization code that you can use to
3795
+ # embed an Amazon QuickSight read-only dashboard in your web server
3796
+ # code. Before you use this command, make sure that you have configured
3797
+ # the dashboards and permissions.
3386
3798
  #
3387
3799
  # Currently, you can use `GetDashboardEmbedURL` only from the server,
3388
3800
  # not from the user's browser. The following rules apply to the
@@ -3396,14 +3808,12 @@ module Aws::QuickSight
3396
3808
  #
3397
3809
  # * The resulting user session is valid for 10 hours.
3398
3810
  #
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*.
3811
+ # For more information, see [Embedding Amazon QuickSight][1] in the
3812
+ # *Amazon QuickSight User Guide* .
3402
3813
  #
3403
3814
  #
3404
3815
  #
3405
3816
  # [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
3817
  #
3408
3818
  # @option params [required, String] :aws_account_id
3409
3819
  # The ID for the AWS account that contains the dashboard that you're
@@ -3441,6 +3851,9 @@ module Aws::QuickSight
3441
3851
  # Federated Single Sign-On using SAML, OpenID Connect, or IAM
3442
3852
  # federation.
3443
3853
  #
3854
+ # Omit this parameter for users in the third group – IAM users and IAM
3855
+ # role-based sessions.
3856
+ #
3444
3857
  # @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3445
3858
  #
3446
3859
  # * {Types::GetDashboardEmbedUrlResponse#embed_url #embed_url} => String
@@ -3474,15 +3887,48 @@ module Aws::QuickSight
3474
3887
  req.send_request(options)
3475
3888
  end
3476
3889
 
3477
- # Generates a session URL and authorization code that you can embed in
3478
- # your web server code.
3890
+ # Generates a session URL and authorization code that you can use to
3891
+ # embed the Amazon QuickSight console in your web server code. Use
3892
+ # `GetSessionEmbedUrl` where you want to provide an authoring portal
3893
+ # that allows users to create data sources, datasets, analyses, and
3894
+ # dashboards. The users who access an embedded QuickSight console need
3895
+ # belong to the author or admin security cohort. If you want to restrict
3896
+ # permissions to some of these features, add a custom permissions
3897
+ # profile to the user with the ` UpdateUser ` API operation. Use `
3898
+ # RegisterUser ` API operation to add a new user with a custom
3899
+ # permission profile attached. For more information, see the following
3900
+ # sections in the *Amazon QuickSight User Guide*\:
3901
+ #
3902
+ # * [Embedding the Amazon QuickSight Console][1]
3903
+ #
3904
+ # * [Customizing Access to the Amazon QuickSight Console][2]
3905
+ #
3906
+ #
3907
+ #
3908
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-the-quicksight-console.html
3909
+ # [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
3479
3910
  #
3480
3911
  # @option params [required, String] :aws_account_id
3481
- # The ID for the AWS account that contains the QuickSight session that
3482
- # you're embedding.
3912
+ # The ID for the AWS account associated with your QuickSight
3913
+ # subscription.
3483
3914
  #
3484
3915
  # @option params [String] :entry_point
3485
- # The entry point for the embedded session.
3916
+ # The URL you use to access the embedded session. The entry point URL is
3917
+ # constrained to the following paths:
3918
+ #
3919
+ # * `/start`
3920
+ #
3921
+ # * `/start/analyses`
3922
+ #
3923
+ # * `/start/dashboards`
3924
+ #
3925
+ # * `/start/favorites`
3926
+ #
3927
+ # * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
3928
+ # key from the QuickSight console URL of the dashboard
3929
+ #
3930
+ # * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
3931
+ # from the QuickSight console URL of the analysis
3486
3932
  #
3487
3933
  # @option params [Integer] :session_lifetime_in_minutes
3488
3934
  # How many minutes the session is valid. The session lifetime must be
@@ -3490,17 +3936,20 @@ module Aws::QuickSight
3490
3936
  #
3491
3937
  # @option params [String] :user_arn
3492
3938
  # 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:
3939
+ # `QUICKSIGHT` identity type. You can use this for any type of Amazon
3940
+ # QuickSight users in your account (readers, authors, or admins). They
3941
+ # need to be authenticated as one of the following:
3496
3942
  #
3497
- # * Active Directory (AD) users or group members
3943
+ # 1. Active Directory (AD) users or group members
3498
3944
  #
3499
- # * Invited nonfederated users
3945
+ # 2. Invited nonfederated users
3500
3946
  #
3501
- # * IAM users and IAM role-based sessions authenticated through
3502
- # Federated Single Sign-On using SAML, OpenID Connect, or IAM
3503
- # federation.
3947
+ # 3. IAM users and IAM role-based sessions authenticated through
3948
+ # Federated Single Sign-On using SAML, OpenID Connect, or IAM
3949
+ # federation
3950
+ #
3951
+ # Omit this parameter for users in the third group – IAM users and IAM
3952
+ # role-based sessions.
3504
3953
  #
3505
3954
  # @return [Types::GetSessionEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3506
3955
  #
@@ -3532,6 +3981,57 @@ module Aws::QuickSight
3532
3981
  req.send_request(options)
3533
3982
  end
3534
3983
 
3984
+ # Lists Amazon QuickSight analyses that exist in the specified AWS
3985
+ # account.
3986
+ #
3987
+ # @option params [required, String] :aws_account_id
3988
+ # The ID of the AWS account that contains the analyses.
3989
+ #
3990
+ # @option params [String] :next_token
3991
+ # A pagination token that can be used in a subsequent request.
3992
+ #
3993
+ # @option params [Integer] :max_results
3994
+ # The maximum number of results to return.
3995
+ #
3996
+ # @return [Types::ListAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3997
+ #
3998
+ # * {Types::ListAnalysesResponse#analysis_summary_list #analysis_summary_list} => Array&lt;Types::AnalysisSummary&gt;
3999
+ # * {Types::ListAnalysesResponse#next_token #next_token} => String
4000
+ # * {Types::ListAnalysesResponse#status #status} => Integer
4001
+ # * {Types::ListAnalysesResponse#request_id #request_id} => String
4002
+ #
4003
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4004
+ #
4005
+ # @example Request syntax with placeholder values
4006
+ #
4007
+ # resp = client.list_analyses({
4008
+ # aws_account_id: "AwsAccountId", # required
4009
+ # next_token: "String",
4010
+ # max_results: 1,
4011
+ # })
4012
+ #
4013
+ # @example Response structure
4014
+ #
4015
+ # resp.analysis_summary_list #=> Array
4016
+ # resp.analysis_summary_list[0].arn #=> String
4017
+ # resp.analysis_summary_list[0].analysis_id #=> String
4018
+ # resp.analysis_summary_list[0].name #=> String
4019
+ # resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
4020
+ # resp.analysis_summary_list[0].created_time #=> Time
4021
+ # resp.analysis_summary_list[0].last_updated_time #=> Time
4022
+ # resp.next_token #=> String
4023
+ # resp.status #=> Integer
4024
+ # resp.request_id #=> String
4025
+ #
4026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalyses AWS API Documentation
4027
+ #
4028
+ # @overload list_analyses(params = {})
4029
+ # @param [Hash] params ({})
4030
+ def list_analyses(params = {}, options = {})
4031
+ req = build_request(:list_analyses, params)
4032
+ req.send_request(options)
4033
+ end
4034
+
3535
4035
  # Lists all the versions of the dashboards in the QuickSight
3536
4036
  # subscription.
3537
4037
  #
@@ -3573,7 +4073,7 @@ module Aws::QuickSight
3573
4073
  # resp.dashboard_version_summary_list[0].arn #=> String
3574
4074
  # resp.dashboard_version_summary_list[0].created_time #=> Time
3575
4075
  # 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"
4076
+ # 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
4077
  # resp.dashboard_version_summary_list[0].source_entity_arn #=> String
3578
4078
  # resp.dashboard_version_summary_list[0].description #=> String
3579
4079
  # resp.next_token #=> String
@@ -3737,7 +4237,7 @@ module Aws::QuickSight
3737
4237
  # resp.data_sources[0].data_source_id #=> String
3738
4238
  # resp.data_sources[0].name #=> String
3739
4239
  # 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"
4240
+ # resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3741
4241
  # resp.data_sources[0].created_time #=> Time
3742
4242
  # resp.data_sources[0].last_updated_time #=> Time
3743
4243
  # resp.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
@@ -4304,7 +4804,7 @@ module Aws::QuickSight
4304
4804
  # resp.template_version_summary_list[0].arn #=> String
4305
4805
  # resp.template_version_summary_list[0].version_number #=> Integer
4306
4806
  # 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"
4807
+ # 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
4808
  # resp.template_version_summary_list[0].description #=> String
4309
4809
  # resp.next_token #=> String
4310
4810
  # resp.status #=> Integer
@@ -4461,7 +4961,7 @@ module Aws::QuickSight
4461
4961
  # resp.theme_version_summary_list[0].arn #=> String
4462
4962
  # resp.theme_version_summary_list[0].description #=> String
4463
4963
  # 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"
4964
+ # 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
4965
  # resp.next_token #=> String
4466
4966
  # resp.status #=> Integer
4467
4967
  # resp.request_id #=> String
@@ -4713,23 +5213,31 @@ module Aws::QuickSight
4713
5213
  #
4714
5214
  # @option params [String] :custom_permissions_name
4715
5215
  # (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.
5216
+ # that you want to assign to this user. Customized permissions allows
5217
+ # you to control a user's access by restricting access the following
5218
+ # operations:
4720
5219
  #
4721
- # Customizing permissions in the QuickSight UI allows you to control a
4722
- # user's access to the following operations:
5220
+ # * Create and update data sources
4723
5221
  #
4724
- # *
4725
- # *
4726
- # *
4727
- # *
5222
+ # * Create and update datasets
5223
+ #
5224
+ # * Create and update email reports
5225
+ #
5226
+ # * Subscribe to email reports
5227
+ #
5228
+ # To add custom permissions to an existing user, use ` UpdateUser `
5229
+ # instead.
5230
+ #
5231
+ # A set of custom permissions includes any combination of these
5232
+ # restrictions. Currently, you need to create the profile names for
5233
+ # custom permission sets by using the QuickSight console. Then, you use
5234
+ # the `RegisterUser` API operation to assign the named set of
5235
+ # permissions to a QuickSight user.
4728
5236
  #
4729
5237
  # QuickSight custom permissions are applied through IAM policies.
4730
5238
  # 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.
5239
+ # assigning QuickSight users to one of the default security cohorts in
5240
+ # QuickSight (admin, author, reader).
4733
5241
  #
4734
5242
  # This feature is available only to QuickSight Enterprise edition
4735
5243
  # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
@@ -4779,7 +5287,107 @@ module Aws::QuickSight
4779
5287
  req.send_request(options)
4780
5288
  end
4781
5289
 
4782
- # Searchs for dashboards that belong to a user.
5290
+ # Restores an analysis.
5291
+ #
5292
+ # @option params [required, String] :aws_account_id
5293
+ # The ID of the AWS account that contains the analysis.
5294
+ #
5295
+ # @option params [required, String] :analysis_id
5296
+ # The ID of the analysis that you're restoring.
5297
+ #
5298
+ # @return [Types::RestoreAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5299
+ #
5300
+ # * {Types::RestoreAnalysisResponse#status #status} => Integer
5301
+ # * {Types::RestoreAnalysisResponse#arn #arn} => String
5302
+ # * {Types::RestoreAnalysisResponse#analysis_id #analysis_id} => String
5303
+ # * {Types::RestoreAnalysisResponse#request_id #request_id} => String
5304
+ #
5305
+ # @example Request syntax with placeholder values
5306
+ #
5307
+ # resp = client.restore_analysis({
5308
+ # aws_account_id: "AwsAccountId", # required
5309
+ # analysis_id: "RestrictiveResourceId", # required
5310
+ # })
5311
+ #
5312
+ # @example Response structure
5313
+ #
5314
+ # resp.status #=> Integer
5315
+ # resp.arn #=> String
5316
+ # resp.analysis_id #=> String
5317
+ # resp.request_id #=> String
5318
+ #
5319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysis AWS API Documentation
5320
+ #
5321
+ # @overload restore_analysis(params = {})
5322
+ # @param [Hash] params ({})
5323
+ def restore_analysis(params = {}, options = {})
5324
+ req = build_request(:restore_analysis, params)
5325
+ req.send_request(options)
5326
+ end
5327
+
5328
+ # Searches for analyses that belong to the user specified in the filter.
5329
+ #
5330
+ # @option params [required, String] :aws_account_id
5331
+ # The ID of the AWS account that contains the analyses that you're
5332
+ # searching for.
5333
+ #
5334
+ # @option params [required, Array<Types::AnalysisSearchFilter>] :filters
5335
+ # The structure for the search filters that you want to apply to your
5336
+ # search.
5337
+ #
5338
+ # @option params [String] :next_token
5339
+ # A pagination token that can be used in a subsequent request.
5340
+ #
5341
+ # @option params [Integer] :max_results
5342
+ # The maximum number of results to return.
5343
+ #
5344
+ # @return [Types::SearchAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5345
+ #
5346
+ # * {Types::SearchAnalysesResponse#analysis_summary_list #analysis_summary_list} => Array&lt;Types::AnalysisSummary&gt;
5347
+ # * {Types::SearchAnalysesResponse#next_token #next_token} => String
5348
+ # * {Types::SearchAnalysesResponse#status #status} => Integer
5349
+ # * {Types::SearchAnalysesResponse#request_id #request_id} => String
5350
+ #
5351
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5352
+ #
5353
+ # @example Request syntax with placeholder values
5354
+ #
5355
+ # resp = client.search_analyses({
5356
+ # aws_account_id: "AwsAccountId", # required
5357
+ # filters: [ # required
5358
+ # {
5359
+ # operator: "StringEquals", # accepts StringEquals
5360
+ # name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
5361
+ # value: "String",
5362
+ # },
5363
+ # ],
5364
+ # next_token: "String",
5365
+ # max_results: 1,
5366
+ # })
5367
+ #
5368
+ # @example Response structure
5369
+ #
5370
+ # resp.analysis_summary_list #=> Array
5371
+ # resp.analysis_summary_list[0].arn #=> String
5372
+ # resp.analysis_summary_list[0].analysis_id #=> String
5373
+ # resp.analysis_summary_list[0].name #=> String
5374
+ # resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5375
+ # resp.analysis_summary_list[0].created_time #=> Time
5376
+ # resp.analysis_summary_list[0].last_updated_time #=> Time
5377
+ # resp.next_token #=> String
5378
+ # resp.status #=> Integer
5379
+ # resp.request_id #=> String
5380
+ #
5381
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalyses AWS API Documentation
5382
+ #
5383
+ # @overload search_analyses(params = {})
5384
+ # @param [Hash] params ({})
5385
+ def search_analyses(params = {}, options = {})
5386
+ req = build_request(:search_analyses, params)
5387
+ req.send_request(options)
5388
+ end
5389
+
5390
+ # Searches for dashboards that belong to a user.
4783
5391
  #
4784
5392
  # @option params [required, String] :aws_account_id
4785
5393
  # The ID of the AWS account that contains the user whose dashboards
@@ -4943,21 +5551,29 @@ module Aws::QuickSight
4943
5551
  req.send_request(options)
4944
5552
  end
4945
5553
 
4946
- # Updates customizations associated with the QuickSight subscription on
4947
- # your AWS account.
5554
+ # Updates Amazon QuickSight customizations the current AWS Region.
5555
+ # Currently, the only customization you can use is a theme.
5556
+ #
5557
+ # You can use customizations for your AWS account or, if you specify a
5558
+ # namespace, for a QuickSight namespace instead. Customizations that
5559
+ # apply to a namespace override customizations that apply to an AWS
5560
+ # account. To find out which customizations apply, use the
5561
+ # `DescribeAccountCustomization` API operation.
4948
5562
  #
4949
5563
  # @option params [required, String] :aws_account_id
4950
5564
  # The ID for the AWS account that you want to update QuickSight
4951
5565
  # customizations for.
4952
5566
  #
4953
5567
  # @option params [String] :namespace
4954
- # The namespace associated with the customization that you're updating.
5568
+ # The namespace that you want to update QuickSight customizations for.
4955
5569
  #
4956
5570
  # @option params [required, Types::AccountCustomization] :account_customization
4957
- # The customizations you want to update in QuickSight.
5571
+ # The QuickSight customizations you're updating in the current AWS
5572
+ # Region.
4958
5573
  #
4959
5574
  # @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4960
5575
  #
5576
+ # * {Types::UpdateAccountCustomizationResponse#arn #arn} => String
4961
5577
  # * {Types::UpdateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
4962
5578
  # * {Types::UpdateAccountCustomizationResponse#namespace #namespace} => String
4963
5579
  # * {Types::UpdateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
@@ -4976,6 +5592,7 @@ module Aws::QuickSight
4976
5592
  #
4977
5593
  # @example Response structure
4978
5594
  #
5595
+ # resp.arn #=> String
4979
5596
  # resp.aws_account_id #=> String
4980
5597
  # resp.namespace #=> String
4981
5598
  # resp.account_customization.default_theme #=> String
@@ -4991,21 +5608,21 @@ module Aws::QuickSight
4991
5608
  req.send_request(options)
4992
5609
  end
4993
5610
 
4994
- # Updates the settings for the Amazon QuickSight subscription in your
4995
- # AWS Account.
5611
+ # Updates the Amazon QuickSight settings in your AWS account.
4996
5612
  #
4997
5613
  # @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.
5614
+ # The ID for the AWS account that contains the QuickSight settings that
5615
+ # you want to list.
5000
5616
  #
5001
5617
  # @option params [required, String] :default_namespace
5002
- # The default namespace for this AWS Account. Currently, the default is
5003
- # `default`. IAM users who register for the first time with QuickSight
5004
- # provide an email that becomes associated with the default namespace.
5618
+ # The default namespace for this AWS account. Currently, the default is
5619
+ # `default`. AWS Identity and Access Management (IAM) users that
5620
+ # register for the first time with QuickSight provide an email that
5621
+ # becomes associated with the default namespace.
5005
5622
  #
5006
5623
  # @option params [String] :notification_email
5007
- # Email address used to send notifications regarding administration of
5008
- # QuickSight.
5624
+ # The email address that you want QuickSight to send notifications to
5625
+ # regarding your AWS account or QuickSight subscription.
5009
5626
  #
5010
5627
  # @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5011
5628
  #
@@ -5034,6 +5651,172 @@ module Aws::QuickSight
5034
5651
  req.send_request(options)
5035
5652
  end
5036
5653
 
5654
+ # Updates an analysis in Amazon QuickSight
5655
+ #
5656
+ # @option params [required, String] :aws_account_id
5657
+ # The ID of the AWS account that contains the analysis that you're
5658
+ # updating.
5659
+ #
5660
+ # @option params [required, String] :analysis_id
5661
+ # The ID for the analysis that you're updating. This ID displays in the
5662
+ # URL of the analysis.
5663
+ #
5664
+ # @option params [required, String] :name
5665
+ # A descriptive name for the analysis that you're updating. This name
5666
+ # displays for the analysis in the QuickSight console.
5667
+ #
5668
+ # @option params [Types::Parameters] :parameters
5669
+ # The parameter names and override values that you want to use. An
5670
+ # analysis can have any parameter type, and some parameters might accept
5671
+ # multiple values.
5672
+ #
5673
+ # @option params [required, Types::AnalysisSourceEntity] :source_entity
5674
+ # A source entity to use for the analysis that you're updating. This
5675
+ # metadata structure contains details that describe a source template
5676
+ # and one or more datasets.
5677
+ #
5678
+ # @option params [String] :theme_arn
5679
+ # The Amazon Resource Name (ARN) for the theme to apply to the analysis
5680
+ # that you're creating. To see the theme in the QuickSight console,
5681
+ # make sure that you have access to it.
5682
+ #
5683
+ # @return [Types::UpdateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5684
+ #
5685
+ # * {Types::UpdateAnalysisResponse#arn #arn} => String
5686
+ # * {Types::UpdateAnalysisResponse#analysis_id #analysis_id} => String
5687
+ # * {Types::UpdateAnalysisResponse#update_status #update_status} => String
5688
+ # * {Types::UpdateAnalysisResponse#status #status} => Integer
5689
+ # * {Types::UpdateAnalysisResponse#request_id #request_id} => String
5690
+ #
5691
+ # @example Request syntax with placeholder values
5692
+ #
5693
+ # resp = client.update_analysis({
5694
+ # aws_account_id: "AwsAccountId", # required
5695
+ # analysis_id: "RestrictiveResourceId", # required
5696
+ # name: "AnalysisName", # required
5697
+ # parameters: {
5698
+ # string_parameters: [
5699
+ # {
5700
+ # name: "NonEmptyString", # required
5701
+ # values: ["String"], # required
5702
+ # },
5703
+ # ],
5704
+ # integer_parameters: [
5705
+ # {
5706
+ # name: "NonEmptyString", # required
5707
+ # values: [1], # required
5708
+ # },
5709
+ # ],
5710
+ # decimal_parameters: [
5711
+ # {
5712
+ # name: "NonEmptyString", # required
5713
+ # values: [1.0], # required
5714
+ # },
5715
+ # ],
5716
+ # date_time_parameters: [
5717
+ # {
5718
+ # name: "NonEmptyString", # required
5719
+ # values: [Time.now], # required
5720
+ # },
5721
+ # ],
5722
+ # },
5723
+ # source_entity: { # required
5724
+ # source_template: {
5725
+ # data_set_references: [ # required
5726
+ # {
5727
+ # data_set_placeholder: "NonEmptyString", # required
5728
+ # data_set_arn: "Arn", # required
5729
+ # },
5730
+ # ],
5731
+ # arn: "Arn", # required
5732
+ # },
5733
+ # },
5734
+ # theme_arn: "Arn",
5735
+ # })
5736
+ #
5737
+ # @example Response structure
5738
+ #
5739
+ # resp.arn #=> String
5740
+ # resp.analysis_id #=> String
5741
+ # resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5742
+ # resp.status #=> Integer
5743
+ # resp.request_id #=> String
5744
+ #
5745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysis AWS API Documentation
5746
+ #
5747
+ # @overload update_analysis(params = {})
5748
+ # @param [Hash] params ({})
5749
+ def update_analysis(params = {}, options = {})
5750
+ req = build_request(:update_analysis, params)
5751
+ req.send_request(options)
5752
+ end
5753
+
5754
+ # Updates the read and write permissions for an analysis.
5755
+ #
5756
+ # @option params [required, String] :aws_account_id
5757
+ # The ID of the AWS account that contains the analysis whose permissions
5758
+ # you're updating. You must be using the AWS account that the analysis
5759
+ # is in.
5760
+ #
5761
+ # @option params [required, String] :analysis_id
5762
+ # The ID of the analysis whose permissions you're updating. The ID is
5763
+ # part of the analysis URL.
5764
+ #
5765
+ # @option params [Array<Types::ResourcePermission>] :grant_permissions
5766
+ # A structure that describes the permissions to add and the principal to
5767
+ # add them to.
5768
+ #
5769
+ # @option params [Array<Types::ResourcePermission>] :revoke_permissions
5770
+ # A structure that describes the permissions to remove and the principal
5771
+ # to remove them from.
5772
+ #
5773
+ # @return [Types::UpdateAnalysisPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5774
+ #
5775
+ # * {Types::UpdateAnalysisPermissionsResponse#analysis_arn #analysis_arn} => String
5776
+ # * {Types::UpdateAnalysisPermissionsResponse#analysis_id #analysis_id} => String
5777
+ # * {Types::UpdateAnalysisPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
5778
+ # * {Types::UpdateAnalysisPermissionsResponse#request_id #request_id} => String
5779
+ # * {Types::UpdateAnalysisPermissionsResponse#status #status} => Integer
5780
+ #
5781
+ # @example Request syntax with placeholder values
5782
+ #
5783
+ # resp = client.update_analysis_permissions({
5784
+ # aws_account_id: "AwsAccountId", # required
5785
+ # analysis_id: "RestrictiveResourceId", # required
5786
+ # grant_permissions: [
5787
+ # {
5788
+ # principal: "Principal", # required
5789
+ # actions: ["String"], # required
5790
+ # },
5791
+ # ],
5792
+ # revoke_permissions: [
5793
+ # {
5794
+ # principal: "Principal", # required
5795
+ # actions: ["String"], # required
5796
+ # },
5797
+ # ],
5798
+ # })
5799
+ #
5800
+ # @example Response structure
5801
+ #
5802
+ # resp.analysis_arn #=> String
5803
+ # resp.analysis_id #=> String
5804
+ # resp.permissions #=> Array
5805
+ # resp.permissions[0].principal #=> String
5806
+ # resp.permissions[0].actions #=> Array
5807
+ # resp.permissions[0].actions[0] #=> String
5808
+ # resp.request_id #=> String
5809
+ # resp.status #=> Integer
5810
+ #
5811
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissions AWS API Documentation
5812
+ #
5813
+ # @overload update_analysis_permissions(params = {})
5814
+ # @param [Hash] params ({})
5815
+ def update_analysis_permissions(params = {}, options = {})
5816
+ req = build_request(:update_analysis_permissions, params)
5817
+ req.send_request(options)
5818
+ end
5819
+
5037
5820
  # Updates a dashboard in an AWS account.
5038
5821
  #
5039
5822
  # @option params [required, String] :aws_account_id
@@ -5080,7 +5863,7 @@ module Aws::QuickSight
5080
5863
  #
5081
5864
  # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
5082
5865
  # either `ENABLED` or `DISABLED`. The visual option to export data to
5083
- # .csv format isn't enabled when this is set to `DISABLED`. This
5866
+ # .CSV format isn't enabled when this is set to `DISABLED`. This
5084
5867
  # option is `ENABLED` by default.
5085
5868
  #
5086
5869
  # * `VisibilityState` for `SheetControlsOption` - This visibility state
@@ -5165,7 +5948,7 @@ module Aws::QuickSight
5165
5948
  # resp.arn #=> String
5166
5949
  # resp.version_arn #=> String
5167
5950
  # 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"
5951
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5169
5952
  # resp.status #=> Integer
5170
5953
  # resp.request_id #=> String
5171
5954
  #
@@ -5751,7 +6534,7 @@ module Aws::QuickSight
5751
6534
  #
5752
6535
  # resp.arn #=> String
5753
6536
  # 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"
6537
+ # resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5755
6538
  # resp.request_id #=> String
5756
6539
  # resp.status #=> Integer
5757
6540
  #
@@ -6021,7 +6804,7 @@ module Aws::QuickSight
6021
6804
  # resp.template_id #=> String
6022
6805
  # resp.arn #=> String
6023
6806
  # 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"
6807
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
6025
6808
  # resp.status #=> Integer
6026
6809
  # resp.request_id #=> String
6027
6810
  #
@@ -6236,7 +7019,7 @@ module Aws::QuickSight
6236
7019
  # resp.theme_id #=> String
6237
7020
  # resp.arn #=> String
6238
7021
  # 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"
7022
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
6240
7023
  # resp.status #=> Integer
6241
7024
  # resp.request_id #=> String
6242
7025
  #
@@ -6415,8 +7198,8 @@ module Aws::QuickSight
6415
7198
  # The email address of the user that you want to update.
6416
7199
  #
6417
7200
  # @option params [required, String] :role
6418
- # The Amazon QuickSight role of the user. The user role can be one of
6419
- # the following:
7201
+ # The Amazon QuickSight role of the user. The role can be one of the
7202
+ # following default security cohorts:
6420
7203
  #
6421
7204
  # * `READER`\: A user who has read-only access to dashboards.
6422
7205
  #
@@ -6426,11 +7209,37 @@ module Aws::QuickSight
6426
7209
  # * `ADMIN`\: A user who is an author, who can also manage Amazon
6427
7210
  # QuickSight settings.
6428
7211
  #
7212
+ # The name of the QuickSight role is invisible to the user except for
7213
+ # the console screens dealing with permissions.
7214
+ #
6429
7215
  # @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.
7216
+ # (Enterprise edition only) The name of the custom permissions profile
7217
+ # that you want to assign to this user. Customized permissions allows
7218
+ # you to control a user's access by restricting access the following
7219
+ # operations:
7220
+ #
7221
+ # * Create and update data sources
7222
+ #
7223
+ # * Create and update datasets
7224
+ #
7225
+ # * Create and update email reports
7226
+ #
7227
+ # * Subscribe to email reports
7228
+ #
7229
+ # A set of custom permissions includes any combination of these
7230
+ # restrictions. Currently, you need to create the profile names for
7231
+ # custom permission sets by using the QuickSight console. Then, you use
7232
+ # the `RegisterUser` API operation to assign the named set of
7233
+ # permissions to a QuickSight user.
7234
+ #
7235
+ # QuickSight custom permissions are applied through IAM policies.
7236
+ # Therefore, they override the permissions typically granted by
7237
+ # assigning QuickSight users to one of the default security cohorts in
7238
+ # QuickSight (admin, author, reader).
7239
+ #
7240
+ # This feature is available only to QuickSight Enterprise edition
7241
+ # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
7242
+ # (SSO).
6434
7243
  #
6435
7244
  # @option params [Boolean] :unapply_custom_permissions
6436
7245
  # A flag that you use to indicate that you want to remove all custom
@@ -6492,7 +7301,7 @@ module Aws::QuickSight
6492
7301
  params: params,
6493
7302
  config: config)
6494
7303
  context[:gem_name] = 'aws-sdk-quicksight'
6495
- context[:gem_version] = '1.26.0'
7304
+ context[:gem_version] = '1.31.0'
6496
7305
  Seahorse::Client::Request.new(handlers, context)
6497
7306
  end
6498
7307