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.MigrationHubStrategy.ListServers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of all the servers.

This operation returns paginated results.

Synopsis

data ListServers = ListServers' {
- filterValue :: Maybe Text
- groupIdFilter :: Maybe [Group]
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- serverCriteria :: Maybe ServerCriteria
- sort :: Maybe SortOrder
}
newListServers :: ListServers
listServers_filterValue :: Lens' ListServers (Maybe Text)
listServers_groupIdFilter :: Lens' ListServers (Maybe [Group])
listServers_maxResults :: Lens' ListServers (Maybe Int)
listServers_nextToken :: Lens' ListServers (Maybe Text)
listServers_serverCriteria :: Lens' ListServers (Maybe ServerCriteria)
listServers_sort :: Lens' ListServers (Maybe SortOrder)
data ListServersResponse = ListServersResponse' {
- nextToken :: Maybe Text
- serverInfos :: Maybe [ServerDetail]
- httpStatus :: Int
}
newListServersResponse :: Int -> ListServersResponse
listServersResponse_nextToken :: Lens' ListServersResponse (Maybe Text)
listServersResponse_serverInfos :: Lens' ListServersResponse (Maybe [ServerDetail])
listServersResponse_httpStatus :: Lens' ListServersResponse Int

Creating a Request

data ListServers Source #

See: newListServers smart constructor.

Constructors

ListServers'

Fields

filterValue :: Maybe Text
Specifies the filter value, which is based on the type of server criteria. For example, if serverCriteria is OS_NAME, and the filterValue is equal to WindowsServer, then ListServers returns all of the servers matching the OS name WindowsServer.
groupIdFilter :: Maybe [Group]
Specifies the group ID to filter on.
maxResults :: Maybe Int
The maximum number of items to include in the response. The maximum value is 100.
nextToken :: Maybe Text
The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.
serverCriteria :: Maybe ServerCriteria
Criteria for filtering servers.
sort :: Maybe SortOrder
Specifies whether to sort by ascending (ASC) or descending (DESC) order.

Instances

Instances details

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

newListServers :: ListServers Source #

Create a value of ListServers 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:filterValue:ListServers', listServers_filterValue - Specifies the filter value, which is based on the type of server criteria. For example, if serverCriteria is OS_NAME, and the filterValue is equal to WindowsServer, then ListServers returns all of the servers matching the OS name WindowsServer.

$sel:groupIdFilter:ListServers', listServers_groupIdFilter - Specifies the group ID to filter on.

$sel:maxResults:ListServers', listServers_maxResults - The maximum number of items to include in the response. The maximum value is 100.

ListServers, listServers_nextToken - The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

$sel:serverCriteria:ListServers', listServers_serverCriteria - Criteria for filtering servers.

$sel:sort:ListServers', listServers_sort - Specifies whether to sort by ascending (ASC) or descending (DESC) order.

Request Lenses

listServers_filterValue :: Lens' ListServers (Maybe Text) Source #

Specifies the filter value, which is based on the type of server criteria. For example, if serverCriteria is OS_NAME, and the filterValue is equal to WindowsServer, then ListServers returns all of the servers matching the OS name WindowsServer.

listServers_groupIdFilter :: Lens' ListServers (Maybe [Group]) Source #

Specifies the group ID to filter on.

listServers_maxResults :: Lens' ListServers (Maybe Int) Source #

The maximum number of items to include in the response. The maximum value is 100.

listServers_nextToken :: Lens' ListServers (Maybe Text) Source #

The token from a previous call that you use to retrieve the next set of results. For example, if a previous call to this action returned 100 items, but you set maxResults to 10. You'll receive a set of 10 results along with a token. You then use the returned token to retrieve the next set of 10.

listServers_serverCriteria :: Lens' ListServers (Maybe ServerCriteria) Source #

Criteria for filtering servers.

listServers_sort :: Lens' ListServers (Maybe SortOrder) Source #

Specifies whether to sort by ascending (ASC) or descending (DESC) order.

Destructuring the Response

data ListServersResponse Source #

See: newListServersResponse smart constructor.

Constructors

ListServersResponse'
Fields nextToken :: Maybe Text The token you use to retrieve the next set of results, or null if there are no more results. serverInfos :: Maybe [ServerDetail] The list of servers with detailed information about each server. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListServersResponse Source #

Arguments

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

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

ListServers, listServersResponse_nextToken - The token you use to retrieve the next set of results, or null if there are no more results.

$sel:serverInfos:ListServersResponse', listServersResponse_serverInfos - The list of servers with detailed information about each server.

$sel:httpStatus:ListServersResponse', listServersResponse_httpStatus - The response's http status code.

Response Lenses

listServersResponse_nextToken :: Lens' ListServersResponse (Maybe Text) Source #

The token you use to retrieve the next set of results, or null if there are no more results.

listServersResponse_serverInfos :: Lens' ListServersResponse (Maybe [ServerDetail]) Source #

The list of servers with detailed information about each server.

listServersResponse_httpStatus :: Lens' ListServersResponse Int Source #

The response's http status code.