amazonka-cloudhsm-1.6.0: Amazon CloudHSM SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudHSM

Contents

Description

AWS CloudHSM Service

This is documentation for AWS CloudHSM Classic . For more information, see AWS CloudHSM Classic FAQs , the AWS CloudHSM Classic User Guide , and the AWS CloudHSM Classic API Reference .

For information about the current version of AWS CloudHSM , see AWS CloudHSM , the AWS CloudHSM User Guide , and the AWS CloudHSM API Reference .

Synopsis

Service Configuration

cloudHSM :: Service #

API version 2014-05-30 of the Amazon CloudHSM SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by CloudHSM.

InvalidRequestException

_InvalidRequestException :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates that one or more of the request parameters are not valid.

CloudHSMServiceException

_CloudHSMServiceException :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates that an exception occurred in the AWS CloudHSM service.

CloudHSMInternalException

_CloudHSMInternalException :: AsError a => Getting (First ServiceError) a ServiceError #

Indicates that an internal error occurred.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

DeleteHAPG

ListHAPGs

ModifyLunaClient

ListHSMs

DescribeLunaClient

ListTagsForResource

CreateHAPG

CreateHSM

RemoveTagsFromResource

DescribeHAPG

CreateLunaClient

ListLunaClients

AddTagsToResource

GetConfig

DeleteHSM

DescribeHSM

ModifyHAPG

DeleteLunaClient

ModifyHSM

ListAvailableZones

Types

ClientVersion

data ClientVersion #

Constructors

VD5_1 
VD5_3 
Instances
Bounded ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Enum ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Eq ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Data ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Methods

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

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

toConstr :: ClientVersion -> Constr #

dataTypeOf :: ClientVersion -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ClientVersion) #

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

gmapT :: (forall b. Data b => b -> b) -> ClientVersion -> ClientVersion #

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

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

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

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

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

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

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

Ord ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Read ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Show ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Generic ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Associated Types

type Rep ClientVersion :: * -> * #

Hashable ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToJSON ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToHeader ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToQuery ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToByteString ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

FromText ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToText ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Methods

toText :: ClientVersion -> Text #

NFData ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Methods

rnf :: ClientVersion -> () #

type Rep ClientVersion # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

type Rep ClientVersion = D1 (MetaData "ClientVersion" "Network.AWS.CloudHSM.Types.Sum" "amazonka-cloudhsm-1.6.0-8mtI1KULp3eAyp2v4HWjSZ" False) (C1 (MetaCons "VD5_1" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "VD5_3" PrefixI False) (U1 :: * -> *))

CloudHSMObjectState

data CloudHSMObjectState #

Constructors

Degraded 
Ready 
Updating 
Instances
Bounded CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Enum CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Eq CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Data CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Methods

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

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

toConstr :: CloudHSMObjectState -> Constr #

dataTypeOf :: CloudHSMObjectState -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CloudHSMObjectState) #

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

gmapT :: (forall b. Data b => b -> b) -> CloudHSMObjectState -> CloudHSMObjectState #

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

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

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

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

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

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

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

Ord CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Read CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Show CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Generic CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Associated Types

type Rep CloudHSMObjectState :: * -> * #

Hashable CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

FromJSON CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToHeader CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToQuery CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToByteString CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

FromText CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToText CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

NFData CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Methods

rnf :: CloudHSMObjectState -> () #

type Rep CloudHSMObjectState # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

