Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns a list of users.
This operation returns paginated results.
Synopsis
- data DescribeUsers = DescribeUsers' {}
- newDescribeUsers :: DescribeUsers
- describeUsers_engine :: Lens' DescribeUsers (Maybe Text)
- describeUsers_filters :: Lens' DescribeUsers (Maybe [Filter])
- describeUsers_marker :: Lens' DescribeUsers (Maybe Text)
- describeUsers_maxRecords :: Lens' DescribeUsers (Maybe Int)
- describeUsers_userId :: Lens' DescribeUsers (Maybe Text)
- data DescribeUsersResponse = DescribeUsersResponse' {}
- newDescribeUsersResponse :: Int -> DescribeUsersResponse
- describeUsersResponse_marker :: Lens' DescribeUsersResponse (Maybe Text)
- describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User])
- describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int
Creating a Request
data DescribeUsers Source #
See: newDescribeUsers
smart constructor.
DescribeUsers' | |
|
Instances
newDescribeUsers :: DescribeUsers Source #
Create a value of DescribeUsers
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeUsers
, describeUsers_engine
- The Redis engine.
$sel:filters:DescribeUsers'
, describeUsers_filters
- Filter to determine the list of User IDs to return.
DescribeUsers
, describeUsers_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. >
$sel:maxRecords:DescribeUsers'
, describeUsers_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.
DescribeUsers
, describeUsers_userId
- The ID of the user.
Request Lenses
describeUsers_engine :: Lens' DescribeUsers (Maybe Text) Source #
The Redis engine.
describeUsers_filters :: Lens' DescribeUsers (Maybe [Filter]) Source #
Filter to determine the list of User IDs to return.
describeUsers_marker :: Lens' DescribeUsers (Maybe Text) Source #
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. >
describeUsers_maxRecords :: Lens' DescribeUsers (Maybe Int) Source #
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.
describeUsers_userId :: Lens' DescribeUsers (Maybe Text) Source #
The ID of the user.
Destructuring the Response
data DescribeUsersResponse Source #
See: newDescribeUsersResponse
smart constructor.
DescribeUsersResponse' | |
|
Instances
newDescribeUsersResponse Source #
Create a value of DescribeUsersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeUsers
, describeUsersResponse_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. >
$sel:users:DescribeUsersResponse'
, describeUsersResponse_users
- A list of users.
$sel:httpStatus:DescribeUsersResponse'
, describeUsersResponse_httpStatus
- The response's http status code.
Response Lenses
describeUsersResponse_marker :: Lens' DescribeUsersResponse (Maybe Text) Source #
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. >
describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User]) Source #
A list of users.
describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int Source #
The response's http status code.