{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.SMS.GetServers -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Describes the servers in your server catalog. -- -- Before you can describe your servers, you must import them using -- ImportServerCatalog. -- -- This operation returns paginated results. module Amazonka.SMS.GetServers ( -- * Creating a Request GetServers (..), newGetServers, -- * Request Lenses getServers_maxResults, getServers_nextToken, getServers_vmServerAddressList, -- * Destructuring the Response GetServersResponse (..), newGetServersResponse, -- * Response Lenses getServersResponse_lastModifiedOn, getServersResponse_nextToken, getServersResponse_serverCatalogStatus, getServersResponse_serverList, getServersResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response import Amazonka.SMS.Types -- | /See:/ 'newGetServers' smart constructor. data GetServers = GetServers' { -- | 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. maxResults :: Prelude.Maybe Prelude.Int, -- | The token for the next set of results. nextToken :: Prelude.Maybe Prelude.Text, -- | The server addresses. vmServerAddressList :: Prelude.Maybe [VmServerAddress] } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'GetServers' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'maxResults', '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. -- -- 'nextToken', 'getServers_nextToken' - The token for the next set of results. -- -- 'vmServerAddressList', 'getServers_vmServerAddressList' - The server addresses. newGetServers :: GetServers newGetServers = GetServers' { maxResults = Prelude.Nothing, nextToken = Prelude.Nothing, vmServerAddressList = Prelude.Nothing } -- | 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_maxResults :: Lens.Lens' GetServers (Prelude.Maybe Prelude.Int) getServers_maxResults = Lens.lens (\GetServers' {maxResults} -> maxResults) (\s@GetServers' {} a -> s {maxResults = a} :: GetServers) -- | The token for the next set of results. getServers_nextToken :: Lens.Lens' GetServers (Prelude.Maybe Prelude.Text) getServers_nextToken = Lens.lens (\GetServers' {nextToken} -> nextToken) (\s@GetServers' {} a -> s {nextToken = a} :: GetServers) -- | The server addresses. getServers_vmServerAddressList :: Lens.Lens' GetServers (Prelude.Maybe [VmServerAddress]) getServers_vmServerAddressList = Lens.lens (\GetServers' {vmServerAddressList} -> vmServerAddressList) (\s@GetServers' {} a -> s {vmServerAddressList = a} :: GetServers) Prelude.. Lens.mapping Lens.coerced instance Core.AWSPager GetServers where page rq rs | Core.stop ( rs Lens.^? getServersResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? getServersResponse_serverList Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& getServers_nextToken Lens..~ rs Lens.^? getServersResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest GetServers where type AWSResponse GetServers = GetServersResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> GetServersResponse' Prelude.<$> (x Data..?> "lastModifiedOn") Prelude.<*> (x Data..?> "nextToken") Prelude.<*> (x Data..?> "serverCatalogStatus") Prelude.<*> (x Data..?> "serverList" Core..!@ Prelude.mempty) Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable GetServers where hashWithSalt _salt GetServers' {..} = _salt `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` vmServerAddressList instance Prelude.NFData GetServers where rnf GetServers' {..} = Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf vmServerAddressList instance Data.ToHeaders GetServers where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "AWSServerMigrationService_V2016_10_24.GetServers" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON GetServers where toJSON GetServers' {..} = Data.object ( Prelude.catMaybes [ ("maxResults" Data..=) Prelude.<$> maxResults, ("nextToken" Data..=) Prelude.<$> nextToken, ("vmServerAddressList" Data..=) Prelude.<$> vmServerAddressList ] ) instance Data.ToPath GetServers where toPath = Prelude.const "/" instance Data.ToQuery GetServers where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newGetServersResponse' smart constructor. data GetServersResponse = GetServersResponse' { -- | The time when the server was last modified. lastModifiedOn :: Prelude.Maybe Data.POSIX, -- | The token required to retrieve the next set of results. This value is -- null when there are no more results to return. nextToken :: Prelude.Maybe Prelude.Text, -- | The status of the server catalog. serverCatalogStatus :: Prelude.Maybe ServerCatalogStatus, -- | Information about the servers. serverList :: Prelude.Maybe [Server], -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'GetServersResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'lastModifiedOn', 'getServersResponse_lastModifiedOn' - The time when the server was last modified. -- -- 'nextToken', 'getServersResponse_nextToken' - The token required to retrieve the next set of results. This value is -- null when there are no more results to return. -- -- 'serverCatalogStatus', 'getServersResponse_serverCatalogStatus' - The status of the server catalog. -- -- 'serverList', 'getServersResponse_serverList' - Information about the servers. -- -- 'httpStatus', 'getServersResponse_httpStatus' - The response's http status code. newGetServersResponse :: -- | 'httpStatus' Prelude.Int -> GetServersResponse newGetServersResponse pHttpStatus_ = GetServersResponse' { lastModifiedOn = Prelude.Nothing, nextToken = Prelude.Nothing, serverCatalogStatus = Prelude.Nothing, serverList = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | The time when the server was last modified. getServersResponse_lastModifiedOn :: Lens.Lens' GetServersResponse (Prelude.Maybe Prelude.UTCTime) getServersResponse_lastModifiedOn = Lens.lens (\GetServersResponse' {lastModifiedOn} -> lastModifiedOn) (\s@GetServersResponse' {} a -> s {lastModifiedOn = a} :: GetServersResponse) Prelude.. Lens.mapping Data._Time -- | The token required to retrieve the next set of results. This value is -- null when there are no more results to return. getServersResponse_nextToken :: Lens.Lens' GetServersResponse (Prelude.Maybe Prelude.Text) getServersResponse_nextToken = Lens.lens (\GetServersResponse' {nextToken} -> nextToken) (\s@GetServersResponse' {} a -> s {nextToken = a} :: GetServersResponse) -- | The status of the server catalog. getServersResponse_serverCatalogStatus :: Lens.Lens' GetServersResponse (Prelude.Maybe ServerCatalogStatus) getServersResponse_serverCatalogStatus = Lens.lens (\GetServersResponse' {serverCatalogStatus} -> serverCatalogStatus) (\s@GetServersResponse' {} a -> s {serverCatalogStatus = a} :: GetServersResponse) -- | Information about the servers. getServersResponse_serverList :: Lens.Lens' GetServersResponse (Prelude.Maybe [Server]) getServersResponse_serverList = Lens.lens (\GetServersResponse' {serverList} -> serverList) (\s@GetServersResponse' {} a -> s {serverList = a} :: GetServersResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. getServersResponse_httpStatus :: Lens.Lens' GetServersResponse Prelude.Int getServersResponse_httpStatus = Lens.lens (\GetServersResponse' {httpStatus} -> httpStatus) (\s@GetServersResponse' {} a -> s {httpStatus = a} :: GetServersResponse) instance Prelude.NFData GetServersResponse where rnf GetServersResponse' {..} = Prelude.rnf lastModifiedOn `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf serverCatalogStatus `Prelude.seq` Prelude.rnf serverList `Prelude.seq` Prelude.rnf httpStatus