Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates 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 client certificates that have any combination of those values are returned.
If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.
This operation returns paginated results.
Synopsis
- describeHSMClientCertificates :: DescribeHSMClientCertificates
- data DescribeHSMClientCertificates
- dhccTagValues :: Lens' DescribeHSMClientCertificates [Text]
- dhccTagKeys :: Lens' DescribeHSMClientCertificates [Text]
- dhccHSMClientCertificateIdentifier :: Lens' DescribeHSMClientCertificates (Maybe Text)
- dhccMarker :: Lens' DescribeHSMClientCertificates (Maybe Text)
- dhccMaxRecords :: Lens' DescribeHSMClientCertificates (Maybe Int)
- describeHSMClientCertificatesResponse :: Int -> DescribeHSMClientCertificatesResponse
- data DescribeHSMClientCertificatesResponse
- dhccrsMarker :: Lens' DescribeHSMClientCertificatesResponse (Maybe Text)
- dhccrsHSMClientCertificates :: Lens' DescribeHSMClientCertificatesResponse [HSMClientCertificate]
- dhccrsResponseStatus :: Lens' DescribeHSMClientCertificatesResponse Int
Creating a Request
describeHSMClientCertificates :: DescribeHSMClientCertificates Source #
Creates a value of DescribeHSMClientCertificates
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dhccTagValues
- A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values calledadmin
andtest
. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.dhccTagKeys
- A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys calledowner
andenvironment
. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.dhccHSMClientCertificateIdentifier
- The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.dhccMarker
- An optional parameter that specifies the starting point to return a set of response records. When the results of aDescribeHsmClientCertificates
request exceed the value specified inMaxRecords
, AWS returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.dhccMaxRecords
- The maximum number of response records to return in each call. If the number of remaining response records exceeds the specifiedMaxRecords
value, a value is returned in amarker
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.
data DescribeHSMClientCertificates Source #
See: describeHSMClientCertificates
smart constructor.
Instances
Request Lenses
dhccTagValues :: Lens' DescribeHSMClientCertificates [Text] Source #
A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates 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 client certificates that have either or both of these tag values associated with them.
dhccTagKeys :: Lens' DescribeHSMClientCertificates [Text] Source #
A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates 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 client certificates that have either or both of these tag keys associated with them.
dhccHSMClientCertificateIdentifier :: Lens' DescribeHSMClientCertificates (Maybe Text) Source #
The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.
dhccMarker :: Lens' DescribeHSMClientCertificates (Maybe Text) Source #
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates
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.
dhccMaxRecords :: Lens' DescribeHSMClientCertificates (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
describeHSMClientCertificatesResponse Source #
Creates a value of DescribeHSMClientCertificatesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dhccrsMarker
- 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 theMarker
parameter and retrying the command. If theMarker
field is empty, all response records have been retrieved for the request.dhccrsHSMClientCertificates
- A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.dhccrsResponseStatus
- -- | The response status code.
data DescribeHSMClientCertificatesResponse Source #
See: describeHSMClientCertificatesResponse
smart constructor.
Instances
Response Lenses
dhccrsMarker :: Lens' DescribeHSMClientCertificatesResponse (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.
dhccrsHSMClientCertificates :: Lens' DescribeHSMClientCertificatesResponse [HSMClientCertificate] Source #
A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.
dhccrsResponseStatus :: Lens' DescribeHSMClientCertificatesResponse Int Source #
- - | The response status code.