| Copyright | (c) 2013-2017 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.OpsWorksCM.DescribeEvents
Description
Describes events for a specified server. Results are ordered by time, with newest events first.
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.
- describeEvents :: Text -> DescribeEvents
- data DescribeEvents
- deNextToken :: Lens' DescribeEvents (Maybe Text)
- deMaxResults :: Lens' DescribeEvents (Maybe Natural)
- deServerName :: Lens' DescribeEvents Text
- describeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeEventsResponse
- dersServerEvents :: Lens' DescribeEventsResponse [ServerEvent]
- dersNextToken :: Lens' DescribeEventsResponse (Maybe Text)
- dersResponseStatus :: Lens' DescribeEventsResponse Int
Creating a Request
Arguments
| :: Text | |
| -> DescribeEvents |
Creates a value of DescribeEvents with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
deNextToken- 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, callDescribeEventsagain, and assign the token from the previous results as the value of thenextTokenparameter. If there are no more results, the response object'snextTokenparameter value isnull. Setting anextTokenvalue that was not returned in your previous results causes anInvalidNextTokenExceptionto occur.deMaxResults- 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 aNextTokenvalue that you can assign to theNextTokenrequest parameter to get the next set of results.deServerName- The name of the server for which you want to view events.
data DescribeEvents Source #
See: describeEvents smart constructor.
Instances
Request Lenses
deNextToken :: Lens' DescribeEvents (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 DescribeEvents 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.
deMaxResults :: Lens' DescribeEvents (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.
deServerName :: Lens' DescribeEvents Text Source #
The name of the server for which you want to view events.
Destructuring the Response
describeEventsResponse Source #
Arguments
| :: Int | |
| -> DescribeEventsResponse |
Creates a value of DescribeEventsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dersServerEvents- Contains the response to aDescribeEventsrequest.dersNextToken- 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, callDescribeEventsagain, and assign the token from the previous results as the value of thenextTokenparameter. If there are no more results, the response object'snextTokenparameter value isnull. Setting anextTokenvalue that was not returned in your previous results causes anInvalidNextTokenExceptionto occur.dersResponseStatus- -- | The response status code.
data DescribeEventsResponse Source #
See: describeEventsResponse smart constructor.
Response Lenses
dersServerEvents :: Lens' DescribeEventsResponse [ServerEvent] Source #
Contains the response to a DescribeEvents request.
dersNextToken :: Lens' DescribeEventsResponse (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 DescribeEvents 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.
dersResponseStatus :: Lens' DescribeEventsResponse Int Source #
- - | The response status code.