aws-sdk-quicksight 1.25.0 → 1.30.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: 73ec87a9d50b097049e6c8d8db9fe235405b7c155906e924d2d394d6dda9e599
4
- data.tar.gz: e77307603a389ee14d809fef1d7390b6b8a083d2046f44709e9ab23e410cc846
3
+ metadata.gz: 4799057a0299859ccfd78a7abbc20384e0b23e4d744f132934415cef61d0266a
4
+ data.tar.gz: 5de632113dd28ab396ab21b4e6c17d2a94a9e98e3f4abc21380a021a0c434a81
5
5
  SHA512:
6
- metadata.gz: 70bff9cd8f5c2d7c3341694a868e2770894ba593aed271b9d9c1fd79a2f1d215107e4ad3173d9c6a28cf3a3c7b029a9d06cbee465b7a3bcdffce33d8486027fa
7
- data.tar.gz: ddc03901ed4669c282032f949203a48c79b0307c79e7481083c9a4fb27cf4e2d310ccb1ec6fccc74ec96f2a3e55374e28645224377e4ad1af80ddb4b802203ea
6
+ metadata.gz: 71db17e4f9fe8fb1bea3147106cf2f38dd481d0f9a08b32614f62a253a5d5ec2a554d844de88480f847af81d56a6d5c4b652c8fdcb1e5362b8e35473153e30c0
7
+ data.tar.gz: d0e37de65f40a6fe6651ce641efa4fd89cc463df9ad796d85075f312834f34bbf2a3585ffba280ebc3a25302d9ecff6f8e20bde81eb9057376c0cde254c484dc
@@ -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.25.0'
51
+ GEM_VERSION = '1.30.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,16 +369,225 @@ module Aws::QuickSight
354
369
  req.send_request(options)
355
370
  end
356
371
 
372
+ # Creates Amazon QuickSight customizations the current AWS Region.
373
+ # Currently, you can add a custom default theme by using the
374
+ # `CreateAccountCustomization` or `UpdateAccountCustomization` API
375
+ # operation. To further customize QuickSight by removing QuickSight
376
+ # sample assets and videos for all new users, see [Customizing
377
+ # QuickSight][1] in the Amazon QuickSight User Guide.
378
+ #
379
+ # You can create customizations for your AWS account or, if you specify
380
+ # a namespace, for a QuickSight namespace instead. Customizations that
381
+ # apply to a namespace always override customizations that apply to an
382
+ # AWS account. To find out which customizations apply, use the
383
+ # `DescribeAccountCustomization` API operation.
384
+ #
385
+ # Before you add a theme as the namespace default, make sure that you
386
+ # first share the theme with the namespace. If you don't share it with
387
+ # the namespace, the theme won't be visible to your users even if you
388
+ # use this API operation to make it the default theme.
389
+ #
390
+ #
391
+ #
392
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html
393
+ #
394
+ # @option params [required, String] :aws_account_id
395
+ # The ID for the AWS account that you want to customize QuickSight for.
396
+ #
397
+ # @option params [String] :namespace
398
+ # The QuickSight namespace that you want to add customizations to.
399
+ #
400
+ # @option params [required, Types::AccountCustomization] :account_customization
401
+ # The QuickSight customizations you're adding in the current AWS
402
+ # Region. You can add these to an AWS account and a QuickSight
403
+ # namespace.
404
+ #
405
+ # For example, you could add a default theme by setting
406
+ # `AccountCustomization` to the midnight theme: `"AccountCustomization":
407
+ # \{ "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" \}. `. Or,
408
+ # you could add a custom theme by specifying `"AccountCustomization": \{
409
+ # "DefaultTheme":
410
+ # "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
411
+ # \}`.
412
+ #
413
+ # @option params [Array<Types::Tag>] :tags
414
+ # A list of the tags that you want to attach to this resource.
415
+ #
416
+ # @return [Types::CreateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
417
+ #
418
+ # * {Types::CreateAccountCustomizationResponse#arn #arn} => String
419
+ # * {Types::CreateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
420
+ # * {Types::CreateAccountCustomizationResponse#namespace #namespace} => String
421
+ # * {Types::CreateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
422
+ # * {Types::CreateAccountCustomizationResponse#request_id #request_id} => String
423
+ # * {Types::CreateAccountCustomizationResponse#status #status} => Integer
424
+ #
425
+ # @example Request syntax with placeholder values
426
+ #
427
+ # resp = client.create_account_customization({
428
+ # aws_account_id: "AwsAccountId", # required
429
+ # namespace: "Namespace",
430
+ # account_customization: { # required
431
+ # default_theme: "Arn",
432
+ # },
433
+ # tags: [
434
+ # {
435
+ # key: "TagKey", # required
436
+ # value: "TagValue", # required
437
+ # },
438
+ # ],
439
+ # })
440
+ #
441
+ # @example Response structure
442
+ #
443
+ # resp.arn #=> String
444
+ # resp.aws_account_id #=> String
445
+ # resp.namespace #=> String
446
+ # resp.account_customization.default_theme #=> String
447
+ # resp.request_id #=> String
448
+ # resp.status #=> Integer
449
+ #
450
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAccountCustomization AWS API Documentation
451
+ #
452
+ # @overload create_account_customization(params = {})
453
+ # @param [Hash] params ({})
454
+ def create_account_customization(params = {}, options = {})
455
+ req = build_request(:create_account_customization, params)
456
+ req.send_request(options)
457
+ end
458
+
459
+ # Creates an analysis in Amazon QuickSight.
460
+ #
461
+ # @option params [required, String] :aws_account_id
462
+ # The ID of the AWS account where you are creating an analysis.
463
+ #
464
+ # @option params [required, String] :analysis_id
465
+ # The ID for the analysis that you're creating. This ID displays in the
466
+ # URL of the analysis.
467
+ #
468
+ # @option params [required, String] :name
469
+ # A descriptive name for the analysis that you're creating. This name
470
+ # displays for the analysis in the QuickSight console.
471
+ #
472
+ # @option params [Types::Parameters] :parameters
473
+ # The parameter names and override values that you want to use. An
474
+ # analysis can have any parameter type, and some parameters might accept
475
+ # multiple values.
476
+ #
477
+ # @option params [Array<Types::ResourcePermission>] :permissions
478
+ # A structure that describes the principals and the resource-level
479
+ # permissions on an analysis. You can use the `Permissions` structure to
480
+ # grant permissions by providing a list of AWS Identity and Access
481
+ # Management (IAM) action information for each principal listed by
482
+ # Amazon Resource Name (ARN).
483
+ #
484
+ # To specify no permissions, omit `Permissions`.
485
+ #
486
+ # @option params [required, Types::AnalysisSourceEntity] :source_entity
487
+ # A source entity to use for the analysis that you're creating. This
488
+ # metadata structure contains details that describe a source template
489
+ # and one or more datasets.
490
+ #
491
+ # @option params [String] :theme_arn
492
+ # The ARN for the theme to apply to the analysis that you're creating.
493
+ # To see the theme in the QuickSight console, make sure that you have
494
+ # access to it.
495
+ #
496
+ # @option params [Array<Types::Tag>] :tags
497
+ # Contains a map of the key-value pairs for the resource tag or tags
498
+ # assigned to the analysis.
499
+ #
500
+ # @return [Types::CreateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
501
+ #
502
+ # * {Types::CreateAnalysisResponse#arn #arn} => String
503
+ # * {Types::CreateAnalysisResponse#analysis_id #analysis_id} => String
504
+ # * {Types::CreateAnalysisResponse#creation_status #creation_status} => String
505
+ # * {Types::CreateAnalysisResponse#status #status} => Integer
506
+ # * {Types::CreateAnalysisResponse#request_id #request_id} => String
507
+ #
508
+ # @example Request syntax with placeholder values
509
+ #
510
+ # resp = client.create_analysis({
511
+ # aws_account_id: "AwsAccountId", # required
512
+ # analysis_id: "RestrictiveResourceId", # required
513
+ # name: "AnalysisName", # required
514
+ # parameters: {
515
+ # string_parameters: [
516
+ # {
517
+ # name: "NonEmptyString", # required
518
+ # values: ["String"], # required
519
+ # },
520
+ # ],
521
+ # integer_parameters: [
522
+ # {
523
+ # name: "NonEmptyString", # required
524
+ # values: [1], # required
525
+ # },
526
+ # ],
527
+ # decimal_parameters: [
528
+ # {
529
+ # name: "NonEmptyString", # required
530
+ # values: [1.0], # required
531
+ # },
532
+ # ],
533
+ # date_time_parameters: [
534
+ # {
535
+ # name: "NonEmptyString", # required
536
+ # values: [Time.now], # required
537
+ # },
538
+ # ],
539
+ # },
540
+ # permissions: [
541
+ # {
542
+ # principal: "Principal", # required
543
+ # actions: ["String"], # required
544
+ # },
545
+ # ],
546
+ # source_entity: { # required
547
+ # source_template: {
548
+ # data_set_references: [ # required
549
+ # {
550
+ # data_set_placeholder: "NonEmptyString", # required
551
+ # data_set_arn: "Arn", # required
552
+ # },
553
+ # ],
554
+ # arn: "Arn", # required
555
+ # },
556
+ # },
557
+ # theme_arn: "Arn",
558
+ # tags: [
559
+ # {
560
+ # key: "TagKey", # required
561
+ # value: "TagValue", # required
562
+ # },
563
+ # ],
564
+ # })
565
+ #
566
+ # @example Response structure
567
+ #
568
+ # resp.arn #=> String
569
+ # resp.analysis_id #=> String
570
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
571
+ # resp.status #=> Integer
572
+ # resp.request_id #=> String
573
+ #
574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateAnalysis AWS API Documentation
575
+ #
576
+ # @overload create_analysis(params = {})
577
+ # @param [Hash] params ({})
578
+ def create_analysis(params = {}, options = {})
579
+ req = build_request(:create_analysis, params)
580
+ req.send_request(options)
581
+ end
582
+
357
583
  # Creates a dashboard from a template. To first create a template, see
358
- # the CreateTemplate API operation.
584
+ # the ` CreateTemplate ` API operation.
359
585
  #
360
586
  # A dashboard is an entity in QuickSight that identifies QuickSight
361
587
  # reports, created from analyses. You can share QuickSight dashboards.
362
588
  # With the right permissions, you can create scheduled email reports
363
- # from them. The `CreateDashboard`, `DescribeDashboard`, and
364
- # `ListDashboardsByUser` API operations act on the dashboard entity. If
365
- # you have the correct permissions, you can create a dashboard from a
366
- # template that exists in a different AWS account.
589
+ # from them. If you have the correct permissions, you can create a
590
+ # dashboard from a template that exists in a different AWS account.
367
591
  #
368
592
  # @option params [required, String] :aws_account_id
369
593
  # The ID of the AWS account where you want to create the dashboard.
@@ -381,8 +605,10 @@ module Aws::QuickSight
381
605
  #
382
606
  # @option params [Array<Types::ResourcePermission>] :permissions
383
607
  # A structure that contains the permissions of the dashboard. You can
384
- # use this structure for granting permissions with principal and action
385
- # information.
608
+ # use this structure for granting permissions by providing a list of IAM
609
+ # action information for each principal ARN.
610
+ #
611
+ # To specify no permissions, omit the permissions list.
386
612
  #
