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 |
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.
This operation returns paginated results.
- describeEvents :: DescribeEvents
- data DescribeEvents
- deLocale :: Lens' DescribeEvents (Maybe Text)
- deNextToken :: Lens' DescribeEvents (Maybe Text)
- deFilter :: Lens' DescribeEvents (Maybe EventFilter)
- deMaxResults :: Lens' DescribeEvents (Maybe Natural)
- describeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeEventsResponse
- dersNextToken :: Lens' DescribeEventsResponse (Maybe Text)
- dersEvents :: Lens' DescribeEventsResponse [Event]
- dersResponseStatus :: Lens' DescribeEventsResponse Int
Creating a Request
describeEvents :: DescribeEvents Source #
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:
deLocale
- The locale (language) to return information in. English (en) is the default and the only supported value at this time.deNextToken
- If the results of a search are large, only a portion of the results are returned, and anextToken
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.deFilter
- Values to narrow the results returned.deMaxResults
- The maximum number of items to return in one batch, between 10 and 100, inclusive.
data DescribeEvents Source #
See: describeEvents
smart constructor.
Request Lenses
deLocale :: 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.
deNextToken :: 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.
deFilter :: Lens' DescribeEvents (Maybe EventFilter) Source #
Values to narrow the results returned.
deMaxResults :: Lens' DescribeEvents (Maybe Natural) Source #
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Destructuring the Response
describeEventsResponse Source #
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:
dersNextToken
- If the results of a search are large, only a portion of the results are returned, and anextToken
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.dersEvents
- The events that match the specified filter criteria.dersResponseStatus
- -- | The response status code.
data DescribeEventsResponse Source #
See: describeEventsResponse
smart constructor.
Response Lenses
dersNextToken :: 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.
dersEvents :: Lens' DescribeEventsResponse [Event] Source #
The events that match the specified filter criteria.
dersResponseStatus :: Lens' DescribeEventsResponse Int Source #
- - | The response status code.