Struct aws_sdk_quicksight::types::User

#[non_exhaustive]
pub struct User {
    pub arn: Option<String>,
    pub user_name: Option<String>,
    pub email: Option<String>,
    pub role: Option<UserRole>,
    pub identity_type: Option<IdentityType>,
    pub active: bool,
    pub principal_id: Option<String>,
    pub custom_permissions_name: Option<String>,
    pub external_login_federation_provider_type: Option<String>,
    pub external_login_federation_provider_url: Option<String>,
    pub external_login_id: Option<String>,
}

A registered user of Amazon QuickSight.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

arn: Option<String>

The Amazon Resource Name (ARN) for the user.

user_name: Option<String>

The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.

email: Option<String>

The user's email address.

role: Option<UserRole>

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 Amazon QuickSight settings.

• READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

• AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

• ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

• RESTRICTED_READER: This role isn't currently available for use.

• RESTRICTED_AUTHOR: This role isn't currently available for use.

identity_type: Option<IdentityType>

The type of identity authentication used by the user.

active: bool

The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.

principal_id: Option<String>

The principal ID of the user.

custom_permissions_name: Option<String>

The custom permissions profile associated with this user.

external_login_federation_provider_type: Option<String>

The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.

• COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.

• CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.

external_login_federation_provider_url: Option<String>

The URL of the external login provider.

external_login_id: Option<String>

The identity ID for the user in the external login provider.

Implementations

impl User

pub fn arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for the user.

pub fn user_name(&self) -> Option<&str>

The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.

pub fn email(&self) -> Option<&str>

The user's email address.

pub fn role(&self) -> Option<&UserRole>

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 Amazon QuickSight settings.

• READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

• AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

• ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

• RESTRICTED_READER: This role isn't currently available for use.

• RESTRICTED_AUTHOR: This role isn't currently available for use.

pub fn identity_type(&self) -> Option<&IdentityType>

The type of identity authentication used by the user.

pub fn active(&self) -> bool

The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.

pub fn principal_id(&self) -> Option<&str>

The principal ID of the user.

pub fn custom_permissions_name(&self) -> Option<&str>

The custom permissions profile associated with this user.

pub fn external_login_federation_provider_type(&self) -> Option<&str>

The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.

• COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.

• CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.

pub fn external_login_federation_provider_url(&self) -> Option<&str>

The URL of the external login provider.

pub fn external_login_id(&self) -> Option<&str>

The identity ID for the user in the external login provider.

impl User

pub fn builder() -> UserBuilder

Creates a new builder-style object to manufacture User.

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for User

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for User

fn eq(&self, other: &User) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for User