IdentityStore / Client / update_user

update_user

IdentityStore.Client.update_user(**kwargs)

Updates the specified user metadata and attributes in the specified identity store.

See also: AWS API Documentation

Request Syntax

response = client.update_user(
    IdentityStoreId='string',
    UserId='string',
    Operations=[
        {
            'AttributePath': 'string',
            'AttributeValue': {...}|[...]|123|123.4|'string'|True|None
        },
    ]
)

Parameters:

• IdentityStoreId (string) –

  [REQUIRED]

  The globally unique identifier for the identity store.

• UserId (string) –

  [REQUIRED]

  The identifier for a user in the identity store.

• Operations (list) –

  [REQUIRED]

  A list of AttributeOperation objects to apply to the requested user. These operations might add, replace, or remove an attribute. For more information on the attributes that can be added, replaced, or removed, see User.

  • (dict) –

    An operation that applies to the requested group. This operation might add, replace, or remove an attribute.

    • AttributePath (string) – [REQUIRED]

      A string representation of the path to a given attribute or sub-attribute. Supports JMESPath.

    • AttributeValue (document) –

      The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the CLI.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• IdentityStore.Client.exceptions.ResourceNotFoundException

• IdentityStore.Client.exceptions.ThrottlingException

• IdentityStore.Client.exceptions.AccessDeniedException

• IdentityStore.Client.exceptions.ConflictException

• IdentityStore.Client.exceptions.InternalServerException

• IdentityStore.Client.exceptions.ValidationException

• IdentityStore.Client.exceptions.ServiceQuotaExceededException