IdentityStore / Client / update_user

update_user¶

IdentityStore.Client.update_user(**kwargs)¶

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

Request Syntax

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

Parameters:

IdentityStoreId (string) –
[REQUIRED]

The globally unique identifier for the identity store.

You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
UserId (string) –
[REQUIRED]

The identifier for a user in the identity store.

You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
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.
Revision (string) – The expected current revision of the user. When you provide this value, the update is applied only if it matches the current revision of the user in the identity store, which prevents you from overwriting concurrent changes. If the value doesn’t match, the operation fails with a ConflictException. If you don’t provide this value, the update is applied unconditionally.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityStoreId': 'string',
    'UserId': 'string',
    'UserArn': 'string',
    'Revision': 'string'
}

Response Structure

(dict) –
- IdentityStoreId (string) –
  
  The globally unique identifier for the identity store.
- UserId (string) –
  
  The identifier for a user in the identity store.
- UserArn (string) –
  
  The Amazon Resource Name (ARN) of the user in the identity store. For example, arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
- Revision (string) –
  
  The revision of the user after the requested update is applied.

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