Struct aws_sdk_quicksight::input::UpdateUserInput

#[non_exhaustive]
pub struct UpdateUserInput {
    pub user_name: Option<String>,
    pub aws_account_id: Option<String>,
    pub namespace: Option<String>,
    pub email: Option<String>,
    pub role: Option<UserRole>,
    pub custom_permissions_name: Option<String>,
    pub unapply_custom_permissions: bool,
    pub external_login_federation_provider_type: Option<String>,
    pub custom_federation_provider_url: Option<String>,
    pub external_login_id: Option<String>,
}

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.

user_name: Option<String>

The Amazon QuickSight user name that you want to update.

aws_account_id: Option<String>

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

namespace: Option<String>

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

email: Option<String>

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

role: Option<UserRole>

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

• 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.

The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

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

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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

unapply_custom_permissions: bool

A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.

external_login_federation_provider_type: Option<String>

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

• COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

• CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

• NONE: This clears all the previously saved external login information for a user. Use the DescribeUser API operation to check the external login information.

custom_federation_provider_url: Option<String>

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

external_login_id: Option<String>

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

Implementations

impl UpdateUserInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<UpdateUser, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<UpdateUser>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture UpdateUserInput

impl UpdateUserInput

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

The Amazon QuickSight user name that you want to update.

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

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

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

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

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

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

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

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

• 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.

The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

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

(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

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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

pub fn unapply_custom_permissions(&self) -> bool

A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.

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

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

• COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

• CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

• NONE: This clears all the previously saved external login information for a user. Use the DescribeUser API operation to check the external login information.

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

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

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

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

Trait Implementations

impl Clone for UpdateUserInput

fn clone(&self) -> UpdateUserInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateUserInput

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

Formats the value using the given formatter.

impl PartialEq<UpdateUserInput> for UpdateUserInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for UpdateUserInput