amazonka-redshift-1.4.5: Amazon Redshift SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Redshift.DescribeClusterParameters

Contents

Description

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup , you can specify source equal to user .

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

This operation returns paginated results.

Synopsis

Creating a Request

describeClusterParameters #

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

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

  • dcpsMarker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters 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.
  • dcpsMaxRecords - 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.
  • dcpsSource - The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group. Default: All parameter types returned. Valid Values: user | engine-default
  • dcpsParameterGroupName - The name of a cluster parameter group for which to return details.

data DescribeClusterParameters #

See: describeClusterParameters smart constructor.

Instances

Eq DescribeClusterParameters # 
Data DescribeClusterParameters # 

Methods

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

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

toConstr :: DescribeClusterParameters -> Constr #

dataTypeOf :: DescribeClusterParameters -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeClusterParameters -> DescribeClusterParameters #

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

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

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

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

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

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

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

Read DescribeClusterParameters # 
Show DescribeClusterParameters # 
Generic DescribeClusterParameters # 
Hashable DescribeClusterParameters # 
NFData DescribeClusterParameters # 
AWSPager DescribeClusterParameters # 
AWSRequest DescribeClusterParameters # 
ToQuery DescribeClusterParameters # 
ToPath DescribeClusterParameters # 
ToHeaders DescribeClusterParameters # 
type Rep DescribeClusterParameters # 
type Rep DescribeClusterParameters = D1 (MetaData "DescribeClusterParameters" "Network.AWS.Redshift.DescribeClusterParameters" "amazonka-redshift-1.4.5-5ygenDSSyjc71mxYPXWxi1" False) (C1 (MetaCons "DescribeClusterParameters'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dcpsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dcpsMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) ((:*:) (S1 (MetaSel (Just Symbol "_dcpsSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dcpsParameterGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs DescribeClusterParameters # 

Request Lenses

dcpsMarker :: Lens' DescribeClusterParameters (Maybe Text) #

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters 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.

dcpsMaxRecords :: Lens' DescribeClusterParameters (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.

dcpsSource :: Lens' DescribeClusterParameters (Maybe Text) #

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group. Default: All parameter types returned. Valid Values: user | engine-default

dcpsParameterGroupName :: Lens' DescribeClusterParameters Text #

The name of a cluster parameter group for which to return details.

Destructuring the Response

describeClusterParametersResponse #

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

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

  • dcprsMarker - 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.
  • dcprsParameters - A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.
  • dcprsResponseStatus - -- | The response status code.

data DescribeClusterParametersResponse #

Contains the output from the DescribeClusterParameters action.

See: describeClusterParametersResponse smart constructor.

Instances

Eq DescribeClusterParametersResponse # 
Data DescribeClusterParametersResponse # 

Methods

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

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

toConstr :: DescribeClusterParametersResponse -> Constr #

dataTypeOf :: DescribeClusterParametersResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeClusterParametersResponse -> DescribeClusterParametersResponse #

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

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

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

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

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

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

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

Read DescribeClusterParametersResponse # 
Show DescribeClusterParametersResponse # 
Generic DescribeClusterParametersResponse # 
NFData DescribeClusterParametersResponse # 
type Rep DescribeClusterParametersResponse # 
type Rep DescribeClusterParametersResponse = D1 (MetaData "DescribeClusterParametersResponse" "Network.AWS.Redshift.DescribeClusterParameters" "amazonka-redshift-1.4.5-5ygenDSSyjc71mxYPXWxi1" False) (C1 (MetaCons "DescribeClusterParametersResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dcprsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dcprsParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Parameter]))) (S1 (MetaSel (Just Symbol "_dcprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dcprsMarker :: Lens' DescribeClusterParametersResponse (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.

dcprsParameters :: Lens' DescribeClusterParametersResponse [Parameter] #

A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.