Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AWSHealth.DescribeEventTypes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web Services 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' {
- filter' :: Maybe EventTypeFilter
- locale :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newDescribeEventTypes :: DescribeEventTypes
describeEventTypes_filter :: Lens' DescribeEventTypes (Maybe EventTypeFilter)
describeEventTypes_locale :: Lens' DescribeEventTypes (Maybe Text)
describeEventTypes_maxResults :: Lens' DescribeEventTypes (Maybe Natural)
describeEventTypes_nextToken :: Lens' DescribeEventTypes (Maybe Text)
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

filter' :: Maybe EventTypeFilter
Values to narrow the results returned.
locale :: Maybe Text
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
maxResults :: Maybe Natural
The maximum number of items to return in one batch, between 10 and 100, inclusive.
nextToken :: Maybe Text
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.

Instances

Instances details

ToJSON DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods toJSON :: DescribeEventTypes -> Value # toEncoding :: DescribeEventTypes -> Encoding # toJSONList :: [DescribeEventTypes] -> Value # toEncodingList :: [DescribeEventTypes] -> Encoding #
ToHeaders DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods toHeaders :: DescribeEventTypes -> [Header] #
ToPath DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods toPath :: DescribeEventTypes -> ByteString #
ToQuery DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods toQuery :: DescribeEventTypes -> QueryString #
AWSPager DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods page :: DescribeEventTypes -> AWSResponse DescribeEventTypes -> Maybe DescribeEventTypes #
AWSRequest DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Associated Types type AWSResponse DescribeEventTypes # Methods request :: (Service -> Service) -> DescribeEventTypes -> Request DescribeEventTypes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEventTypes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEventTypes))) #
Generic DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Associated Types type Rep DescribeEventTypes :: Type -> Type # Methods from :: DescribeEventTypes -> Rep DescribeEventTypes x # to :: Rep DescribeEventTypes x -> DescribeEventTypes #
Read DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods readsPrec :: Int -> ReadS DescribeEventTypes # readList :: ReadS [DescribeEventTypes] # readPrec :: ReadPrec DescribeEventTypes # readListPrec :: ReadPrec [DescribeEventTypes] #
Show DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods showsPrec :: Int -> DescribeEventTypes -> ShowS # show :: DescribeEventTypes -> String # showList :: [DescribeEventTypes] -> ShowS #
NFData DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods rnf :: DescribeEventTypes -> () #
Eq DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods (==) :: DescribeEventTypes -> DescribeEventTypes -> Bool # (/=) :: DescribeEventTypes -> DescribeEventTypes -> Bool #
Hashable DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods hashWithSalt :: Int -> DescribeEventTypes -> Int # hash :: DescribeEventTypes -> Int #
type AWSResponse DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes type AWSResponse DescribeEventTypes = DescribeEventTypesResponse
type Rep DescribeEventTypes Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes type Rep DescribeEventTypes = D1 ('MetaData "DescribeEventTypes" "Amazonka.AWSHealth.DescribeEventTypes" "amazonka-health-2.0-97kQZARXu4I8k4sVSmOp5K" 'False) (C1 ('MetaCons "DescribeEventTypes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventTypeFilter)) :: S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

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:filter':DescribeEventTypes', describeEventTypes_filter - Values to narrow the results returned.

$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:maxResults:DescribeEventTypes', describeEventTypes_maxResults - The maximum number of items to return in one batch, between 10 and 100, inclusive.

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.

Request Lenses

describeEventTypes_filter :: Lens' DescribeEventTypes (Maybe EventTypeFilter) Source #

Values to narrow the results returned.

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_maxResults :: Lens' DescribeEventTypes (Maybe Natural) Source #

The maximum number of items to return in one batch, between 10 and 100, inclusive.

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.

Destructuring the Response

data DescribeEventTypesResponse Source #

See: newDescribeEventTypesResponse smart constructor.

Constructors

DescribeEventTypesResponse'

Fields

eventTypes :: Maybe [EventType]
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).
nextToken :: Maybe Text
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeEventTypesResponse Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Associated Types type Rep DescribeEventTypesResponse :: Type -> Type # Methods from :: DescribeEventTypesResponse -> Rep DescribeEventTypesResponse x # to :: Rep DescribeEventTypesResponse x -> DescribeEventTypesResponse #
Read DescribeEventTypesResponse Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods readsPrec :: Int -> ReadS DescribeEventTypesResponse # readList :: ReadS [DescribeEventTypesResponse] # readPrec :: ReadPrec DescribeEventTypesResponse # readListPrec :: ReadPrec [DescribeEventTypesResponse] #
Show DescribeEventTypesResponse Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods showsPrec :: Int -> DescribeEventTypesResponse -> ShowS # show :: DescribeEventTypesResponse -> String # showList :: [DescribeEventTypesResponse] -> ShowS #
NFData DescribeEventTypesResponse Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods rnf :: DescribeEventTypesResponse -> () #
Eq DescribeEventTypesResponse Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes Methods (==) :: DescribeEventTypesResponse -> DescribeEventTypesResponse -> Bool # (/=) :: DescribeEventTypesResponse -> DescribeEventTypesResponse -> Bool #
type Rep DescribeEventTypesResponse Source #
Instance details Defined in Amazonka.AWSHealth.DescribeEventTypes type Rep DescribeEventTypesResponse = D1 ('MetaData "DescribeEventTypesResponse" "Amazonka.AWSHealth.DescribeEventTypes" "amazonka-health-2.0-97kQZARXu4I8k4sVSmOp5K" 'False) (C1 ('MetaCons "DescribeEventTypesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EventType])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventTypesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEventTypesResponse'`
-> DescribeEventTypesResponse

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).

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.