Network.AWS.Redshift.DescribeClusterParameterGroups

Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide .

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.

This operation returns paginated results.

Creating a Request

describeClusterParameterGroups :: DescribeClusterParameterGroups

Creates a value of DescribeClusterParameterGroups with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcpgTagValues - A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test . If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.
• dcpgTagKeys - A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment . If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.
• dcpgMarker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
• dcpgMaxRecords - The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
• dcpgParameterGroupName - The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

data DescribeClusterParameterGroups

See: describeClusterParameterGroups smart constructor.

Instances

Eq DescribeClusterParameterGroups

Methods

(==) :: DescribeClusterParameterGroups -> DescribeClusterParameterGroups -> Bool

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

Data DescribeClusterParameterGroups

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeClusterParameterGroups -> c DescribeClusterParameterGroups

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeClusterParameterGroups

toConstr :: DescribeClusterParameterGroups -> Constr

dataTypeOf :: DescribeClusterParameterGroups -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeClusterParameterGroups)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeClusterParameterGroups)

gmapT :: (forall b. Data b => b -> b) -> DescribeClusterParameterGroups -> DescribeClusterParameterGroups

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusterParameterGroups -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusterParameterGroups -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeClusterParameterGroups -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeClusterParameterGroups -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeClusterParameterGroups -> m DescribeClusterParameterGroups

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusterParameterGroups -> m DescribeClusterParameterGroups

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusterParameterGroups -> m DescribeClusterParameterGroups

Read DescribeClusterParameterGroups

Methods

readsPrec :: Int -> ReadS DescribeClusterParameterGroups

readList :: ReadS [DescribeClusterParameterGroups]

readPrec :: ReadPrec DescribeClusterParameterGroups

readListPrec :: ReadPrec [DescribeClusterParameterGroups]

Show DescribeClusterParameterGroups

Methods

showsPrec :: Int -> DescribeClusterParameterGroups -> ShowS

show :: DescribeClusterParameterGroups -> String

showList :: [DescribeClusterParameterGroups] -> ShowS

Generic DescribeClusterParameterGroups

Associated Types

type Rep DescribeClusterParameterGroups :: * -> *

Methods

from :: DescribeClusterParameterGroups -> Rep DescribeClusterParameterGroups x

to :: Rep DescribeClusterParameterGroups x -> DescribeClusterParameterGroups

Hashable DescribeClusterParameterGroups

Methods

hashWithSalt :: Int -> DescribeClusterParameterGroups -> Int

hash :: DescribeClusterParameterGroups -> Int

NFData DescribeClusterParameterGroups

Methods

rnf :: DescribeClusterParameterGroups -> ()

AWSPager DescribeClusterParameterGroups

Methods

page :: DescribeClusterParameterGroups -> Rs DescribeClusterParameterGroups -> Maybe DescribeClusterParameterGroups

AWSRequest DescribeClusterParameterGroups

Associated Types

type Rs DescribeClusterParameterGroups :: *

Methods

request :: DescribeClusterParameterGroups -> Request DescribeClusterParameterGroups

response :: MonadResource m => Logger -> Service -> Proxy * DescribeClusterParameterGroups -> ClientResponse -> m (Response DescribeClusterParameterGroups)

ToPath DescribeClusterParameterGroups

Methods

toPath :: DescribeClusterParameterGroups -> ByteString

ToHeaders DescribeClusterParameterGroups

Methods

toHeaders :: DescribeClusterParameterGroups -> [Header]

ToQuery DescribeClusterParameterGroups

Methods

toQuery :: DescribeClusterParameterGroups -> QueryString

type Rep DescribeClusterParameterGroups

