Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudHSM.DescribeHapg

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Retrieves information about a high-availability partition group.

Synopsis

data DescribeHapg = DescribeHapg' {
- hapgArn :: Text
}
newDescribeHapg :: Text -> DescribeHapg
describeHapg_hapgArn :: Lens' DescribeHapg Text
data DescribeHapgResponse = DescribeHapgResponse' {
- hapgArn :: Maybe Text
- hapgSerial :: Maybe Text
- hsmsLastActionFailed :: Maybe [Text]
- hsmsPendingDeletion :: Maybe [Text]
- hsmsPendingRegistration :: Maybe [Text]
- label :: Maybe Text
- lastModifiedTimestamp :: Maybe Text
- partitionSerialList :: Maybe [Text]
- state :: Maybe CloudHsmObjectState
- httpStatus :: Int
}
newDescribeHapgResponse :: Int -> DescribeHapgResponse
describeHapgResponse_hapgArn :: Lens' DescribeHapgResponse (Maybe Text)
describeHapgResponse_hapgSerial :: Lens' DescribeHapgResponse (Maybe Text)
describeHapgResponse_hsmsLastActionFailed :: Lens' DescribeHapgResponse (Maybe [Text])
describeHapgResponse_hsmsPendingDeletion :: Lens' DescribeHapgResponse (Maybe [Text])
describeHapgResponse_hsmsPendingRegistration :: Lens' DescribeHapgResponse (Maybe [Text])
describeHapgResponse_label :: Lens' DescribeHapgResponse (Maybe Text)
describeHapgResponse_lastModifiedTimestamp :: Lens' DescribeHapgResponse (Maybe Text)
describeHapgResponse_partitionSerialList :: Lens' DescribeHapgResponse (Maybe [Text])
describeHapgResponse_state :: Lens' DescribeHapgResponse (Maybe CloudHsmObjectState)
describeHapgResponse_httpStatus :: Lens' DescribeHapgResponse Int

Creating a Request

data DescribeHapg Source #

Contains the inputs for the DescribeHapg action.

See: newDescribeHapg smart constructor.

Constructors

DescribeHapg'
Fields hapgArn :: Text The ARN of the high-availability partition group to describe.

Instances

Instances details

