#[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>, }
Expand description

A registered user of Amazon QuickSight.

Fields (Non-exhaustive)

This struct is marked as 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. 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.

  • 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

The Amazon Resource Name (ARN) for the user.

The user's user name. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.

The user's email address.

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.

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

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

The type of identity authentication used by the user.

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.

The principal ID of the user.

The custom permissions profile associated with this user.

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.

The URL of the external login provider.

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

Creates a new builder-style object to manufacture User

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more