aws-sdk-quicksight 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ed332e50752563b68f182b2a692ec1f99e6382e
-  data.tar.gz: c8d94bb8a25be8d56e64be37a8363489022eb4ce
+  metadata.gz: db886b2237ad2cb9aa3204ac06960466ae3ef0e7
+  data.tar.gz: 2e471ec205971e0b8c2ec9d6584f8e9f2943548a
 SHA512:
-  metadata.gz: 7113fe7c8c34043b3f5aa7e8eb938054cff4756f4ade37849fa5d2ea925421cd3a236ea64d5ea4c2d7121a503313b5122e7e80f925fa196005524ab01cf5cf49
-  data.tar.gz: 3444f4c3f5dedd68923e74e4cd146696fbc78706661b9199de91cfd8c205af1b42d549a3a48d622479cbc1f95ec8f6885caf3b1006dd1deb42aa1d5cfcf432b0
+  metadata.gz: 82e0d1db69b69b8a7c39d67dcab1a64bdcefdfa5981e020b28fc37c9f770e63f82fee62a8dccfe62dcc623bd8d4f4836f003dd9ac4eccfe4bbe81bbba6d522f9
+  data.tar.gz: 618cf042a61a8f8822c2e9f9628a80d33872f08c801547b20ef055e41709a9740caafce7b1708aa16f24c9e4cea3e6fa3cd3473f5a2f0e62a121aedd49331cce

data/lib/aws-sdk-quicksight.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-quicksight/customizations'
 # @service
 module Aws::QuickSight
 
-  GEM_VERSION = '1.0.0'
+  GEM_VERSION = '1.1.0'
 
 end

data/lib/aws-sdk-quicksight/client.rb

@@ -213,6 +213,12 @@ module Aws::QuickSight
     #
     # The response is a group object.
     #
+    # **CLI Sample:**
+    #
+    # `aws quicksight create-group --aws-account-id=111122223333
+    # --namespace=default --group-name="Sales-Management"
+    # --description="Sales Management - Forecasting" `
+    #
     # @option params [required, String] :group_name
     #   A name for the group that you want to create.
     #
@@ -271,6 +277,11 @@ module Aws::QuickSight
     #
     # The response is the group member object.
     #
+    # **CLI Sample:**
+    #
+    # `aws quicksight create-group-membership --aws-account-id=111122223333
+    # --namespace=default --group-name=Sales --member-name=Pat `
+    #
     # @option params [required, String] :member_name
     #   The name of the user that you want to add to the group membership.
     #
@@ -322,6 +333,11 @@ module Aws::QuickSight
     # `arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name>
     # `.
     #
+    # **CLI Sample:**
+    #
+    # `aws quicksight delete-group -\-aws-account-id=111122223333
+    # -\-namespace=default -\-group-name=Sales-Management `
+    #
     # @option params [required, String] :group_name
     #   The name of the group that you want to delete.
     #
@@ -371,6 +387,12 @@ module Aws::QuickSight
     #
     # The condition key is `quicksight:UserName`.
     #
+    # **CLI Sample:**
+    #
+    # `aws quicksight delete-group-membership --aws-account-id=111122223333
+    # --namespace=default --group-name=Sales-Management
+    # --member-name=Charlie `
+    #
     # @option params [required, String] :member_name
     #   The name of the user that you want to delete from the group
     #   membership.
@@ -423,6 +445,11 @@ module Aws::QuickSight
     # `arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name>
     # `.
     #
+    # **CLI Sample:**
+    #
+    # `aws quicksight delete-user --aws-account-id=111122223333
+    # --namespace=default --user-name=Pat `
+    #
     # @option params [required, String] :user_name
     #   The name of the user that you want to delete.
     #
@@ -469,6 +496,11 @@ module Aws::QuickSight
     #
     # The response is the group object.
     #
+    # **CLI Sample:**
+    #
+    # `aws quicksight describe-group -\-aws-account-id=11112222333
+    # -\-namespace=default -\-group-name=Sales `
+    #
     # @option params [required, String] :group_name
     #   The name of the group that you want to describe.
     #
@@ -521,6 +553,11 @@ module Aws::QuickSight
     # Resource Name (ARN), AWS Identity and Access Management (IAM) role,
     # and email address.
     #
+    # **CLI Sample:**
+    #
+    # `aws quicksight describe-user --aws-account-id=111122223333
+    # --namespace=default --user-name=Pat `
+    #
     # @option params [required, String] :user_name
     #   The name of the user that you want to describe.
     #
@@ -565,9 +602,42 @@ module Aws::QuickSight
       req.send_request(options)
     end
 