387
613
  # @option params [required, Types::DashboardSourceEntity] :source_entity
388
614
  # The entity that you are using as a source when you create the
@@ -417,7 +643,7 @@ module Aws::QuickSight
417
643
  #
418
644
  # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
419
645
  # either `ENABLED` or `DISABLED`. The visual option to export data to
420
- # .csv format isn't enabled when this is set to `DISABLED`. This
646
+ # .CSV format isn't enabled when this is set to `DISABLED`. This
421
647
  # option is `ENABLED` by default.
422
648
  #
423
649
  # * `VisibilityState` for `SheetControlsOption` - This visibility state
@@ -514,7 +740,7 @@ module Aws::QuickSight
514
740
  # resp.arn #=> String
515
741
  # resp.version_arn #=> String
516
742
  # resp.dashboard_id #=> String
517
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
743
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
518
744
  # resp.status #=> Integer
519
745
  # resp.request_id #=> String
520
746
  #
@@ -689,6 +915,7 @@ module Aws::QuickSight
689
915
  # },
690
916
  # ],
691
917
  # row_level_permission_data_set: {
918
+ # namespace: "Namespace",
692
919
  # arn: "Arn", # required
693
920
  # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
694
921
  # },
@@ -980,7 +1207,7 @@ module Aws::QuickSight
980
1207
  #
981
1208
  # resp.arn #=> String
982
1209
  # resp.data_source_id #=> String
983
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
1210
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
984
1211
  # resp.request_id #=> String
985
1212
  # resp.status #=> Integer
986
1213
  #
@@ -1228,6 +1455,76 @@ module Aws::QuickSight
1228
1455
  req.send_request(options)
1229
1456
  end
1230
1457
 
1458
+ # (Enterprise edition only) Creates a new namespace for you to use with
1459
+ # Amazon QuickSight.
1460
+ #
1461
+ # A namespace allows you to isolate the QuickSight users and groups that
1462
+ # are registered for that namespace. Users that access the namespace can
1463
+ # share assets only with other users or groups in the same namespace.
1464
+ # They can't see users and groups in other namespaces. You can create a
1465
+ # namespace after your AWS account is subscribed to QuickSight. The
1466
+ # namespace must be unique within the AWS account. By default, there is
1467
+ # a limit of 100 namespaces per AWS account. To increase your limit,
1468
+ # create a ticket with AWS Support.
1469
+ #
1470
+ # @option params [required, String] :aws_account_id
1471
+ # The ID for the AWS account that you want to create the QuickSight
1472
+ # namespace in.
1473
+ #
1474
+ # @option params [required, String] :namespace
1475
+ # The name that you want to use to describe the new namespace.
1476
+ #
1477
+ # @option params [required, String] :identity_store
1478
+ # Specifies the type of your user identity directory. Currently, this
1479
+ # supports users with an identity type of `QUICKSIGHT`.
1480
+ #
1481
+ # @option params [Array<Types::Tag>] :tags
1482
+ # The tags that you want to associate with the namespace that you're
1483
+ # creating.
1484
+ #
1485
+ # @return [Types::CreateNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1486
+ #
1487
+ # * {Types::CreateNamespaceResponse#arn #arn} => String
1488
+ # * {Types::CreateNamespaceResponse#name #name} => String
1489
+ # * {Types::CreateNamespaceResponse#capacity_region #capacity_region} => String
1490
+ # * {Types::CreateNamespaceResponse#creation_status #creation_status} => String
1491
+ # * {Types::CreateNamespaceResponse#identity_store #identity_store} => String
1492
+ # * {Types::CreateNamespaceResponse#request_id #request_id} => String
1493
+ # * {Types::CreateNamespaceResponse#status #status} => Integer
1494
+ #
1495
+ # @example Request syntax with placeholder values
1496
+ #
1497
+ # resp = client.create_namespace({
1498
+ # aws_account_id: "AwsAccountId", # required
1499
+ # namespace: "Namespace", # required
1500
+ # identity_store: "QUICKSIGHT", # required, accepts QUICKSIGHT
1501
+ # tags: [
1502
+ # {
1503
+ # key: "TagKey", # required
1504
+ # value: "TagValue", # required
1505
+ # },
1506
+ # ],
1507
+ # })
1508
+ #
1509
+ # @example Response structure
1510
+ #
1511
+ # resp.arn #=> String
1512
+ # resp.name #=> String
1513
+ # resp.capacity_region #=> String
1514
+ # resp.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
1515
+ # resp.identity_store #=> String, one of "QUICKSIGHT"
1516
+ # resp.request_id #=> String
1517
+ # resp.status #=> Integer
1518
+ #
1519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateNamespace AWS API Documentation
1520
+ #
1521
+ # @overload create_namespace(params = {})
1522
+ # @param [Hash] params ({})
1523
+ def create_namespace(params = {}, options = {})
1524
+ req = build_request(:create_namespace, params)
1525
+ req.send_request(options)
1526
+ end
1527
+
1231
1528
  # Creates a template from an existing QuickSight analysis or template.
1232
1529
  # You can use the resulting template to create a dashboard.
1233
1530
  #
@@ -1329,7 +1626,7 @@ module Aws::QuickSight
1329
1626
  # resp.arn #=> String
1330
1627
  # resp.version_arn #=> String
1331
1628
  # resp.template_id #=> String
1332
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
1629
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
1333
1630
  # resp.status #=> Integer
1334
1631
  # resp.request_id #=> String
1335
1632
  #
@@ -1509,7 +1806,7 @@ module Aws::QuickSight
1509
1806
  # resp.arn #=> String
1510
1807
  # resp.version_arn #=> String
1511
1808
  # resp.theme_id #=> String
1512
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
1809
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
1513
1810
  # resp.status #=> Integer
1514
1811
  # resp.request_id #=> String
1515
1812
  #
@@ -1571,6 +1868,111 @@ module Aws::QuickSight
1571
1868
  req.send_request(options)
1572
1869
  end
1573
1870
 
1871
+ # Deletes all Amazon QuickSight customizations in this AWS Region for
1872
+ # the specified AWS Account and QuickSight namespace.
1873
+ #
1874
+ # @option params [required, String] :aws_account_id
1875
+ # The ID for the AWS account that you want to delete QuickSight
1876
+ # customizations from in this AWS Region.
1877
+ #
1878
+ # @option params [String] :namespace
1879
+ # The QuickSight namespace that you're deleting the customizations
1880
+ # from.
1881
+ #
1882
+ # @return [Types::DeleteAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1883
+ #
1884
+ # * {Types::DeleteAccountCustomizationResponse#request_id #request_id} => String
1885
+ # * {Types::DeleteAccountCustomizationResponse#status #status} => Integer
1886
+ #
1887
+ # @example Request syntax with placeholder values
1888
+ #
1889
+ # resp = client.delete_account_customization({
1890
+ # aws_account_id: "AwsAccountId", # required
1891
+ # namespace: "Namespace",
1892
+ # })
1893
+ #
1894
+ # @example Response structure
1895
+ #
1896
+ # resp.request_id #=> String
1897
+ # resp.status #=> Integer
1898
+ #
1899
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAccountCustomization AWS API Documentation
1900
+ #
1901
+ # @overload delete_account_customization(params = {})
1902
+ # @param [Hash] params ({})
1903
+ def delete_account_customization(params = {}, options = {})
1904
+ req = build_request(:delete_account_customization, params)
1905
+ req.send_request(options)
1906
+ end
1907
+
1908
+ # Deletes an analysis from Amazon QuickSight. You can optionally include
1909
+ # a recovery window during which you can restore the analysis. If you
1910
+ # don't specify a recovery window value, the operation defaults to 30
1911
+ # days. QuickSight attaches a `DeletionTime` stamp to the response that
1912
+ # specifies the end of the recovery window. At the end of the recovery
1913
+ # window, QuickSight deletes the analysis permanently.
1914
+ #
1915
+ # At any time before recovery window ends, you can use the
1916
+ # `RestoreAnalysis` API operation to remove the `DeletionTime` stamp and
1917
+ # cancel the deletion of the analysis. The analysis remains visible in
1918
+ # the API until it's deleted, so you can describe it but you can't
1919
+ # make a template from it.
1920
+ #
1921
+ # An analysis that's scheduled for deletion isn't accessible in the
1922
+ # QuickSight console. To access it in the console, restore it. Deleting
1923
+ # an analysis doesn't delete the dashboards that you publish from it.
1924
+ #
1925
+ # @option params [required, String] :aws_account_id
1926
+ # The ID of the AWS account where you want to delete an analysis.
1927
+ #
1928
+ # @option params [required, String] :analysis_id
1929
+ # The ID of the analysis that you're deleting.
1930
+ #
1931
+ # @option params [Integer] :recovery_window_in_days
1932
+ # A value that specifies the number of days that QuickSight waits before
1933
+ # it deletes the analysis. You can't use this parameter with the
1934
+ # `ForceDeleteWithoutRecovery` option in the same API call. The default
1935
+ # value is 30.
1936
+ #
1937
+ # @option params [Boolean] :force_delete_without_recovery
1938
+ # This option defaults to the value `NoForceDeleteWithoutRecovery`. To
1939
+ # immediately delete the analysis, add the `ForceDeleteWithoutRecovery`
1940
+ # option. You can't restore an analysis after it's deleted.
1941
+ #
1942
+ # @return [Types::DeleteAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1943
+ #
1944
+ # * {Types::DeleteAnalysisResponse#status #status} => Integer
1945
+ # * {Types::DeleteAnalysisResponse#arn #arn} => String
1946
+ # * {Types::DeleteAnalysisResponse#analysis_id #analysis_id} => String
1947
+ # * {Types::DeleteAnalysisResponse#deletion_time #deletion_time} => Time
1948
+ # * {Types::DeleteAnalysisResponse#request_id #request_id} => String
1949
+ #
1950
+ # @example Request syntax with placeholder values
1951
+ #
1952
+ # resp = client.delete_analysis({
1953
+ # aws_account_id: "AwsAccountId", # required
1954
+ # analysis_id: "RestrictiveResourceId", # required
1955
+ # recovery_window_in_days: 1,
1956
+ # force_delete_without_recovery: false,
1957
+ # })
1958
+ #
1959
+ # @example Response structure
1960
+ #
1961
+ # resp.status #=> Integer
1962
+ # resp.arn #=> String
1963
+ # resp.analysis_id #=> String
1964
+ # resp.deletion_time #=> Time
1965
+ # resp.request_id #=> String
1966
+ #
1967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteAnalysis AWS API Documentation
1968
+ #
1969
+ # @overload delete_analysis(params = {})
1970
+ # @param [Hash] params ({})
1971
+ def delete_analysis(params = {}, options = {})
1972
+ req = build_request(:delete_analysis, params)
1973
+ req.send_request(options)
1974
+ end
1975
+
1574
1976
  # Deletes a dashboard.
1575
1977
  #
1576
1978
  # @option params [required, String] :aws_account_id
@@ -1654,7 +2056,7 @@ module Aws::QuickSight
1654
2056
  req.send_request(options)
1655
2057
  end
1656
2058
 
