Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ElastiCache.DescribeUsers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of users.

This operation returns paginated results.

Synopsis

data DescribeUsers = DescribeUsers' {
- filters :: Maybe [Filter]
- engine :: Maybe Text
- userId :: Maybe Text
- marker :: Maybe Text
- maxRecords :: Maybe Int
}
newDescribeUsers :: DescribeUsers
describeUsers_filters :: Lens' DescribeUsers (Maybe [Filter])
describeUsers_engine :: Lens' DescribeUsers (Maybe Text)
describeUsers_userId :: Lens' DescribeUsers (Maybe Text)
describeUsers_marker :: Lens' DescribeUsers (Maybe Text)
describeUsers_maxRecords :: Lens' DescribeUsers (Maybe Int)
data DescribeUsersResponse = DescribeUsersResponse' {
- users :: Maybe [User]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeUsersResponse :: Int -> DescribeUsersResponse
describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User])
describeUsersResponse_marker :: Lens' DescribeUsersResponse (Maybe Text)
describeUsersResponse_httpStatus :: Lens' DescribeUsersResponse Int

Creating a Request

data DescribeUsers Source #

See: newDescribeUsers smart constructor.

Constructors

DescribeUsers'

Fields

filters :: Maybe [Filter]
Filter to determine the list of User IDs to return.
engine :: Maybe Text
The Redis engine.
userId :: Maybe Text
The ID of the user.
marker :: Maybe Text
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. >
maxRecords :: Maybe Int
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.

Instances

Instances details

Eq DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods (==) :: DescribeUsers -> DescribeUsers -> Bool # (/=) :: DescribeUsers -> DescribeUsers -> Bool #
Read DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods readsPrec :: Int -> ReadS DescribeUsers # readList :: ReadS [DescribeUsers] # readPrec :: ReadPrec DescribeUsers # readListPrec :: ReadPrec [DescribeUsers] #
Show DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods showsPrec :: Int -> DescribeUsers -> ShowS # show :: DescribeUsers -> String # showList :: [DescribeUsers] -> ShowS #
Generic DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Associated Types type Rep DescribeUsers :: Type -> Type # Methods from :: DescribeUsers -> Rep DescribeUsers x # to :: Rep DescribeUsers x -> DescribeUsers #
NFData DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods rnf :: DescribeUsers -> () #
Hashable DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods hashWithSalt :: Int -> DescribeUsers -> Int # hash :: DescribeUsers -> Int #
AWSPager DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods page :: DescribeUsers -> AWSResponse DescribeUsers -> Maybe DescribeUsers #
AWSRequest DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Associated Types type AWSResponse DescribeUsers # Methods request :: DescribeUsers -> Request DescribeUsers # response :: MonadResource m => Logger -> Service -> Proxy DescribeUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUsers))) #
ToHeaders DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods toHeaders :: DescribeUsers -> [Header] #
ToPath DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods toPath :: DescribeUsers -> ByteString #
ToQuery DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods toQuery :: DescribeUsers -> QueryString #
type Rep DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers type Rep DescribeUsers = D1 ('MetaData "DescribeUsers" "Amazonka.ElastiCache.DescribeUsers" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeUsers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))
type AWSResponse DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers type AWSResponse DescribeUsers = DescribeUsersResponse

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:

$sel:filters:DescribeUsers', describeUsers_filters - Filter to determine the list of User IDs to return.

$sel:engine:DescribeUsers', describeUsers_engine - The Redis engine.

$sel:userId:DescribeUsers', describeUsers_userId - The ID of the user.

$sel:marker: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.

Request Lenses

describeUsers_filters :: Lens' DescribeUsers (Maybe [Filter]) Source #

Filter to determine the list of User IDs to return.

describeUsers_engine :: Lens' DescribeUsers (Maybe Text) Source #

The Redis engine.

describeUsers_userId :: Lens' DescribeUsers (Maybe Text) Source #

The ID of the user.

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.

Destructuring the Response

data DescribeUsersResponse Source #

See: newDescribeUsersResponse smart constructor.

Constructors

DescribeUsersResponse'
Fields users :: Maybe [User] A list of users. marker :: Maybe Text 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. > httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeUsersResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods (==) :: DescribeUsersResponse -> DescribeUsersResponse -> Bool # (/=) :: DescribeUsersResponse -> DescribeUsersResponse -> Bool #
Read DescribeUsersResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods readsPrec :: Int -> ReadS DescribeUsersResponse # readList :: ReadS [DescribeUsersResponse] # readPrec :: ReadPrec DescribeUsersResponse # readListPrec :: ReadPrec [DescribeUsersResponse] #
Show DescribeUsersResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods showsPrec :: Int -> DescribeUsersResponse -> ShowS # show :: DescribeUsersResponse -> String # showList :: [DescribeUsersResponse] -> ShowS #
Generic DescribeUsersResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Associated Types type Rep DescribeUsersResponse :: Type -> Type # Methods from :: DescribeUsersResponse -> Rep DescribeUsersResponse x # to :: Rep DescribeUsersResponse x -> DescribeUsersResponse #
NFData DescribeUsersResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods rnf :: DescribeUsersResponse -> () #
type Rep DescribeUsersResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers type Rep DescribeUsersResponse = D1 ('MetaData "DescribeUsersResponse" "Amazonka.ElastiCache.DescribeUsers" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeUsersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [User])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeUsersResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeUsersResponse'`
-> DescribeUsersResponse

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:

$sel:users:DescribeUsersResponse', describeUsersResponse_users - A list of users.

$sel:marker: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:httpStatus:DescribeUsersResponse', describeUsersResponse_httpStatus - The response's http status code.

Response Lenses

describeUsersResponse_users :: Lens' DescribeUsersResponse (Maybe [User]) Source #

A list of users.

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_httpStatus :: Lens' DescribeUsersResponse Int Source #

The response's http status code.