Amazonka.Redshift.DescribeHsmClientCertificates

Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates 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 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.

Creating a Request

data DescribeHsmClientCertificates

See: newDescribeHsmClientCertificates smart constructor.

Constructors

DescribeHsmClientCertificates'

Fields

• hsmClientCertificateIdentifier :: Maybe Text

  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 Amazon Web Services account.

• marker :: Maybe Text

  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, 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.

• maxRecords :: Maybe Int

  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.

• tagKeys :: Maybe [Text]

  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.

• tagValues :: Maybe [Text]

  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.

Instances

ToHeaders DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

toHeaders :: DescribeHsmClientCertificates -> [Header]

ToPath DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

toPath :: DescribeHsmClientCertificates -> ByteString

ToQuery DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

toQuery :: DescribeHsmClientCertificates -> QueryString

AWSPager DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

page :: DescribeHsmClientCertificates -> AWSResponse DescribeHsmClientCertificates -> Maybe DescribeHsmClientCertificates

AWSRequest DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Associated Types

type AWSResponse DescribeHsmClientCertificates

Methods

request :: (Service -> Service) -> DescribeHsmClientCertificates -> Request DescribeHsmClientCertificates

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeHsmClientCertificates -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeHsmClientCertificates)))

Generic DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Associated Types

type Rep DescribeHsmClientCertificates :: Type -> Type

Methods

from :: DescribeHsmClientCertificates -> Rep DescribeHsmClientCertificates x

to :: Rep DescribeHsmClientCertificates x -> DescribeHsmClientCertificates

Read DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

readsPrec :: Int -> ReadS DescribeHsmClientCertificates

readList :: ReadS [DescribeHsmClientCertificates]

readPrec :: ReadPrec DescribeHsmClientCertificates

readListPrec :: ReadPrec [DescribeHsmClientCertificates]

Show DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

showsPrec :: Int -> DescribeHsmClientCertificates -> ShowS

show :: DescribeHsmClientCertificates -> String

showList :: [DescribeHsmClientCertificates] -> ShowS

NFData DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

rnf :: DescribeHsmClientCertificates -> ()

Eq DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

(==) :: DescribeHsmClientCertificates -> DescribeHsmClientCertificates -> Bool

(/=) :: DescribeHsmClientCertificates -> DescribeHsmClientCertificates -> Bool

Hashable DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

hashWithSalt :: Int -> DescribeHsmClientCertificates -> Int

hash :: DescribeHsmClientCertificates -> Int

type AWSResponse DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

type AWSResponse DescribeHsmClientCertificates = DescribeHsmClientCertificatesResponse

type Rep DescribeHsmClientCertificates

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

type Rep DescribeHsmClientCertificates = D1 ('MetaData "DescribeHsmClientCertificates" "Amazonka.Redshift.DescribeHsmClientCertificates" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeHsmClientCertificates'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hsmClientCertificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "tagValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeHsmClientCertificates :: DescribeHsmClientCertificates

Create a value of DescribeHsmClientCertificates 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:

DescribeHsmClientCertificates, describeHsmClientCertificates_hsmClientCertificateIdentifier - 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 Amazon Web Services account.

DescribeHsmClientCertificates, describeHsmClientCertificates_marker - 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, 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:DescribeHsmClientCertificates', describeHsmClientCertificates_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:tagKeys:DescribeHsmClientCertificates', describeHsmClientCertificates_tagKeys - 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.

$sel:tagValues:DescribeHsmClientCertificates', describeHsmClientCertificates_tagValues - 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.

Request Lenses

describeHsmClientCertificates_hsmClientCertificateIdentifier :: Lens' DescribeHsmClientCertificates (Maybe Text)

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 Amazon Web Services account.

describeHsmClientCertificates_marker :: Lens' DescribeHsmClientCertificates (Maybe Text)

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, 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.

describeHsmClientCertificates_maxRecords :: Lens' DescribeHsmClientCertificates (Maybe Int)

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.

describeHsmClientCertificates_tagKeys :: Lens' DescribeHsmClientCertificates (Maybe [Text])

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.

describeHsmClientCertificates_tagValues :: Lens' DescribeHsmClientCertificates (Maybe [Text])

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.

Destructuring the Response

data DescribeHsmClientCertificatesResponse

See: newDescribeHsmClientCertificatesResponse smart constructor.

Constructors

DescribeHsmClientCertificatesResponse'

Fields

• hsmClientCertificates :: Maybe [HsmClientCertificate]

  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.

• marker :: Maybe Text

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeHsmClientCertificatesResponse

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Associated Types

type Rep DescribeHsmClientCertificatesResponse :: Type -> Type

Methods

from :: DescribeHsmClientCertificatesResponse -> Rep DescribeHsmClientCertificatesResponse x

to :: Rep DescribeHsmClientCertificatesResponse x -> DescribeHsmClientCertificatesResponse

Read DescribeHsmClientCertificatesResponse

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

readsPrec :: Int -> ReadS DescribeHsmClientCertificatesResponse

readList :: ReadS [DescribeHsmClientCertificatesResponse]

readPrec :: ReadPrec DescribeHsmClientCertificatesResponse

readListPrec :: ReadPrec [DescribeHsmClientCertificatesResponse]

Show DescribeHsmClientCertificatesResponse

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

showsPrec :: Int -> DescribeHsmClientCertificatesResponse -> ShowS

show :: DescribeHsmClientCertificatesResponse -> String

showList :: [DescribeHsmClientCertificatesResponse] -> ShowS

NFData DescribeHsmClientCertificatesResponse

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

rnf :: DescribeHsmClientCertificatesResponse -> ()

Eq DescribeHsmClientCertificatesResponse

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

Methods

(==) :: DescribeHsmClientCertificatesResponse -> DescribeHsmClientCertificatesResponse -> Bool

(/=) :: DescribeHsmClientCertificatesResponse -> DescribeHsmClientCertificatesResponse -> Bool

type Rep DescribeHsmClientCertificatesResponse

Defined in Amazonka.Redshift.DescribeHsmClientCertificates

type Rep DescribeHsmClientCertificatesResponse = D1 ('MetaData "DescribeHsmClientCertificatesResponse" "Amazonka.Redshift.DescribeHsmClientCertificates" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeHsmClientCertificatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hsmClientCertificates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HsmClientCertificate])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeHsmClientCertificatesResponse

Arguments

:: Int

$sel:httpStatus:DescribeHsmClientCertificatesResponse'

-> DescribeHsmClientCertificatesResponse

Create a value of DescribeHsmClientCertificatesResponse 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:hsmClientCertificates:DescribeHsmClientCertificatesResponse', describeHsmClientCertificatesResponse_hsmClientCertificates - 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.

DescribeHsmClientCertificates, describeHsmClientCertificatesResponse_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:DescribeHsmClientCertificatesResponse', describeHsmClientCertificatesResponse_httpStatus - The response's http status code.

Response Lenses

describeHsmClientCertificatesResponse_hsmClientCertificates :: Lens' DescribeHsmClientCertificatesResponse (Maybe [HsmClientCertificate])

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.

describeHsmClientCertificatesResponse_marker :: Lens' DescribeHsmClientCertificatesResponse (Maybe Text)

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.

describeHsmClientCertificatesResponse_httpStatus :: Lens' DescribeHsmClientCertificatesResponse Int

The response's http status code.