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

NAME

Paws::Quicksight::User

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Quicksight::User object:

$service_obj->Method(Att1 => { Active => $value, ..., UserName => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Quicksight::User object:

$result = $service_obj->Method(...);
$result->Att1->Active

DESCRIPTION

A registered user of Amazon QuickSight.

ATTRIBUTES

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.

Arn => Str

The Amazon Resource Name (ARN) for the user.

CustomPermissionsName => Str

The custom permissions profile associated with this user.

Email => Str

The user's email address.

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

ExternalLoginFederationProviderUrl => Str

The URL of the external login provider.

ExternalLoginId => Str

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

IdentityType => Str

The type of identity authentication used by the user.

PrincipalId => Str

The principal ID of the user.

Role => Str

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

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

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

UserName => Str

The user's user name.

SEE ALSO

This class forms part of Paws, describing an object used 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