Struct aws_sdk_quicksight::input::update_user_input::Builder

pub struct Builder { /* private fields */ }

A builder for UpdateUserInput.

Implementations

impl Builder

pub fn user_name(self, input: impl Into<String>) -> Self

The Amazon QuickSight user name that you want to update.

Examples found in repository

src/client.rs (line 15972)

        pub fn user_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.user_name(input.into());
            self
        }

pub fn set_user_name(self, input: Option<String>) -> Self

The Amazon QuickSight user name that you want to update.

Examples found in repository

src/client.rs (line 15977)

        pub fn set_user_name(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_user_name(input);
            self
        }

pub fn aws_account_id(self, input: impl Into<String>) -> Self

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.

Examples found in repository

src/client.rs (line 15982)

        pub fn aws_account_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.aws_account_id(input.into());
            self
        }

pub fn set_aws_account_id(self, input: Option<String>) -> Self

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.

Examples found in repository

src/client.rs (line 15990)

        pub fn set_aws_account_id(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_aws_account_id(input);
            self
        }

pub fn namespace(self, input: impl Into<String>) -> Self

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

Examples found in repository

src/client.rs (line 15995)

        pub fn namespace(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.namespace(input.into());
            self
        }

pub fn set_namespace(self, input: Option<String>) -> Self

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

Examples found in repository

src/client.rs (line 16000)

        pub fn set_namespace(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_namespace(input);
            self
        }

pub fn email(self, input: impl Into<String>) -> Self

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

Examples found in repository

src/client.rs (line 16005)

        pub fn email(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.email(input.into());
            self
        }

pub fn set_email(self, input: Option<String>) -> Self

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

Examples found in repository

src/client.rs (line 16010)

        pub fn set_email(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_email(input);
            self
        }

pub fn role(self, input: UserRole) -> Self

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.

Examples found in repository

src/client.rs (line 16021)

        pub fn role(mut self, input: crate::model::UserRole) -> Self {
            self.inner = self.inner.role(input);
            self
        }

pub fn set_role(self, input: Option<UserRole>) -> Self

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.

Examples found in repository

src/client.rs (line 16032)

        pub fn set_role(mut self, input: std::option::Option<crate::model::UserRole>) -> Self {
            self.inner = self.inner.set_role(input);
            self
        }

pub fn custom_permissions_name(self, input: impl Into<String>) -> Self

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

Examples found in repository

src/client.rs (line 16046)

        pub fn custom_permissions_name(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.custom_permissions_name(input.into());
            self
        }

pub fn set_custom_permissions_name(self, input: Option<String>) -> Self

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

Examples found in repository

src/client.rs (line 16063)

        pub fn set_custom_permissions_name(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_custom_permissions_name(input);
            self
        }

pub fn unapply_custom_permissions(self, input: bool) -> Self

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.

Examples found in repository

src/client.rs (line 16068)

        pub fn unapply_custom_permissions(mut self, input: bool) -> Self {
            self.inner = self.inner.unapply_custom_permissions(input);
            self
        }

pub fn set_unapply_custom_permissions(self, input: Option<bool>) -> Self

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.

Examples found in repository

src/client.rs (line 16073)

        pub fn set_unapply_custom_permissions(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_unapply_custom_permissions(input);
            self
        }

pub fn external_login_federation_provider_type(
    self,
    input: impl Into<String>
) -> Self

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.

Examples found in repository

src/client.rs (line 16088)

        pub fn external_login_federation_provider_type(
            mut self,
            input: impl Into<std::string::String>,
        ) -> Self {
            self.inner = self
                .inner
                .external_login_federation_provider_type(input.into());
            self
        }

pub fn set_external_login_federation_provider_type(
    self,
    input: Option<String>
) -> Self

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.

Examples found in repository

src/client.rs (line 16103)

        pub fn set_external_login_federation_provider_type(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self
                .inner
                .set_external_login_federation_provider_type(input);
            self
        }

pub fn custom_federation_provider_url(self, input: impl Into<String>) -> Self

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.

Examples found in repository

src/client.rs (line 16111)

        pub fn custom_federation_provider_url(
            mut self,
            input: impl Into<std::string::String>,
        ) -> Self {
            self.inner = self.inner.custom_federation_provider_url(input.into());
            self
        }

pub fn set_custom_federation_provider_url(self, input: Option<String>) -> Self

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.

Examples found in repository

src/client.rs (line 16119)

        pub fn set_custom_federation_provider_url(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_custom_federation_provider_url(input);
            self
        }

pub fn external_login_id(self, input: impl Into<String>) -> Self

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

Examples found in repository

src/client.rs (line 16124)

        pub fn external_login_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.external_login_id(input.into());
            self
        }

pub fn set_external_login_id(self, input: Option<String>) -> Self

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

Examples found in repository

src/client.rs (line 16132)

        pub fn set_external_login_id(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_external_login_id(input);
            self
        }

pub fn build(self) -> Result<UpdateUserInput, BuildError>

Consumes the builder and constructs a UpdateUserInput.

Examples found in repository

src/client.rs (line 15939)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::UpdateUser,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::UpdateUserError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::UpdateUserOutput,
            aws_smithy_http::result::SdkError<crate::error::UpdateUserError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

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

impl StructuralPartialEq for Builder