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 |
Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.
- describeEventAggregates :: EventAggregateField -> DescribeEventAggregates
- data DescribeEventAggregates
- deaNextToken :: Lens' DescribeEventAggregates (Maybe Text)
- deaFilter :: Lens' DescribeEventAggregates (Maybe EventFilter)
- deaMaxResults :: Lens' DescribeEventAggregates (Maybe Natural)
- deaAggregateField :: Lens' DescribeEventAggregates EventAggregateField
- describeEventAggregatesResponse :: Int -> DescribeEventAggregatesResponse
- data DescribeEventAggregatesResponse
- drsNextToken :: Lens' DescribeEventAggregatesResponse (Maybe Text)
- drsEventAggregates :: Lens' DescribeEventAggregatesResponse [EventAggregate]
- drsResponseStatus :: Lens' DescribeEventAggregatesResponse Int
Creating a Request
describeEventAggregates Source #
Creates a value of DescribeEventAggregates
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
deaNextToken
- 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.deaFilter
- Values to narrow the results returned.deaMaxResults
- The maximum number of items to return in one batch.deaAggregateField
- The only currently supported value iseventTypeCategory
.
data DescribeEventAggregates Source #
See: describeEventAggregates
smart constructor.
Request Lenses
deaNextToken :: Lens' DescribeEventAggregates (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.
deaFilter :: Lens' DescribeEventAggregates (Maybe EventFilter) Source #
Values to narrow the results returned.
deaMaxResults :: Lens' DescribeEventAggregates (Maybe Natural) Source #
The maximum number of items to return in one batch.
deaAggregateField :: Lens' DescribeEventAggregates EventAggregateField Source #
The only currently supported value is eventTypeCategory
.
Destructuring the Response
describeEventAggregatesResponse Source #
Creates a value of DescribeEventAggregatesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drsNextToken
- 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.drsEventAggregates
- The number of events in each category that meet the optional filter criteria.drsResponseStatus
- -- | The response status code.
data DescribeEventAggregatesResponse Source #
See: describeEventAggregatesResponse
smart constructor.
Response Lenses
drsNextToken :: Lens' DescribeEventAggregatesResponse (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.
drsEventAggregates :: Lens' DescribeEventAggregatesResponse [EventAggregate] Source #
The number of events in each category that meet the optional filter criteria.
drsResponseStatus :: Lens' DescribeEventAggregatesResponse Int Source #
- - | The response status code.