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.MemoryDb.DescribeEngineVersions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the available Redis engine versions.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeEngineVersions Source #

See: newDescribeEngineVersions smart constructor.

Constructors

DescribeEngineVersions'

Fields

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.
engineVersion :: Maybe Text
The Redis engine version
maxResults :: Maybe Int
The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
nextToken :: Maybe Text
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
parameterGroupFamily :: Maybe Text
The name of a specific parameter group family to return details for.

Instances

Instances details

ToJSON DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods toJSON :: DescribeEngineVersions -> Value # toEncoding :: DescribeEngineVersions -> Encoding # toJSONList :: [DescribeEngineVersions] -> Value # toEncodingList :: [DescribeEngineVersions] -> Encoding #
ToHeaders DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods toHeaders :: DescribeEngineVersions -> [Header] #
ToPath DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods toPath :: DescribeEngineVersions -> ByteString #
ToQuery DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods toQuery :: DescribeEngineVersions -> QueryString #
AWSPager DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods page :: DescribeEngineVersions -> AWSResponse DescribeEngineVersions -> Maybe DescribeEngineVersions #
AWSRequest DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Associated Types type AWSResponse DescribeEngineVersions # Methods request :: (Service -> Service) -> DescribeEngineVersions -> Request DescribeEngineVersions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEngineVersions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEngineVersions))) #
Generic DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Associated Types type Rep DescribeEngineVersions :: Type -> Type # Methods from :: DescribeEngineVersions -> Rep DescribeEngineVersions x # to :: Rep DescribeEngineVersions x -> DescribeEngineVersions #
Read DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods readsPrec :: Int -> ReadS DescribeEngineVersions # readList :: ReadS [DescribeEngineVersions] # readPrec :: ReadPrec DescribeEngineVersions # readListPrec :: ReadPrec [DescribeEngineVersions] #
Show DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods showsPrec :: Int -> DescribeEngineVersions -> ShowS # show :: DescribeEngineVersions -> String # showList :: [DescribeEngineVersions] -> ShowS #
NFData DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods rnf :: DescribeEngineVersions -> () #
Eq DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods (==) :: DescribeEngineVersions -> DescribeEngineVersions -> Bool # (/=) :: DescribeEngineVersions -> DescribeEngineVersions -> Bool #
Hashable DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods hashWithSalt :: Int -> DescribeEngineVersions -> Int # hash :: DescribeEngineVersions -> Int #
type AWSResponse DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions type AWSResponse DescribeEngineVersions = DescribeEngineVersionsResponse
type Rep DescribeEngineVersions Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions type Rep DescribeEngineVersions = D1 ('MetaData "DescribeEngineVersions" "Amazonka.MemoryDb.DescribeEngineVersions" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeEngineVersions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameterGroupFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeEngineVersions :: DescribeEngineVersions Source #

Create a value of DescribeEngineVersions 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:defaultOnly:DescribeEngineVersions', describeEngineVersions_defaultOnly - If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

DescribeEngineVersions, describeEngineVersions_engineVersion - The Redis engine version

$sel:maxResults:DescribeEngineVersions', describeEngineVersions_maxResults - The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

DescribeEngineVersions, describeEngineVersions_nextToken - An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

DescribeEngineVersions, describeEngineVersions_parameterGroupFamily - The name of a specific parameter group family to return details for.

Request Lenses

describeEngineVersions_defaultOnly :: Lens' DescribeEngineVersions (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.

describeEngineVersions_engineVersion :: Lens' DescribeEngineVersions (Maybe Text) Source #

The Redis engine version

describeEngineVersions_maxResults :: Lens' DescribeEngineVersions (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

describeEngineVersions_nextToken :: Lens' DescribeEngineVersions (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeEngineVersions_parameterGroupFamily :: Lens' DescribeEngineVersions (Maybe Text) Source #

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

Destructuring the Response

data DescribeEngineVersionsResponse Source #

See: newDescribeEngineVersionsResponse smart constructor.

Constructors

DescribeEngineVersionsResponse'

Fields

engineVersions :: Maybe [EngineVersionInfo]
A list of engine version details. Each element in the list contains detailed information about one engine version.
nextToken :: Maybe Text
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeEngineVersionsResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Associated Types type Rep DescribeEngineVersionsResponse :: Type -> Type # Methods from :: DescribeEngineVersionsResponse -> Rep DescribeEngineVersionsResponse x # to :: Rep DescribeEngineVersionsResponse x -> DescribeEngineVersionsResponse #
Read DescribeEngineVersionsResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods readsPrec :: Int -> ReadS DescribeEngineVersionsResponse # readList :: ReadS [DescribeEngineVersionsResponse] # readPrec :: ReadPrec DescribeEngineVersionsResponse # readListPrec :: ReadPrec [DescribeEngineVersionsResponse] #
Show DescribeEngineVersionsResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods showsPrec :: Int -> DescribeEngineVersionsResponse -> ShowS # show :: DescribeEngineVersionsResponse -> String # showList :: [DescribeEngineVersionsResponse] -> ShowS #
NFData DescribeEngineVersionsResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods rnf :: DescribeEngineVersionsResponse -> () #
Eq DescribeEngineVersionsResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions Methods (==) :: DescribeEngineVersionsResponse -> DescribeEngineVersionsResponse -> Bool # (/=) :: DescribeEngineVersionsResponse -> DescribeEngineVersionsResponse -> Bool #
type Rep DescribeEngineVersionsResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeEngineVersions type Rep DescribeEngineVersionsResponse = D1 ('MetaData "DescribeEngineVersionsResponse" "Amazonka.MemoryDb.DescribeEngineVersions" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeEngineVersionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "engineVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EngineVersionInfo])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEngineVersionsResponse Source #

Arguments

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

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

DescribeEngineVersions, describeEngineVersionsResponse_nextToken - An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

$sel:httpStatus:DescribeEngineVersionsResponse', describeEngineVersionsResponse_httpStatus - The response's http status code.

Response Lenses

describeEngineVersionsResponse_engineVersions :: Lens' DescribeEngineVersionsResponse (Maybe [EngineVersionInfo]) Source #

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

describeEngineVersionsResponse_nextToken :: Lens' DescribeEngineVersionsResponse (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

describeEngineVersionsResponse_httpStatus :: Lens' DescribeEngineVersionsResponse Int Source #

The response's http status code.