libZSservicesZSamazonka-dynamodb-daxZSamazonka-dynamodb-dax
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DAX.DescribeParameterGroups

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeParameterGroups Source #

See: newDescribeParameterGroups smart constructor.

Constructors

DescribeParameterGroups' 

Fields

  • nextToken :: Maybe Text

    An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

  • parameterGroupNames :: Maybe [Text]

    The names of the parameter groups.

  • maxResults :: Maybe Int

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

    The value for MaxResults must be between 20 and 100.

Instances

Instances details
Eq DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

(==) :: DescribeParameterGroups -> DescribeParameterGroups -> Bool #

(/=) :: DescribeParameterGroups -> DescribeParameterGroups -> Bool #

Read DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

readsPrec :: Int -> ReadS DescribeParameterGroups #

readList :: ReadS [DescribeParameterGroups] #

readPrec :: ReadPrec DescribeParameterGroups #

readListPrec :: ReadPrec [DescribeParameterGroups] #

Show DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

showsPrec :: Int -> DescribeParameterGroups -> ShowS #

show :: DescribeParameterGroups -> String #

showList :: [DescribeParameterGroups] -> ShowS #

Generic DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Associated Types

type Rep DescribeParameterGroups :: Type -> Type #

Methods

from :: DescribeParameterGroups -> Rep DescribeParameterGroups x #

to :: Rep DescribeParameterGroups x -> DescribeParameterGroups #

NFData DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

rnf :: DescribeParameterGroups -> () #

Hashable DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

hashWithSalt :: Int -> DescribeParameterGroups -> Int #

hash :: DescribeParameterGroups -> Int #

ToJSON DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

toJSON :: DescribeParameterGroups -> Value #

toEncoding :: DescribeParameterGroups -> Encoding #

toJSONList :: [DescribeParameterGroups] -> Value #

toEncodingList :: [DescribeParameterGroups] -> Encoding #

AWSPager DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

page :: DescribeParameterGroups -> AWSResponse DescribeParameterGroups -> Maybe DescribeParameterGroups #

AWSRequest DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Associated Types

type AWSResponse DescribeParameterGroups #

Methods

request :: DescribeParameterGroups -> Request DescribeParameterGroups #

response :: MonadResource m => Logger -> Service -> Proxy DescribeParameterGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeParameterGroups))) #

ToHeaders DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

toHeaders :: DescribeParameterGroups -> [Header] #

ToPath DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

toPath :: DescribeParameterGroups -> ByteString #

ToQuery DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

toQuery :: DescribeParameterGroups -> QueryString #

type Rep DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

type Rep DescribeParameterGroups = D1 ('MetaData "DescribeParameterGroups" "Amazonka.DAX.DescribeParameterGroups" "libZSservicesZSamazonka-dynamodb-daxZSamazonka-dynamodb-dax" 'False) (C1 ('MetaCons "DescribeParameterGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "parameterGroupNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeParameterGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

type AWSResponse DescribeParameterGroups = DescribeParameterGroupsResponse

newDescribeParameterGroups :: DescribeParameterGroups Source #

Create a value of DescribeParameterGroups 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:nextToken:DescribeParameterGroups', describeParameterGroups_nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

$sel:parameterGroupNames:DescribeParameterGroups', describeParameterGroups_parameterGroupNames - The names of the parameter groups.

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

The value for MaxResults must be between 20 and 100.

Request Lenses

describeParameterGroups_nextToken :: Lens' DescribeParameterGroups (Maybe Text) Source #

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

describeParameterGroups_parameterGroupNames :: Lens' DescribeParameterGroups (Maybe [Text]) Source #

The names of the parameter groups.

describeParameterGroups_maxResults :: Lens' DescribeParameterGroups (Maybe Int) Source #

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

The value for MaxResults must be between 20 and 100.

Destructuring the Response

data DescribeParameterGroupsResponse Source #

See: newDescribeParameterGroupsResponse smart constructor.

Constructors

DescribeParameterGroupsResponse' 

Fields

Instances

Instances details
Eq DescribeParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

(==) :: DescribeParameterGroupsResponse -> DescribeParameterGroupsResponse -> Bool #

(/=) :: DescribeParameterGroupsResponse -> DescribeParameterGroupsResponse -> Bool #

Read DescribeParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

readsPrec :: Int -> ReadS DescribeParameterGroupsResponse #

readList :: ReadS [DescribeParameterGroupsResponse] #

readPrec :: ReadPrec DescribeParameterGroupsResponse #

readListPrec :: ReadPrec [DescribeParameterGroupsResponse] #

Show DescribeParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

showsPrec :: Int -> DescribeParameterGroupsResponse -> ShowS #

show :: DescribeParameterGroupsResponse -> String #

showList :: [DescribeParameterGroupsResponse] -> ShowS #

Generic DescribeParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Associated Types

type Rep DescribeParameterGroupsResponse :: Type -> Type #

Methods

from :: DescribeParameterGroupsResponse -> Rep DescribeParameterGroupsResponse x #

to :: Rep DescribeParameterGroupsResponse x -> DescribeParameterGroupsResponse #

NFData DescribeParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

Methods

rnf :: DescribeParameterGroupsResponse -> () #

type Rep DescribeParameterGroupsResponse Source # 
Instance details

Defined in Amazonka.DAX.DescribeParameterGroups

type Rep DescribeParameterGroupsResponse = D1 ('MetaData "DescribeParameterGroupsResponse" "Amazonka.DAX.DescribeParameterGroups" "libZSservicesZSamazonka-dynamodb-daxZSamazonka-dynamodb-dax" 'False) (C1 ('MetaCons "DescribeParameterGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "parameterGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ParameterGroup])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeParameterGroupsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeParameterGroupsResponse'

-> DescribeParameterGroupsResponse 

Create a value of DescribeParameterGroupsResponse 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:nextToken:DescribeParameterGroups', describeParameterGroupsResponse_nextToken - Provides an identifier to allow retrieval of paginated results.

$sel:parameterGroups:DescribeParameterGroupsResponse', describeParameterGroupsResponse_parameterGroups - An array of parameter groups. Each element in the array represents one parameter group.

$sel:httpStatus:DescribeParameterGroupsResponse', describeParameterGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeParameterGroupsResponse_nextToken :: Lens' DescribeParameterGroupsResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeParameterGroupsResponse_parameterGroups :: Lens' DescribeParameterGroupsResponse (Maybe [ParameterGroup]) Source #

An array of parameter groups. Each element in the array represents one parameter group.

describeParameterGroupsResponse_httpStatus :: Lens' DescribeParameterGroupsResponse Int Source #

The response's http status code.