1657
- # Deletes the data source permanently. This action breaks all the
2059
+ # Deletes the data source permanently. This operation breaks all the
1658
2060
  # datasets that reference the deleted data source.
1659
2061
  #
1660
2062
  # @option params [required, String] :aws_account_id
@@ -1820,6 +2222,45 @@ module Aws::QuickSight
1820
2222
  req.send_request(options)
1821
2223
  end
1822
2224
 
2225
+ # Deletes a namespace and the users and groups that are associated with
2226
+ # the namespace. This is an asynchronous process. Assets including
2227
+ # dashboards, analyses, datasets and data sources are not deleted. To
2228
+ # delete these assets, you use the API operations for the relevant
2229
+ # asset.
2230
+ #
2231
+ # @option params [required, String] :aws_account_id
2232
+ # The ID for the AWS account that you want to delete the QuickSight
2233
+ # namespace from.
2234
+ #
2235
+ # @option params [required, String] :namespace
2236
+ # The namespace that you want to delete.
2237
+ #
2238
+ # @return [Types::DeleteNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2239
+ #
2240
+ # * {Types::DeleteNamespaceResponse#request_id #request_id} => String
2241
+ # * {Types::DeleteNamespaceResponse#status #status} => Integer
2242
+ #
2243
+ # @example Request syntax with placeholder values
2244
+ #
2245
+ # resp = client.delete_namespace({
2246
+ # aws_account_id: "AwsAccountId", # required
2247
+ # namespace: "Namespace", # required
2248
+ # })
2249
+ #
2250
+ # @example Response structure
2251
+ #
2252
+ # resp.request_id #=> String
2253
+ # resp.status #=> Integer
2254
+ #
2255
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteNamespace AWS API Documentation
2256
+ #
2257
+ # @overload delete_namespace(params = {})
2258
+ # @param [Hash] params ({})
2259
+ def delete_namespace(params = {}, options = {})
2260
+ req = build_request(:delete_namespace, params)
2261
+ req.send_request(options)
2262
+ end
2263
+
1823
2264
  # Deletes a template.
1824
2265
  #
1825
2266
  # @option params [required, String] :aws_account_id
@@ -2087,6 +2528,243 @@ module Aws::QuickSight
2087
2528
  req.send_request(options)
2088
2529
  end
2089
2530
 
2531
+ # Describes the customizations associated with the provided AWS account
2532
+ # and Amazon QuickSight namespace in an AWS Region. The QuickSight
2533
+ # console evaluates which customizations to apply by running this API
2534
+ # operation with the `Resolved` flag included.
2535
+ #
2536
+ # To determine what customizations display when you run this command, it
2537
+ # can help to visualize the relationship of the entities involved.
2538
+ #
2539
+ # * `AWS Account` - The AWS account exists at the top of the hierarchy.
2540
+ # It has the potential to use all of the AWS Regions and AWS Services.
2541
+ # When you subscribe to QuickSight, you choose one AWS Region to use
2542
+ # as your home region. That's where your free SPICE capacity is
2543
+ # located. You can use QuickSight in any supported AWS Region.
2544
+ #
2545
+ # * `AWS Region` - In each AWS Region where you sign in to QuickSight at
2546
+ # least once, QuickSight acts as a separate instance of the same
2547
+ # service. If you have a user directory, it resides in us-east-1,
2548
+ # which is the US East (N. Virginia). Generally speaking, these users
2549
+ # have access to QuickSight in any AWS Region, unless they are
2550
+ # constrained to a namespace.
2551
+ #
2552
+ # To run the command in a different AWS Region, you change your region
2553
+ # settings. If you're using the AWS CLI, you can use one of the
2554
+ # following options:
2555
+ #
2556
+ # * Use [command line options][1].
2557
+ #
2558
+ # * Use [named profiles][2].
2559
+ #
2560
+ # * Run `aws configure` to change your default AWS Region. Use Enter
2561
+ # to key the same settings for your keys. For more information, see
2562
+ # [Configuring the AWS CLI][3].
2563
+ #
2564
+ # * `Namespace` - A QuickSight namespace is a partition that contains
2565
+ # users and assets (data sources, datasets, dashboards, and so on). To
2566
+ # access assets that are in a specific namespace, users and groups
2567
+ # must also be part of the same namespace. People who share a
2568
+ # namespace are completely isolated from users and assets in other
2569
+ # namespaces, even if they are in the same AWS account and AWS Region.
2570
+ #
2571
+ # * `Applied customizations` - Within an AWS Region, a set of QuickSight
2572
+ # customizations can apply to an AWS account or to a namespace.
2573
+ # Settings that you apply to a namespace override settings that you
2574
+ # apply to an AWS Account. All settings are isolated to a single AWS
2575
+ # Region. To apply them in other AWS Regions, run the
2576
+ # `CreateAccountCustomization` command in each AWS Region where you
2577
+ # want to apply the same customizations.
2578
+ #
2579
+ #
2580
+ #
2581
+ # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html
2582
+ # [2]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html
2583
+ # [3]: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html
2584
+ #
2585
+ # @option params [required, String] :aws_account_id
2586
+ # The ID for the AWS account that you want to describe QuickSight
2587
+ # customizations for.
2588
+ #
2589
+ # @option params [String] :namespace
2590
+ # The QuickSight namespace that you want to describe QuickSight
2591
+ # customizations for.
2592
+ #
2593
+ # @option params [Boolean] :resolved
2594
+ # The `Resolved` flag works with the other parameters to determine which
2595
+ # view of QuickSight customizations is returned. You can add this flag
2596
+ # to your command to use the same view that QuickSight uses to identify
2597
+ # which customizations to apply to the console. Omit this flag, or set
2598
+ # it to `no-resolved`, to reveal customizations that are configured at
2599
+ # different levels.
2600
+ #
2601
+ # @return [Types::DescribeAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2602
+ #
2603
+ # * {Types::DescribeAccountCustomizationResponse#arn #arn} => String
2604
+ # * {Types::DescribeAccountCustomizationResponse#aws_account_id #aws_account_id} => String
2605
+ # * {Types::DescribeAccountCustomizationResponse#namespace #namespace} => String
2606
+ # * {Types::DescribeAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
2607
+ # * {Types::DescribeAccountCustomizationResponse#request_id #request_id} => String
2608
+ # * {Types::DescribeAccountCustomizationResponse#status #status} => Integer
2609
+ #
2610
+ # @example Request syntax with placeholder values
2611
+ #
2612
+ # resp = client.describe_account_customization({
2613
+ # aws_account_id: "AwsAccountId", # required
2614
+ # namespace: "Namespace",
2615
+ # resolved: false,
2616
+ # })
2617
+ #
2618
+ # @example Response structure
2619
+ #
2620
+ # resp.arn #=> String
2621
+ # resp.aws_account_id #=> String
2622
+ # resp.namespace #=> String
2623
+ # resp.account_customization.default_theme #=> String
2624
+ # resp.request_id #=> String
2625
+ # resp.status #=> Integer
2626
+ #
2627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountCustomization AWS API Documentation
2628
+ #
2629
+ # @overload describe_account_customization(params = {})
2630
+ # @param [Hash] params ({})
2631
+ def describe_account_customization(params = {}, options = {})
2632
+ req = build_request(:describe_account_customization, params)
2633
+ req.send_request(options)
2634
+ end
2635
+
2636
+ # Describes the settings that were used when your QuickSight
2637
+ # subscription was first created in this AWS Account.
2638
+ #
2639
+ # @option params [required, String] :aws_account_id
2640
+ # The ID for the AWS account that contains the settings that you want to
2641
+ # list.
2642
+ #
2643
+ # @return [Types::DescribeAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2644
+ #
2645
+ # * {Types::DescribeAccountSettingsResponse#account_settings #account_settings} => Types::AccountSettings
2646
+ # * {Types::DescribeAccountSettingsResponse#request_id #request_id} => String
2647
+ # * {Types::DescribeAccountSettingsResponse#status #status} => Integer
2648
+ #
2649
+ # @example Request syntax with placeholder values
2650
+ #
2651
+ # resp = client.describe_account_settings({
2652
+ # aws_account_id: "AwsAccountId", # required
2653
+ # })
2654
+ #
2655
+ # @example Response structure
2656
+ #
2657
+ # resp.account_settings.account_name #=> String
2658
+ # resp.account_settings.edition #=> String, one of "STANDARD", "ENTERPRISE"
2659
+ # resp.account_settings.default_namespace #=> String
2660
+ # resp.account_settings.notification_email #=> String
2661
+ # resp.request_id #=> String
2662
+ # resp.status #=> Integer
2663
+ #
2664
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAccountSettings AWS API Documentation
2665
+ #
2666
+ # @overload describe_account_settings(params = {})
2667
+ # @param [Hash] params ({})
2668
+ def describe_account_settings(params = {}, options = {})
2669
+ req = build_request(:describe_account_settings, params)
2670
+ req.send_request(options)
2671
+ end
2672
+
2673
+ # Provides a summary of the metadata for an analysis.
2674
+ #
2675
+ # @option params [required, String] :aws_account_id
2676
+ # The ID of the AWS account that contains the analysis. You must be
2677
+ # using the AWS account that the analysis is in.
2678
+ #
2679
+ # @option params [required, String] :analysis_id
2680
+ # The ID of the analysis that you're describing. The ID is part of the
2681
+ # URL of the analysis.
2682
+ #
2683
+ # @return [Types::DescribeAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2684
+ #
2685
+ # * {Types::DescribeAnalysisResponse#analysis #analysis} => Types::Analysis
2686
+ # * {Types::DescribeAnalysisResponse#status #status} => Integer
2687
+ # * {Types::DescribeAnalysisResponse#request_id #request_id} => String
2688
+ #
2689
+ # @example Request syntax with placeholder values
2690
+ #
2691
+ # resp = client.describe_analysis({
2692
+ # aws_account_id: "AwsAccountId", # required
2693
+ # analysis_id: "RestrictiveResourceId", # required
2694
+ # })
2695
+ #
2696
+ # @example Response structure
2697
+ #
2698
+ # resp.analysis.analysis_id #=> String
2699
+ # resp.analysis.arn #=> String
2700
+ # resp.analysis.name #=> String
2701
+ # resp.analysis.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2702
+ # resp.analysis.errors #=> Array
2703
+ # 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"
2704
+ # resp.analysis.errors[0].message #=> String
2705
+ # resp.analysis.data_set_arns #=> Array
2706
+ # resp.analysis.data_set_arns[0] #=> String
2707
+ # resp.analysis.theme_arn #=> String
2708
+ # resp.analysis.created_time #=> Time
2709
+ # resp.analysis.last_updated_time #=> Time
2710
+ # resp.status #=> Integer
2711
+ # resp.request_id #=> String
2712
+ #
2713
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysis AWS API Documentation
2714
+ #
2715
+ # @overload describe_analysis(params = {})
2716
+ # @param [Hash] params ({})
2717
+ def describe_analysis(params = {}, options = {})
2718
+ req = build_request(:describe_analysis, params)
2719
+ req.send_request(options)
2720
+ end
2721
+
2722
+ # Provides the read and write permissions for an analysis.
2723
+ #
2724
+ # @option params [required, String] :aws_account_id
2725
+ # The ID of the AWS account that contains the analysis whose permissions
2726
+ # you're describing. You must be using the AWS account that the
2727
+ # analysis is in.
2728
+ #
2729
+ # @option params [required, String] :analysis_id
2730
+ # The ID of the analysis whose permissions you're describing. The ID is
2731
+ # part of the analysis URL.
2732
+ #
2733
+ # @return [Types::DescribeAnalysisPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2734
+ #
2735
+ # * {Types::DescribeAnalysisPermissionsResponse#analysis_id #analysis_id} => String
2736
+ # * {Types::DescribeAnalysisPermissionsResponse#analysis_arn #analysis_arn} => String
2737
+ # * {Types::DescribeAnalysisPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
2738
+ # * {Types::DescribeAnalysisPermissionsResponse#status #status} => Integer
2739
+ # * {Types::DescribeAnalysisPermissionsResponse#request_id #request_id} => String
2740
+ #
2741
+ # @example Request syntax with placeholder values
2742
+ #
2743
+ # resp = client.describe_analysis_permissions({
2744
+ # aws_account_id: "AwsAccountId", # required
2745
+ # analysis_id: "RestrictiveResourceId", # required
2746
+ # })
2747
+ #
2748
+ # @example Response structure
2749
+ #
2750
+ # resp.analysis_id #=> String
2751
+ # resp.analysis_arn #=> String
2752
+ # resp.permissions #=> Array
2753
+ # resp.permissions[0].principal #=> String
2754
+ # resp.permissions[0].actions #=> Array
2755
+ # resp.permissions[0].actions[0] #=> String
2756
+ # resp.status #=> Integer
2757
+ # resp.request_id #=> String
2758
+ #
2759
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeAnalysisPermissions AWS API Documentation
2760
+ #
2761
+ # @overload describe_analysis_permissions(params = {})
2762
+ # @param [Hash] params ({})
2763
+ def describe_analysis_permissions(params = {}, options = {})
2764
+ req = build_request(:describe_analysis_permissions, params)
2765
+ req.send_request(options)
2766
+ end
2767
+
2090
2768
  # Provides a summary for a dashboard.
