health_describe_event_types: Returns the event types that meet the specified filter...

Description Usage Arguments Value Request syntax

View source: R/health_operations.R

Description

Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Usage

1
health_describe_event_types(filter, locale, nextToken, maxResults)

Arguments

filter

Values to narrow the results returned.

locale

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

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 10 and 100, inclusive.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
list(
  eventTypes = list(
    list(
      service = "string",
      code = "string",
      category = "issue"|"accountNotification"|"scheduledChange"|"investigation"
    )
  ),
  nextToken = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
svc$describe_event_types(
  filter = list(
    eventTypeCodes = list(
      "string"
    ),
    services = list(
      "string"
    ),
    eventTypeCategories = list(
      "issue"|"accountNotification"|"scheduledChange"|"investigation"
    )
  ),
  locale = "string",
  nextToken = "string",
  maxResults = 123
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.