libZSservicesZSamazonka-healthZSamazonka-health
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AWSHealth.DescribeEvents

Description

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

  • When you call the DescribeEvents operation and specify an entity for the entityValues parameter, AWS Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event.
  • This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeEvents Source #

See: newDescribeEvents smart constructor.

Constructors

DescribeEvents' 

Fields

  • locale :: Maybe Text

    The locale (language) to return information in. English (en) is the default and the only supported value at this time.

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

  • filter' :: Maybe EventFilter

    Values to narrow the results returned.

  • maxResults :: Maybe Natural

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

Instances

Instances details
Eq DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

Read DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

Show DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

Generic DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

Associated Types

type Rep DescribeEvents :: Type -> Type #

NFData DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

Methods

rnf :: DescribeEvents -> () #

Hashable DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

ToJSON DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

AWSPager DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

AWSRequest DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

Associated Types

type AWSResponse DescribeEvents #

ToHeaders DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

ToPath DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

ToQuery DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

type Rep DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

type Rep DescribeEvents = D1 ('MetaData "DescribeEvents" "Amazonka.AWSHealth.DescribeEvents" "libZSservicesZSamazonka-healthZSamazonka-health" 'False) (C1 ('MetaCons "DescribeEvents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "locale") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse DescribeEvents Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

newDescribeEvents :: DescribeEvents Source #

Create a value of DescribeEvents 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:DescribeEvents', describeEvents_locale - The locale (language) to return information in. English (en) is the default and the only supported value at this time.

$sel:nextToken:DescribeEvents', describeEvents_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':DescribeEvents', describeEvents_filter - Values to narrow the results returned.

$sel:maxResults:DescribeEvents', describeEvents_maxResults - The maximum number of items to return in one batch, between 10 and 100, inclusive.

Request Lenses

describeEvents_locale :: 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.

describeEvents_nextToken :: 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.

describeEvents_filter :: Lens' DescribeEvents (Maybe EventFilter) Source #

Values to narrow the results returned.

describeEvents_maxResults :: Lens' DescribeEvents (Maybe Natural) Source #

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

Destructuring the Response

data DescribeEventsResponse Source #

See: newDescribeEventsResponse smart constructor.

Constructors

DescribeEventsResponse' 

Fields

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

  • events :: Maybe [Event]

    The events that match the specified filter criteria.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

Read DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

Show DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

Generic DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

Associated Types

type Rep DescribeEventsResponse :: Type -> Type #

NFData DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

Methods

rnf :: DescribeEventsResponse -> () #

type Rep DescribeEventsResponse Source # 
Instance details

Defined in Amazonka.AWSHealth.DescribeEvents

type Rep DescribeEventsResponse = D1 ('MetaData "DescribeEventsResponse" "Amazonka.AWSHealth.DescribeEvents" "libZSservicesZSamazonka-healthZSamazonka-health" 'False) (C1 ('MetaCons "DescribeEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "events") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Event])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEventsResponse Source #

Create a value of DescribeEventsResponse 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:DescribeEvents', describeEventsResponse_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:events:DescribeEventsResponse', describeEventsResponse_events - The events that match the specified filter criteria.

$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.

Response Lenses

describeEventsResponse_nextToken :: 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.

describeEventsResponse_events :: Lens' DescribeEventsResponse (Maybe [Event]) Source #

The events that match the specified filter criteria.