Skip to content

Describe Users

elasticache_describe_users R Documentation

Returns a list of users

Description

Returns a list of users.

Usage

elasticache_describe_users(Engine, UserId, Filters, MaxRecords, Marker)

Arguments

Engine

The Redis OSS engine.

UserId

The ID of the user.

Filters

Filter to determine the list of User IDs to return.

MaxRecords

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

Marker

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. \>

Value

A list with the following syntax:

list(
  Users = list(
    list(
      UserId = "string",
      UserName = "string",
      Status = "string",
      Engine = "string",
      MinimumEngineVersion = "string",
      AccessString = "string",
      UserGroupIds = list(
        "string"
      ),
      Authentication = list(
        Type = "password"|"no-password"|"iam",
        PasswordCount = 123
      ),
      ARN = "string"
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_users(
  Engine = "string",
  UserId = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)