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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the available cache engines and their versions.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeCacheEngineVersions Source #

Represents the input of a DescribeCacheEngineVersions operation.

See: newDescribeCacheEngineVersions smart constructor.

Constructors

DescribeCacheEngineVersions'

Fields

engineVersion :: Maybe Text
The cache engine version to return.
Example: 1.4.14
cacheParameterGroupFamily :: Maybe Text
The name of a specific cache parameter group family to return details for.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |
Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
defaultOnly :: Maybe Bool
If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.
engine :: Maybe Text
The cache engine to return. Valid values: memcached | redis
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 DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions Methods (==) :: DescribeCacheEngineVersions -> DescribeCacheEngineVersions -> Bool # (/=) :: DescribeCacheEngineVersions -> DescribeCacheEngineVersions -> Bool #
Read DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions Methods readsPrec :: Int -> ReadS DescribeCacheEngineVersions # readList :: ReadS [DescribeCacheEngineVersions] # readPrec :: ReadPrec DescribeCacheEngineVersions # readListPrec :: ReadPrec [DescribeCacheEngineVersions] #
Show DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions Methods showsPrec :: Int -> DescribeCacheEngineVersions -> ShowS # show :: DescribeCacheEngineVersions -> String # showList :: [DescribeCacheEngineVersions] -> ShowS #
Generic DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions Associated Types type Rep DescribeCacheEngineVersions :: Type -> Type # Methods from :: DescribeCacheEngineVersions -> Rep DescribeCacheEngineVersions x # to :: Rep DescribeCacheEngineVersions x -> DescribeCacheEngineVersions #
NFData DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions Methods rnf :: DescribeCacheEngineVersions -> () #
Hashable DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions Methods hashWithSalt :: Int -> DescribeCacheEngineVersions -> Int # hash :: DescribeCacheEngineVersions -> Int #
AWSPager DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions Methods page :: DescribeCacheEngineVersions -> AWSResponse DescribeCacheEngineVersions -> Maybe DescribeCacheEngineVersions #
AWSRequest DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions Associated Types type AWSResponse DescribeCacheEngineVersions # Methods request :: DescribeCacheEngineVersions -> Request DescribeCacheEngineVersions # response :: MonadResource m => Logger -> Service -> Proxy DescribeCacheEngineVersions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCacheEngineVersions))) #
ToHeaders DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions Methods toHeaders :: DescribeCacheEngineVersions -> [Header] #
ToPath DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions Methods toPath :: DescribeCacheEngineVersions -> ByteString #
ToQuery DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions Methods toQuery :: DescribeCacheEngineVersions -> QueryString #
type Rep DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions type Rep DescribeCacheEngineVersions = D1 ('MetaData "DescribeCacheEngineVersions" "Amazonka.ElastiCache.DescribeCacheEngineVersions" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "DescribeCacheEngineVersions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "cacheParameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "defaultOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "engine") '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 DescribeCacheEngineVersions Source #
Instance details Defined in Amazonka.ElastiCache.DescribeCacheEngineVersions type AWSResponse DescribeCacheEngineVersions = DescribeCacheEngineVersionsResponse

newDescribeCacheEngineVersions :: DescribeCacheEngineVersions Source #

Create a value of DescribeCacheEngineVersions 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:engineVersion:DescribeCacheEngineVersions', describeCacheEngineVersions_engineVersion - The cache engine version to return.

Example: 1.4.14

$sel:cacheParameterGroupFamily:DescribeCacheEngineVersions', describeCacheEngineVersions_cacheParameterGroupFamily - The name of a specific cache parameter group family to return details for.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

$sel:defaultOnly:DescribeCacheEngineVersions', describeCacheEngineVersions_defaultOnly - If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

$sel:engine:DescribeCacheEngineVersions', describeCacheEngineVersions_engine - The cache engine to return. Valid values: memcached | redis

$sel:marker:DescribeCacheEngineVersions', describeCacheEngineVersions_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:DescribeCacheEngineVersions', describeCacheEngineVersions_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

describeCacheEngineVersions_engineVersion :: Lens' DescribeCacheEngineVersions (Maybe Text) Source #

The cache engine version to return.

Example: 1.4.14

describeCacheEngineVersions_cacheParameterGroupFamily :: Lens' DescribeCacheEngineVersions (Maybe Text) Source #

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

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

describeCacheEngineVersions_defaultOnly :: Lens' DescribeCacheEngineVersions (Maybe Bool) Source #

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

describeCacheEngineVersions_engine :: Lens' DescribeCacheEngineVersions (Maybe Text) Source #

The cache engine to return. Valid values: memcached | redis

describeCacheEngineVersions_marker :: Lens' DescribeCacheEngineVersions (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.

describeCacheEngineVersions_maxRecords :: Lens' DescribeCacheEngineVersions (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 DescribeCacheEngineVersionsResponse Source #

Represents the output of a DescribeCacheEngineVersions operation.

See: newDescribeCacheEngineVersionsResponse smart constructor.

Constructors

DescribeCacheEngineVersionsResponse'
Fields cacheEngineVersions :: Maybe [CacheEngineVersion] A list of cache engine version details. Each element in the list contains detailed information about one cache engine version. marker :: Maybe Text Provides an identifier to allow retrieval of paginated results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeCacheEngineVersionsResponse Source #

Arguments

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

Create a value of DescribeCacheEngineVersionsResponse 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:cacheEngineVersions:DescribeCacheEngineVersionsResponse', describeCacheEngineVersionsResponse_cacheEngineVersions - A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

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

$sel:httpStatus:DescribeCacheEngineVersionsResponse', describeCacheEngineVersionsResponse_httpStatus - The response's http status code.

Response Lenses

describeCacheEngineVersionsResponse_cacheEngineVersions :: Lens' DescribeCacheEngineVersionsResponse (Maybe [CacheEngineVersion]) Source #

A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

describeCacheEngineVersionsResponse_marker :: Lens' DescribeCacheEngineVersionsResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeCacheEngineVersionsResponse_httpStatus :: Lens' DescribeCacheEngineVersionsResponse Int Source #

The response's http status code.