QuickSight / Paginator / ListUsers


class QuickSight.Paginator.ListUsers#
paginator = client.get_paginator('list_users')

Creates an iterator that will paginate through responses from QuickSight.Client.list_users().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • AwsAccountId (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 (string) –


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

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'UserList': [
            'Arn': 'string',
            'UserName': 'string',
            'Email': 'string',
            'IdentityType': 'IAM'|'QUICKSIGHT'|'IAM_IDENTITY_CENTER',
            'Active': True|False,
            'PrincipalId': 'string',
            'CustomPermissionsName': 'string',
            'ExternalLoginFederationProviderType': 'string',
            'ExternalLoginFederationProviderUrl': 'string',
            'ExternalLoginId': 'string'
    'RequestId': 'string',
    'Status': 123

Response Structure

  • (dict) –

    • UserList (list) –

      The list of users.

      • (dict) –

        A registered user of Amazon QuickSight.

        • Arn (string) –

          The Amazon Resource Name (ARN) for the user.

        • UserName (string) –

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

        • Email (string) –

          The user’s email address.

        • Role (string) –

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

          • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, 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 Amazon QuickSight 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.

        • IdentityType (string) –

          The type of identity authentication used by the user.

        • Active (boolean) –

          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.

        • PrincipalId (string) –

          The principal ID of the user.

        • CustomPermissionsName (string) –

          The custom permissions profile associated with this user.

        • ExternalLoginFederationProviderType (string) –

          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 (string) –

          The URL of the external login provider.

        • ExternalLoginId (string) –

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

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.