2091
2769
  #
2092
2770
  # @option params [required, String] :aws_account_id
@@ -2128,12 +2806,13 @@ module Aws::QuickSight
2128
2806
  # 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"
2129
2807
  # resp.dashboard.version.errors[0].message #=> String
2130
2808
  # resp.dashboard.version.version_number #=> Integer
2131
- # resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
2809
+ # resp.dashboard.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2132
2810
  # resp.dashboard.version.arn #=> String
2133
2811
  # resp.dashboard.version.source_entity_arn #=> String
2134
2812
  # resp.dashboard.version.data_set_arns #=> Array
2135
2813
  # resp.dashboard.version.data_set_arns[0] #=> String
2136
2814
  # resp.dashboard.version.description #=> String
2815
+ # resp.dashboard.version.theme_arn #=> String
2137
2816
  # resp.dashboard.created_time #=> Time
2138
2817
  # resp.dashboard.last_published_time #=> Time
2139
2818
  # resp.dashboard.last_updated_time #=> Time
@@ -2277,6 +2956,7 @@ module Aws::QuickSight
2277
2956
  # resp.data_set.column_groups[0].geo_spatial_column_group.country_code #=> String, one of "US"
2278
2957
  # resp.data_set.column_groups[0].geo_spatial_column_group.columns #=> Array
2279
2958
  # resp.data_set.column_groups[0].geo_spatial_column_group.columns[0] #=> String
2959
+ # resp.data_set.row_level_permission_data_set.namespace #=> String
2280
2960
  # resp.data_set.row_level_permission_data_set.arn #=> String
2281
2961
  # resp.data_set.row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
2282
2962
  # resp.request_id #=> String
@@ -2366,7 +3046,7 @@ module Aws::QuickSight
2366
3046
  # resp.data_source.data_source_id #=> String
2367
3047
  # resp.data_source.name #=> String
2368
3048
  # 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"
2369
- # resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
3049
+ # resp.data_source.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2370
3050
  # resp.data_source.created_time #=> Time
2371
3051
  # resp.data_source.last_updated_time #=> Time
2372
3052
  # resp.data_source.data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
@@ -2666,6 +3346,49 @@ module Aws::QuickSight
2666
3346
  req.send_request(options)
2667
3347
  end
2668
3348
 
3349
+ # Describes the current namespace.
3350
+ #
3351
+ # @option params [required, String] :aws_account_id
3352
+ # The ID for the AWS account that contains the QuickSight namespace that
3353
+ # you want to describe.
3354
+ #
3355
+ # @option params [required, String] :namespace
3356
+ # The namespace that you want to describe.
3357
+ #
3358
+ # @return [Types::DescribeNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3359
+ #
3360
+ # * {Types::DescribeNamespaceResponse#namespace #namespace} => Types::NamespaceInfoV2
3361
+ # * {Types::DescribeNamespaceResponse#request_id #request_id} => String
3362
+ # * {Types::DescribeNamespaceResponse#status #status} => Integer
3363
+ #
3364
+ # @example Request syntax with placeholder values
3365
+ #
3366
+ # resp = client.describe_namespace({
3367
+ # aws_account_id: "AwsAccountId", # required
3368
+ # namespace: "Namespace", # required
3369
+ # })
3370
+ #
3371
+ # @example Response structure
3372
+ #
3373
+ # resp.namespace.name #=> String
3374
+ # resp.namespace.arn #=> String
3375
+ # resp.namespace.capacity_region #=> String
3376
+ # resp.namespace.creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
3377
+ # resp.namespace.identity_store #=> String, one of "QUICKSIGHT"
3378
+ # resp.namespace.namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
3379
+ # resp.namespace.namespace_error.message #=> String
3380
+ # resp.request_id #=> String
3381
+ # resp.status #=> Integer
3382
+ #
3383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeNamespace AWS API Documentation
3384
+ #
3385
+ # @overload describe_namespace(params = {})
3386
+ # @param [Hash] params ({})
3387
+ def describe_namespace(params = {}, options = {})
3388
+ req = build_request(:describe_namespace, params)
3389
+ req.send_request(options)
3390
+ end
3391
+
2669
3392
  # Describes a template's metadata.
2670
3393
  #
2671
3394
  # @option params [required, String] :aws_account_id
@@ -2708,10 +3431,10 @@ module Aws::QuickSight
2708
3431
  # resp.template.name #=> String
2709
3432
  # resp.template.version.created_time #=> Time
2710
3433
  # resp.template.version.errors #=> Array
2711
- # resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE"
3434
+ # resp.template.version.errors[0].type #=> String, one of "SOURCE_NOT_FOUND", "DATA_SET_NOT_FOUND", "INTERNAL_FAILURE", "ACCESS_DENIED"
2712
3435
  # resp.template.version.errors[0].message #=> String
2713
3436
  # resp.template.version.version_number #=> Integer
2714
- # resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
3437
+ # resp.template.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2715
3438
  # resp.template.version.data_set_configurations #=> Array
2716
3439
  # resp.template.version.data_set_configurations[0].placeholder #=> String
2717
3440
  # resp.template.version.data_set_configurations[0].data_set_schema.column_schema_list #=> Array
@@ -2724,6 +3447,7 @@ module Aws::QuickSight
2724
3447
  # resp.template.version.data_set_configurations[0].column_group_schema_list[0].column_group_column_schema_list[0].name #=> String
2725
3448
  # resp.template.version.description #=> String
2726
3449
  # resp.template.version.source_entity_arn #=> String
3450
+ # resp.template.version.theme_arn #=> String
2727
3451
  # resp.template.template_id #=> String
2728
3452
  # resp.template.last_updated_time #=> Time
2729
3453
  # resp.template.created_time #=> Time
@@ -2903,7 +3627,7 @@ module Aws::QuickSight
2903
3627
  # resp.theme.version.errors #=> Array
2904
3628
  # resp.theme.version.errors[0].type #=> String, one of "INTERNAL_FAILURE"
2905
3629
  # resp.theme.version.errors[0].message #=> String
2906
- # resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
3630
+ # resp.theme.version.status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
2907
3631
  # resp.theme.created_time #=> Time
2908
3632
  # resp.theme.last_updated_time #=> Time
2909
3633
  # resp.theme.type #=> String, one of "QUICKSIGHT", "CUSTOM", "ALL"
@@ -3041,6 +3765,7 @@ module Aws::QuickSight
3041
3765
  # resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
3042
3766
  # resp.user.active #=> Boolean
3043
3767
  # resp.user.principal_id #=> String
3768
+ # resp.user.custom_permissions_name #=> String
3044
3769
  # resp.request_id #=> String
3045
3770
  # resp.status #=> Integer
3046
3771
  #
@@ -3053,9 +3778,10 @@ module Aws::QuickSight
3053
3778
  req.send_request(options)
3054
3779
  end
3055
3780
 
3056
- # Generates a URL and authorization code that you can embed in your web
3057
- # server code. Before you use this command, make sure that you have
3058
- # configured the dashboards and permissions.
3781
+ # Generates a session URL and authorization code that you can use to
3782
+ # embed an Amazon QuickSight read-only dashboard in your web server
3783
+ # code. Before you use this command, make sure that you have configured
3784
+ # the dashboards and permissions.
3059
3785
  #
3060
3786
  # Currently, you can use `GetDashboardEmbedURL` only from the server,
3061
3787
  # not from the user's browser. The following rules apply to the
@@ -3069,14 +3795,12 @@ module Aws::QuickSight
3069
3795
  #
3070
3796
  # * The resulting user session is valid for 10 hours.
3071
3797
  #
3072
- # For more information, see [Embedding Amazon QuickSight Dashboards][1]
3073
- # in the *Amazon QuickSight User Guide* or [Embedding Amazon QuickSight
3074
- # Dashboards][2] in the *Amazon QuickSight API Reference*.
3798
+ # For more information, see [Embedding Amazon QuickSight][1] in the
3799
+ # *Amazon QuickSight User Guide* .
3075
3800
  #
3076
3801
  #
3077
3802
  #
3078
3803
  # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html
3079
- # [2]: https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html
3080
3804
  #
3081
3805
  # @option params [required, String] :aws_account_id
3082
3806
  # The ID for the AWS account that contains the dashboard that you're
@@ -3114,6 +3838,9 @@ module Aws::QuickSight
3114
3838
  # Federated Single Sign-On using SAML, OpenID Connect, or IAM
3115
3839
  # federation.
3116
3840
  #
3841
+ # Omit this parameter for users in the third group – IAM users and IAM
3842
+ # role-based sessions.
3843
+ #
3117
3844
  # @return [Types::GetDashboardEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3118
3845
  #
3119
3846
  # * {Types::GetDashboardEmbedUrlResponse#embed_url #embed_url} => String
@@ -3147,6 +3874,151 @@ module Aws::QuickSight
3147
3874
  req.send_request(options)
3148
3875
  end
3149
3876
 
