| 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.DescribeEventTypes
Description
Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the AWS Health event, such as the category, AWS service, and event code. The metadata for each event appears in the EventType object.
If you don't specify a filter criteria, the API operation returns all event types, in no particular order.
This API operation uses pagination. Specify the nextToken parameter in
the next request to return more results.
This operation returns paginated results.
Synopsis
- data DescribeEventTypes = DescribeEventTypes' {}
- newDescribeEventTypes :: DescribeEventTypes
- describeEventTypes_locale :: Lens' DescribeEventTypes (Maybe Text)
- describeEventTypes_nextToken :: Lens' DescribeEventTypes (Maybe Text)
- describeEventTypes_filter :: Lens' DescribeEventTypes (Maybe EventTypeFilter)
- describeEventTypes_maxResults :: Lens' DescribeEventTypes (Maybe Natural)
- data DescribeEventTypesResponse = DescribeEventTypesResponse' {
- eventTypes :: Maybe [EventType]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeEventTypesResponse :: Int -> DescribeEventTypesResponse
- describeEventTypesResponse_eventTypes :: Lens' DescribeEventTypesResponse (Maybe [EventType])
- describeEventTypesResponse_nextToken :: Lens' DescribeEventTypesResponse (Maybe Text)
- describeEventTypesResponse_httpStatus :: Lens' DescribeEventTypesResponse Int
Creating a Request
data DescribeEventTypes Source #
See: newDescribeEventTypes smart constructor.
Constructors
| DescribeEventTypes' | |
Fields
| |
Instances
newDescribeEventTypes :: DescribeEventTypes Source #
Create a value of DescribeEventTypes 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:DescribeEventTypes', describeEventTypes_locale - The locale (language) to return information in. English (en) is the
default and the only supported value at this time.
$sel:nextToken:DescribeEventTypes', describeEventTypes_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':DescribeEventTypes', describeEventTypes_filter - Values to narrow the results returned.
$sel:maxResults:DescribeEventTypes', describeEventTypes_maxResults - The maximum number of items to return in one batch, between 10 and 100,
inclusive.
Request Lenses
describeEventTypes_locale :: Lens' DescribeEventTypes (Maybe Text) Source #
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
describeEventTypes_nextToken :: Lens' DescribeEventTypes (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.
describeEventTypes_filter :: Lens' DescribeEventTypes (Maybe EventTypeFilter) Source #
Values to narrow the results returned.
describeEventTypes_maxResults :: Lens' DescribeEventTypes (Maybe Natural) Source #
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Destructuring the Response
data DescribeEventTypesResponse Source #
See: newDescribeEventTypesResponse smart constructor.
Constructors
| DescribeEventTypesResponse' | |
Fields
| |
Instances
newDescribeEventTypesResponse Source #
Create a value of DescribeEventTypesResponse 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:eventTypes:DescribeEventTypesResponse', describeEventTypesResponse_eventTypes - A list of event types that match the filter criteria. Event types have a
category (issue, accountNotification, or scheduledChange), a
service (for example, EC2, RDS, DATAPIPELINE, BILLING), and a
code (in the format AWS_SERVICE_DESCRIPTION ; for example,
AWS_EC2_SYSTEM_MAINTENANCE_EVENT).
$sel:nextToken:DescribeEventTypes', describeEventTypesResponse_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:httpStatus:DescribeEventTypesResponse', describeEventTypesResponse_httpStatus - The response's http status code.
Response Lenses
describeEventTypesResponse_eventTypes :: Lens' DescribeEventTypesResponse (Maybe [EventType]) Source #
A list of event types that match the filter criteria. Event types have a
category (issue, accountNotification, or scheduledChange), a
service (for example, EC2, RDS, DATAPIPELINE, BILLING), and a
code (in the format AWS_SERVICE_DESCRIPTION ; for example,
AWS_EC2_SYSTEM_MAINTENANCE_EVENT).
describeEventTypesResponse_nextToken :: Lens' DescribeEventTypesResponse (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.
describeEventTypesResponse_httpStatus :: Lens' DescribeEventTypesResponse Int Source #
The response's http status code.