type Rep CloudHSMObjectState = D1 (MetaData "CloudHSMObjectState" "Network.AWS.CloudHSM.Types.Sum" "amazonka-cloudhsm-1.6.0-8mtI1KULp3eAyp2v4HWjSZ" False) (C1 (MetaCons "Degraded" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "Ready" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Updating" PrefixI False) (U1 :: * -> *)))

HSMStatus

data HSMStatus #

Instances
Bounded HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Enum HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Eq HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Data HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Methods

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

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

toConstr :: HSMStatus -> Constr #

dataTypeOf :: HSMStatus -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c HSMStatus) #

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

gmapT :: (forall b. Data b => b -> b) -> HSMStatus -> HSMStatus #

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

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

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

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

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

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

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

Ord HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Read HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Show HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Generic HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Associated Types

type Rep HSMStatus :: * -> * #

Hashable HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

FromJSON HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToHeader HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToQuery HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToByteString HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Methods

toBS :: HSMStatus -> ByteString #

FromText HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToText HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Methods

toText :: HSMStatus -> Text #

NFData HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Methods

rnf :: HSMStatus -> () #

type Rep HSMStatus # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

type Rep HSMStatus = D1 (MetaData "HSMStatus" "Network.AWS.CloudHSM.Types.Sum" "amazonka-cloudhsm-1.6.0-8mtI1KULp3eAyp2v4HWjSZ" False) ((C1 (MetaCons "HSDegraded" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "HSPending" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "HSRunning" PrefixI False) (U1 :: * -> *))) :+: ((C1 (MetaCons "HSSuspended" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "HSTerminated" PrefixI False) (U1 :: * -> *)) :+: (C1 (MetaCons "HSTerminating" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "HSUpdating" PrefixI False) (U1 :: * -> *))))

SubscriptionType

data SubscriptionType #

Specifies the type of subscription for the HSM.

  • PRODUCTION - The HSM is being used in a production environment.
  • TRIAL - The HSM is being used in a product trial.

Constructors

Production 
Instances
Bounded SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Enum SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Eq SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Data SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Methods

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

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

toConstr :: SubscriptionType -> Constr #

dataTypeOf :: SubscriptionType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SubscriptionType) #

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

gmapT :: (forall b. Data b => b -> b) -> SubscriptionType -> SubscriptionType #

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

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

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

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

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

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

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

Ord SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Read SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Show SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Generic SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Associated Types

type Rep SubscriptionType :: * -> * #

Hashable SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToJSON SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

FromJSON SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToHeader SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToQuery SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToByteString SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

FromText SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

ToText SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

NFData SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

Methods

rnf :: SubscriptionType -> () #

type Rep SubscriptionType # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Sum

type Rep SubscriptionType = D1 (MetaData "SubscriptionType" "Network.AWS.CloudHSM.Types.Sum" "amazonka-cloudhsm-1.6.0-8mtI1KULp3eAyp2v4HWjSZ" False) (C1 (MetaCons "Production" PrefixI False) (U1 :: * -> *))

Tag

data Tag #

A key-value pair that identifies or specifies metadata about an AWS CloudHSM resource.

See: tag smart constructor.

Instances
Eq Tag # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Product

Methods

(==) :: Tag -> Tag -> Bool #

(/=) :: Tag -> Tag -> Bool #

Data Tag # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Product

Methods

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

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

toConstr :: Tag -> Constr #

dataTypeOf :: Tag -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Tag) #

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

gmapT :: (forall b. Data b => b -> b) -> Tag -> Tag #

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

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

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

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

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

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

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

Read Tag # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Product

Show Tag # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Product

Methods

showsPrec :: Int -> Tag -> ShowS #

show :: Tag -> String #

showList :: [Tag] -> ShowS #

Generic Tag # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Product

Associated Types

type Rep Tag :: * -> * #

Methods

from :: Tag -> Rep Tag x #

to :: Rep Tag x -> Tag #

Hashable Tag # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Product

Methods

hashWithSalt :: Int -> Tag -> Int #

hash :: Tag -> Int #

ToJSON Tag # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Product

FromJSON Tag # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Product

NFData Tag # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Product

Methods

rnf :: Tag -> () #

type Rep Tag # 
Instance details

Defined in Network.AWS.CloudHSM.Types.Product

type Rep Tag = D1 (MetaData "Tag" "Network.AWS.CloudHSM.Types.Product" "amazonka-cloudhsm-1.6.0-8mtI1KULp3eAyp2v4HWjSZ" False) (C1 (MetaCons "Tag'" PrefixI True) (S1 (MetaSel (Just "_tagKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_tagValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

tag #

Arguments

:: Text

tagKey

-> Text

tagValue

-> Tag 

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tagKey :: Lens' Tag Text #

The key of the tag.

tagValue :: Lens' Tag Text #

The value of the tag.