QuickSight / Client / list_users

list_users#

QuickSight.Client.list_users(**kwargs)#

Returns a list of all of the Amazon QuickSight users belonging to this account.

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    AwsAccountId='string',
    NextToken='string',
    MaxResults=123,
    Namespace='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    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.

  • NextToken (string) – A pagination token that can be used in a subsequent request.

  • MaxResults (integer) – The maximum number of results to return from this request.

  • Namespace (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'UserList': [
        {
            'Arn': 'string',
            'UserName': 'string',
            'Email': 'string',
            'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
            'IdentityType': 'IAM'|'QUICKSIGHT',
            'Active': True|False,
            'PrincipalId': 'string',
            'CustomPermissionsName': 'string',
            'ExternalLoginFederationProviderType': 'string',
            'ExternalLoginFederationProviderUrl': 'string',
            'ExternalLoginId': 'string'
        },
    ],
    'NextToken': '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.

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

    • NextToken (string) –

      A pagination token that can be used in a subsequent request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InvalidNextTokenException

  • QuickSight.Client.exceptions.PreconditionNotMetException

  • QuickSight.Client.exceptions.InternalFailureException

  • QuickSight.Client.exceptions.ResourceUnavailableException