UpdateUserCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MemoryDBClient, UpdateUserCommand } from "@aws-sdk/client-memorydb"; // ES Modules import
// const { MemoryDBClient, UpdateUserCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import
const client = new MemoryDBClient(config);
const input = { // UpdateUserRequest
  UserName: "STRING_VALUE", // required
  AuthenticationMode: { // AuthenticationMode
    Type: "password" || "iam",
    Passwords: [ // PasswordListInput
      "STRING_VALUE",
    ],
  },
  AccessString: "STRING_VALUE",
};
const command = new UpdateUserCommand(input);
const response = await client.send(command);
// { // UpdateUserResponse
//   User: { // User
//     Name: "STRING_VALUE",
//     Status: "STRING_VALUE",
//     AccessString: "STRING_VALUE",
//     ACLNames: [ // ACLNameList
//       "STRING_VALUE",
//     ],
//     MinimumEngineVersion: "STRING_VALUE",
//     Authentication: { // Authentication
//       Type: "password" || "no-password" || "iam",
//       PasswordCount: Number("int"),
//     },
//     ARN: "STRING_VALUE",
//   },
// };

UpdateUserCommand Input

See UpdateUserCommandInput for more details

Parameter
Type
Description
UserName
Required
string | undefined

The name of the user

AccessString
string | undefined

Access permissions string used for this user.

AuthenticationMode
AuthenticationMode | undefined

Denotes the user's authentication properties, such as whether it requires a password to authenticate.

UpdateUserCommand Output

See UpdateUserCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
User
User | undefined

The updated user

Throws

Name
Fault
Details
InvalidParameterCombinationException
client

InvalidParameterValueException
client

InvalidUserStateFault
client

UserNotFoundFault
client

MemoryDBServiceException
Base exception class for all service exceptions from MemoryDB service.