3877
+ # Generates a session URL and authorization code that you can use to
3878
+ # embed the Amazon QuickSight console in your web server code. Use
3879
+ # `GetSessionEmbedUrl` where you want to provide an authoring portal
3880
+ # that allows users to create data sources, datasets, analyses, and
3881
+ # dashboards. The users who access an embedded QuickSight console need
3882
+ # belong to the author or admin security cohort. If you want to restrict
3883
+ # permissions to some of these features, add a custom permissions
3884
+ # profile to the user with the ` UpdateUser ` API operation. Use `
3885
+ # RegisterUser ` API operation to add a new user with a custom
3886
+ # permission profile attached. For more information, see the following
3887
+ # sections in the *Amazon QuickSight User Guide*\:
3888
+ #
3889
+ # * [Embedding the Amazon QuickSight Console][1]
3890
+ #
3891
+ # * [Customizing Access to the Amazon QuickSight Console][2]
3892
+ #
3893
+ #
3894
+ #
3895
+ # [1]: https://docs.aws.amazon.com/quicksight/latest/user/embedding-the-quicksight-console.html
3896
+ # [2]: https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html
3897
+ #
3898
+ # @option params [required, String] :aws_account_id
3899
+ # The ID for the AWS account associated with your QuickSight
3900
+ # subscription.
3901
+ #
3902
+ # @option params [String] :entry_point
3903
+ # The URL you use to access the embedded session. The entry point URL is
3904
+ # constrained to the following paths:
3905
+ #
3906
+ # * `/start`
3907
+ #
3908
+ # * `/start/analyses`
3909
+ #
3910
+ # * `/start/dashboards`
3911
+ #
3912
+ # * `/start/favorites`
3913
+ #
3914
+ # * `/dashboards/DashboardId ` - where `DashboardId` is the actual ID
3915
+ # key from the QuickSight console URL of the dashboard
3916
+ #
3917
+ # * `/analyses/AnalysisId ` - where `AnalysisId` is the actual ID key
3918
+ # from the QuickSight console URL of the analysis
3919
+ #
3920
+ # @option params [Integer] :session_lifetime_in_minutes
3921
+ # How many minutes the session is valid. The session lifetime must be
3922
+ # 15-600 minutes.
3923
+ #
3924
+ # @option params [String] :user_arn
3925
+ # The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
3926
+ # `QUICKSIGHT` identity type. You can use this for any type of Amazon
3927
+ # QuickSight users in your account (readers, authors, or admins). They
3928
+ # need to be authenticated as one of the following:
3929
+ #
3930
+ # 1. Active Directory (AD) users or group members
3931
+ #
3932
+ # 2. Invited nonfederated users
3933
+ #
3934
+ # 3. IAM users and IAM role-based sessions authenticated through
3935
+ # Federated Single Sign-On using SAML, OpenID Connect, or IAM
3936
+ # federation
3937
+ #
3938
+ # Omit this parameter for users in the third group – IAM users and IAM
3939
+ # role-based sessions.
3940
+ #
3941
+ # @return [Types::GetSessionEmbedUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3942
+ #
3943
+ # * {Types::GetSessionEmbedUrlResponse#embed_url #embed_url} => String
3944
+ # * {Types::GetSessionEmbedUrlResponse#status #status} => Integer
3945
+ # * {Types::GetSessionEmbedUrlResponse#request_id #request_id} => String
3946
+ #
3947
+ # @example Request syntax with placeholder values
3948
+ #
3949
+ # resp = client.get_session_embed_url({
3950
+ # aws_account_id: "AwsAccountId", # required
3951
+ # entry_point: "EntryPoint",
3952
+ # session_lifetime_in_minutes: 1,
3953
+ # user_arn: "Arn",
3954
+ # })
3955
+ #
3956
+ # @example Response structure
3957
+ #
3958
+ # resp.embed_url #=> String
3959
+ # resp.status #=> Integer
3960
+ # resp.request_id #=> String
3961
+ #
3962
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetSessionEmbedUrl AWS API Documentation
3963
+ #
3964
+ # @overload get_session_embed_url(params = {})
3965
+ # @param [Hash] params ({})
3966
+ def get_session_embed_url(params = {}, options = {})
3967
+ req = build_request(:get_session_embed_url, params)
3968
+ req.send_request(options)
3969
+ end
3970
+
3971
+ # Lists Amazon QuickSight analyses that exist in the specified AWS
3972
+ # account.
3973
+ #
3974
+ # @option params [required, String] :aws_account_id
3975
+ # The ID of the AWS account that contains the analyses.
3976
+ #
3977
+ # @option params [String] :next_token
3978
+ # A pagination token that can be used in a subsequent request.
3979
+ #
3980
+ # @option params [Integer] :max_results
3981
+ # The maximum number of results to return.
3982
+ #
3983
+ # @return [Types::ListAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3984
+ #
3985
+ # * {Types::ListAnalysesResponse#analysis_summary_list #analysis_summary_list} => Array&lt;Types::AnalysisSummary&gt;
3986
+ # * {Types::ListAnalysesResponse#next_token #next_token} => String
3987
+ # * {Types::ListAnalysesResponse#status #status} => Integer
3988
+ # * {Types::ListAnalysesResponse#request_id #request_id} => String
3989
+ #
3990
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3991
+ #
3992
+ # @example Request syntax with placeholder values
3993
+ #
3994
+ # resp = client.list_analyses({
3995
+ # aws_account_id: "AwsAccountId", # required
3996
+ # next_token: "String",
3997
+ # max_results: 1,
3998
+ # })
3999
+ #
4000
+ # @example Response structure
4001
+ #
4002
+ # resp.analysis_summary_list #=> Array
4003
+ # resp.analysis_summary_list[0].arn #=> String
4004
+ # resp.analysis_summary_list[0].analysis_id #=> String
4005
+ # resp.analysis_summary_list[0].name #=> String
4006
+ # resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
4007
+ # resp.analysis_summary_list[0].created_time #=> Time
4008
+ # resp.analysis_summary_list[0].last_updated_time #=> Time
4009
+ # resp.next_token #=> String
4010
+ # resp.status #=> Integer
4011
+ # resp.request_id #=> String
4012
+ #
4013
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListAnalyses AWS API Documentation
4014
+ #
4015
+ # @overload list_analyses(params = {})
4016
+ # @param [Hash] params ({})
4017
+ def list_analyses(params = {}, options = {})
4018
+ req = build_request(:list_analyses, params)
4019
+ req.send_request(options)
4020
+ end
4021
+
3150
4022
  # Lists all the versions of the dashboards in the QuickSight
3151
4023
  # subscription.
3152
4024
  #
@@ -3188,7 +4060,7 @@ module Aws::QuickSight
3188
4060
  # resp.dashboard_version_summary_list[0].arn #=> String
3189
4061
  # resp.dashboard_version_summary_list[0].created_time #=> Time
3190
4062
  # resp.dashboard_version_summary_list[0].version_number #=> Integer
3191
- # resp.dashboard_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
4063
+ # 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"
3192
4064
  # resp.dashboard_version_summary_list[0].source_entity_arn #=> String
3193
4065
  # resp.dashboard_version_summary_list[0].description #=> String
3194
4066
  # resp.next_token #=> String
@@ -3299,6 +4171,7 @@ module Aws::QuickSight
3299
4171
  # resp.data_set_summaries[0].created_time #=> Time
3300
4172
  # resp.data_set_summaries[0].last_updated_time #=> Time
3301
4173
  # resp.data_set_summaries[0].import_mode #=> String, one of "SPICE", "DIRECT_QUERY"
4174
+ # resp.data_set_summaries[0].row_level_permission_data_set.namespace #=> String
3302
4175
  # resp.data_set_summaries[0].row_level_permission_data_set.arn #=> String
3303
4176
  # resp.data_set_summaries[0].row_level_permission_data_set.permission_policy #=> String, one of "GRANT_ACCESS", "DENY_ACCESS"
3304
4177
  # resp.next_token #=> String
@@ -3351,7 +4224,7 @@ module Aws::QuickSight
3351
4224
  # resp.data_sources[0].data_source_id #=> String
3352
4225
  # resp.data_sources[0].name #=> String
3353
4226
  # 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"
3354
- # resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
4227
+ # resp.data_sources[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
3355
4228
  # resp.data_sources[0].created_time #=> Time
3356
4229
  # resp.data_sources[0].last_updated_time #=> Time
3357
4230
  # resp.data_sources[0].data_source_parameters.amazon_elasticsearch_parameters.domain #=> String
@@ -3709,31 +4582,83 @@ module Aws::QuickSight
3709
4582
  #
3710
4583
  # @example Response structure
3711
4584
  #