-    # Generates an embedded URL and authorization code. Before this can work
-    # properly, you need to configure the dashboards and user permissions
-    # first.
+    # Generates a server-side embeddable URL and authorization code. Before
+    # this can work properly, first you need to configure the dashboards and
+    # user permissions. For more information, see [ Embedding Amazon
+    # QuickSight Dashboards][1].
+    #
+    # Currently, you can use `GetDashboardEmbedURL` only from the server,
+    # not from the user’s browser.
+    #
+    # **CLI Sample:**
+    #
+    # Assume the role with permissions enabled for actions:
+    # `quickSight:RegisterUser` and `quicksight:GetDashboardEmbedURL`. You
+    # can use assume-role, assume-role-with-web-identity, or
+    # assume-role-with-saml.
+    #
+    # `aws sts assume-role --role-arn
+    # "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role"
+    # --role-session-name embeddingsession`
+    #
+    # If the user does not exist in QuickSight, register the user:
+    #
+    # `aws quicksight register-user --aws-account-id 111122223333
+    # --namespace default --identity-type IAM --iam-arn
+    # "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role"
+    # --user-role READER --session-name "embeddingsession" --email
+    # user123@example.com --region us-east-1`
+    #
+    # Get the URL for the embedded dashboard
+    #
+    # `aws quicksight get-dashboard-embed-url --aws-account-id 111122223333
+    # --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type
+    # IAM`
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/en_us/quicksight/latest/user/embedding.html
     #
     # @option params [required, String] :aws_account_id
     #   AWS account ID that contains the dashboard you are embedding.
@@ -576,8 +646,7 @@ module Aws::QuickSight
     #   The ID for the dashboard, also added to IAM policy
     #
     # @option params [required, String] :identity_type
-    #   The authentication method the user uses to sign in (IAM or
-    #   QUICKSIGHT).
+    #   The authentication method the user uses to sign in (IAM only).
     #
     # @option params [Integer] :session_lifetime_in_minutes
     #   How many minutes the session is valid. The session lifetime must be
@@ -631,6 +700,11 @@ module Aws::QuickSight
     #
     # The response is a list of group member objects.
     #
+    # **CLI Sample:**
+    #
+    # `aws quicksight list-group-memberships -\-aws-account-id=111122223333
+    # -\-namespace=default `
+    #
     # @option params [required, String] :group_name
     #   The name of the group that you want to see a membership list of.
     #
@@ -690,6 +764,11 @@ module Aws::QuickSight
     #
     # The response is a list of group objects.
     #
+    # **CLI Sample:**
+    #
+    # `aws quicksight list-groups -\-aws-account-id=111122223333
+    # -\-namespace=default `
+    #
     # @option params [required, String] :aws_account_id
     #   The ID for the AWS account that the group is in. Currently, you use
     #   the ID for the AWS account that contains your Amazon QuickSight
@@ -739,14 +818,28 @@ module Aws::QuickSight
       req.send_request(options)
     end
 
-    # Lists the Amazon QuickSight groups that a user is part of.
+    # Lists the Amazon QuickSight groups that an Amazon QuickSight user is a
+    # member of.
+    #
+    # The permission resource is
+    # `arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name>
+    # `.
+    #
+    # The response is a one or more group objects.
+    #
+    # **CLI Sample:**
+    #
+    # `aws quicksight list-user-groups -\-user-name=Pat
+    # -\-aws-account-id=111122223333 -\-namespace=default
+    # -\-region=us-east-1 `
     #
     # @option params [required, String] :user_name
-    #   The name of the user that you want to list groups for.
+    #   The Amazon QuickSight user name that you want to list group
+    #   memberships for.
     #
     # @option params [required, String] :aws_account_id
-    #   The AWS Account ID that the user is in. Currently, use the AWS Account
-    #   ID which contains your Amazon QuickSight account.
+    #   The AWS Account ID that the user is in. Currently, you use the ID for
+    #   the AWS account that contains your Amazon QuickSight account.
     #
     # @option params [required, String] :namespace
     #   The namespace. Currently, you should set this to `default`.
@@ -803,6 +896,11 @@ module Aws::QuickSight
     # Resource Name (ARN), AWS Identity and Access Management (IAM) role,
     # and email address.
     #
+    # **CLI Sample:**
+    #
+    # `aws quicksight list-users --aws-account-id=111122223333
+    # --namespace=default `
+    #
     # @option params [required, String] :aws_account_id
     #   The ID for the AWS account that the user is in. Currently, you use the
     #   ID for the AWS account that contains your Amazon QuickSight account.
@@ -868,6 +966,12 @@ module Aws::QuickSight
     # The condition keys are `quicksight:IamArn` and
     # `quicksight:SessionName`.
     #
+    # **CLI Sample:**
+    #
+    # `aws quicksight register-user -\-aws-account-id=111122223333
+    # -\-namespace=default -\-email=pat@example.com -\-identity-type=IAM
+    # -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat `
+    #
     # @option params [required, String] :identity_type
     #   Amazon QuickSight supports several ways of managing the identity of
     #   users. This parameter accepts two values:
@@ -921,6 +1025,7 @@ module Aws::QuickSight
     # @return [Types::RegisterUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::RegisterUserResponse#user #user} => Types::User
+    #   * {Types::RegisterUserResponse#user_invitation_url #user_invitation_url} => String
     #   * {Types::RegisterUserResponse#request_id #request_id} => String
     #   * {Types::RegisterUserResponse#status #status} => Integer
     #
@@ -945,6 +1050,7 @@ module Aws::QuickSight
     #   resp.user.role #=> String, one of "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"
     #   resp.user.identity_type #=> String, one of "IAM", "QUICKSIGHT"
     #   resp.user.active #=> Boolean
