| Copyright | (c) 2013-2021 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 |
Amazonka.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.
This operation returns paginated results.
Synopsis
- data DescribeEvents = DescribeEvents' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- serverName :: Text
- newDescribeEvents :: Text -> DescribeEvents
- describeEvents_nextToken :: Lens' DescribeEvents (Maybe Text)
- describeEvents_maxResults :: Lens' DescribeEvents (Maybe Natural)
- describeEvents_serverName :: Lens' DescribeEvents Text
- data DescribeEventsResponse = DescribeEventsResponse' {
- serverEvents :: Maybe [ServerEvent]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeEventsResponse :: Int -> DescribeEventsResponse
- describeEventsResponse_serverEvents :: Lens' DescribeEventsResponse (Maybe [ServerEvent])
- describeEventsResponse_nextToken :: Lens' DescribeEventsResponse (Maybe Text)
- describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int
Creating a Request
data DescribeEvents Source #
See: newDescribeEvents smart constructor.
Constructors
| DescribeEvents' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DescribeEvents |
Create a value of DescribeEvents 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:nextToken:DescribeEvents', describeEvents_nextToken - 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.
$sel:maxResults:DescribeEvents', describeEvents_maxResults - 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.
$sel:serverName:DescribeEvents', describeEvents_serverName - The name of the server for which you want to view events.
Request Lenses
describeEvents_nextToken :: 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.
describeEvents_maxResults :: 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.
describeEvents_serverName :: Lens' DescribeEvents Text Source #
The name of the server for which you want to view events.
Destructuring the Response
data DescribeEventsResponse Source #
See: newDescribeEventsResponse smart constructor.
Constructors
| DescribeEventsResponse' | |
Fields
| |
Instances
newDescribeEventsResponse Source #
Create a value of DescribeEventsResponse 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:serverEvents:DescribeEventsResponse', describeEventsResponse_serverEvents - Contains the response to a DescribeEvents request.
$sel:nextToken:DescribeEvents', describeEventsResponse_nextToken - 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.
$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.
Response Lenses
describeEventsResponse_serverEvents :: Lens' DescribeEventsResponse (Maybe [ServerEvent]) Source #
Contains the response to a DescribeEvents request.
describeEventsResponse_nextToken :: 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.
describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int Source #
The response's http status code.