Network.AWS.OpsWorksCM.DescribeServers

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Creating a Request

describeServers :: DescribeServers

Creates a value of DescribeServers with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dssServerName - Describes the server with the specified ServerName.
• dssNextToken - NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeServers again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null . Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.
• dssMaxResults - To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

data DescribeServers

See: describeServers smart constructor.

Instances

Eq DescribeServers

Methods

(==) :: DescribeServers -> DescribeServers -> Bool

(/=) :: DescribeServers -> DescribeServers -> Bool

Data DescribeServers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeServers -> c DescribeServers

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeServers

toConstr :: DescribeServers -> Constr

dataTypeOf :: DescribeServers -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeServers)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeServers)

gmapT :: (forall b. Data b => b -> b) -> DescribeServers -> DescribeServers

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeServers -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeServers -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeServers -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeServers -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeServers -> m DescribeServers

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeServers -> m DescribeServers

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeServers -> m DescribeServers

Read DescribeServers

Methods

readsPrec :: Int -> ReadS DescribeServers

readList :: ReadS [DescribeServers]

readPrec :: ReadPrec DescribeServers

readListPrec :: ReadPrec [DescribeServers]

Show DescribeServers

Methods

showsPrec :: Int -> DescribeServers -> ShowS

show :: DescribeServers -> String

showList :: [DescribeServers] -> ShowS

Generic DescribeServers

Associated Types

type Rep DescribeServers :: * -> *

Methods

from :: DescribeServers -> Rep DescribeServers x

to :: Rep DescribeServers x -> DescribeServers

Hashable DescribeServers

Methods

hashWithSalt :: Int -> DescribeServers -> Int

hash :: DescribeServers -> Int

ToJSON DescribeServers

Methods

toJSON :: DescribeServers -> Value

toEncoding :: DescribeServers -> Encoding

toJSONList :: [DescribeServers] -> Value

toEncodingList :: [DescribeServers] -> Encoding

NFData DescribeServers

Methods

rnf :: DescribeServers -> ()

AWSRequest DescribeServers

Associated Types

type Rs DescribeServers :: *

Methods

request :: DescribeServers -> Request DescribeServers

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeServers -> ClientResponse -> m (Response DescribeServers)

ToHeaders DescribeServers

Methods

toHeaders :: DescribeServers -> [Header]

ToPath DescribeServers

Methods

toPath :: DescribeServers -> ByteString

ToQuery DescribeServers

Methods

toQuery :: DescribeServers -> QueryString

type Rep DescribeServers

type Rep DescribeServers = D1 * (MetaData "DescribeServers" "Network.AWS.OpsWorksCM.DescribeServers" "amazonka-opsworks-cm-1.6.0-D1lLq3cpj5Y52sT2PvyDqA" False) (C1 * (MetaCons "DescribeServers'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dssServerName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dssNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dssMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs DescribeServers

type Rs DescribeServers = DescribeServersResponse

Request Lenses

dssServerName :: Lens' DescribeServers (Maybe Text)

Describes the server with the specified ServerName.

dssNextToken :: Lens' DescribeServers (Maybe Text)

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeServers again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null . Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

dssMaxResults :: Lens' DescribeServers (Maybe Natural)

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Destructuring the Response

describeServersResponse

Arguments

:: Int

dssrsResponseStatus

-> DescribeServersResponse

Creates a value of DescribeServersResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dssrsServers - Contains the response to a DescribeServers request. For Puppet Server: DescribeServersResponse$Servers$EngineAttributes contains PUPPET_API_CA_CERT. This is the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates.
• dssrsNextToken - NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeServers again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null . Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.
• dssrsResponseStatus - -- | The response status code.

data DescribeServersResponse

See: describeServersResponse smart constructor.

Instances

Eq DescribeServersResponse

Methods

(==) :: DescribeServersResponse -> DescribeServersResponse -> Bool

(/=) :: DescribeServersResponse -> DescribeServersResponse -> Bool

Data DescribeServersResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeServersResponse -> c DescribeServersResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeServersResponse

toConstr :: DescribeServersResponse -> Constr

dataTypeOf :: DescribeServersResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeServersResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeServersResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeServersResponse -> DescribeServersResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeServersResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeServersResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeServersResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeServersResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeServersResponse -> m DescribeServersResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeServersResponse -> m DescribeServersResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeServersResponse -> m DescribeServersResponse

Show DescribeServersResponse

Methods

showsPrec :: Int -> DescribeServersResponse -> ShowS

show :: DescribeServersResponse -> String

showList :: [DescribeServersResponse] -> ShowS

Generic DescribeServersResponse

Associated Types

type Rep DescribeServersResponse :: * -> *

Methods

from :: DescribeServersResponse -> Rep DescribeServersResponse x

to :: Rep DescribeServersResponse x -> DescribeServersResponse

NFData DescribeServersResponse

Methods

rnf :: DescribeServersResponse -> ()

type Rep DescribeServersResponse

type Rep DescribeServersResponse = D1 * (MetaData "DescribeServersResponse" "Network.AWS.OpsWorksCM.DescribeServers" "amazonka-opsworks-cm-1.6.0-D1lLq3cpj5Y52sT2PvyDqA" False) (C1 * (MetaCons "DescribeServersResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dssrsServers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Server]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dssrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dssrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

dssrsServers :: Lens' DescribeServersResponse [Server]

Contains the response to a DescribeServers request. For Puppet Server: DescribeServersResponse$Servers$EngineAttributes contains PUPPET_API_CA_CERT. This is the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates.

dssrsNextToken :: Lens' DescribeServersResponse (Maybe Text)

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeServers again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null . Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

dssrsResponseStatus :: Lens' DescribeServersResponse Int

• - | The response status code.