Amazonka.MemoryDb.DescribeParameters

Returns the detailed parameter list for a particular parameter group.

This operation returns paginated results.

Creating a Request

data DescribeParameters

See: newDescribeParameters smart constructor.

Constructors

DescribeParameters'

Fields

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

• parameterGroupName :: Text

  he name of a specific parameter group to return details for.

Instances

ToJSON DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

toJSON :: DescribeParameters -> Value

toEncoding :: DescribeParameters -> Encoding

toJSONList :: [DescribeParameters] -> Value

toEncodingList :: [DescribeParameters] -> Encoding

ToHeaders DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

toHeaders :: DescribeParameters -> [Header]

ToPath DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

toPath :: DescribeParameters -> ByteString

ToQuery DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

toQuery :: DescribeParameters -> QueryString

AWSPager DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

page :: DescribeParameters -> AWSResponse DescribeParameters -> Maybe DescribeParameters

AWSRequest DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

Associated Types

type AWSResponse DescribeParameters

Methods

request :: (Service -> Service) -> DescribeParameters -> Request DescribeParameters

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeParameters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeParameters)))

Generic DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

Associated Types

type Rep DescribeParameters :: Type -> Type

Methods

from :: DescribeParameters -> Rep DescribeParameters x

to :: Rep DescribeParameters x -> DescribeParameters

Read DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

readsPrec :: Int -> ReadS DescribeParameters

readList :: ReadS [DescribeParameters]

readPrec :: ReadPrec DescribeParameters

readListPrec :: ReadPrec [DescribeParameters]

Show DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

showsPrec :: Int -> DescribeParameters -> ShowS

show :: DescribeParameters -> String

showList :: [DescribeParameters] -> ShowS

NFData DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

rnf :: DescribeParameters -> ()

Eq DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

(==) :: DescribeParameters -> DescribeParameters -> Bool

(/=) :: DescribeParameters -> DescribeParameters -> Bool

Hashable DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

hashWithSalt :: Int -> DescribeParameters -> Int

hash :: DescribeParameters -> Int

type AWSResponse DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

type AWSResponse DescribeParameters = DescribeParametersResponse

type Rep DescribeParameters

Defined in Amazonka.MemoryDb.DescribeParameters

type Rep DescribeParameters = D1 ('MetaData "DescribeParameters" "Amazonka.MemoryDb.DescribeParameters" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeParameters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "parameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeParameters

Arguments

:: Text

DescribeParameters

-> DescribeParameters

Create a value of DescribeParameters 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:maxResults:DescribeParameters', describeParameters_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.

DescribeParameters, describeParameters_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.

DescribeParameters, describeParameters_parameterGroupName - he name of a specific parameter group to return details for.

Request Lenses

describeParameters_maxResults :: Lens' DescribeParameters (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.

describeParameters_nextToken :: Lens' DescribeParameters (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.

describeParameters_parameterGroupName :: Lens' DescribeParameters Text

he name of a specific parameter group to return details for.

Destructuring the Response

data DescribeParametersResponse

See: newDescribeParametersResponse smart constructor.

Constructors

DescribeParametersResponse'

Fields

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

• parameters :: Maybe [Parameter]

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeParametersResponse

Defined in Amazonka.MemoryDb.DescribeParameters

Associated Types

type Rep DescribeParametersResponse :: Type -> Type

Methods

from :: DescribeParametersResponse -> Rep DescribeParametersResponse x

to :: Rep DescribeParametersResponse x -> DescribeParametersResponse

Read DescribeParametersResponse

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

readsPrec :: Int -> ReadS DescribeParametersResponse

readList :: ReadS [DescribeParametersResponse]

readPrec :: ReadPrec DescribeParametersResponse

readListPrec :: ReadPrec [DescribeParametersResponse]

Show DescribeParametersResponse

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

showsPrec :: Int -> DescribeParametersResponse -> ShowS

show :: DescribeParametersResponse -> String

showList :: [DescribeParametersResponse] -> ShowS

NFData DescribeParametersResponse

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

rnf :: DescribeParametersResponse -> ()

Eq DescribeParametersResponse

Defined in Amazonka.MemoryDb.DescribeParameters

Methods

(==) :: DescribeParametersResponse -> DescribeParametersResponse -> Bool

(/=) :: DescribeParametersResponse -> DescribeParametersResponse -> Bool

type Rep DescribeParametersResponse

Defined in Amazonka.MemoryDb.DescribeParameters

type Rep DescribeParametersResponse = D1 ('MetaData "DescribeParametersResponse" "Amazonka.MemoryDb.DescribeParameters" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeParametersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") '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))))

newDescribeParametersResponse

Arguments

:: Int

$sel:httpStatus:DescribeParametersResponse'

-> DescribeParametersResponse

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

DescribeParameters, describeParametersResponse_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:parameters:DescribeParametersResponse', describeParametersResponse_parameters - A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.

$sel:httpStatus:DescribeParametersResponse', describeParametersResponse_httpStatus - The response's http status code.

Response Lenses

describeParametersResponse_nextToken :: Lens' DescribeParametersResponse (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.

describeParametersResponse_parameters :: Lens' DescribeParametersResponse (Maybe [Parameter])

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

describeParametersResponse_httpStatus :: Lens' DescribeParametersResponse Int

The response's http status code.