3712
- # resp.ingestions #=> Array
3713
- # resp.ingestions[0].arn #=> String
3714
- # resp.ingestions[0].ingestion_id #=> String
3715
- # resp.ingestions[0].ingestion_status #=> String, one of "INITIALIZED", "QUEUED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
3716
- # resp.ingestions[0].error_info.type #=> String, one of "FAILURE_TO_ASSUME_ROLE", "INGESTION_SUPERSEDED", "INGESTION_CANCELED", "DATA_SET_DELETED", "DATA_SET_NOT_SPICE", "S3_UPLOADED_FILE_DELETED", "S3_MANIFEST_ERROR", "DATA_TOLERANCE_EXCEPTION", "SPICE_TABLE_NOT_FOUND", "DATA_SET_SIZE_LIMIT_EXCEEDED", "ROW_SIZE_LIMIT_EXCEEDED", "ACCOUNT_CAPACITY_LIMIT_EXCEEDED", "CUSTOMER_ERROR", "DATA_SOURCE_NOT_FOUND", "IAM_ROLE_NOT_AVAILABLE", "CONNECTION_FAILURE", "SQL_TABLE_NOT_FOUND", "PERMISSION_DENIED", "SSL_CERTIFICATE_VALIDATION_FAILURE", "OAUTH_TOKEN_FAILURE", "SOURCE_API_LIMIT_EXCEEDED_FAILURE", "PASSWORD_AUTHENTICATION_FAILURE", "SQL_SCHEMA_MISMATCH_ERROR", "INVALID_DATE_FORMAT", "INVALID_DATAPREP_SYNTAX", "SOURCE_RESOURCE_LIMIT_EXCEEDED", "SQL_INVALID_PARAMETER_VALUE", "QUERY_TIMEOUT", "SQL_NUMERIC_OVERFLOW", "UNRESOLVABLE_HOST", "UNROUTABLE_HOST", "SQL_EXCEPTION", "S3_FILE_INACCESSIBLE", "IOT_FILE_NOT_FOUND", "IOT_DATA_SET_FILE_EMPTY", "INVALID_DATA_SOURCE_CONFIG", "DATA_SOURCE_AUTH_FAILED", "DATA_SOURCE_CONNECTION_FAILED", "FAILURE_TO_PROCESS_JSON_FILE", "INTERNAL_SERVICE_ERROR"
3717
- # resp.ingestions[0].error_info.message #=> String
3718
- # resp.ingestions[0].row_info.rows_ingested #=> Integer
3719
- # resp.ingestions[0].row_info.rows_dropped #=> Integer
3720
- # resp.ingestions[0].queue_info.waiting_on_ingestion #=> String
3721
- # resp.ingestions[0].queue_info.queued_ingestion #=> String
3722
- # resp.ingestions[0].created_time #=> Time
3723
- # resp.ingestions[0].ingestion_time_in_seconds #=> Integer
3724
- # resp.ingestions[0].ingestion_size_in_bytes #=> Integer
3725
- # resp.ingestions[0].request_source #=> String, one of "MANUAL", "SCHEDULED"
3726
- # resp.ingestions[0].request_type #=> String, one of "INITIAL_INGESTION", "EDIT", "INCREMENTAL_REFRESH", "FULL_REFRESH"
4585
+ # resp.ingestions #=> Array
4586
+ # resp.ingestions[0].arn #=> String
4587
+ # resp.ingestions[0].ingestion_id #=> String
4588
+ # resp.ingestions[0].ingestion_status #=> String, one of "INITIALIZED", "QUEUED", "RUNNING", "FAILED", "COMPLETED", "CANCELLED"
4589
+ # resp.ingestions[0].error_info.type #=> String, one of "FAILURE_TO_ASSUME_ROLE", "INGESTION_SUPERSEDED", "INGESTION_CANCELED", "DATA_SET_DELETED", "DATA_SET_NOT_SPICE", "S3_UPLOADED_FILE_DELETED", "S3_MANIFEST_ERROR", "DATA_TOLERANCE_EXCEPTION", "SPICE_TABLE_NOT_FOUND", "DATA_SET_SIZE_LIMIT_EXCEEDED", "ROW_SIZE_LIMIT_EXCEEDED", "ACCOUNT_CAPACITY_LIMIT_EXCEEDED", "CUSTOMER_ERROR", "DATA_SOURCE_NOT_FOUND", "IAM_ROLE_NOT_AVAILABLE", "CONNECTION_FAILURE", "SQL_TABLE_NOT_FOUND", "PERMISSION_DENIED", "SSL_CERTIFICATE_VALIDATION_FAILURE", "OAUTH_TOKEN_FAILURE", "SOURCE_API_LIMIT_EXCEEDED_FAILURE", "PASSWORD_AUTHENTICATION_FAILURE", "SQL_SCHEMA_MISMATCH_ERROR", "INVALID_DATE_FORMAT", "INVALID_DATAPREP_SYNTAX", "SOURCE_RESOURCE_LIMIT_EXCEEDED", "SQL_INVALID_PARAMETER_VALUE", "QUERY_TIMEOUT", "SQL_NUMERIC_OVERFLOW", "UNRESOLVABLE_HOST", "UNROUTABLE_HOST", "SQL_EXCEPTION", "S3_FILE_INACCESSIBLE", "IOT_FILE_NOT_FOUND", "IOT_DATA_SET_FILE_EMPTY", "INVALID_DATA_SOURCE_CONFIG", "DATA_SOURCE_AUTH_FAILED", "DATA_SOURCE_CONNECTION_FAILED", "FAILURE_TO_PROCESS_JSON_FILE", "INTERNAL_SERVICE_ERROR"
4590
+ # resp.ingestions[0].error_info.message #=> String
4591
+ # resp.ingestions[0].row_info.rows_ingested #=> Integer
4592
+ # resp.ingestions[0].row_info.rows_dropped #=> Integer
4593
+ # resp.ingestions[0].queue_info.waiting_on_ingestion #=> String
4594
+ # resp.ingestions[0].queue_info.queued_ingestion #=> String
4595
+ # resp.ingestions[0].created_time #=> Time
4596
+ # resp.ingestions[0].ingestion_time_in_seconds #=> Integer
4597
+ # resp.ingestions[0].ingestion_size_in_bytes #=> Integer
4598
+ # resp.ingestions[0].request_source #=> String, one of "MANUAL", "SCHEDULED"
4599
+ # resp.ingestions[0].request_type #=> String, one of "INITIAL_INGESTION", "EDIT", "INCREMENTAL_REFRESH", "FULL_REFRESH"
4600
+ # resp.next_token #=> String
4601
+ # resp.request_id #=> String
4602
+ # resp.status #=> Integer
4603
+ #
4604
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListIngestions AWS API Documentation
4605
+ #
4606
+ # @overload list_ingestions(params = {})
4607
+ # @param [Hash] params ({})
4608
+ def list_ingestions(params = {}, options = {})
4609
+ req = build_request(:list_ingestions, params)
4610
+ req.send_request(options)
4611
+ end
4612
+
4613
+ # Lists the namespaces for the specified AWS account.
4614
+ #
4615
+ # @option params [required, String] :aws_account_id
4616
+ # The ID for the AWS account that contains the QuickSight namespaces
4617
+ # that you want to list.
4618
+ #
4619
+ # @option params [String] :next_token
4620
+ # A pagination token that can be used in a subsequent request.
4621
+ #
4622
+ # @option params [Integer] :max_results
4623
+ # The maximum number of results to return.
4624
+ #
4625
+ # @return [Types::ListNamespacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4626
+ #
4627
+ # * {Types::ListNamespacesResponse#namespaces #namespaces} => Array&lt;Types::NamespaceInfoV2&gt;
4628
+ # * {Types::ListNamespacesResponse#next_token #next_token} => String
4629
+ # * {Types::ListNamespacesResponse#request_id #request_id} => String
4630
+ # * {Types::ListNamespacesResponse#status #status} => Integer
4631
+ #
4632
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4633
+ #
4634
+ # @example Request syntax with placeholder values
4635
+ #
4636
+ # resp = client.list_namespaces({
4637
+ # aws_account_id: "AwsAccountId", # required
4638
+ # next_token: "String",
4639
+ # max_results: 1,
4640
+ # })
4641
+ #
4642
+ # @example Response structure
4643
+ #
4644
+ # resp.namespaces #=> Array
4645
+ # resp.namespaces[0].name #=> String
4646
+ # resp.namespaces[0].arn #=> String
4647
+ # resp.namespaces[0].capacity_region #=> String
4648
+ # resp.namespaces[0].creation_status #=> String, one of "CREATED", "CREATING", "DELETING", "RETRYABLE_FAILURE", "NON_RETRYABLE_FAILURE"
4649
+ # resp.namespaces[0].identity_store #=> String, one of "QUICKSIGHT"
4650
+ # resp.namespaces[0].namespace_error.type #=> String, one of "PERMISSION_DENIED", "INTERNAL_SERVICE_ERROR"
4651
+ # resp.namespaces[0].namespace_error.message #=> String
3727
4652
  # resp.next_token #=> String
3728
4653
  # resp.request_id #=> String
3729
4654
  # resp.status #=> Integer
3730
4655
  #
3731
- # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListIngestions AWS API Documentation
4656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListNamespaces AWS API Documentation
3732
4657
  #
3733
- # @overload list_ingestions(params = {})
4658
+ # @overload list_namespaces(params = {})
3734
4659
  # @param [Hash] params ({})
3735
- def list_ingestions(params = {}, options = {})
3736
- req = build_request(:list_ingestions, params)
4660
+ def list_namespaces(params = {}, options = {})
4661
+ req = build_request(:list_namespaces, params)
3737
4662
  req.send_request(options)
3738
4663
  end
3739
4664
 
@@ -3866,7 +4791,7 @@ module Aws::QuickSight
3866
4791
  # resp.template_version_summary_list[0].arn #=> String
3867
4792
  # resp.template_version_summary_list[0].version_number #=> Integer
3868
4793
  # resp.template_version_summary_list[0].created_time #=> Time
3869
- # resp.template_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
4794
+ # 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"
3870
4795
  # resp.template_version_summary_list[0].description #=> String
3871
4796
  # resp.next_token #=> String
3872
4797
  # resp.status #=> Integer
@@ -4023,7 +4948,7 @@ module Aws::QuickSight
4023
4948
  # resp.theme_version_summary_list[0].arn #=> String
4024
4949
  # resp.theme_version_summary_list[0].description #=> String
4025
4950
  # resp.theme_version_summary_list[0].created_time #=> Time
4026
- # resp.theme_version_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
4951
+ # 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"
4027
4952
  # resp.next_token #=> String
4028
4953
  # resp.status #=> Integer
4029
4954
  # resp.request_id #=> String
@@ -4199,6 +5124,7 @@ module Aws::QuickSight
4199
5124
  # resp.user_list[0].identity_type #=> String, one of "IAM", "QUICKSIGHT"
4200
5125
  # resp.user_list[0].active #=> Boolean
4201
5126
  # resp.user_list[0].principal_id #=> String
5127
+ # resp.user_list[0].custom_permissions_name #=> String
4202
5128
  # resp.next_token #=> String
4203
5129
  # resp.request_id #=> String
4204
5130
  # resp.status #=> Integer
@@ -4272,6 +5198,38 @@ module Aws::QuickSight
4272
5198
  # The Amazon QuickSight user name that you want to create for the user
4273
5199
  # you are registering.
4274
5200
  #
5201
+ # @option params [String] :custom_permissions_name
5202
+ # (Enterprise edition only) The name of the custom permissions profile
5203
+ # that you want to assign to this user. Customized permissions allows
5204
+ # you to control a user's access by restricting access the following
5205
+ # operations:
5206
+ #
5207
+ # * Create and update data sources
5208
+ #
5209
+ # * Create and update datasets
5210
+ #
5211
+ # * Create and update email reports
5212
+ #
5213
+ # * Subscribe to email reports
5214
+ #
5215
+ # To add custom permissions to an existing user, use ` UpdateUser `
5216
+ # instead.
5217
+ #
5218
+ # A set of custom permissions includes any combination of these
5219
+ # restrictions. Currently, you need to create the profile names for
5220
+ # custom permission sets by using the QuickSight console. Then, you use
5221
+ # the `RegisterUser` API operation to assign the named set of
5222
+ # permissions to a QuickSight user.
5223
+ #
5224
+ # QuickSight custom permissions are applied through IAM policies.
5225
+ # Therefore, they override the permissions typically granted by
5226
+ # assigning QuickSight users to one of the default security cohorts in
5227
+ # QuickSight (admin, author, reader).
5228
+ #
5229
+ # This feature is available only to QuickSight Enterprise edition
5230
+ # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
5231
+ # (SSO).
5232
+ #
4275
5233
  # @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4276
5234
  #
4277
5235
  # * {Types::RegisterUserResponse#user #user} => Types::User
@@ -4290,6 +5248,7 @@ module Aws::QuickSight
4290
5248
  # aws_account_id: "AwsAccountId", # required
4291
5249
  # namespace: "Namespace", # required
4292
5250
  # user_name: "UserName",
5251
+ # custom_permissions_name: "RoleName",
4293
5252
  # })
4294
5253
  #
4295
5254
  # @example Response structure
@@ -4301,6 +5260,7 @@ module Aws::QuickSight
4301
5260
  # resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
4302
5261
  # resp.user.active #=> Boolean
4303
5262
  # resp.user.principal_id #=> String
5263
+ # resp.user.custom_permissions_name #=> String
4304
5264
  # resp.user_invitation_url #=> String
4305
5265
  # resp.request_id #=> String
4306
5266
  # resp.status #=> Integer
@@ -4314,7 +5274,107 @@ module Aws::QuickSight
4314
5274
  req.send_request(options)
4315
5275
  end
4316
5276
 
