AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . health ]

describe-event-aggregates

Description

Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.

Note

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

See also: AWS API Documentation

describe-event-aggregates is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: eventAggregates

Synopsis

  describe-event-aggregates
[--filter <value>]
--aggregate-field <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--filter (structure)

Values to narrow the results returned.

eventArns -> (list)

A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"

(string)

eventTypeCodes -> (list)

A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".

(string)

services -> (list)

The Amazon Web Services services associated with the event. For example, EC2 , RDS .

(string)

regions -> (list)

A list of Amazon Web Services Regions.

(string)

availabilityZones -> (list)

A list of Amazon Web Services Availability Zones.

(string)

startTimes -> (list)

A list of dates and times that the event began.

(structure)

A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp (startTime , endTime , or lastUpdatedTime ) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from . If from is not set and to is set: match items where the timestamp value is equal to or before to .

from -> (timestamp)

The starting date and time of a time range.

to -> (timestamp)

The ending date and time of a time range.

endTimes -> (list)

A list of dates and times that the event ended.

(structure)

A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp (startTime , endTime , or lastUpdatedTime ) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from . If from is not set and to is set: match items where the timestamp value is equal to or before to .

from -> (timestamp)

The starting date and time of a time range.

to -> (timestamp)

The ending date and time of a time range.

lastUpdatedTimes -> (list)

A list of dates and times that the event was last updated.

(structure)

A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp (startTime , endTime , or lastUpdatedTime ) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from . If from is not set and to is set: match items where the timestamp value is equal to or before to .

from -> (timestamp)

The starting date and time of a time range.

to -> (timestamp)

The ending date and time of a time range.

entityArns -> (list)

A list of entity ARNs (unique identifiers).

(string)

entityValues -> (list)

A list of entity identifiers, such as EC2 instance IDs (i-34ab692e ) or EBS volumes (vol-426ab23e ).

(string)

eventTypeCategories -> (list)

A list of event type category codes. Possible values are issue , accountNotification , or scheduledChange . Currently, the investigation value isn't supported at this time.

(string)

tags -> (list)

A map of entity tags attached to the affected entity.

Note

Currently, the tags property isn't supported.

(map)

key -> (string)

value -> (string)

eventStatusCodes -> (list)

A list of event status codes.

(string)

Shorthand Syntax:

eventArns=string,string,eventTypeCodes=string,string,services=string,string,regions=string,string,availabilityZones=string,string,startTimes=[{from=timestamp,to=timestamp},{from=timestamp,to=timestamp}],endTimes=[{from=timestamp,to=timestamp},{from=timestamp,to=timestamp}],lastUpdatedTimes=[{from=timestamp,to=timestamp},{from=timestamp,to=timestamp}],entityArns=string,string,entityValues=string,string,eventTypeCategories=string,string,tags=[{KeyName1=string,KeyName2=string},{KeyName1=string,KeyName2=string}],eventStatusCodes=string,string

JSON Syntax:

{
  "eventArns": ["string", ...],
  "eventTypeCodes": ["string", ...],
  "services": ["string", ...],
  "regions": ["string", ...],
  "availabilityZones": ["string", ...],
  "startTimes": [
    {
      "from": timestamp,
      "to": timestamp
    }
    ...
  ],
  "endTimes": [
    {
      "from": timestamp,
      "to": timestamp
    }
    ...
  ],
  "lastUpdatedTimes": [
    {
      "from": timestamp,
      "to": timestamp
    }
    ...
  ],
  "entityArns": ["string", ...],
  "entityValues": ["string", ...],
  "eventTypeCategories": ["issue"|"accountNotification"|"scheduledChange"|"investigation", ...],
  "tags": [
    {"string": "string"
      ...}
    ...
  ],
  "eventStatusCodes": ["open"|"closed"|"upcoming", ...]
}

--aggregate-field (string)

The only currently supported value is eventTypeCategory .

Possible values:

  • eventTypeCategory

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

eventAggregates -> (list)

The number of events in each category that meet the optional filter criteria.

(structure)

The number of events of each issue type. Returned by the DescribeEventAggregates operation.

aggregateValue -> (string)

The issue type for the associated count.

count -> (integer)

The number of events of the associated issue type.

nextToken -> (string)

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.