Skip to contents

Returns information about events that meet the specified filter criteria

Source: R/health_operations.R
health_describe_events.Rd

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 describe_event_details and describe_affected_entities operations.

See https://www.paws-r-sdk.com/docs/health_describe_events/ for full documentation.

Usage

health_describe_events(
  filter = NULL,
  nextToken = NULL,
  maxResults = NULL,
  locale = NULL
)

Arguments

filter

Values to narrow the results returned.

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.

maxResults

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

locale

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