4317
- # Searchs for dashboards that belong to a user.
5277
+ # Restores an analysis.
5278
+ #
5279
+ # @option params [required, String] :aws_account_id
5280
+ # The ID of the AWS account that contains the analysis.
5281
+ #
5282
+ # @option params [required, String] :analysis_id
5283
+ # The ID of the analysis that you're restoring.
5284
+ #
5285
+ # @return [Types::RestoreAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5286
+ #
5287
+ # * {Types::RestoreAnalysisResponse#status #status} => Integer
5288
+ # * {Types::RestoreAnalysisResponse#arn #arn} => String
5289
+ # * {Types::RestoreAnalysisResponse#analysis_id #analysis_id} => String
5290
+ # * {Types::RestoreAnalysisResponse#request_id #request_id} => String
5291
+ #
5292
+ # @example Request syntax with placeholder values
5293
+ #
5294
+ # resp = client.restore_analysis({
5295
+ # aws_account_id: "AwsAccountId", # required
5296
+ # analysis_id: "RestrictiveResourceId", # required
5297
+ # })
5298
+ #
5299
+ # @example Response structure
5300
+ #
5301
+ # resp.status #=> Integer
5302
+ # resp.arn #=> String
5303
+ # resp.analysis_id #=> String
5304
+ # resp.request_id #=> String
5305
+ #
5306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RestoreAnalysis AWS API Documentation
5307
+ #
5308
+ # @overload restore_analysis(params = {})
5309
+ # @param [Hash] params ({})
5310
+ def restore_analysis(params = {}, options = {})
5311
+ req = build_request(:restore_analysis, params)
5312
+ req.send_request(options)
5313
+ end
5314
+
5315
+ # Searches for analyses that belong to the user specified in the filter.
5316
+ #
5317
+ # @option params [required, String] :aws_account_id
5318
+ # The ID of the AWS account that contains the analyses that you're
5319
+ # searching for.
5320
+ #
5321
+ # @option params [required, Array<Types::AnalysisSearchFilter>] :filters
5322
+ # The structure for the search filters that you want to apply to your
5323
+ # search.
5324
+ #
5325
+ # @option params [String] :next_token
5326
+ # A pagination token that can be used in a subsequent request.
5327
+ #
5328
+ # @option params [Integer] :max_results
5329
+ # The maximum number of results to return.
5330
+ #
5331
+ # @return [Types::SearchAnalysesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5332
+ #
5333
+ # * {Types::SearchAnalysesResponse#analysis_summary_list #analysis_summary_list} => Array&lt;Types::AnalysisSummary&gt;
5334
+ # * {Types::SearchAnalysesResponse#next_token #next_token} => String
5335
+ # * {Types::SearchAnalysesResponse#status #status} => Integer
5336
+ # * {Types::SearchAnalysesResponse#request_id #request_id} => String
5337
+ #
5338
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5339
+ #
5340
+ # @example Request syntax with placeholder values
5341
+ #
5342
+ # resp = client.search_analyses({
5343
+ # aws_account_id: "AwsAccountId", # required
5344
+ # filters: [ # required
5345
+ # {
5346
+ # operator: "StringEquals", # accepts StringEquals
5347
+ # name: "QUICKSIGHT_USER", # accepts QUICKSIGHT_USER
5348
+ # value: "String",
5349
+ # },
5350
+ # ],
5351
+ # next_token: "String",
5352
+ # max_results: 1,
5353
+ # })
5354
+ #
5355
+ # @example Response structure
5356
+ #
5357
+ # resp.analysis_summary_list #=> Array
5358
+ # resp.analysis_summary_list[0].arn #=> String
5359
+ # resp.analysis_summary_list[0].analysis_id #=> String
5360
+ # resp.analysis_summary_list[0].name #=> String
5361
+ # resp.analysis_summary_list[0].status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5362
+ # resp.analysis_summary_list[0].created_time #=> Time
5363
+ # resp.analysis_summary_list[0].last_updated_time #=> Time
5364
+ # resp.next_token #=> String
5365
+ # resp.status #=> Integer
5366
+ # resp.request_id #=> String
5367
+ #
5368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/SearchAnalyses AWS API Documentation
5369
+ #
5370
+ # @overload search_analyses(params = {})
5371
+ # @param [Hash] params ({})
5372
+ def search_analyses(params = {}, options = {})
5373
+ req = build_request(:search_analyses, params)
5374
+ req.send_request(options)
5375
+ end
5376
+
5377
+ # Searches for dashboards that belong to a user.
4318
5378
  #
4319
5379
  # @option params [required, String] :aws_account_id
4320
5380
  # The ID of the AWS account that contains the user whose dashboards
@@ -4478,6 +5538,271 @@ module Aws::QuickSight
4478
5538
  req.send_request(options)
4479
5539
  end
4480
5540
 
5541
+ # Updates Amazon QuickSight customizations the current AWS Region.
5542
+ # Currently, the only customization you can use is a theme.
5543
+ #
5544
+ # You can use customizations for your AWS account or, if you specify a
5545
+ # namespace, for a QuickSight namespace instead. Customizations that
5546
+ # apply to a namespace override customizations that apply to an AWS
5547
+ # account. To find out which customizations apply, use the
5548
+ # `DescribeAccountCustomization` API operation.
5549
+ #
5550
+ # @option params [required, String] :aws_account_id
5551
+ # The ID for the AWS account that you want to update QuickSight
5552
+ # customizations for.
5553
+ #
5554
+ # @option params [String] :namespace
5555
+ # The namespace that you want to update QuickSight customizations for.
5556
+ #
5557
+ # @option params [required, Types::AccountCustomization] :account_customization
5558
+ # The QuickSight customizations you're updating in the current AWS
5559
+ # Region.
5560
+ #
5561
+ # @return [Types::UpdateAccountCustomizationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5562
+ #
5563
+ # * {Types::UpdateAccountCustomizationResponse#arn #arn} => String
5564
+ # * {Types::UpdateAccountCustomizationResponse#aws_account_id #aws_account_id} => String
5565
+ # * {Types::UpdateAccountCustomizationResponse#namespace #namespace} => String
5566
+ # * {Types::UpdateAccountCustomizationResponse#account_customization #account_customization} => Types::AccountCustomization
5567
+ # * {Types::UpdateAccountCustomizationResponse#request_id #request_id} => String
5568
+ # * {Types::UpdateAccountCustomizationResponse#status #status} => Integer
5569
+ #
5570
+ # @example Request syntax with placeholder values
5571
+ #
5572
+ # resp = client.update_account_customization({
5573
+ # aws_account_id: "AwsAccountId", # required
5574
+ # namespace: "Namespace",
5575
+ # account_customization: { # required
5576
+ # default_theme: "Arn",
5577
+ # },
5578
+ # })
5579
+ #
5580
+ # @example Response structure
5581
+ #
5582
+ # resp.arn #=> String
5583
+ # resp.aws_account_id #=> String
5584
+ # resp.namespace #=> String
5585
+ # resp.account_customization.default_theme #=> String
5586
+ # resp.request_id #=> String
5587
+ # resp.status #=> Integer
5588
+ #
5589
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountCustomization AWS API Documentation
5590
+ #
5591
+ # @overload update_account_customization(params = {})
5592
+ # @param [Hash] params ({})
5593
+ def update_account_customization(params = {}, options = {})
5594
+ req = build_request(:update_account_customization, params)
5595
+ req.send_request(options)
5596
+ end
5597
+
5598
+ # Updates the Amazon QuickSight settings in your AWS Account.
5599
+ #
5600
+ # @option params [required, String] :aws_account_id
5601
+ # The ID for the AWS account that contains the QuickSight settings that
5602
+ # you want to list.
5603
+ #
5604
+ # @option params [required, String] :default_namespace
5605
+ # The default namespace for this AWS Account. Currently, the default is
5606
+ # `default`. IAM users who register for the first time with QuickSight
5607
+ # provide an email that becomes associated with the default namespace.
5608
+ #
5609
+ # @option params [String] :notification_email
5610
+ # The email address that you want QuickSight to send notifications to
5611
+ # regarding your AWS account or QuickSight subscription.
5612
+ #
5613
+ # @return [Types::UpdateAccountSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5614
+ #
5615
+ # * {Types::UpdateAccountSettingsResponse#request_id #request_id} => String
5616
+ # * {Types::UpdateAccountSettingsResponse#status #status} => Integer
5617
+ #
5618
+ # @example Request syntax with placeholder values
5619
+ #
5620
+ # resp = client.update_account_settings({
5621
+ # aws_account_id: "AwsAccountId", # required
5622
+ # default_namespace: "Namespace", # required
5623
+ # notification_email: "String",
5624
+ # })
5625
+ #
5626
+ # @example Response structure
5627
+ #
5628
+ # resp.request_id #=> String
5629
+ # resp.status #=> Integer
5630
+ #
5631
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAccountSettings AWS API Documentation
5632
+ #
5633
+ # @overload update_account_settings(params = {})
5634
+ # @param [Hash] params ({})
5635
+ def update_account_settings(params = {}, options = {})
5636
+ req = build_request(:update_account_settings, params)
5637
+ req.send_request(options)
5638
+ end
5639
+
5640
+ # Updates an analysis in Amazon QuickSight
5641
+ #
5642
+ # @option params [required, String] :aws_account_id
5643
+ # The ID of the AWS account that contains the analysis that you're
5644
+ # updating.
5645
+ #
5646
+ # @option params [required, String] :analysis_id
5647
+ # The ID for the analysis that you're updating. This ID displays in the
5648
+ # URL of the analysis.
5649
+ #
5650
+ # @option params [required, String] :name
5651
+ # A descriptive name for the analysis that you're updating. This name
5652
+ # displays for the analysis in the QuickSight console.
5653
+ #
5654
+ # @option params [Types::Parameters] :parameters
5655
+ # The parameter names and override values that you want to use. An
5656
+ # analysis can have any parameter type, and some parameters might accept
5657
+ # multiple values.
5658
+ #
5659
+ # @option params [required, Types::AnalysisSourceEntity] :source_entity
5660
+ # A source entity to use for the analysis that you're updating. This
5661
+ # metadata structure contains details that describe a source template
5662
+ # and one or more datasets.
5663
+ #
5664
+ # @option params [String] :theme_arn
5665
+ # The Amazon Resource Name (ARN) for the theme to apply to the analysis
5666
+ # that you're creating. To see the theme in the QuickSight console,
5667
+ # make sure that you have access to it.
5668
+ #
5669
+ # @return [Types::UpdateAnalysisResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5670
+ #
5671
+ # * {Types::UpdateAnalysisResponse#arn #arn} => String
5672
+ # * {Types::UpdateAnalysisResponse#analysis_id #analysis_id} => String
5673
+ # * {Types::UpdateAnalysisResponse#update_status #update_status} => String
5674
+ # * {Types::UpdateAnalysisResponse#status #status} => Integer
5675
+ # * {Types::UpdateAnalysisResponse#request_id #request_id} => String
5676
+ #
5677
+ # @example Request syntax with placeholder values
5678
+ #
5679
+ # resp = client.update_analysis({
5680
+ # aws_account_id: "AwsAccountId", # required
5681
+ # analysis_id: "RestrictiveResourceId", # required
5682
+ # name: "AnalysisName", # required
5683
+ # parameters: {
5684
+ # string_parameters: [
5685
+ # {
5686
+ # name: "NonEmptyString", # required
5687
+ # values: ["String"], # required
5688
+ # },
5689
+ # ],
5690
+ # integer_parameters: [
5691
+ # {
5692
+ # name: "NonEmptyString", # required
5693
+ # values: [1], # required
5694
+ # },
5695
+ # ],
5696
+ # decimal_parameters: [
5697
+ # {
5698
+ # name: "NonEmptyString", # required
5699
+ # values: [1.0], # required
5700
+ # },
5701
+ # ],
5702
+ # date_time_parameters: [
5703
+ # {
5704
+ # name: "NonEmptyString", # required
5705
+ # values: [Time.now], # required
5706
+ # },
5707
+ # ],
5708
+ # },
5709
+ # source_entity: { # required
5710
+ # source_template: {
5711
+ # data_set_references: [ # required
5712
+ # {
5713
+ # data_set_placeholder: "NonEmptyString", # required
5714
+ # data_set_arn: "Arn", # required
5715
+ # },
5716
+ # ],
5717
+ # arn: "Arn", # required
5718
+ # },
5719
+ # },
5720
+ # theme_arn: "Arn",
5721
+ # })
5722
+ #
5723
+ # @example Response structure
5724
+ #
5725
+ # resp.arn #=> String
5726
+ # resp.analysis_id #=> String
5727
+ # resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5728
+ # resp.status #=> Integer
5729
+ # resp.request_id #=> String
5730
+ #
5731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysis AWS API Documentation
5732
+ #
5733
+ # @overload update_analysis(params = {})
5734
+ # @param [Hash] params ({})
5735
+ def update_analysis(params = {}, options = {})
5736
+ req = build_request(:update_analysis, params)
5737
+ req.send_request(options)
5738
+ end
5739
+
5740
+ # Updates the read and write permissions for an analysis.
5741
+ #
5742
+ # @option params [required, String] :aws_account_id
5743
+ # The ID of the AWS account that contains the analysis whose permissions
5744
+ # you're updating. You must be using the AWS account that the analysis
5745
+ # is in.
5746
+ #
5747
+ # @option params [required, String] :analysis_id
5748
+ # The ID of the analysis whose permissions you're updating. The ID is
5749
+ # part of the analysis URL.
5750
+ #
5751
+ # @option params [Array<Types::ResourcePermission>] :grant_permissions
5752
+ # A structure that describes the permissions to add and the principal to
5753
+ # add them to.
5754
+ #
5755
+ # @option params [Array<Types::ResourcePermission>] :revoke_permissions
5756
+ # A structure that describes the permissions to remove and the principal
5757
+ # to remove them from.
5758
+ #
5759
+ # @return [Types::UpdateAnalysisPermissionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5760
+ #
5761
+ # * {Types::UpdateAnalysisPermissionsResponse#analysis_arn #analysis_arn} => String
5762
+ # * {Types::UpdateAnalysisPermissionsResponse#analysis_id #analysis_id} => String
5763
+ # * {Types::UpdateAnalysisPermissionsResponse#permissions #permissions} => Array&lt;Types::ResourcePermission&gt;
5764
+ # * {Types::UpdateAnalysisPermissionsResponse#request_id #request_id} => String
5765
+ # * {Types::UpdateAnalysisPermissionsResponse#status #status} => Integer
5766
+ #
5767
+ # @example Request syntax with placeholder values
5768
+ #
5769
+ # resp = client.update_analysis_permissions({
5770
+ # aws_account_id: "AwsAccountId", # required
5771
+ # analysis_id: "RestrictiveResourceId", # required
5772
+ # grant_permissions: [
5773
+ # {
5774
+ # principal: "Principal", # required
5775
+ # actions: ["String"], # required
5776
+ # },
5777
+ # ],
5778
+ # revoke_permissions: [
5779
+ # {
5780
+ # principal: "Principal", # required
5781
+ # actions: ["String"], # required
5782
+ # },
5783
+ # ],
5784
+ # })
5785
+ #
5786
+ # @example Response structure
5787
+ #
5788
+ # resp.analysis_arn #=> String
5789
+ # resp.analysis_id #=> String
5790
+ # resp.permissions #=> Array
5791
+ # resp.permissions[0].principal #=> String
5792
+ # resp.permissions[0].actions #=> Array
5793
+ # resp.permissions[0].actions[0] #=> String
5794
+ # resp.request_id #=> String
5795
+ # resp.status #=> Integer
5796
+ #
5797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateAnalysisPermissions AWS API Documentation
5798
+ #
5799
+ # @overload update_analysis_permissions(params = {})
5800
+ # @param [Hash] params ({})
5801
+ def update_analysis_permissions(params = {}, options = {})
5802
+ req = build_request(:update_analysis_permissions, params)
5803
+ req.send_request(options)
5804
+ end
5805
+
4481
5806
  # Updates a dashboard in an AWS account.