ToJSON DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods toJSON :: DescribeHapg -> Value # toEncoding :: DescribeHapg -> Encoding # toJSONList :: [DescribeHapg] -> Value # toEncodingList :: [DescribeHapg] -> Encoding #
ToHeaders DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods toHeaders :: DescribeHapg -> [Header] #
ToPath DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods toPath :: DescribeHapg -> ByteString #
ToQuery DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods toQuery :: DescribeHapg -> QueryString #
AWSRequest DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Associated Types type AWSResponse DescribeHapg # Methods request :: (Service -> Service) -> DescribeHapg -> Request DescribeHapg # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeHapg -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeHapg))) #
Generic DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Associated Types type Rep DescribeHapg :: Type -> Type # Methods from :: DescribeHapg -> Rep DescribeHapg x # to :: Rep DescribeHapg x -> DescribeHapg #
Read DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods readsPrec :: Int -> ReadS DescribeHapg # readList :: ReadS [DescribeHapg] # readPrec :: ReadPrec DescribeHapg # readListPrec :: ReadPrec [DescribeHapg] #
Show DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods showsPrec :: Int -> DescribeHapg -> ShowS # show :: DescribeHapg -> String # showList :: [DescribeHapg] -> ShowS #
NFData DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods rnf :: DescribeHapg -> () #
Eq DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods (==) :: DescribeHapg -> DescribeHapg -> Bool # (/=) :: DescribeHapg -> DescribeHapg -> Bool #
Hashable DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods hashWithSalt :: Int -> DescribeHapg -> Int # hash :: DescribeHapg -> Int #
type AWSResponse DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg type AWSResponse DescribeHapg = DescribeHapgResponse
type Rep DescribeHapg Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg type Rep DescribeHapg = D1 ('MetaData "DescribeHapg" "Amazonka.CloudHSM.DescribeHapg" "amazonka-cloudhsm-2.0-AR9j2lWCpfn9LR8RFi06vA" 'False) (C1 ('MetaCons "DescribeHapg'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hapgArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeHapg Source #

Arguments

:: Text	`DescribeHapg`
-> DescribeHapg

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

DescribeHapg, describeHapg_hapgArn - The ARN of the high-availability partition group to describe.

Request Lenses

describeHapg_hapgArn :: Lens' DescribeHapg Text Source #

The ARN of the high-availability partition group to describe.

Destructuring the Response

data DescribeHapgResponse Source #

Contains the output of the DescribeHapg action.

See: newDescribeHapgResponse smart constructor.

Constructors

DescribeHapgResponse'

Fields

hapgArn :: Maybe Text
The ARN of the high-availability partition group.
hapgSerial :: Maybe Text
The serial number of the high-availability partition group.
hsmsLastActionFailed :: Maybe [Text]
hsmsPendingDeletion :: Maybe [Text]
hsmsPendingRegistration :: Maybe [Text]
label :: Maybe Text
The label for the high-availability partition group.
lastModifiedTimestamp :: Maybe Text
The date and time the high-availability partition group was last modified.
partitionSerialList :: Maybe [Text]
The list of partition serial numbers that belong to the high-availability partition group.
state :: Maybe CloudHsmObjectState
The state of the high-availability partition group.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeHapgResponse Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Associated Types type Rep DescribeHapgResponse :: Type -> Type # Methods from :: DescribeHapgResponse -> Rep DescribeHapgResponse x # to :: Rep DescribeHapgResponse x -> DescribeHapgResponse #
Read DescribeHapgResponse Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods readsPrec :: Int -> ReadS DescribeHapgResponse # readList :: ReadS [DescribeHapgResponse] # readPrec :: ReadPrec DescribeHapgResponse # readListPrec :: ReadPrec [DescribeHapgResponse] #
Show DescribeHapgResponse Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods showsPrec :: Int -> DescribeHapgResponse -> ShowS # show :: DescribeHapgResponse -> String # showList :: [DescribeHapgResponse] -> ShowS #
NFData DescribeHapgResponse Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods rnf :: DescribeHapgResponse -> () #
Eq DescribeHapgResponse Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg Methods (==) :: DescribeHapgResponse -> DescribeHapgResponse -> Bool # (/=) :: DescribeHapgResponse -> DescribeHapgResponse -> Bool #
type Rep DescribeHapgResponse Source #
Instance details Defined in Amazonka.CloudHSM.DescribeHapg type Rep DescribeHapgResponse = D1 ('MetaData "DescribeHapgResponse" "Amazonka.CloudHSM.DescribeHapg" "amazonka-cloudhsm-2.0-AR9j2lWCpfn9LR8RFi06vA" 'False) (C1 ('MetaCons "DescribeHapgResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "hapgArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "hapgSerial") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "hsmsLastActionFailed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "hsmsPendingDeletion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "hsmsPendingRegistration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastModifiedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "partitionSerialList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudHsmObjectState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeHapgResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeHapgResponse'`
-> DescribeHapgResponse

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

DescribeHapg, describeHapgResponse_hapgArn - The ARN of the high-availability partition group.

$sel:hapgSerial:DescribeHapgResponse', describeHapgResponse_hapgSerial - The serial number of the high-availability partition group.

$sel:hsmsLastActionFailed:DescribeHapgResponse', describeHapgResponse_hsmsLastActionFailed -

$sel:hsmsPendingDeletion:DescribeHapgResponse', describeHapgResponse_hsmsPendingDeletion -

$sel:hsmsPendingRegistration:DescribeHapgResponse', describeHapgResponse_hsmsPendingRegistration -

$sel:label:DescribeHapgResponse', describeHapgResponse_label - The label for the high-availability partition group.

$sel:lastModifiedTimestamp:DescribeHapgResponse', describeHapgResponse_lastModifiedTimestamp - The date and time the high-availability partition group was last modified.

$sel:partitionSerialList:DescribeHapgResponse', describeHapgResponse_partitionSerialList - The list of partition serial numbers that belong to the high-availability partition group.

$sel:state:DescribeHapgResponse', describeHapgResponse_state - The state of the high-availability partition group.

$sel:httpStatus:DescribeHapgResponse', describeHapgResponse_httpStatus - The response's http status code.

Response Lenses

describeHapgResponse_hapgArn :: Lens' DescribeHapgResponse (Maybe Text) Source #

The ARN of the high-availability partition group.

describeHapgResponse_hapgSerial :: Lens' DescribeHapgResponse (Maybe Text) Source #

The serial number of the high-availability partition group.

describeHapgResponse_hsmsLastActionFailed :: Lens' DescribeHapgResponse (Maybe [Text]) Source #

describeHapgResponse_hsmsPendingDeletion :: Lens' DescribeHapgResponse (Maybe [Text]) Source #

describeHapgResponse_hsmsPendingRegistration :: Lens' DescribeHapgResponse (Maybe [Text]) Source #

describeHapgResponse_label :: Lens' DescribeHapgResponse (Maybe Text) Source #

The label for the high-availability partition group.

describeHapgResponse_lastModifiedTimestamp :: Lens' DescribeHapgResponse (Maybe Text) Source #

The date and time the high-availability partition group was last modified.

describeHapgResponse_partitionSerialList :: Lens' DescribeHapgResponse (Maybe [Text]) Source #

The list of partition serial numbers that belong to the high-availability partition group.

describeHapgResponse_state :: Lens' DescribeHapgResponse (Maybe CloudHsmObjectState) Source #

The state of the high-availability partition group.

describeHapgResponse_httpStatus :: Lens' DescribeHapgResponse Int Source #

The response's http status code.