/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Quicksight::UpdateUser

NAME

Paws::Quicksight::UpdateUser - Arguments for method UpdateUser on Paws::Quicksight

DESCRIPTION

This class represents the parameters used for calling the method UpdateUser on the Amazon QuickSight service. Use the attributes of this class as arguments to method UpdateUser.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateUser.

SYNOPSIS

my $quicksight = Paws->service('Quicksight');
my $UpdateUserResponse = $quicksight->UpdateUser(
  AwsAccountId                        => 'MyAwsAccountId',
  Email                               => 'MyString',
  Namespace                           => 'MyNamespace',
  Role                                => 'ADMIN',
  UserName                            => 'MyUserName',
  CustomFederationProviderUrl         => 'MyString',         # OPTIONAL
  CustomPermissionsName               => 'MyRoleName',       # OPTIONAL
  ExternalLoginFederationProviderType => 'MyString',         # OPTIONAL
  ExternalLoginId                     => 'MyString',         # OPTIONAL
  UnapplyCustomPermissions            => 1,                  # OPTIONAL
);

# Results:
my $RequestId = $UpdateUserResponse->RequestId;
my $Status    = $UpdateUserResponse->Status;
my $User      = $UpdateUserResponse->User;

# Returns a L<Paws::Quicksight::UpdateUserResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/quicksight/UpdateUser

ATTRIBUTES

REQUIRED AwsAccountId => Str

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.

CustomFederationProviderUrl => Str

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

CustomPermissionsName => 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 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).

REQUIRED Email => Str

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

ExternalLoginFederationProviderType => Str

The type of supported external login provider that provides identity to let a user federate into QuickSight with an associated AWS 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 DescribeUser API to check the external login information.

ExternalLoginId => Str

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

REQUIRED Namespace => Str

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

REQUIRED Role => Str

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 QuickSight role is invisible to the user except for the console screens dealing with permissions.

Valid values are: "ADMIN", "AUTHOR", "READER", "RESTRICTED_AUTHOR", "RESTRICTED_READER"

UnapplyCustomPermissions => 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.

REQUIRED UserName => Str

The Amazon QuickSight user name that you want to update.

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateUser in Paws::Quicksight

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues