Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks for Chef Automate 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 invalid.
- describeServers :: DescribeServers
- data DescribeServers
- dssServerName :: Lens' DescribeServers (Maybe Text)
- dssNextToken :: Lens' DescribeServers (Maybe Text)
- dssMaxResults :: Lens' DescribeServers (Maybe Natural)
- describeServersResponse :: Int -> DescribeServersResponse
- data DescribeServersResponse
- dssrsServers :: Lens' DescribeServersResponse [Server]
- dssrsNextToken :: Lens' DescribeServersResponse (Maybe Text)
- dssrsResponseStatus :: Lens' DescribeServersResponse Int
Creating a Request
describeServers :: DescribeServers Source #
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, callDescribeServers
again, and assign the token from the previous results as the value of thenextToken
parameter. If there are no more results, the response object'snextToken
parameter value isnull
. Setting anextToken
value that was not returned in your previous results causes anInvalidNextTokenException
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 aNextToken
value that you can assign to theNextToken
request parameter to get the next set of results.
data DescribeServers Source #
See: describeServers
smart constructor.
Request Lenses
dssServerName :: Lens' DescribeServers (Maybe Text) Source #
Describes the server with the specified ServerName.
dssNextToken :: Lens' DescribeServers (Maybe Text) Source #
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) Source #
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 Source #
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 aDescribeServers
request.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, callDescribeServers
again, and assign the token from the previous results as the value of thenextToken
parameter. If there are no more results, the response object'snextToken
parameter value isnull
. Setting anextToken
value that was not returned in your previous results causes anInvalidNextTokenException
to occur.dssrsResponseStatus
- -- | The response status code.
data DescribeServersResponse Source #
See: describeServersResponse
smart constructor.
Response Lenses
dssrsServers :: Lens' DescribeServersResponse [Server] Source #
Contains the response to a DescribeServers
request.
dssrsNextToken :: Lens' DescribeServersResponse (Maybe Text) Source #
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 Source #
- - | The response status code.