[−][src]Struct rusoto_quicksight::RegisterUserRequest
Fields
aws_account_id: String
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.
custom_permissions_name: Option<String>
(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
-
Create and update data sources
-
Create and update datasets
-
Create and update email reports
-
Subscribe to email reports
To add custom permissions to an existing user, use UpdateUser
instead.
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser
API operation to assign the named set of permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).
This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
email: String
The email address of the user that you want to register.
iam_arn: Option<String>
The ARN of the IAM user or role that you are registering with Amazon QuickSight.
identity_type: String
Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:
-
IAM
: A user whose identity maps to an existing IAM user or role. -
QUICKSIGHT
: A user whose identity is owned and managed internally by Amazon QuickSight.
namespace: String
The namespace. Currently, you should set this to default
.
session_name: Option<String>
You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role
in the AWS CLI Reference.
user_name: Option<String>
The Amazon QuickSight user name that you want to create for the user you are registering.
user_role: String
The Amazon QuickSight role for 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. -
RESTRICTEDREADER
: This role isn't currently available for use. -
RESTRICTEDAUTHOR
: This role isn't currently available for use.
Trait Implementations
impl Clone for RegisterUserRequest
[src]
pub fn clone(&self) -> RegisterUserRequest
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for RegisterUserRequest
[src]
impl Default for RegisterUserRequest
[src]
pub fn default() -> RegisterUserRequest
[src]
impl PartialEq<RegisterUserRequest> for RegisterUserRequest
[src]
pub fn eq(&self, other: &RegisterUserRequest) -> bool
[src]
pub fn ne(&self, other: &RegisterUserRequest) -> bool
[src]
impl Serialize for RegisterUserRequest
[src]
pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralPartialEq for RegisterUserRequest
[src]
Auto Trait Implementations
impl RefUnwindSafe for RegisterUserRequest
[src]
impl Send for RegisterUserRequest
[src]
impl Sync for RegisterUserRequest
[src]
impl Unpin for RegisterUserRequest
[src]
impl UnwindSafe for RegisterUserRequest
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,