Class: Aws::QuickSight::Types::UpdateUserRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Note:

When making an API call, you may pass UpdateUserRequest data as a hash:

{
  user_name: "UserName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  email: "String", # required
  role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

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.

Returns:

  • (String)


10730
10731
10732
10733
10734
10735
10736
10737
10738
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10730

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role)
  SENSITIVE = []
  include Aws::Structure
end

#emailString

The email address of the user that you want to update.

Returns:

  • (String)


10730
10731
10732
10733
10734
10735
10736
10737
10738
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10730

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role)
  SENSITIVE = []
  include Aws::Structure
end

#namespaceString

The namespace. Currently, you should set this to default.

Returns:

  • (String)


10730
10731
10732
10733
10734
10735
10736
10737
10738
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10730

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role)
  SENSITIVE = []
  include Aws::Structure
end

#roleString

The Amazon QuickSight role of the user. The user role can be one of the following:

  • READER: A user who has read-only access to dashboards.

  • AUTHOR: A user who can create data sources, datasets, analyses, and dashboards.

  • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

Returns:

  • (String)


10730
10731
10732
10733
10734
10735
10736
10737
10738
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10730

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role)
  SENSITIVE = []
  include Aws::Structure
end

#user_nameString

The Amazon QuickSight user name that you want to update.

Returns:

  • (String)


10730
10731
10732
10733
10734
10735
10736
10737
10738
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 10730

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role)
  SENSITIVE = []
  include Aws::Structure
end