Network.AWS.Redshift.DescribeHSMConfigurations

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.

This operation returns paginated results.

Creating a Request

describeHSMConfigurations :: DescribeHSMConfigurations

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:

• dhsmcTagValues - 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 - 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 - 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 - 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 - 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.

data DescribeHSMConfigurations

See: describeHSMConfigurations smart constructor.

Instances

Eq DescribeHSMConfigurations

Methods

(==) :: DescribeHSMConfigurations -> DescribeHSMConfigurations -> Bool

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

Data DescribeHSMConfigurations

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeHSMConfigurations -> c DescribeHSMConfigurations

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeHSMConfigurations

toConstr :: DescribeHSMConfigurations -> Constr

dataTypeOf :: DescribeHSMConfigurations -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeHSMConfigurations)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeHSMConfigurations)

gmapT :: (forall b. Data b => b -> b) -> DescribeHSMConfigurations -> DescribeHSMConfigurations

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeHSMConfigurations -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeHSMConfigurations -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeHSMConfigurations -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeHSMConfigurations -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeHSMConfigurations -> m DescribeHSMConfigurations

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeHSMConfigurations -> m DescribeHSMConfigurations

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeHSMConfigurations -> m DescribeHSMConfigurations

Read DescribeHSMConfigurations

Methods

readsPrec :: Int -> ReadS DescribeHSMConfigurations

readList :: ReadS [DescribeHSMConfigurations]

readPrec :: ReadPrec DescribeHSMConfigurations

readListPrec :: ReadPrec [DescribeHSMConfigurations]

Show DescribeHSMConfigurations

Methods

showsPrec :: Int -> DescribeHSMConfigurations -> ShowS

show :: DescribeHSMConfigurations -> String

showList :: [DescribeHSMConfigurations] -> ShowS

Generic DescribeHSMConfigurations

Associated Types

type Rep DescribeHSMConfigurations :: * -> *

Methods

from :: DescribeHSMConfigurations -> Rep DescribeHSMConfigurations x

to :: Rep DescribeHSMConfigurations x -> DescribeHSMConfigurations

Hashable DescribeHSMConfigurations

Methods

hashWithSalt :: Int -> DescribeHSMConfigurations -> Int

hash :: DescribeHSMConfigurations -> Int

NFData DescribeHSMConfigurations

Methods

rnf :: DescribeHSMConfigurations -> ()

AWSPager DescribeHSMConfigurations

Methods

page :: DescribeHSMConfigurations -> Rs DescribeHSMConfigurations -> Maybe DescribeHSMConfigurations

AWSRequest DescribeHSMConfigurations

Associated Types

type Rs DescribeHSMConfigurations :: *

Methods

request :: DescribeHSMConfigurations -> Request DescribeHSMConfigurations

response :: MonadResource m => Logger -> Service -> Proxy * DescribeHSMConfigurations -> ClientResponse -> m (Response DescribeHSMConfigurations)

ToPath DescribeHSMConfigurations

Methods

toPath :: DescribeHSMConfigurations -> ByteString

ToHeaders DescribeHSMConfigurations

Methods

toHeaders :: DescribeHSMConfigurations -> [Header]

ToQuery DescribeHSMConfigurations

Methods

toQuery :: DescribeHSMConfigurations -> QueryString

type Rep DescribeHSMConfigurations

type Rep DescribeHSMConfigurations = D1 (MetaData "DescribeHSMConfigurations" "Network.AWS.Redshift.DescribeHSMConfigurations" "amazonka-redshift-1.4.5-2iQeXmFrftS29tYZtVOT2g" False) (C1 (MetaCons "DescribeHSMConfigurations'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dhsmcTagValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_dhsmcHSMConfigurationIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dhsmcTagKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_dhsmcMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dhsmcMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))))))

type Rs DescribeHSMConfigurations

type Rs DescribeHSMConfigurations = DescribeHSMConfigurationsResponse

Request Lenses

dhsmcTagValues :: Lens' DescribeHSMConfigurations [Text]

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)

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]

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)

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)

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

Arguments

:: Int

dhcrsResponseStatus

-> DescribeHSMConfigurationsResponse

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:

• dhcrsMarker - 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 - A list of HsmConfiguration objects.
• dhcrsResponseStatus - -- | The response status code.

data DescribeHSMConfigurationsResponse

See: describeHSMConfigurationsResponse smart constructor.

Instances

Eq DescribeHSMConfigurationsResponse

Methods

(==) :: DescribeHSMConfigurationsResponse -> DescribeHSMConfigurationsResponse -> Bool

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

Data DescribeHSMConfigurationsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeHSMConfigurationsResponse -> c DescribeHSMConfigurationsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeHSMConfigurationsResponse

toConstr :: DescribeHSMConfigurationsResponse -> Constr

dataTypeOf :: DescribeHSMConfigurationsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeHSMConfigurationsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeHSMConfigurationsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeHSMConfigurationsResponse -> DescribeHSMConfigurationsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeHSMConfigurationsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeHSMConfigurationsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeHSMConfigurationsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeHSMConfigurationsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeHSMConfigurationsResponse -> m DescribeHSMConfigurationsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeHSMConfigurationsResponse -> m DescribeHSMConfigurationsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeHSMConfigurationsResponse -> m DescribeHSMConfigurationsResponse

Read DescribeHSMConfigurationsResponse

Methods

readsPrec :: Int -> ReadS DescribeHSMConfigurationsResponse

readList :: ReadS [DescribeHSMConfigurationsResponse]

readPrec :: ReadPrec DescribeHSMConfigurationsResponse

readListPrec :: ReadPrec [DescribeHSMConfigurationsResponse]

Show DescribeHSMConfigurationsResponse

Methods

showsPrec :: Int -> DescribeHSMConfigurationsResponse -> ShowS

show :: DescribeHSMConfigurationsResponse -> String

showList :: [DescribeHSMConfigurationsResponse] -> ShowS

Generic DescribeHSMConfigurationsResponse

Associated Types

type Rep DescribeHSMConfigurationsResponse :: * -> *

Methods

from :: DescribeHSMConfigurationsResponse -> Rep DescribeHSMConfigurationsResponse x

to :: Rep DescribeHSMConfigurationsResponse x -> DescribeHSMConfigurationsResponse

NFData DescribeHSMConfigurationsResponse

Methods

rnf :: DescribeHSMConfigurationsResponse -> ()

type Rep DescribeHSMConfigurationsResponse

type Rep DescribeHSMConfigurationsResponse = D1 (MetaData "DescribeHSMConfigurationsResponse" "Network.AWS.Redshift.DescribeHSMConfigurations" "amazonka-redshift-1.4.5-2iQeXmFrftS29tYZtVOT2g" False) (C1 (MetaCons "DescribeHSMConfigurationsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dhcrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dhcrsHSMConfigurations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [HSMConfiguration]))) (S1 (MetaSel (Just Symbol "_dhcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dhcrsMarker :: Lens' DescribeHSMConfigurationsResponse (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.

dhcrsHSMConfigurations :: Lens' DescribeHSMConfigurationsResponse [HSMConfiguration]

A list of HsmConfiguration objects.

dhcrsResponseStatus :: Lens' DescribeHSMConfigurationsResponse Int

• - | The response status code.