+    #   resp.user_invitation_url #=> String
     #   resp.request_id #=> String
     #   resp.status #=> Integer
     #
@@ -965,6 +1071,12 @@ module Aws::QuickSight
     #
     # The response is a group object.
     #
+    # **CLI Sample:**
+    #
+    # `aws quicksight update-group --aws-account-id=111122223333
+    # --namespace=default --group-name=Sales --description="Sales BI
+    # Dashboards" `
+    #
     # @option params [required, String] :group_name
     #   The name of the group that you want to update.
     #
@@ -1013,6 +1125,21 @@ module Aws::QuickSight
 
     # Updates an Amazon QuickSight user.
     #
+    # The permission resource is
+    # `arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name>
+    # `.
+    #
+    # The response is a user object that contains the user's Amazon
+    # QuickSight user name, email address, active or inactive status in
+    # Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name
+    # (ARN).
+    #
+    # **CLI Sample:**
+    #
+    # `aws quicksight update-user --user-name=Pat --role=ADMIN
+    # --email=new_address@amazon.com --aws-account-id=111122223333
+    # --namespace=default --region=us-east-1 `
+    #
     # @option params [required, String] :user_name
     #   The Amazon QuickSight user name that you want to update.
     #
@@ -1087,7 +1214,7 @@ module Aws::QuickSight
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-quicksight'
-      context[:gem_version] = '1.0.0'
+      context[:gem_version] = '1.1.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-quicksight/client_api.rb

@@ -237,6 +237,7 @@ module Aws::QuickSight
     RegisterUserRequest.struct_class = Types::RegisterUserRequest
 
     RegisterUserResponse.add_member(:user, Shapes::ShapeRef.new(shape: User, location_name: "User"))
+    RegisterUserResponse.add_member(:user_invitation_url, Shapes::ShapeRef.new(shape: String, location_name: "UserInvitationUrl"))
     RegisterUserResponse.add_member(:request_id, Shapes::ShapeRef.new(shape: String, location_name: "RequestId"))
     RegisterUserResponse.add_member(:status, Shapes::ShapeRef.new(shape: StatusCode, location: "statusCode", location_name: "Status"))
     RegisterUserResponse.struct_class = Types::RegisterUserResponse

data/lib/aws-sdk-quicksight/types.rb

@@ -408,8 +408,7 @@ module Aws::QuickSight
     #   @return [String]
     #
     # @!attribute [rw] identity_type
-    #   The authentication method the user uses to sign in (IAM or
-    #   QUICKSIGHT).
+    #   The authentication method the user uses to sign in (IAM only).
     #   @return [String]
     #
     # @!attribute [rw] session_lifetime_in_minutes
@@ -440,10 +439,10 @@ module Aws::QuickSight
     end
 
     # @!attribute [rw] embed_url
-    #   Call the GetDashboardEmbedUrl API to get the URL that you can embed
-    #   in your dashboard. This URL is valid for 5 minutes, and the
-    #   resulting session is valid for 10 hours. The API provides the URL
-    #   with an auth\_code that enables a single-signon session.
+    #   URL that you can put into your server-side webpage to embed your
+    #   dashboard. This URL is valid for 5 minutes, and the resulting
+    #   session is valid for 10 hours. The API provides the URL with an
+    #   auth\_code that enables a single-signon session.
     #   @return [String]
     #
     # @!attribute [rw] status
@@ -654,12 +653,13 @@ module Aws::QuickSight
     #       }
     #
     # @!attribute [rw] user_name
-    #   The name of the user that you want to list groups for.
+    #   The Amazon QuickSight user name that you want to list group
+    #   memberships for.
     #   @return [String]
     #
     # @!attribute [rw] aws_account_id
-    #   The AWS Account ID that the user is in. Currently, use the AWS
-    #   Account ID which contains your Amazon QuickSight account.
+    #   The AWS Account ID that the user is in. Currently, you use the ID
+    #   for the AWS account that contains your Amazon QuickSight account.
     #   @return [String]
     #
     # @!attribute [rw] namespace
@@ -698,7 +698,7 @@ module Aws::QuickSight
     #   @return [String]
     #
     # @!attribute [rw] status
-    #   The http status of the request.
+    #   The HTTP status of the request.
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroupsResponse AWS API Documentation
@@ -867,6 +867,12 @@ module Aws::QuickSight
     #   The user name.
     #   @return [Types::User]
     #
+    # @!attribute [rw] user_invitation_url
+    #   The URL the user visits to complete registration and provide a
+    #   password. This is returned only for users with an identity type of
+    #   `QUICKSIGHT`.
+    #   @return [String]
+    #
     # @!attribute [rw] request_id
     #   The AWS request ID for this operation.
     #   @return [String]
@@ -879,6 +885,7 @@ module Aws::QuickSight
     #
     class RegisterUserResponse < Struct.new(
       :user,
+      :user_invitation_url,
       :request_id,
       :status)
       include Aws::Structure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-quicksight
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-20 00:00:00.000000000 Z
+date: 2018-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core