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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeCacheParameterGroups Source #

Represents the input of a DescribeCacheParameterGroups operation.

See: newDescribeCacheParameterGroups smart constructor.

Constructors

DescribeCacheParameterGroups'

Fields

cacheParameterGroupName :: Maybe Text
The name of a specific cache parameter group to return details for.
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.
Default: 100
Constraints: minimum 20; maximum 100.

Instances

Instances details

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

newDescribeCacheParameterGroups :: DescribeCacheParameterGroups Source #

Create a value of DescribeCacheParameterGroups 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:cacheParameterGroupName:DescribeCacheParameterGroups', describeCacheParameterGroups_cacheParameterGroupName - The name of a specific cache parameter group to return details for.

$sel:marker:DescribeCacheParameterGroups', describeCacheParameterGroups_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:DescribeCacheParameterGroups', describeCacheParameterGroups_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.

Default: 100

Constraints: minimum 20; maximum 100.

Request Lenses

describeCacheParameterGroups_cacheParameterGroupName :: Lens' DescribeCacheParameterGroups (Maybe Text) Source #

The name of a specific cache parameter group to return details for.

describeCacheParameterGroups_marker :: Lens' DescribeCacheParameterGroups (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.

describeCacheParameterGroups_maxRecords :: Lens' DescribeCacheParameterGroups (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.

Default: 100

Constraints: minimum 20; maximum 100.

Destructuring the Response

data DescribeCacheParameterGroupsResponse Source #

Represents the output of a DescribeCacheParameterGroups operation.

See: newDescribeCacheParameterGroupsResponse smart constructor.

Constructors

DescribeCacheParameterGroupsResponse'
Fields cacheParameterGroups :: Maybe [CacheParameterGroup] A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group. marker :: Maybe Text Provides an identifier to allow retrieval of paginated results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeCacheParameterGroupsResponse Source #

Arguments

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

Create a value of DescribeCacheParameterGroupsResponse 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:cacheParameterGroups:DescribeCacheParameterGroupsResponse', describeCacheParameterGroupsResponse_cacheParameterGroups - A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

$sel:marker:DescribeCacheParameterGroups', describeCacheParameterGroupsResponse_marker - Provides an identifier to allow retrieval of paginated results.

$sel:httpStatus:DescribeCacheParameterGroupsResponse', describeCacheParameterGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeCacheParameterGroupsResponse_cacheParameterGroups :: Lens' DescribeCacheParameterGroupsResponse (Maybe [CacheParameterGroup]) Source #

A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

describeCacheParameterGroupsResponse_marker :: Lens' DescribeCacheParameterGroupsResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeCacheParameterGroupsResponse_httpStatus :: Lens' DescribeCacheParameterGroupsResponse Int Source #

The response's http status code.