Copyright	(c) 2013-2021 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

Amazonka.CloudHSM.ListHsms

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 the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

This operation returns paginated results.

Synopsis

data ListHsms = ListHsms' {
- nextToken :: Maybe Text
}
newListHsms :: ListHsms
listHsms_nextToken :: Lens' ListHsms (Maybe Text)
data ListHsmsResponse = ListHsmsResponse' {
- nextToken :: Maybe Text
- hsmList :: Maybe [Text]
- httpStatus :: Int
}
newListHsmsResponse :: Int -> ListHsmsResponse
listHsmsResponse_nextToken :: Lens' ListHsmsResponse (Maybe Text)
listHsmsResponse_hsmList :: Lens' ListHsmsResponse (Maybe [Text])
listHsmsResponse_httpStatus :: Lens' ListHsmsResponse Int

Creating a Request

data ListHsms Source #

See: newListHsms smart constructor.

Constructors

ListHsms'
Fields nextToken :: Maybe Text The `NextToken` value from a previous call to `ListHsms`. Pass null if this is the first call.

Instances

Instances details

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

newListHsms :: ListHsms Source #

Create a value of ListHsms 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:nextToken:ListHsms', listHsms_nextToken - The NextToken value from a previous call to ListHsms. Pass null if this is the first call.

Request Lenses

listHsms_nextToken :: Lens' ListHsms (Maybe Text) Source #

The NextToken value from a previous call to ListHsms. Pass null if this is the first call.

Destructuring the Response

data ListHsmsResponse Source #

Contains the output of the ListHsms operation.

See: newListHsmsResponse smart constructor.

Constructors

ListHsmsResponse'
Fields nextToken :: Maybe Text If not null, more results are available. Pass this value to `ListHsms` to retrieve the next set of items. hsmList :: Maybe [Text] The list of ARNs that identify the HSMs. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListHsmsResponse Source #
Instance details Defined in Amazonka.CloudHSM.ListHsms Methods (==) :: ListHsmsResponse -> ListHsmsResponse -> Bool # (/=) :: ListHsmsResponse -> ListHsmsResponse -> Bool #
Read ListHsmsResponse Source #
Instance details Defined in Amazonka.CloudHSM.ListHsms Methods readsPrec :: Int -> ReadS ListHsmsResponse # readList :: ReadS [ListHsmsResponse] # readPrec :: ReadPrec ListHsmsResponse # readListPrec :: ReadPrec [ListHsmsResponse] #
Show ListHsmsResponse Source #
Instance details Defined in Amazonka.CloudHSM.ListHsms Methods showsPrec :: Int -> ListHsmsResponse -> ShowS # show :: ListHsmsResponse -> String # showList :: [ListHsmsResponse] -> ShowS #
Generic ListHsmsResponse Source #
Instance details Defined in Amazonka.CloudHSM.ListHsms Associated Types type Rep ListHsmsResponse :: Type -> Type # Methods from :: ListHsmsResponse -> Rep ListHsmsResponse x # to :: Rep ListHsmsResponse x -> ListHsmsResponse #
NFData ListHsmsResponse Source #
Instance details Defined in Amazonka.CloudHSM.ListHsms Methods rnf :: ListHsmsResponse -> () #
type Rep ListHsmsResponse Source #
Instance details Defined in Amazonka.CloudHSM.ListHsms type Rep ListHsmsResponse = D1 ('MetaData "ListHsmsResponse" "Amazonka.CloudHSM.ListHsms" "libZSservicesZSamazonka-cloudhsmZSamazonka-cloudhsm" 'False) (C1 ('MetaCons "ListHsmsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "hsmList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListHsmsResponse Source #

Arguments

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

Create a value of ListHsmsResponse 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:nextToken:ListHsms', listHsmsResponse_nextToken - If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.

$sel:hsmList:ListHsmsResponse', listHsmsResponse_hsmList - The list of ARNs that identify the HSMs.

$sel:httpStatus:ListHsmsResponse', listHsmsResponse_httpStatus - The response's http status code.

Response Lenses

listHsmsResponse_nextToken :: Lens' ListHsmsResponse (Maybe Text) Source #

If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.

listHsmsResponse_hsmList :: Lens' ListHsmsResponse (Maybe [Text]) Source #

The list of ARNs that identify the HSMs.

listHsmsResponse_httpStatus :: Lens' ListHsmsResponse Int Source #

The response's http status code.