Skip to content

Describe Users

memorydb_describe_users R Documentation

Returns a list of users

Description

Returns a list of users.

Usage

memorydb_describe_users(UserName, Filters, MaxResults, NextToken)

Arguments

UserName

The name of the user

Filters

Filter to determine the list of users to return.

MaxResults

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

NextToken

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Value

A list with the following syntax:

list(
  Users = list(
    list(
      Name = "string",
      Status = "string",
      AccessString = "string",
      ACLNames = list(
        "string"
      ),
      MinimumEngineVersion = "string",
      Authentication = list(
        Type = "password"|"no-password"|"iam",
        PasswordCount = 123
      ),
      ARN = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_users(
  UserName = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)