DescribeUsers
Returns a list of users.
Request Syntax
{
"Filters": [
{
"Name": "string
",
"Values": [ "string
" ]
}
],
"MaxResults": number
,
"NextToken": "string
",
"UserName": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Filters
-
Filter to determine the list of users to return.
Type: Array of Filter objects
Required: No
- 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.
Type: Integer
Required: No
- 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.
Type: String
Required: No
- UserName
-
The name of the user.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
[a-zA-Z][a-zA-Z0-9\-]*
Required: No
Response Syntax
{
"NextToken": "string",
"Users": [
{
"AccessString": "string",
"ACLNames": [ "string" ],
"ARN": "string",
"Authentication": {
"PasswordCount": number,
"Type": "string"
},
"MinimumEngineVersion": "string",
"Name": "string",
"Status": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- 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.
Type: String
- Users
-
A list of users.
Type: Array of User objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterCombinationException
-
HTTP Status Code: 400
- UserNotFoundFault
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: