User - Amazon Quick Sight
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

User

A registered user of Quick Sight.

Contents

Note

In the following list, the required parameters are described first.

Active

The active status of user. When you create an Quick Sight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.

Type: Boolean

Required: No

Arn

The Amazon Resource Name (ARN) for the user.

Type: String

Required: No

CustomPermissionsName

The custom permissions profile associated with this user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9+=,.@_-]+$

Required: No

Email

The user's email address.

Type: String

Required: No

ExternalLoginFederationProviderType

The type of supported external login provider that provides identity to let the user federate into Quick Sight 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.

Type: String

Required: No

ExternalLoginFederationProviderUrl

The URL of the external login provider.

Type: String

Required: No

ExternalLoginId

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

Type: String

Required: No

IdentityType

The type of identity authentication used by the user.

Type: String

Valid Values: IAM | QUICKSIGHT | IAM_IDENTITY_CENTER

Required: No

PrincipalId

The principal ID of the user.

Type: String

Required: No

Role

The Quick Sight 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 Quick Sight settings.

  • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

  • AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

  • ADMIN_PRO: Admin Pros are Author Pros who can also manage Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.

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

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

Type: String

Valid Values: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER | ADMIN_PRO | AUTHOR_PRO | READER_PRO

Required: No

UserName

The user's user name. This value is required if you are registering a user that will be managed in Quick Sight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\u0020-\u00FF]+

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: