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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the detailed parameter list for a particular cache parameter group.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeCacheParameters Source #

Represents the input of a DescribeCacheParameters operation.

See: newDescribeCacheParameters smart constructor.

Constructors

DescribeCacheParameters'

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.
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.
source :: Maybe Text
The parameter types to return.
Valid values: user | system | engine-default
cacheParameterGroupName :: Text
The name of a specific cache parameter group to return details for.

Instances

Instances details

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

newDescribeCacheParameters Source #

Arguments

:: Text	`DescribeCacheParameters`
-> DescribeCacheParameters

Create a value of DescribeCacheParameters 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:

DescribeCacheParameters, describeCacheParameters_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:DescribeCacheParameters', describeCacheParameters_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.

DescribeCacheParameters, describeCacheParameters_source - The parameter types to return.

Valid values: user | system | engine-default

DescribeCacheParameters, describeCacheParameters_cacheParameterGroupName - The name of a specific cache parameter group to return details for.

Request Lenses

describeCacheParameters_marker :: Lens' DescribeCacheParameters (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.

describeCacheParameters_maxRecords :: Lens' DescribeCacheParameters (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.

describeCacheParameters_source :: Lens' DescribeCacheParameters (Maybe Text) Source #

The parameter types to return.

Valid values: user | system | engine-default

describeCacheParameters_cacheParameterGroupName :: Lens' DescribeCacheParameters Text Source #

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

Destructuring the Response

data DescribeCacheParametersResponse Source #

Represents the output of a DescribeCacheParameters operation.

See: newDescribeCacheParametersResponse smart constructor.

Constructors

DescribeCacheParametersResponse'

Fields

cacheNodeTypeSpecificParameters :: Maybe [CacheNodeTypeSpecificParameter]
A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.
marker :: Maybe Text
Provides an identifier to allow retrieval of paginated results.
parameters :: Maybe [Parameter]
A list of Parameter instances.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeCacheParametersResponse Source #

Arguments

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

Create a value of DescribeCacheParametersResponse 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:

DescribeCacheParametersResponse, describeCacheParametersResponse_cacheNodeTypeSpecificParameters - A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

DescribeCacheParameters, describeCacheParametersResponse_marker - Provides an identifier to allow retrieval of paginated results.

DescribeCacheParametersResponse, describeCacheParametersResponse_parameters - A list of Parameter instances.

$sel:httpStatus:DescribeCacheParametersResponse', describeCacheParametersResponse_httpStatus - The response's http status code.

Response Lenses

describeCacheParametersResponse_cacheNodeTypeSpecificParameters :: Lens' DescribeCacheParametersResponse (Maybe [CacheNodeTypeSpecificParameter]) Source #

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

describeCacheParametersResponse_marker :: Lens' DescribeCacheParametersResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeCacheParametersResponse_parameters :: Lens' DescribeCacheParametersResponse (Maybe [Parameter]) Source #

A list of Parameter instances.

describeCacheParametersResponse_httpStatus :: Lens' DescribeCacheParametersResponse Int Source #

The response's http status code.