aws-sdk-quicksight 1.0.0 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-quicksight.rb +1 -1
- data/lib/aws-sdk-quicksight/client.rb +137 -10
- data/lib/aws-sdk-quicksight/client_api.rb +1 -0
- data/lib/aws-sdk-quicksight/types.rb +17 -10
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: db886b2237ad2cb9aa3204ac06960466ae3ef0e7
|
4
|
+
data.tar.gz: 2e471ec205971e0b8c2ec9d6584f8e9f2943548a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 82e0d1db69b69b8a7c39d67dcab1a64bdcefdfa5981e020b28fc37c9f770e63f82fee62a8dccfe62dcc623bd8d4f4836f003dd9ac4eccfe4bbe81bbba6d522f9
|
7
|
+
data.tar.gz: 618cf042a61a8f8822c2e9f9628a80d33872f08c801547b20ef055e41709a9740caafce7b1708aa16f24c9e4cea3e6fa3cd3473f5a2f0e62a121aedd49331cce
|
data/lib/aws-sdk-quicksight.rb
CHANGED
@@ -213,6 +213,12 @@ module Aws::QuickSight
|
|
213
213
|
#
|
214
214
|
# The response is a group object.
|
215
215
|
#
|
216
|
+
# **CLI Sample:**
|
217
|
+
#
|
218
|
+
# `aws quicksight create-group --aws-account-id=111122223333
|
219
|
+
# --namespace=default --group-name="Sales-Management"
|
220
|
+
# --description="Sales Management - Forecasting" `
|
221
|
+
#
|
216
222
|
# @option params [required, String] :group_name
|
217
223
|
# A name for the group that you want to create.
|
218
224
|
#
|
@@ -271,6 +277,11 @@ module Aws::QuickSight
|
|
271
277
|
#
|
272
278
|
# The response is the group member object.
|
273
279
|
#
|
280
|
+
# **CLI Sample:**
|
281
|
+
#
|
282
|
+
# `aws quicksight create-group-membership --aws-account-id=111122223333
|
283
|
+
# --namespace=default --group-name=Sales --member-name=Pat `
|
284
|
+
#
|
274
285
|
# @option params [required, String] :member_name
|
275
286
|
# The name of the user that you want to add to the group membership.
|
276
287
|
#
|
@@ -322,6 +333,11 @@ module Aws::QuickSight
|
|
322
333
|
# `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name>
|
323
334
|
# `.
|
324
335
|
#
|
336
|
+
# **CLI Sample:**
|
337
|
+
#
|
338
|
+
# `aws quicksight delete-group -\-aws-account-id=111122223333
|
339
|
+
# -\-namespace=default -\-group-name=Sales-Management `
|
340
|
+
#
|
325
341
|
# @option params [required, String] :group_name
|
326
342
|
# The name of the group that you want to delete.
|
327
343
|
#
|
@@ -371,6 +387,12 @@ module Aws::QuickSight
|
|
371
387
|
#
|
372
388
|
# The condition key is `quicksight:UserName`.
|
373
389
|
#
|
390
|
+
# **CLI Sample:**
|
391
|
+
#
|
392
|
+
# `aws quicksight delete-group-membership --aws-account-id=111122223333
|
393
|
+
# --namespace=default --group-name=Sales-Management
|
394
|
+
# --member-name=Charlie `
|
395
|
+
#
|
374
396
|
# @option params [required, String] :member_name
|
375
397
|
# The name of the user that you want to delete from the group
|
376
398
|
# membership.
|
@@ -423,6 +445,11 @@ module Aws::QuickSight
|
|
423
445
|
# `arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name>
|
424
446
|
# `.
|
425
447
|
#
|
448
|
+
# **CLI Sample:**
|
449
|
+
#
|
450
|
+
# `aws quicksight delete-user --aws-account-id=111122223333
|
451
|
+
# --namespace=default --user-name=Pat `
|
452
|
+
#
|
426
453
|
# @option params [required, String] :user_name
|
427
454
|
# The name of the user that you want to delete.
|
428
455
|
#
|
@@ -469,6 +496,11 @@ module Aws::QuickSight
|
|
469
496
|
#
|
470
497
|
# The response is the group object.
|
471
498
|
#
|
499
|
+
# **CLI Sample:**
|
500
|
+
#
|
501
|
+
# `aws quicksight describe-group -\-aws-account-id=11112222333
|
502
|
+
# -\-namespace=default -\-group-name=Sales `
|
503
|
+
#
|
472
504
|
# @option params [required, String] :group_name
|
473
505
|
# The name of the group that you want to describe.
|
474
506
|
#
|
@@ -521,6 +553,11 @@ module Aws::QuickSight
|
|
521
553
|
# Resource Name (ARN), AWS Identity and Access Management (IAM) role,
|
522
554
|
# and email address.
|
523
555
|
#
|
556
|
+
# **CLI Sample:**
|
557
|
+
#
|
558
|
+
# `aws quicksight describe-user --aws-account-id=111122223333
|
559
|
+
# --namespace=default --user-name=Pat `
|
560
|
+
#
|
524
561
|
# @option params [required, String] :user_name
|
525
562
|
# The name of the user that you want to describe.
|
526
563
|
#
|
@@ -565,9 +602,42 @@ module Aws::QuickSight
|
|
565
602
|
req.send_request(options)
|
566
603
|
end
|
567
604
|
|
568
|
-
# Generates
|
569
|
-
# properly, you need to configure the dashboards and
|
570
|
-
#
|
605
|
+
# Generates a server-side embeddable URL and authorization code. Before
|
606
|
+
# this can work properly, first you need to configure the dashboards and
|
607
|
+
# user permissions. For more information, see [ Embedding Amazon
|
608
|
+
# QuickSight Dashboards][1].
|
609
|
+
#
|
610
|
+
# Currently, you can use `GetDashboardEmbedURL` only from the server,
|
611
|
+
# not from the user’s browser.
|
612
|
+
#
|
613
|
+
# **CLI Sample:**
|
614
|
+
#
|
615
|
+
# Assume the role with permissions enabled for actions:
|
616
|
+
# `quickSight:RegisterUser` and `quicksight:GetDashboardEmbedURL`. You
|
617
|
+
# can use assume-role, assume-role-with-web-identity, or
|
618
|
+
# assume-role-with-saml.
|
619
|
+
#
|
620
|
+
# `aws sts assume-role --role-arn
|
621
|
+
# "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role"
|
622
|
+
# --role-session-name embeddingsession`
|
623
|
+
#
|
624
|
+
# If the user does not exist in QuickSight, register the user:
|
625
|
+
#
|
626
|
+
# `aws quicksight register-user --aws-account-id 111122223333
|
627
|
+
# --namespace default --identity-type IAM --iam-arn
|
628
|
+
# "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role"
|
629
|
+
# --user-role READER --session-name "embeddingsession" --email
|
630
|
+
# user123@example.com --region us-east-1`
|
631
|
+
#
|
632
|
+
# Get the URL for the embedded dashboard
|
633
|
+
#
|
634
|
+
# `aws quicksight get-dashboard-embed-url --aws-account-id 111122223333
|
635
|
+
# --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type
|
636
|
+
# IAM`
|
637
|
+
#
|
638
|
+
#
|
639
|
+
#
|
640
|
+
# [1]: https://docs.aws.amazon.com/en_us/quicksight/latest/user/embedding.html
|
571
641
|
#
|
572
642
|
# @option params [required, String] :aws_account_id
|
573
643
|
# AWS account ID that contains the dashboard you are embedding.
|
@@ -576,8 +646,7 @@ module Aws::QuickSight
|
|
576
646
|
# The ID for the dashboard, also added to IAM policy
|
577
647
|
#
|
578
648
|
# @option params [required, String] :identity_type
|
579
|
-
# The authentication method the user uses to sign in (IAM
|
580
|
-
# QUICKSIGHT).
|
649
|
+
# The authentication method the user uses to sign in (IAM only).
|
581
650
|
#
|
582
651
|
# @option params [Integer] :session_lifetime_in_minutes
|
583
652
|
# How many minutes the session is valid. The session lifetime must be
|
@@ -631,6 +700,11 @@ module Aws::QuickSight
|
|
631
700
|
#
|
632
701
|
# The response is a list of group member objects.
|
633
702
|
#
|
703
|
+
# **CLI Sample:**
|
704
|
+
#
|
705
|
+
# `aws quicksight list-group-memberships -\-aws-account-id=111122223333
|
706
|
+
# -\-namespace=default `
|
707
|
+
#
|
634
708
|
# @option params [required, String] :group_name
|
635
709
|
# The name of the group that you want to see a membership list of.
|
636
710
|
#
|
@@ -690,6 +764,11 @@ module Aws::QuickSight
|
|
690
764
|
#
|
691
765
|
# The response is a list of group objects.
|
692
766
|
#
|
767
|
+
# **CLI Sample:**
|
768
|
+
#
|
769
|
+
# `aws quicksight list-groups -\-aws-account-id=111122223333
|
770
|
+
# -\-namespace=default `
|
771
|
+
#
|
693
772
|
# @option params [required, String] :aws_account_id
|
694
773
|
# The ID for the AWS account that the group is in. Currently, you use
|
695
774
|
# the ID for the AWS account that contains your Amazon QuickSight
|
@@ -739,14 +818,28 @@ module Aws::QuickSight
|
|
739
818
|
req.send_request(options)
|
740
819
|
end
|
741
820
|
|
742
|
-
# Lists the Amazon QuickSight groups that
|
821
|
+
# Lists the Amazon QuickSight groups that an Amazon QuickSight user is a
|
822
|
+
# member of.
|
823
|
+
#
|
824
|
+
# The permission resource is
|
825
|
+
# `arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name>
|
826
|
+
# `.
|
827
|
+
#
|
828
|
+
# The response is a one or more group objects.
|
829
|
+
#
|
830
|
+
# **CLI Sample:**
|
831
|
+
#
|
832
|
+
# `aws quicksight list-user-groups -\-user-name=Pat
|
833
|
+
# -\-aws-account-id=111122223333 -\-namespace=default
|
834
|
+
# -\-region=us-east-1 `
|
743
835
|
#
|
744
836
|
# @option params [required, String] :user_name
|
745
|
-
# The
|
837
|
+
# The Amazon QuickSight user name that you want to list group
|
838
|
+
# memberships for.
|
746
839
|
#
|
747
840
|
# @option params [required, String] :aws_account_id
|
748
|
-
# The AWS Account ID that the user is in. Currently, use the
|
749
|
-
#
|
841
|
+
# The AWS Account ID that the user is in. Currently, you use the ID for
|
842
|
+
# the AWS account that contains your Amazon QuickSight account.
|
750
843
|
#
|
751
844
|
# @option params [required, String] :namespace
|
752
845
|
# The namespace. Currently, you should set this to `default`.
|
@@ -803,6 +896,11 @@ module Aws::QuickSight
|
|
803
896
|
# Resource Name (ARN), AWS Identity and Access Management (IAM) role,
|
804
897
|
# and email address.
|
805
898
|
#
|
899
|
+
# **CLI Sample:**
|
900
|
+
#
|
901
|
+
# `aws quicksight list-users --aws-account-id=111122223333
|
902
|
+
# --namespace=default `
|
903
|
+
#
|
806
904
|
# @option params [required, String] :aws_account_id
|
807
905
|
# The ID for the AWS account that the user is in. Currently, you use the
|
808
906
|
# ID for the AWS account that contains your Amazon QuickSight account.
|
@@ -868,6 +966,12 @@ module Aws::QuickSight
|
|
868
966
|
# The condition keys are `quicksight:IamArn` and
|
869
967
|
# `quicksight:SessionName`.
|
870
968
|
#
|
969
|
+
# **CLI Sample:**
|
970
|
+
#
|
971
|
+
# `aws quicksight register-user -\-aws-account-id=111122223333
|
972
|
+
# -\-namespace=default -\-email=pat@example.com -\-identity-type=IAM
|
973
|
+
# -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat `
|
974
|
+
#
|
871
975
|
# @option params [required, String] :identity_type
|
872
976
|
# Amazon QuickSight supports several ways of managing the identity of
|
873
977
|
# users. This parameter accepts two values:
|
@@ -921,6 +1025,7 @@ module Aws::QuickSight
|
|
921
1025
|
# @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
922
1026
|
#
|
923
1027
|
# * {Types::RegisterUserResponse#user #user} => Types::User
|
1028
|
+
# * {Types::RegisterUserResponse#user_invitation_url #user_invitation_url} => String
|
924
1029
|
# * {Types::RegisterUserResponse#request_id #request_id} => String
|
925
1030
|
# * {Types::RegisterUserResponse#status #status} => Integer
|
926
1031
|
#
|
@@ -945,6 +1050,7 @@ module Aws::QuickSight
|
|
945
1050
|
# resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
|
946
1051
|
# resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
|
947
1052
|
# resp.user.active #=> Boolean
|
1053
|
+
# resp.user_invitation_url #=> String
|
948
1054
|
# resp.request_id #=> String
|
949
1055
|
# resp.status #=> Integer
|
950
1056
|
#
|
@@ -965,6 +1071,12 @@ module Aws::QuickSight
|
|
965
1071
|
#
|
966
1072
|
# The response is a group object.
|
967
1073
|
#
|
1074
|
+
# **CLI Sample:**
|
1075
|
+
#
|
1076
|
+
# `aws quicksight update-group --aws-account-id=111122223333
|
1077
|
+
# --namespace=default --group-name=Sales --description="Sales BI
|
1078
|
+
# Dashboards" `
|
1079
|
+
#
|
968
1080
|
# @option params [required, String] :group_name
|
969
1081
|
# The name of the group that you want to update.
|
970
1082
|
#
|
@@ -1013,6 +1125,21 @@ module Aws::QuickSight
|
|
1013
1125
|
|
1014
1126
|
# Updates an Amazon QuickSight user.
|
1015
1127
|
#
|
1128
|
+
# The permission resource is
|
1129
|
+
# `arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name>
|
1130
|
+
# `.
|
1131
|
+
#
|
1132
|
+
# The response is a user object that contains the user's Amazon
|
1133
|
+
# QuickSight user name, email address, active or inactive status in
|
1134
|
+
# Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name
|
1135
|
+
# (ARN).
|
1136
|
+
#
|
1137
|
+
# **CLI Sample:**
|
1138
|
+
#
|
1139
|
+
# `aws quicksight update-user --user-name=Pat --role=ADMIN
|
1140
|
+
# --email=new_address@amazon.com --aws-account-id=111122223333
|
1141
|
+
# --namespace=default --region=us-east-1 `
|
1142
|
+
#
|
1016
1143
|
# @option params [required, String] :user_name
|
1017
1144
|
# The Amazon QuickSight user name that you want to update.
|
1018
1145
|
#
|
@@ -1087,7 +1214,7 @@ module Aws::QuickSight
|
|
1087
1214
|
params: params,
|
1088
1215
|
config: config)
|
1089
1216
|
context[:gem_name] = 'aws-sdk-quicksight'
|
1090
|
-
context[:gem_version] = '1.
|
1217
|
+
context[:gem_version] = '1.1.0'
|
1091
1218
|
Seahorse::Client::Request.new(handlers, context)
|
1092
1219
|
end
|
1093
1220
|
|
@@ -237,6 +237,7 @@ module Aws::QuickSight
|
|
237
237
|
RegisterUserRequest.struct_class = Types::RegisterUserRequest
|
238
238
|
|
239
239
|
RegisterUserResponse.add_member(:user, Shapes::ShapeRef.new(shape: User, location_name: "User"))
|
240
|
+
RegisterUserResponse.add_member(:user_invitation_url, Shapes::ShapeRef.new(shape: String, location_name: "UserInvitationUrl"))
|
240
241
|
RegisterUserResponse.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
|
241
242
|
RegisterUserResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusCode, location: "statusCode", location_name: "Status"))
|
242
243
|
RegisterUserResponse.struct_class = Types::RegisterUserResponse
|
@@ -408,8 +408,7 @@ module Aws::QuickSight
|
|
408
408
|
# @return [String]
|
409
409
|
#
|
410
410
|
# @!attribute [rw] identity_type
|
411
|
-
# The authentication method the user uses to sign in (IAM
|
412
|
-
# QUICKSIGHT).
|
411
|
+
# The authentication method the user uses to sign in (IAM only).
|
413
412
|
# @return [String]
|
414
413
|
#
|
415
414
|
# @!attribute [rw] session_lifetime_in_minutes
|
@@ -440,10 +439,10 @@ module Aws::QuickSight
|
|
440
439
|
end
|
441
440
|
|
442
441
|
# @!attribute [rw] embed_url
|
443
|
-
#
|
444
|
-
#
|
445
|
-
#
|
446
|
-
#
|
442
|
+
# URL that you can put into your server-side webpage to embed your
|
443
|
+
# dashboard. This URL is valid for 5 minutes, and the resulting
|
444
|
+
# session is valid for 10 hours. The API provides the URL with an
|
445
|
+
# auth\_code that enables a single-signon session.
|
447
446
|
# @return [String]
|
448
447
|
#
|
449
448
|
# @!attribute [rw] status
|
@@ -654,12 +653,13 @@ module Aws::QuickSight
|
|
654
653
|
# }
|
655
654
|
#
|
656
655
|
# @!attribute [rw] user_name
|
657
|
-
# The
|
656
|
+
# The Amazon QuickSight user name that you want to list group
|
657
|
+
# memberships for.
|
658
658
|
# @return [String]
|
659
659
|
#
|
660
660
|
# @!attribute [rw] aws_account_id
|
661
|
-
# The AWS Account ID that the user is in. Currently, use the
|
662
|
-
#
|
661
|
+
# The AWS Account ID that the user is in. Currently, you use the ID
|
662
|
+
# for the AWS account that contains your Amazon QuickSight account.
|
663
663
|
# @return [String]
|
664
664
|
#
|
665
665
|
# @!attribute [rw] namespace
|
@@ -698,7 +698,7 @@ module Aws::QuickSight
|
|
698
698
|
# @return [String]
|
699
699
|
#
|
700
700
|
# @!attribute [rw] status
|
701
|
-
# The
|
701
|
+
# The HTTP status of the request.
|
702
702
|
# @return [Integer]
|
703
703
|
#
|
704
704
|
# @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroupsResponse AWS API Documentation
|
@@ -867,6 +867,12 @@ module Aws::QuickSight
|
|
867
867
|
# The user name.
|
868
868
|
# @return [Types::User]
|
869
869
|
#
|
870
|
+
# @!attribute [rw] user_invitation_url
|
871
|
+
# The URL the user visits to complete registration and provide a
|
872
|
+
# password. This is returned only for users with an identity type of
|
873
|
+
# `QUICKSIGHT`.
|
874
|
+
# @return [String]
|
875
|
+
#
|
870
876
|
# @!attribute [rw] request_id
|
871
877
|
# The AWS request ID for this operation.
|
872
878
|
# @return [String]
|
@@ -879,6 +885,7 @@ module Aws::QuickSight
|
|
879
885
|
#
|
880
886
|
class RegisterUserResponse < Struct.new(
|
881
887
|
:user,
|
888
|
+
:user_invitation_url,
|
882
889
|
:request_id,
|
883
890
|
:status)
|
884
891
|
include Aws::Structure
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-quicksight
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.1.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-12-17 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|