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.ListVirtualMachines

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists your virtual machines.

This operation returns paginated results.

Synopsis

data ListVirtualMachines = ListVirtualMachines' {
- hypervisorArn :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListVirtualMachines :: ListVirtualMachines
listVirtualMachines_hypervisorArn :: Lens' ListVirtualMachines (Maybe Text)
listVirtualMachines_maxResults :: Lens' ListVirtualMachines (Maybe Natural)
listVirtualMachines_nextToken :: Lens' ListVirtualMachines (Maybe Text)
data ListVirtualMachinesResponse = ListVirtualMachinesResponse' {
- nextToken :: Maybe Text
- virtualMachines :: Maybe [VirtualMachine]
- httpStatus :: Int
}
newListVirtualMachinesResponse :: Int -> ListVirtualMachinesResponse
listVirtualMachinesResponse_nextToken :: Lens' ListVirtualMachinesResponse (Maybe Text)
listVirtualMachinesResponse_virtualMachines :: Lens' ListVirtualMachinesResponse (Maybe [VirtualMachine])
listVirtualMachinesResponse_httpStatus :: Lens' ListVirtualMachinesResponse Int

Creating a Request

data ListVirtualMachines Source #

See: newListVirtualMachines smart constructor.

Constructors

ListVirtualMachines'

Fields

hypervisorArn :: Maybe Text
The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.
maxResults :: Maybe Natural
The maximum number of virtual machines 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 ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines Methods toJSON :: ListVirtualMachines -> Value # toEncoding :: ListVirtualMachines -> Encoding # toJSONList :: [ListVirtualMachines] -> Value # toEncodingList :: [ListVirtualMachines] -> Encoding #
ToHeaders ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines Methods toHeaders :: ListVirtualMachines -> [Header] #
ToPath ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines Methods toPath :: ListVirtualMachines -> ByteString #
ToQuery ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines Methods toQuery :: ListVirtualMachines -> QueryString #
AWSPager ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines Methods page :: ListVirtualMachines -> AWSResponse ListVirtualMachines -> Maybe ListVirtualMachines #
AWSRequest ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines Associated Types type AWSResponse ListVirtualMachines # Methods request :: (Service -> Service) -> ListVirtualMachines -> Request ListVirtualMachines # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListVirtualMachines -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListVirtualMachines))) #
Generic ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines Associated Types type Rep ListVirtualMachines :: Type -> Type # Methods from :: ListVirtualMachines -> Rep ListVirtualMachines x # to :: Rep ListVirtualMachines x -> ListVirtualMachines #
Read ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines Methods readsPrec :: Int -> ReadS ListVirtualMachines # readList :: ReadS [ListVirtualMachines] # readPrec :: ReadPrec ListVirtualMachines # readListPrec :: ReadPrec [ListVirtualMachines] #
Show ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines Methods showsPrec :: Int -> ListVirtualMachines -> ShowS # show :: ListVirtualMachines -> String # showList :: [ListVirtualMachines] -> ShowS #
NFData ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines Methods rnf :: ListVirtualMachines -> () #
Eq ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines Methods (==) :: ListVirtualMachines -> ListVirtualMachines -> Bool # (/=) :: ListVirtualMachines -> ListVirtualMachines -> Bool #
Hashable ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines Methods hashWithSalt :: Int -> ListVirtualMachines -> Int # hash :: ListVirtualMachines -> Int #
type AWSResponse ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines type AWSResponse ListVirtualMachines = ListVirtualMachinesResponse
type Rep ListVirtualMachines Source #
Instance details Defined in Amazonka.BackupGateway.ListVirtualMachines type Rep ListVirtualMachines = D1 ('MetaData "ListVirtualMachines" "Amazonka.BackupGateway.ListVirtualMachines" "amazonka-backup-gateway-2.0-Ee3gVOmXMeV2r3uv4sRO9" 'False) (C1 ('MetaCons "ListVirtualMachines'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hypervisorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListVirtualMachines :: ListVirtualMachines Source #

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

ListVirtualMachines, listVirtualMachines_hypervisorArn - The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.

$sel:maxResults:ListVirtualMachines', listVirtualMachines_maxResults - The maximum number of virtual machines to list.

ListVirtualMachines, listVirtualMachines_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

listVirtualMachines_hypervisorArn :: Lens' ListVirtualMachines (Maybe Text) Source #

The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.

listVirtualMachines_maxResults :: Lens' ListVirtualMachines (Maybe Natural) Source #

The maximum number of virtual machines to list.

listVirtualMachines_nextToken :: Lens' ListVirtualMachines (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 ListVirtualMachinesResponse Source #

See: newListVirtualMachinesResponse smart constructor.

Constructors

ListVirtualMachinesResponse'

Fields

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.
virtualMachines :: Maybe [VirtualMachine]
A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListVirtualMachinesResponse Source #

Arguments

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

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

ListVirtualMachines, listVirtualMachinesResponse_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:virtualMachines:ListVirtualMachinesResponse', listVirtualMachinesResponse_virtualMachines - A list of your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

$sel:httpStatus:ListVirtualMachinesResponse', listVirtualMachinesResponse_httpStatus - The response's http status code.

Response Lenses

listVirtualMachinesResponse_nextToken :: Lens' ListVirtualMachinesResponse (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.

listVirtualMachinesResponse_virtualMachines :: Lens' ListVirtualMachinesResponse (Maybe [VirtualMachine]) Source #

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

listVirtualMachinesResponse_httpStatus :: Lens' ListVirtualMachinesResponse Int Source #

The response's http status code.