| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Redshift.DescribeClusterParameterGroups
Description
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.
Synopsis
- data DescribeClusterParameterGroups = DescribeClusterParameterGroups' {}
- newDescribeClusterParameterGroups :: DescribeClusterParameterGroups
- describeClusterParameterGroups_tagValues :: Lens' DescribeClusterParameterGroups (Maybe [Text])
- describeClusterParameterGroups_tagKeys :: Lens' DescribeClusterParameterGroups (Maybe [Text])
- describeClusterParameterGroups_marker :: Lens' DescribeClusterParameterGroups (Maybe Text)
- describeClusterParameterGroups_maxRecords :: Lens' DescribeClusterParameterGroups (Maybe Int)
- describeClusterParameterGroups_parameterGroupName :: Lens' DescribeClusterParameterGroups (Maybe Text)
- data DescribeClusterParameterGroupsResponse = DescribeClusterParameterGroupsResponse' {}
- newDescribeClusterParameterGroupsResponse :: Int -> DescribeClusterParameterGroupsResponse
- describeClusterParameterGroupsResponse_marker :: Lens' DescribeClusterParameterGroupsResponse (Maybe Text)
- describeClusterParameterGroupsResponse_parameterGroups :: Lens' DescribeClusterParameterGroupsResponse (Maybe [ClusterParameterGroup])
- describeClusterParameterGroupsResponse_httpStatus :: Lens' DescribeClusterParameterGroupsResponse Int
Creating a Request
data DescribeClusterParameterGroups Source #
See: newDescribeClusterParameterGroups smart constructor.
Constructors
| DescribeClusterParameterGroups' | |
Fields
| |
Instances
newDescribeClusterParameterGroups :: DescribeClusterParameterGroups Source #
Create a value of DescribeClusterParameterGroups 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:tagValues:DescribeClusterParameterGroups', describeClusterParameterGroups_tagValues - 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.
$sel:tagKeys:DescribeClusterParameterGroups', describeClusterParameterGroups_tagKeys - 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.
$sel:marker:DescribeClusterParameterGroups', describeClusterParameterGroups_marker - 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, Amazon Web Services 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.
$sel:maxRecords:DescribeClusterParameterGroups', describeClusterParameterGroups_maxRecords - 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.
$sel:parameterGroupName:DescribeClusterParameterGroups', describeClusterParameterGroups_parameterGroupName - 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.
Request Lenses
describeClusterParameterGroups_tagValues :: Lens' DescribeClusterParameterGroups (Maybe [Text]) Source #
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.
describeClusterParameterGroups_tagKeys :: Lens' DescribeClusterParameterGroups (Maybe [Text]) Source #
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.
describeClusterParameterGroups_marker :: Lens' DescribeClusterParameterGroups (Maybe Text) Source #
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, Amazon Web Services 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.
describeClusterParameterGroups_maxRecords :: Lens' DescribeClusterParameterGroups (Maybe Int) Source #
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.
describeClusterParameterGroups_parameterGroupName :: Lens' DescribeClusterParameterGroups (Maybe Text) Source #
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
data DescribeClusterParameterGroupsResponse Source #
Contains the output from the DescribeClusterParameterGroups action.
See: newDescribeClusterParameterGroupsResponse smart constructor.
Constructors
| DescribeClusterParameterGroupsResponse' | |
Fields
| |
Instances
newDescribeClusterParameterGroupsResponse Source #
Arguments
| :: Int | |
| -> DescribeClusterParameterGroupsResponse |
Create a value of DescribeClusterParameterGroupsResponse 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:marker:DescribeClusterParameterGroups', describeClusterParameterGroupsResponse_marker - 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.
$sel:parameterGroups:DescribeClusterParameterGroupsResponse', describeClusterParameterGroupsResponse_parameterGroups - A list of ClusterParameterGroup instances. Each instance describes one
cluster parameter group.
$sel:httpStatus:DescribeClusterParameterGroupsResponse', describeClusterParameterGroupsResponse_httpStatus - The response's http status code.
Response Lenses
describeClusterParameterGroupsResponse_marker :: Lens' DescribeClusterParameterGroupsResponse (Maybe Text) Source #
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.
describeClusterParameterGroupsResponse_parameterGroups :: Lens' DescribeClusterParameterGroupsResponse (Maybe [ClusterParameterGroup]) Source #
A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.
describeClusterParameterGroupsResponse_httpStatus :: Lens' DescribeClusterParameterGroupsResponse Int Source #
The response's http status code.