4482
5807
  #
4483
5808
  # @option params [required, String] :aws_account_id
@@ -4524,7 +5849,7 @@ module Aws::QuickSight
4524
5849
  #
4525
5850
  # * `AvailabilityStatus` for `ExportToCSVOption` - This status can be
4526
5851
  # either `ENABLED` or `DISABLED`. The visual option to export data to
4527
- # .csv format isn't enabled when this is set to `DISABLED`. This
5852
+ # .CSV format isn't enabled when this is set to `DISABLED`. This
4528
5853
  # option is `ENABLED` by default.
4529
5854
  #
4530
5855
  # * `VisibilityState` for `SheetControlsOption` - This visibility state
@@ -4609,7 +5934,7 @@ module Aws::QuickSight
4609
5934
  # resp.arn #=> String
4610
5935
  # resp.version_arn #=> String
4611
5936
  # resp.dashboard_id #=> String
4612
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
5937
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
4613
5938
  # resp.status #=> Integer
4614
5939
  # resp.request_id #=> String
4615
5940
  #
@@ -4875,6 +6200,7 @@ module Aws::QuickSight
4875
6200
  # },
4876
6201
  # ],
4877
6202
  # row_level_permission_data_set: {
6203
+ # namespace: "Namespace",
4878
6204
  # arn: "Arn", # required
4879
6205
  # permission_policy: "GRANT_ACCESS", # required, accepts GRANT_ACCESS, DENY_ACCESS
4880
6206
  # },
@@ -5194,7 +6520,7 @@ module Aws::QuickSight
5194
6520
  #
5195
6521
  # resp.arn #=> String
5196
6522
  # resp.data_source_id #=> String
5197
- # resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
6523
+ # resp.update_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5198
6524
  # resp.request_id #=> String
5199
6525
  # resp.status #=> Integer
5200
6526
  #
@@ -5464,7 +6790,7 @@ module Aws::QuickSight
5464
6790
  # resp.template_id #=> String
5465
6791
  # resp.arn #=> String
5466
6792
  # resp.version_arn #=> String
5467
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
6793
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5468
6794
  # resp.status #=> Integer
5469
6795
  # resp.request_id #=> String
5470
6796
  #
@@ -5679,7 +7005,7 @@ module Aws::QuickSight
5679
7005
  # resp.theme_id #=> String
5680
7006
  # resp.arn #=> String
5681
7007
  # resp.version_arn #=> String
5682
- # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED"
7008
+ # resp.creation_status #=> String, one of "CREATION_IN_PROGRESS", "CREATION_SUCCESSFUL", "CREATION_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_SUCCESSFUL", "UPDATE_FAILED", "DELETED"
5683
7009
  # resp.status #=> Integer
5684
7010
  # resp.request_id #=> String
5685
7011
  #
@@ -5858,8 +7184,8 @@ module Aws::QuickSight
5858
7184
  # The email address of the user that you want to update.
5859
7185
  #
5860
7186
  # @option params [required, String] :role
5861
- # The Amazon QuickSight role of the user. The user role can be one of
5862
- # the following:
7187
+ # The Amazon QuickSight role of the user. The role can be one of the
7188
+ # following default security cohorts:
5863
7189
  #
5864
7190
  # * `READER`\: A user who has read-only access to dashboards.
5865
7191
  #
@@ -5869,6 +7195,45 @@ module Aws::QuickSight
5869
7195
  # * `ADMIN`\: A user who is an author, who can also manage Amazon
5870
7196
  # QuickSight settings.
5871
7197
  #
7198
+ # The name of the QuickSight role is invisible to the user except for
7199
+ # the console screens dealing with permissions.
7200
+ #
7201
+ # @option params [String] :custom_permissions_name
7202
+ # (Enterprise edition only) The name of the custom permissions profile
7203
+ # that you want to assign to this user. Customized permissions allows
7204
+ # you to control a user's access by restricting access the following
7205
+ # operations:
7206
+ #
7207
+ # * Create and update data sources
7208
+ #
7209
+ # * Create and update datasets
7210
+ #
7211
+ # * Create and update email reports
7212
+ #
7213
+ # * Subscribe to email reports
7214
+ #
7215
+ # A set of custom permissions includes any combination of these
7216
+ # restrictions. Currently, you need to create the profile names for
7217
+ # custom permission sets by using the QuickSight console. Then, you use
7218
+ # the `RegisterUser` API operation to assign the named set of
7219
+ # permissions to a QuickSight user.
7220
+ #
7221
+ # QuickSight custom permissions are applied through IAM policies.
7222
+ # Therefore, they override the permissions typically granted by
7223
+ # assigning QuickSight users to one of the default security cohorts in
7224
+ # QuickSight (admin, author, reader).
7225
+ #
7226
+ # This feature is available only to QuickSight Enterprise edition
7227
+ # subscriptions that use SAML 2.0-Based Federation for Single Sign-On
7228
+ # (SSO).
7229
+ #
7230
+ # @option params [Boolean] :unapply_custom_permissions
7231
+ # A flag that you use to indicate that you want to remove all custom
7232
+ # permissions from this user. Using this parameter resets the user to
7233
+ # the state it was in before a custom permissions profile was applied.
7234
+ # This parameter defaults to NULL and it doesn't accept any other
7235
+ # value.
7236
+ #
5872
7237
  # @return [Types::UpdateUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5873
7238
  #
5874
7239
  # * {Types::UpdateUserResponse#user #user} => Types::User
@@ -5883,6 +7248,8 @@ module Aws::QuickSight
5883
7248
  # namespace: "Namespace", # required
5884
7249
  # email: "String", # required
5885
7250
  # role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
7251
+ # custom_permissions_name: "RoleName",
7252
+ # unapply_custom_permissions: false,
5886
7253
  # })
5887
7254
  #
5888
7255
  # @example Response structure
@@ -5894,6 +7261,7 @@ module Aws::QuickSight
5894
7261
  # resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
5895
7262
  # resp.user.active #=> Boolean
5896
7263
  # resp.user.principal_id #=> String
7264
+ # resp.user.custom_permissions_name #=> String
5897
7265
  # resp.request_id #=> String
5898
7266
  # resp.status #=> Integer
5899
7267
  #
@@ -5919,7 +7287,7 @@ module Aws::QuickSight
5919
7287
  params: params,
5920
7288
  config: config)
5921
7289
  context[:gem_name] = 'aws-sdk-quicksight'
5922
- context[:gem_version] = '1.25.0'
7290
+ context[:gem_version] = '1.30.0'
5923
7291
  Seahorse::Client::Request.new(handlers, context)
5924
7292
  end
5925
7293