QuickSight / Client / update_user

update_user#

QuickSight.Client.update_user(**kwargs)#

Updates an Amazon QuickSight user.

See also: AWS API Documentation

Request Syntax

response = client.update_user(
    UserName='string',
    AwsAccountId='string',
    Namespace='string',
    Email='string',
    Role='ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
    CustomPermissionsName='string',
    UnapplyCustomPermissions=True|False,
    ExternalLoginFederationProviderType='string',
    CustomFederationProviderUrl='string',
    ExternalLoginId='string'
)
Parameters:

  • UserName (string) –

    [REQUIRED]

    The Amazon QuickSight user name that you want to update.

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

  • Namespace (string) –

    [REQUIRED]

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

  • Email (string) –

    [REQUIRED]

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

  • Role (string) –

    [REQUIRED]

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

  • CustomPermissionsName (string) –

    (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 Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

    Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).

    This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

  • UnapplyCustomPermissions (boolean) – 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.

  • ExternalLoginFederationProviderType (string) –

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

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

  • ExternalLoginId (string) – The identity ID for a user in the external login provider.

Return type:

dict

Returns:

Response Syntax

{
    'User': {
        'Arn': 'string',
        'UserName': 'string',
        'Email': 'string',
        'Role': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER',
        '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) –

    • User (dict) –

      The Amazon QuickSight user.

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

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

  • QuickSight.Client.exceptions.InternalFailureException

  • QuickSight.Client.exceptions.ResourceUnavailableException