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

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' {
- engine :: Maybe Text
- filters :: Maybe [Filter]
- marker :: Maybe Text
- maxRecords :: Maybe Int
- userId :: Maybe Text
}
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' {
- marker :: Maybe Text
- users :: Maybe [User]
- httpStatus :: Int
}
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.

Constructors

DescribeUsers'

Fields

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

Instances

Instances details

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 #
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 :: (Service -> Service) -> DescribeUsers -> Request DescribeUsers # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUsers))) #
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 #
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 #
NFData DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods rnf :: DescribeUsers -> () #
Eq DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods (==) :: DescribeUsers -> DescribeUsers -> Bool # (/=) :: DescribeUsers -> DescribeUsers -> Bool #
Hashable DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods hashWithSalt :: Int -> DescribeUsers -> Int # hash :: DescribeUsers -> Int #
type AWSResponse DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers type AWSResponse DescribeUsers = DescribeUsersResponse
type Rep DescribeUsers Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers type Rep DescribeUsers = D1 ('MetaData "DescribeUsers" "Amazonka.ElastiCache.DescribeUsers" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "DescribeUsers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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.

Constructors

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

Instances

Instances details

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 #
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 #
NFData DescribeUsersResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods rnf :: DescribeUsersResponse -> () #
Eq DescribeUsersResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers Methods (==) :: DescribeUsersResponse -> DescribeUsersResponse -> Bool # (/=) :: DescribeUsersResponse -> DescribeUsersResponse -> Bool #
type Rep DescribeUsersResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUsers type Rep DescribeUsersResponse = D1 ('MetaData "DescribeUsersResponse" "Amazonka.ElastiCache.DescribeUsers" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "DescribeUsersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [User])) :: 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:

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.