DescribeUsers
Returns a list of users.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Engine
-
The Redis engine.
Type: String
Pattern:
[a-zA-Z]*Required: No
- Filters.member.N
-
Filter to determine the list of User IDs to return.
Type: Array of Filter objects
Required: No
- 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. >
Type: String
Required: No
- 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.
Type: Integer
Required: No
- UserId
-
The ID of the user.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
[a-zA-Z][a-zA-Z0-9\-]*Required: No
Response Elements
The following elements are returned by the service.
- 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. >
Type: String
- Users.member.N
-
A list of users.
Type: Array of User objects
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
- ServiceLinkedRoleNotFoundFault
-
The specified service linked role (SLR) was not found.
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:
