Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon
Redshift returns all HSM connections 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
HSM connections that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.
See: AWS API Reference for DescribeHSMConfigurations.
This operation returns paginated results.
- describeHSMConfigurations :: DescribeHSMConfigurations
- data DescribeHSMConfigurations
- dhsmcTagValues :: Lens' DescribeHSMConfigurations [Text]
- dhsmcHSMConfigurationIdentifier :: Lens' DescribeHSMConfigurations (Maybe Text)
- dhsmcTagKeys :: Lens' DescribeHSMConfigurations [Text]
- dhsmcMarker :: Lens' DescribeHSMConfigurations (Maybe Text)
- dhsmcMaxRecords :: Lens' DescribeHSMConfigurations (Maybe Int)
- describeHSMConfigurationsResponse :: Int -> DescribeHSMConfigurationsResponse
- data DescribeHSMConfigurationsResponse
- dhcrsMarker :: Lens' DescribeHSMConfigurationsResponse (Maybe Text)
- dhcrsHSMConfigurations :: Lens' DescribeHSMConfigurationsResponse [HSMConfiguration]
- dhcrsResponseStatus :: Lens' DescribeHSMConfigurationsResponse Int
Creating a Request
describeHSMConfigurations :: DescribeHSMConfigurations Source
Creates a value of DescribeHSMConfigurations
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeHSMConfigurations Source
See: describeHSMConfigurations
smart constructor.
Request Lenses
dhsmcTagValues :: Lens' DescribeHSMConfigurations [Text] Source
A tag value or values for which you want to return all matching HSM
configurations that are associated with the specified tag value or
values. For example, suppose that you have HSM configurations 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 HSM configurations that have either or both of these tag values
associated with them.
dhsmcHSMConfigurationIdentifier :: Lens' DescribeHSMConfigurations (Maybe Text) Source
The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.
dhsmcTagKeys :: Lens' DescribeHSMConfigurations [Text] Source
A tag key or keys for which you want to return all matching HSM
configurations that are associated with the specified key or keys. For
example, suppose that you have HSM configurations 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 HSM
configurations that have either or both of these tag keys associated
with them.
dhsmcMarker :: Lens' DescribeHSMConfigurations (Maybe Text) Source
An optional parameter that specifies the starting point to return a set
of response records. When the results of a DescribeHsmConfigurations
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.
dhsmcMaxRecords :: Lens' DescribeHSMConfigurations (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
describeHSMConfigurationsResponse Source
Creates a value of DescribeHSMConfigurationsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeHSMConfigurationsResponse Source
See: describeHSMConfigurationsResponse
smart constructor.
Response Lenses
dhcrsMarker :: Lens' DescribeHSMConfigurationsResponse (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.
dhcrsHSMConfigurations :: Lens' DescribeHSMConfigurationsResponse [HSMConfiguration] Source
A list of Amazon Redshift HSM configurations.
dhcrsResponseStatus :: Lens' DescribeHSMConfigurationsResponse Int Source
The response status code.