| 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.AWSHealth.DescribeEvents
Description
Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.
If no filter criteria are specified, all events are returned. Results
are sorted by lastModifiedTime, starting with the most recent event.
- When you call the
DescribeEventsoperation and specify an entity for theentityValuesparameter, AWS Health might return public events that aren't specific to that resource. For example, if you callDescribeEventsand specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use theservicesparameter in thefilterobject. For more information, see Event. - This API operation uses pagination. Specify the
nextTokenparameter in the next request to return more results.
This operation returns paginated results.
Synopsis
- data DescribeEvents = DescribeEvents' {}
- newDescribeEvents :: DescribeEvents
- describeEvents_locale :: Lens' DescribeEvents (Maybe Text)
- describeEvents_nextToken :: Lens' DescribeEvents (Maybe Text)
- describeEvents_filter :: Lens' DescribeEvents (Maybe EventFilter)
- describeEvents_maxResults :: Lens' DescribeEvents (Maybe Natural)
- data DescribeEventsResponse = DescribeEventsResponse' {}
- newDescribeEventsResponse :: Int -> DescribeEventsResponse
- describeEventsResponse_nextToken :: Lens' DescribeEventsResponse (Maybe Text)
- describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event])
- describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int
Creating a Request
data DescribeEvents Source #
See: newDescribeEvents smart constructor.
Constructors
| DescribeEvents' | |
Fields
| |
Instances
newDescribeEvents :: DescribeEvents Source #
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:locale:DescribeEvents', describeEvents_locale - The locale (language) to return information in. English (en) is the
default and the only supported value at this time.
$sel:nextToken:DescribeEvents', describeEvents_nextToken - If the results of a search are large, only a portion of the results are
returned, and a nextToken pagination token is returned in the
response. To retrieve the next batch of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
$sel:filter':DescribeEvents', describeEvents_filter - Values to narrow the results returned.
$sel:maxResults:DescribeEvents', describeEvents_maxResults - The maximum number of items to return in one batch, between 10 and 100,
inclusive.
Request Lenses
describeEvents_locale :: Lens' DescribeEvents (Maybe Text) Source #
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
describeEvents_nextToken :: Lens' DescribeEvents (Maybe Text) Source #
If the results of a search are large, only a portion of the results are
returned, and a nextToken pagination token is returned in the
response. To retrieve the next batch of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
describeEvents_filter :: Lens' DescribeEvents (Maybe EventFilter) Source #
Values to narrow the results returned.
describeEvents_maxResults :: Lens' DescribeEvents (Maybe Natural) Source #
The maximum number of items to return in one batch, between 10 and 100, inclusive.
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:nextToken:DescribeEvents', describeEventsResponse_nextToken - If the results of a search are large, only a portion of the results are
returned, and a nextToken pagination token is returned in the
response. To retrieve the next batch of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
$sel:events:DescribeEventsResponse', describeEventsResponse_events - The events that match the specified filter criteria.
$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.
Response Lenses
describeEventsResponse_nextToken :: Lens' DescribeEventsResponse (Maybe Text) Source #
If the results of a search are large, only a portion of the results are
returned, and a nextToken pagination token is returned in the
response. To retrieve the next batch of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event]) Source #
The events that match the specified filter criteria.
describeEventsResponse_httpStatus :: Lens' DescribeEventsResponse Int Source #
The response's http status code.