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.SMS.GetServers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the servers in your server catalog.

Before you can describe your servers, you must import them using ImportServerCatalog.

This operation returns paginated results.

Synopsis

data GetServers = GetServers' {
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- vmServerAddressList :: Maybe [VmServerAddress]
}
newGetServers :: GetServers
getServers_maxResults :: Lens' GetServers (Maybe Int)
getServers_nextToken :: Lens' GetServers (Maybe Text)
getServers_vmServerAddressList :: Lens' GetServers (Maybe [VmServerAddress])
data GetServersResponse = GetServersResponse' {
- lastModifiedOn :: Maybe POSIX
- nextToken :: Maybe Text
- serverCatalogStatus :: Maybe ServerCatalogStatus
- serverList :: Maybe [Server]
- httpStatus :: Int
}
newGetServersResponse :: Int -> GetServersResponse
getServersResponse_lastModifiedOn :: Lens' GetServersResponse (Maybe UTCTime)
getServersResponse_nextToken :: Lens' GetServersResponse (Maybe Text)
getServersResponse_serverCatalogStatus :: Lens' GetServersResponse (Maybe ServerCatalogStatus)
getServersResponse_serverList :: Lens' GetServersResponse (Maybe [Server])
getServersResponse_httpStatus :: Lens' GetServersResponse Int

Creating a Request

data GetServers Source #

See: newGetServers smart constructor.

Constructors

GetServers'
Fields maxResults :: Maybe Int The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned `NextToken` value. nextToken :: Maybe Text The token for the next set of results. vmServerAddressList :: Maybe [VmServerAddress] The server addresses.

Instances

Instances details

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

newGetServers :: GetServers Source #

Create a value of GetServers 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:GetServers', getServers_maxResults - The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

GetServers, getServers_nextToken - The token for the next set of results.

$sel:vmServerAddressList:GetServers', getServers_vmServerAddressList - The server addresses.

Request Lenses

getServers_maxResults :: Lens' GetServers (Maybe Int) Source #

The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

getServers_nextToken :: Lens' GetServers (Maybe Text) Source #

The token for the next set of results.

getServers_vmServerAddressList :: Lens' GetServers (Maybe [VmServerAddress]) Source #

The server addresses.

Destructuring the Response

data GetServersResponse Source #

See: newGetServersResponse smart constructor.

Constructors

GetServersResponse'

Fields

lastModifiedOn :: Maybe POSIX
The time when the server was last modified.
nextToken :: Maybe Text
The token required to retrieve the next set of results. This value is null when there are no more results to return.
serverCatalogStatus :: Maybe ServerCatalogStatus
The status of the server catalog.
serverList :: Maybe [Server]
Information about the servers.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetServersResponse Source #
Instance details Defined in Amazonka.SMS.GetServers Associated Types type Rep GetServersResponse :: Type -> Type # Methods from :: GetServersResponse -> Rep GetServersResponse x # to :: Rep GetServersResponse x -> GetServersResponse #
Read GetServersResponse Source #
Instance details Defined in Amazonka.SMS.GetServers Methods readsPrec :: Int -> ReadS GetServersResponse # readList :: ReadS [GetServersResponse] # readPrec :: ReadPrec GetServersResponse # readListPrec :: ReadPrec [GetServersResponse] #
Show GetServersResponse Source #
Instance details Defined in Amazonka.SMS.GetServers Methods showsPrec :: Int -> GetServersResponse -> ShowS # show :: GetServersResponse -> String # showList :: [GetServersResponse] -> ShowS #
NFData GetServersResponse Source #
Instance details Defined in Amazonka.SMS.GetServers Methods rnf :: GetServersResponse -> () #
Eq GetServersResponse Source #
Instance details Defined in Amazonka.SMS.GetServers Methods (==) :: GetServersResponse -> GetServersResponse -> Bool # (/=) :: GetServersResponse -> GetServersResponse -> Bool #
type Rep GetServersResponse Source #
Instance details Defined in Amazonka.SMS.GetServers type Rep GetServersResponse = D1 ('MetaData "GetServersResponse" "Amazonka.SMS.GetServers" "amazonka-sms-2.0-4YLznk7UFuE5VtyLFXmW6X" 'False) (C1 ('MetaCons "GetServersResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastModifiedOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "serverCatalogStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServerCatalogStatus)) :: (S1 ('MetaSel ('Just "serverList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Server])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetServersResponse Source #

Arguments

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

Create a value of GetServersResponse 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:lastModifiedOn:GetServersResponse', getServersResponse_lastModifiedOn - The time when the server was last modified.

GetServers, getServersResponse_nextToken - The token required to retrieve the next set of results. This value is null when there are no more results to return.

$sel:serverCatalogStatus:GetServersResponse', getServersResponse_serverCatalogStatus - The status of the server catalog.

GetServersResponse, getServersResponse_serverList - Information about the servers.

$sel:httpStatus:GetServersResponse', getServersResponse_httpStatus - The response's http status code.

Response Lenses

getServersResponse_lastModifiedOn :: Lens' GetServersResponse (Maybe UTCTime) Source #

The time when the server was last modified.

getServersResponse_nextToken :: Lens' GetServersResponse (Maybe Text) Source #

The token required to retrieve the next set of results. This value is null when there are no more results to return.

getServersResponse_serverCatalogStatus :: Lens' GetServersResponse (Maybe ServerCatalogStatus) Source #

The status of the server catalog.

getServersResponse_serverList :: Lens' GetServersResponse (Maybe [Server]) Source #

Information about the servers.

getServersResponse_httpStatus :: Lens' GetServersResponse Int Source #

The response's http status code.