| 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.DescribeClusterSubnetGroups
Description
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon
Redshift returns all subnet 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
subnet groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
This operation returns paginated results.
Synopsis
- data DescribeClusterSubnetGroups = DescribeClusterSubnetGroups' {}
- newDescribeClusterSubnetGroups :: DescribeClusterSubnetGroups
- describeClusterSubnetGroups_tagValues :: Lens' DescribeClusterSubnetGroups (Maybe [Text])
- describeClusterSubnetGroups_tagKeys :: Lens' DescribeClusterSubnetGroups (Maybe [Text])
- describeClusterSubnetGroups_clusterSubnetGroupName :: Lens' DescribeClusterSubnetGroups (Maybe Text)
- describeClusterSubnetGroups_marker :: Lens' DescribeClusterSubnetGroups (Maybe Text)
- describeClusterSubnetGroups_maxRecords :: Lens' DescribeClusterSubnetGroups (Maybe Int)
- data DescribeClusterSubnetGroupsResponse = DescribeClusterSubnetGroupsResponse' {}
- newDescribeClusterSubnetGroupsResponse :: Int -> DescribeClusterSubnetGroupsResponse
- describeClusterSubnetGroupsResponse_clusterSubnetGroups :: Lens' DescribeClusterSubnetGroupsResponse (Maybe [ClusterSubnetGroup])
- describeClusterSubnetGroupsResponse_marker :: Lens' DescribeClusterSubnetGroupsResponse (Maybe Text)
- describeClusterSubnetGroupsResponse_httpStatus :: Lens' DescribeClusterSubnetGroupsResponse Int
Creating a Request
data DescribeClusterSubnetGroups Source #
See: newDescribeClusterSubnetGroups smart constructor.
Constructors
| DescribeClusterSubnetGroups' | |
Fields
| |
Instances
newDescribeClusterSubnetGroups :: DescribeClusterSubnetGroups Source #
Create a value of DescribeClusterSubnetGroups 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:DescribeClusterSubnetGroups', describeClusterSubnetGroups_tagValues - A tag value or values for which you want to return all matching cluster
subnet groups that are associated with the specified tag value or
values. For example, suppose that you have subnet 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
subnet groups that have either or both of these tag values associated
with them.
$sel:tagKeys:DescribeClusterSubnetGroups', describeClusterSubnetGroups_tagKeys - A tag key or keys for which you want to return all matching cluster
subnet groups that are associated with the specified key or keys. For
example, suppose that you have subnet 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 subnet
groups that have either or both of these tag keys associated with them.
$sel:clusterSubnetGroupName:DescribeClusterSubnetGroups', describeClusterSubnetGroups_clusterSubnetGroupName - The name of the cluster subnet group for which information is requested.
$sel:marker:DescribeClusterSubnetGroups', describeClusterSubnetGroups_marker - An optional parameter that specifies the starting point to return a set
of response records. When the results of a DescribeClusterSubnetGroups
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:DescribeClusterSubnetGroups', describeClusterSubnetGroups_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.
Request Lenses
describeClusterSubnetGroups_tagValues :: Lens' DescribeClusterSubnetGroups (Maybe [Text]) Source #
A tag value or values for which you want to return all matching cluster
subnet groups that are associated with the specified tag value or
values. For example, suppose that you have subnet 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
subnet groups that have either or both of these tag values associated
with them.
describeClusterSubnetGroups_tagKeys :: Lens' DescribeClusterSubnetGroups (Maybe [Text]) Source #
A tag key or keys for which you want to return all matching cluster
subnet groups that are associated with the specified key or keys. For
example, suppose that you have subnet 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 subnet
groups that have either or both of these tag keys associated with them.
describeClusterSubnetGroups_clusterSubnetGroupName :: Lens' DescribeClusterSubnetGroups (Maybe Text) Source #
The name of the cluster subnet group for which information is requested.
describeClusterSubnetGroups_marker :: Lens' DescribeClusterSubnetGroups (Maybe Text) Source #
An optional parameter that specifies the starting point to return a set
of response records. When the results of a DescribeClusterSubnetGroups
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.
describeClusterSubnetGroups_maxRecords :: Lens' DescribeClusterSubnetGroups (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.
Destructuring the Response
data DescribeClusterSubnetGroupsResponse Source #
Contains the output from the DescribeClusterSubnetGroups action.
See: newDescribeClusterSubnetGroupsResponse smart constructor.
Constructors
| DescribeClusterSubnetGroupsResponse' | |
Fields
| |
Instances
newDescribeClusterSubnetGroupsResponse Source #
Arguments
| :: Int | |
| -> DescribeClusterSubnetGroupsResponse |
Create a value of DescribeClusterSubnetGroupsResponse 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:clusterSubnetGroups:DescribeClusterSubnetGroupsResponse', describeClusterSubnetGroupsResponse_clusterSubnetGroups - A list of ClusterSubnetGroup instances.
$sel:marker:DescribeClusterSubnetGroups', describeClusterSubnetGroupsResponse_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:httpStatus:DescribeClusterSubnetGroupsResponse', describeClusterSubnetGroupsResponse_httpStatus - The response's http status code.
Response Lenses
describeClusterSubnetGroupsResponse_clusterSubnetGroups :: Lens' DescribeClusterSubnetGroupsResponse (Maybe [ClusterSubnetGroup]) Source #
A list of ClusterSubnetGroup instances.
describeClusterSubnetGroupsResponse_marker :: Lens' DescribeClusterSubnetGroupsResponse (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.
describeClusterSubnetGroupsResponse_httpStatus :: Lens' DescribeClusterSubnetGroupsResponse Int Source #
The response's http status code.