AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the DescribeEventAggregates operation against AWS Health.

Syntax

Get-HLTHEventAggregate
-AggregateField <EventAggregateField>
-Filter_AvailabilityZone <String[]>
-Filter_EndTime <DateTimeRange[]>
-Filter_EntityArn <String[]>
-Filter_EntityValue <String[]>
-Filter_EventArn <String[]>
-Filter_EventStatusCode <String[]>
-Filter_EventTypeCategory <String[]>
-Filter_EventTypeCode <String[]>
-Filter_LastUpdatedTime <DateTimeRange[]>
-Filter_Region <String[]>
-Filter_Service <String[]>
-Filter_StartTime <DateTimeRange[]>
-Filter_Tag <Hashtable[]>
-MaxResult <Int32>
-NextToken <String>

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.

This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.

Parameters

-AggregateField <EventAggregateField>
The only currently supported value is eventTypeCategory.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-Filter_AvailabilityZone <String[]>
A list of AWS availability zones.
Required?False
Position?Named
Accept pipeline input?False
-Filter_EndTime <DateTimeRange[]>
A list of dates and times that the event ended.
Required?False
Position?Named
Accept pipeline input?False
-Filter_EntityArn <String[]>
A list of entity ARNs (unique identifiers).
Required?False
Position?Named
Accept pipeline input?False
-Filter_EntityValue <String[]>
A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
Required?False
Position?Named
Accept pipeline input?False
-Filter_EventArn <String[]>
A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331", "arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz"
Required?False
Position?Named
Accept pipeline input?False
-Filter_EventStatusCode <String[]>
A list of event status codes.
Required?False
Position?Named
Accept pipeline input?False
-Filter_EventTypeCategory <String[]>
A list of event type category codes (issue, scheduledChange, or accountNotification).
Required?False
Position?Named
Accept pipeline input?False
-Filter_EventTypeCode <String[]>
A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED"
Required?False
Position?Named
Accept pipeline input?False
-Filter_LastUpdatedTime <DateTimeRange[]>
A list of dates and times that the event was last updated.
Required?False
Position?Named
Accept pipeline input?False
-Filter_Region <String[]>
A list of AWS regions.
Required?False
Position?Named
Accept pipeline input?False
-Filter_Service <String[]>
The AWS services associated with the event. For example, EC2, RDS.
Required?False
Position?Named
Accept pipeline input?False
-Filter_StartTime <DateTimeRange[]>
A list of dates and times that the event began.
Required?False
Position?Named
Accept pipeline input?False
-Filter_Tag <Hashtable[]>
A map of entity tags attached to the affected entity.
Required?False
Position?Named
Accept pipeline input?False
-MaxResult <Int32>
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Required?False
Position?Named
Accept pipeline input?False
-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.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a EventAggregateField object to this cmdlet for the AggregateField parameter.

Outputs

This cmdlet returns a collection of EventAggregate objects. The service call response (type Amazon.AWSHealth.Model.DescribeEventAggregatesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack. Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)

Supported Version

AWS Tools for PowerShell: 2.x.y.z