ModifyUser - Amazon ElastiCache

ModifyUser

Changes user password(s) and/or access string.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

UserId

The ID of the user.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: Yes

AccessString

Access permissions string used for this user account.

Type: String

Pattern: .*\S.*

Required: No

AppendAccessString

Adds additional user permissions to the access string.

Type: String

Pattern: .*\S.*

Required: No

NoPasswordRequired

Indicates no password is required for the user account.

Type: Boolean

Required: No

Passwords.member.N

The passwords belonging to the user account. You are allowed up to two.

Type: Array of strings

Array Members: Minimum number of 1 item.

Required: No

Response Elements

The following elements are returned by the service.

AccessString

Access permissions string used for this user account.

Type: String

ARN

The Amazon Resource Name (ARN) of the user account.

Type: String

Authentication

Denotes whether the user requires a password to authenticate.

Type: Authentication object

Engine

Must be Redis.

Type: String

Pattern: [a-zA-Z]*

Status

Indicates the user status. Can be "active", "modifying" or "deleting".

Type: String

UserGroupIds.member.N

Returns a list of the user group IDs the user belongs to.

Type: Array of strings

Length Constraints: Minimum length of 1.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

UserId

The ID of the user.

Type: String

UserName

The username of the user.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterCombination

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

InvalidUserState

The user is not in active state.

HTTP Status Code: 400

UserNotFound

The user does not exist or could not be found.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: