QBusiness / Client / update_user

update_user

QBusiness.Client.update_user(**kwargs)

Updates a information associated with a user id.

See also: AWS API Documentation

Request Syntax

response = client.update_user(
    applicationId='string',
    userId='string',
    userAliasesToUpdate=[
        {
            'indexId': 'string',
            'dataSourceId': 'string',
            'userId': 'string'
        },
    ],
    userAliasesToDelete=[
        {
            'indexId': 'string',
            'dataSourceId': 'string',
            'userId': 'string'
        },
    ]
)

Parameters:

• applicationId (string) –

  [REQUIRED]

  The identifier of the application the user is attached to.

• userId (string) –

  [REQUIRED]

  The email id attached to the user.

• userAliasesToUpdate (list) –

  The user aliases attached to the user id that are to be updated.

  • (dict) –

    Aliases attached to a user id within an Amazon Q Business application.

    • indexId (string) –

      The identifier of the index that the user aliases are associated with.

    • dataSourceId (string) –

      The identifier of the data source that the user aliases are associated with.

    • userId (string) – [REQUIRED]

      The identifier of the user id associated with the user aliases.

• userAliasesToDelete (list) –

  The user aliases attached to the user id that are to be deleted.

  • (dict) –

    Aliases attached to a user id within an Amazon Q Business application.

    • indexId (string) –

      The identifier of the index that the user aliases are associated with.

    • dataSourceId (string) –

      The identifier of the data source that the user aliases are associated with.

    • userId (string) – [REQUIRED]

      The identifier of the user id associated with the user aliases.

Return type:

dict

Returns:

Response Syntax

{
    'userAliasesAdded': [
        {
            'indexId': 'string',
            'dataSourceId': 'string',
            'userId': 'string'
        },
    ],
    'userAliasesUpdated': [
        {
            'indexId': 'string',
            'dataSourceId': 'string',
            'userId': 'string'
        },
    ],
    'userAliasesDeleted': [
        {
            'indexId': 'string',
            'dataSourceId': 'string',
            'userId': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • userAliasesAdded (list) –

    The user aliases that have been to be added to a user id.

    • (dict) –

      Aliases attached to a user id within an Amazon Q Business application.

      • indexId (string) –

        The identifier of the index that the user aliases are associated with.

      • dataSourceId (string) –

        The identifier of the data source that the user aliases are associated with.

      • userId (string) –

        The identifier of the user id associated with the user aliases.

  • userAliasesUpdated (list) –

    The user aliases attached to a user id that have been updated.

    • (dict) –

      Aliases attached to a user id within an Amazon Q Business application.

      • indexId (string) –

        The identifier of the index that the user aliases are associated with.

      • dataSourceId (string) –

        The identifier of the data source that the user aliases are associated with.

      • userId (string) –

        The identifier of the user id associated with the user aliases.

  • userAliasesDeleted (list) –

    The user aliases that have been deleted from a user id.

    • (dict) –

      Aliases attached to a user id within an Amazon Q Business application.

      • indexId (string) –

        The identifier of the index that the user aliases are associated with.

      • dataSourceId (string) –

        The identifier of the data source that the user aliases are associated with.

      • userId (string) –

        The identifier of the user id associated with the user aliases.

Exceptions

• QBusiness.Client.exceptions.ResourceNotFoundException

• QBusiness.Client.exceptions.InternalServerException

• QBusiness.Client.exceptions.ThrottlingException

• QBusiness.Client.exceptions.ValidationException

• QBusiness.Client.exceptions.AccessDeniedException

• QBusiness.Client.exceptions.ServiceQuotaExceededException