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.BackupGateway.ListHypervisors

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists your hypervisors.

This operation returns paginated results.

Creating a Request

data ListHypervisors Source #

See: newListHypervisors smart constructor.

Constructors

ListHypervisors'
Fields maxResults :: Maybe Natural The maximum number of hypervisors to list. nextToken :: Maybe Text The next item following a partial list of returned resources. For example, if a request is made to return `maxResults` number of resources, `NextToken` allows you to return more items in your list starting at the location pointed to by the next token.

Instances

Instances details

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

newListHypervisors :: ListHypervisors Source #

Create a value of ListHypervisors 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:maxResults:ListHypervisors', listHypervisors_maxResults - The maximum number of hypervisors to list.

ListHypervisors, listHypervisors_nextToken - The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Request Lenses

listHypervisors_maxResults :: Lens' ListHypervisors (Maybe Natural) Source #

The maximum number of hypervisors to list.

listHypervisors_nextToken :: Lens' ListHypervisors (Maybe Text) Source #

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Destructuring the Response

data ListHypervisorsResponse Source #

See: newListHypervisorsResponse smart constructor.

Constructors

ListHypervisorsResponse'

Fields

hypervisors :: Maybe [Hypervisor]
A list of your Hypervisor objects, ordered by their Amazon Resource Names (ARNs).
nextToken :: Maybe Text
The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListHypervisorsResponse Source #
Instance details Defined in Amazonka.BackupGateway.ListHypervisors Associated Types type Rep ListHypervisorsResponse :: Type -> Type # Methods from :: ListHypervisorsResponse -> Rep ListHypervisorsResponse x # to :: Rep ListHypervisorsResponse x -> ListHypervisorsResponse #
Read ListHypervisorsResponse Source #
Instance details Defined in Amazonka.BackupGateway.ListHypervisors Methods readsPrec :: Int -> ReadS ListHypervisorsResponse # readList :: ReadS [ListHypervisorsResponse] # readPrec :: ReadPrec ListHypervisorsResponse # readListPrec :: ReadPrec [ListHypervisorsResponse] #
Show ListHypervisorsResponse Source #
Instance details Defined in Amazonka.BackupGateway.ListHypervisors Methods showsPrec :: Int -> ListHypervisorsResponse -> ShowS # show :: ListHypervisorsResponse -> String # showList :: [ListHypervisorsResponse] -> ShowS #
NFData ListHypervisorsResponse Source #
Instance details Defined in Amazonka.BackupGateway.ListHypervisors Methods rnf :: ListHypervisorsResponse -> () #
Eq ListHypervisorsResponse Source #
Instance details Defined in Amazonka.BackupGateway.ListHypervisors Methods (==) :: ListHypervisorsResponse -> ListHypervisorsResponse -> Bool # (/=) :: ListHypervisorsResponse -> ListHypervisorsResponse -> Bool #
type Rep ListHypervisorsResponse Source #
Instance details Defined in Amazonka.BackupGateway.ListHypervisors type Rep ListHypervisorsResponse = D1 ('MetaData "ListHypervisorsResponse" "Amazonka.BackupGateway.ListHypervisors" "amazonka-backup-gateway-2.0-Ee3gVOmXMeV2r3uv4sRO9" 'False) (C1 ('MetaCons "ListHypervisorsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hypervisors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Hypervisor])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListHypervisorsResponse Source #

Arguments

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

Create a value of ListHypervisorsResponse 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:hypervisors:ListHypervisorsResponse', listHypervisorsResponse_hypervisors - A list of your Hypervisor objects, ordered by their Amazon Resource Names (ARNs).

ListHypervisors, listHypervisorsResponse_nextToken - The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

$sel:httpStatus:ListHypervisorsResponse', listHypervisorsResponse_httpStatus - The response's http status code.

Response Lenses

listHypervisorsResponse_hypervisors :: Lens' ListHypervisorsResponse (Maybe [Hypervisor]) Source #

A list of your Hypervisor objects, ordered by their Amazon Resource Names (ARNs).

listHypervisorsResponse_nextToken :: Lens' ListHypervisorsResponse (Maybe Text) Source #

The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

listHypervisorsResponse_httpStatus :: Lens' ListHypervisorsResponse Int Source #

The response's http status code.