| 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.DescribeEventAggregates
Description
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.
This API operation uses pagination. Specify the nextToken parameter in
the next request to return more results.
This operation returns paginated results.
Synopsis
- data DescribeEventAggregates = DescribeEventAggregates' {}
- newDescribeEventAggregates :: EventAggregateField -> DescribeEventAggregates
- describeEventAggregates_nextToken :: Lens' DescribeEventAggregates (Maybe Text)
- describeEventAggregates_filter :: Lens' DescribeEventAggregates (Maybe EventFilter)
- describeEventAggregates_maxResults :: Lens' DescribeEventAggregates (Maybe Natural)
- describeEventAggregates_aggregateField :: Lens' DescribeEventAggregates EventAggregateField
- data DescribeEventAggregatesResponse = DescribeEventAggregatesResponse' {}
- newDescribeEventAggregatesResponse :: Int -> DescribeEventAggregatesResponse
- describeEventAggregatesResponse_nextToken :: Lens' DescribeEventAggregatesResponse (Maybe Text)
- describeEventAggregatesResponse_eventAggregates :: Lens' DescribeEventAggregatesResponse (Maybe [EventAggregate])
- describeEventAggregatesResponse_httpStatus :: Lens' DescribeEventAggregatesResponse Int
Creating a Request
data DescribeEventAggregates Source #
See: newDescribeEventAggregates smart constructor.
Constructors
| DescribeEventAggregates' | |
Fields
| |
Instances
newDescribeEventAggregates Source #
Arguments
| :: EventAggregateField | |
| -> DescribeEventAggregates |
Create a value of DescribeEventAggregates 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:DescribeEventAggregates', describeEventAggregates_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':DescribeEventAggregates', describeEventAggregates_filter - Values to narrow the results returned.
$sel:maxResults:DescribeEventAggregates', describeEventAggregates_maxResults - The maximum number of items to return in one batch, between 10 and 100,
inclusive.
$sel:aggregateField:DescribeEventAggregates', describeEventAggregates_aggregateField - The only currently supported value is eventTypeCategory.
Request Lenses
describeEventAggregates_nextToken :: 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.
describeEventAggregates_filter :: Lens' DescribeEventAggregates (Maybe EventFilter) Source #
Values to narrow the results returned.
describeEventAggregates_maxResults :: Lens' DescribeEventAggregates (Maybe Natural) Source #
The maximum number of items to return in one batch, between 10 and 100, inclusive.
describeEventAggregates_aggregateField :: Lens' DescribeEventAggregates EventAggregateField Source #
The only currently supported value is eventTypeCategory.
Destructuring the Response
data DescribeEventAggregatesResponse Source #
See: newDescribeEventAggregatesResponse smart constructor.
Constructors
| DescribeEventAggregatesResponse' | |
Fields
| |
Instances
newDescribeEventAggregatesResponse Source #
Create a value of DescribeEventAggregatesResponse 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:DescribeEventAggregates', describeEventAggregatesResponse_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:eventAggregates:DescribeEventAggregatesResponse', describeEventAggregatesResponse_eventAggregates - The number of events in each category that meet the optional filter
criteria.
$sel:httpStatus:DescribeEventAggregatesResponse', describeEventAggregatesResponse_httpStatus - The response's http status code.
Response Lenses
describeEventAggregatesResponse_nextToken :: 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.
describeEventAggregatesResponse_eventAggregates :: Lens' DescribeEventAggregatesResponse (Maybe [EventAggregate]) Source #
The number of events in each category that meet the optional filter criteria.
describeEventAggregatesResponse_httpStatus :: Lens' DescribeEventAggregatesResponse Int Source #
The response's http status code.