type Rep DescribeClusterParameterGroups = D1 (MetaData "DescribeClusterParameterGroups" "Network.AWS.Redshift.DescribeClusterParameterGroups" "amazonka-redshift-1.4.5-2iQeXmFrftS29tYZtVOT2g" False) (C1 (MetaCons "DescribeClusterParameterGroups'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dcpgTagValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_dcpgTagKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_dcpgMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dcpgMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_dcpgParameterGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Rs DescribeClusterParameterGroups

type Rs DescribeClusterParameterGroups = DescribeClusterParameterGroupsResponse

Request Lenses

dcpgTagValues :: Lens' DescribeClusterParameterGroups [Text]

A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test . If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

dcpgTagKeys :: Lens' DescribeClusterParameterGroups [Text]

A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment . If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

dcpgMarker :: Lens' DescribeClusterParameterGroups (Maybe Text)

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

dcpgMaxRecords :: Lens' DescribeClusterParameterGroups (Maybe Int)

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.

dcpgParameterGroupName :: Lens' DescribeClusterParameterGroups (Maybe Text)

The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

Destructuring the Response

describeClusterParameterGroupsResponse

Arguments

:: Int

dcpgrsResponseStatus

-> DescribeClusterParameterGroupsResponse

Creates a value of DescribeClusterParameterGroupsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcpgrsMarker - A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
• dcpgrsParameterGroups - A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.
• dcpgrsResponseStatus - -- | The response status code.

data DescribeClusterParameterGroupsResponse

Contains the output from the DescribeClusterParameterGroups action.

See: describeClusterParameterGroupsResponse smart constructor.

Instances

Eq DescribeClusterParameterGroupsResponse

Methods

(==) :: DescribeClusterParameterGroupsResponse -> DescribeClusterParameterGroupsResponse -> Bool

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

Data DescribeClusterParameterGroupsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeClusterParameterGroupsResponse -> c DescribeClusterParameterGroupsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeClusterParameterGroupsResponse

toConstr :: DescribeClusterParameterGroupsResponse -> Constr

dataTypeOf :: DescribeClusterParameterGroupsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeClusterParameterGroupsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeClusterParameterGroupsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeClusterParameterGroupsResponse -> DescribeClusterParameterGroupsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusterParameterGroupsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusterParameterGroupsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeClusterParameterGroupsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeClusterParameterGroupsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeClusterParameterGroupsResponse -> m DescribeClusterParameterGroupsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusterParameterGroupsResponse -> m DescribeClusterParameterGroupsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusterParameterGroupsResponse -> m DescribeClusterParameterGroupsResponse

Read DescribeClusterParameterGroupsResponse

Methods

readsPrec :: Int -> ReadS DescribeClusterParameterGroupsResponse

readList :: ReadS [DescribeClusterParameterGroupsResponse]

readPrec :: ReadPrec DescribeClusterParameterGroupsResponse

readListPrec :: ReadPrec [DescribeClusterParameterGroupsResponse]

Show DescribeClusterParameterGroupsResponse

Methods

showsPrec :: Int -> DescribeClusterParameterGroupsResponse -> ShowS

show :: DescribeClusterParameterGroupsResponse -> String

showList :: [DescribeClusterParameterGroupsResponse] -> ShowS

Generic DescribeClusterParameterGroupsResponse

Associated Types

type Rep DescribeClusterParameterGroupsResponse :: * -> *

Methods

from :: DescribeClusterParameterGroupsResponse -> Rep DescribeClusterParameterGroupsResponse x

to :: Rep DescribeClusterParameterGroupsResponse x -> DescribeClusterParameterGroupsResponse

NFData DescribeClusterParameterGroupsResponse

Methods

rnf :: DescribeClusterParameterGroupsResponse -> ()

type Rep DescribeClusterParameterGroupsResponse

type Rep DescribeClusterParameterGroupsResponse = D1 (MetaData "DescribeClusterParameterGroupsResponse" "Network.AWS.Redshift.DescribeClusterParameterGroups" "amazonka-redshift-1.4.5-2iQeXmFrftS29tYZtVOT2g" False) (C1 (MetaCons "DescribeClusterParameterGroupsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dcpgrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dcpgrsParameterGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ClusterParameterGroup]))) (S1 (MetaSel (Just Symbol "_dcpgrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dcpgrsMarker :: Lens' DescribeClusterParameterGroupsResponse (Maybe Text)

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

dcpgrsParameterGroups :: Lens' DescribeClusterParameterGroupsResponse [ClusterParameterGroup]

A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.

dcpgrsResponseStatus :: Lens' DescribeClusterParameterGroupsResponse Int

• - | The response status code.