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.DescribeUserGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of user groups.

This operation returns paginated results.

Creating a Request

data DescribeUserGroups Source #

See: newDescribeUserGroups smart constructor.

Constructors

DescribeUserGroups'

Fields

userGroupId :: Maybe Text
The ID of the user group.
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 DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods (==) :: DescribeUserGroups -> DescribeUserGroups -> Bool # (/=) :: DescribeUserGroups -> DescribeUserGroups -> Bool #
Read DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods readsPrec :: Int -> ReadS DescribeUserGroups # readList :: ReadS [DescribeUserGroups] # readPrec :: ReadPrec DescribeUserGroups # readListPrec :: ReadPrec [DescribeUserGroups] #
Show DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods showsPrec :: Int -> DescribeUserGroups -> ShowS # show :: DescribeUserGroups -> String # showList :: [DescribeUserGroups] -> ShowS #
Generic DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Associated Types type Rep DescribeUserGroups :: Type -> Type # Methods from :: DescribeUserGroups -> Rep DescribeUserGroups x # to :: Rep DescribeUserGroups x -> DescribeUserGroups #
NFData DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods rnf :: DescribeUserGroups -> () #
Hashable DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods hashWithSalt :: Int -> DescribeUserGroups -> Int # hash :: DescribeUserGroups -> Int #
AWSPager DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods page :: DescribeUserGroups -> AWSResponse DescribeUserGroups -> Maybe DescribeUserGroups #
AWSRequest DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Associated Types type AWSResponse DescribeUserGroups # Methods request :: DescribeUserGroups -> Request DescribeUserGroups # response :: MonadResource m => Logger -> Service -> Proxy DescribeUserGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUserGroups))) #
ToHeaders DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods toHeaders :: DescribeUserGroups -> [Header] #
ToPath DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods toPath :: DescribeUserGroups -> ByteString #
ToQuery DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods toQuery :: DescribeUserGroups -> QueryString #
type Rep DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups type Rep DescribeUserGroups = D1 ('MetaData "DescribeUserGroups" "Amazonka.ElastiCache.DescribeUserGroups" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeUserGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userGroupId") '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 DescribeUserGroups Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups type AWSResponse DescribeUserGroups = DescribeUserGroupsResponse

newDescribeUserGroups :: DescribeUserGroups Source #

Create a value of DescribeUserGroups 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:userGroupId:DescribeUserGroups', describeUserGroups_userGroupId - The ID of the user group.

$sel:marker:DescribeUserGroups', describeUserGroups_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:DescribeUserGroups', describeUserGroups_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

describeUserGroups_userGroupId :: Lens' DescribeUserGroups (Maybe Text) Source #

The ID of the user group.

describeUserGroups_marker :: Lens' DescribeUserGroups (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. >

describeUserGroups_maxRecords :: Lens' DescribeUserGroups (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 DescribeUserGroupsResponse Source #

See: newDescribeUserGroupsResponse smart constructor.

Constructors

DescribeUserGroupsResponse'
Fields userGroups :: Maybe [UserGroup] Returns a list of user groups. 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 DescribeUserGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods (==) :: DescribeUserGroupsResponse -> DescribeUserGroupsResponse -> Bool # (/=) :: DescribeUserGroupsResponse -> DescribeUserGroupsResponse -> Bool #
Read DescribeUserGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods readsPrec :: Int -> ReadS DescribeUserGroupsResponse # readList :: ReadS [DescribeUserGroupsResponse] # readPrec :: ReadPrec DescribeUserGroupsResponse # readListPrec :: ReadPrec [DescribeUserGroupsResponse] #
Show DescribeUserGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods showsPrec :: Int -> DescribeUserGroupsResponse -> ShowS # show :: DescribeUserGroupsResponse -> String # showList :: [DescribeUserGroupsResponse] -> ShowS #
Generic DescribeUserGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Associated Types type Rep DescribeUserGroupsResponse :: Type -> Type # Methods from :: DescribeUserGroupsResponse -> Rep DescribeUserGroupsResponse x # to :: Rep DescribeUserGroupsResponse x -> DescribeUserGroupsResponse #
NFData DescribeUserGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups Methods rnf :: DescribeUserGroupsResponse -> () #
type Rep DescribeUserGroupsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeUserGroups type Rep DescribeUserGroupsResponse = D1 ('MetaData "DescribeUserGroupsResponse" "Amazonka.ElastiCache.DescribeUserGroups" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeUserGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserGroup])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeUserGroupsResponse Source #

Arguments

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

Create a value of DescribeUserGroupsResponse 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:userGroups:DescribeUserGroupsResponse', describeUserGroupsResponse_userGroups - Returns a list of user groups.

$sel:marker:DescribeUserGroups', describeUserGroupsResponse_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:DescribeUserGroupsResponse', describeUserGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeUserGroupsResponse_userGroups :: Lens' DescribeUserGroupsResponse (Maybe [UserGroup]) Source #

Returns a list of user groups.

describeUserGroupsResponse_marker :: Lens' DescribeUserGroupsResponse (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. >

describeUserGroupsResponse_httpStatus :: Lens' DescribeUserGroupsResponse Int Source #

The response's http status code.