| 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.DescribeHsmConfigurations
Description
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 Amazon Web Services 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.
This operation returns paginated results.
Synopsis
- data DescribeHsmConfigurations = DescribeHsmConfigurations' {}
- newDescribeHsmConfigurations :: DescribeHsmConfigurations
- describeHsmConfigurations_tagValues :: Lens' DescribeHsmConfigurations (Maybe [Text])
- describeHsmConfigurations_hsmConfigurationIdentifier :: Lens' DescribeHsmConfigurations (Maybe Text)
- describeHsmConfigurations_tagKeys :: Lens' DescribeHsmConfigurations (Maybe [Text])
- describeHsmConfigurations_marker :: Lens' DescribeHsmConfigurations (Maybe Text)
- describeHsmConfigurations_maxRecords :: Lens' DescribeHsmConfigurations (Maybe Int)
- data DescribeHsmConfigurationsResponse = DescribeHsmConfigurationsResponse' {}
- newDescribeHsmConfigurationsResponse :: Int -> DescribeHsmConfigurationsResponse
- describeHsmConfigurationsResponse_marker :: Lens' DescribeHsmConfigurationsResponse (Maybe Text)
- describeHsmConfigurationsResponse_hsmConfigurations :: Lens' DescribeHsmConfigurationsResponse (Maybe [HsmConfiguration])
- describeHsmConfigurationsResponse_httpStatus :: Lens' DescribeHsmConfigurationsResponse Int
Creating a Request
data DescribeHsmConfigurations Source #
See: newDescribeHsmConfigurations smart constructor.
Constructors
| DescribeHsmConfigurations' | |
Fields
| |
Instances
newDescribeHsmConfigurations :: DescribeHsmConfigurations Source #
Create a value of DescribeHsmConfigurations 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:DescribeHsmConfigurations', describeHsmConfigurations_tagValues - 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.
$sel:hsmConfigurationIdentifier:DescribeHsmConfigurations', describeHsmConfigurations_hsmConfigurationIdentifier - 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 Amazon Web Services account.
$sel:tagKeys:DescribeHsmConfigurations', describeHsmConfigurations_tagKeys - 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.
$sel:marker:DescribeHsmConfigurations', describeHsmConfigurations_marker - 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, 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:DescribeHsmConfigurations', describeHsmConfigurations_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
describeHsmConfigurations_tagValues :: Lens' DescribeHsmConfigurations (Maybe [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.
describeHsmConfigurations_hsmConfigurationIdentifier :: 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 Amazon Web Services account.
describeHsmConfigurations_tagKeys :: Lens' DescribeHsmConfigurations (Maybe [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.
describeHsmConfigurations_marker :: 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, 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.
describeHsmConfigurations_maxRecords :: 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
data DescribeHsmConfigurationsResponse Source #
See: newDescribeHsmConfigurationsResponse smart constructor.
Constructors
| DescribeHsmConfigurationsResponse' | |
Fields
| |
Instances
newDescribeHsmConfigurationsResponse Source #
Arguments
| :: Int | |
| -> DescribeHsmConfigurationsResponse |
Create a value of DescribeHsmConfigurationsResponse 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:DescribeHsmConfigurations', describeHsmConfigurationsResponse_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:hsmConfigurations:DescribeHsmConfigurationsResponse', describeHsmConfigurationsResponse_hsmConfigurations - A list of HsmConfiguration objects.
$sel:httpStatus:DescribeHsmConfigurationsResponse', describeHsmConfigurationsResponse_httpStatus - The response's http status code.
Response Lenses
describeHsmConfigurationsResponse_marker :: 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.
describeHsmConfigurationsResponse_hsmConfigurations :: Lens' DescribeHsmConfigurationsResponse (Maybe [HsmConfiguration]) Source #
A list of HsmConfiguration objects.
describeHsmConfigurationsResponse_httpStatus :: Lens' DescribeHsmConfigurationsResponse Int Source #
The response's http status code.