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

Calls the AWS Health DescribeEvents API operation.

Syntax

Get-HLTHEvent
-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[]>
-Locale <String>
-Filter_Region <String[]>
-Filter_Service <String[]>
-Filter_StartTime <DateTimeRange[]>
-Filter_Tag <Hashtable[]>
-MaxResult <Int32>
-NextToken <String>
-Select <String>
-NoAutoIteration <SwitchParameter>

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.

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.

Parameters

-Filter_AvailabilityZone <String[]>
A list of AWS availability zones.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilter_AvailabilityZones
-Filter_EndTime <DateTimeRange[]>
A list of dates and times that the event ended.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilter_EndTimes
-Filter_EntityArn <String[]>
A list of entity ARNs (unique identifiers).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilter_EntityArns
-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?True (ByPropertyName)
AliasesFilter_EntityValues
-Filter_EventArn <String[]>
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"
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilter_EventArns
-Filter_EventStatusCode <String[]>
A list of event status codes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilter_EventStatusCodes
-Filter_EventTypeCategory <String[]>
A list of event type category codes (issue, scheduledChange, or accountNotification).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilter_EventTypeCategories
-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?True (ByPropertyName)
AliasesFilter_EventTypeCodes
-Filter_LastUpdatedTime <DateTimeRange[]>
A list of dates and times that the event was last updated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilter_LastUpdatedTimes
-Filter_Region <String[]>
A list of AWS regions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilter_Regions
-Filter_Service <String[]>
The AWS services associated with the event. For example, EC2, RDS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilter_Services
-Filter_StartTime <DateTimeRange[]>
A list of dates and times that the event began.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilter_StartTimes
-Filter_Tag <Hashtable[]>
A map of entity tags attached to the affected entity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilter_Tags
-Locale <String>
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxResult <Int32>
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet.
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call.
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxItems, MaxResults
-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.
In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NoAutoIteration <SwitchParameter>
By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Events'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSHealth.Model.DescribeEventsResponse). Specifying the name of a property of type Amazon.AWSHealth.Model.DescribeEventsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a collection of Amazon.AWSHealth.Model.Event objects. The service call response (type Amazon.AWSHealth.Model.DescribeEventsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\>Get-HLTHEvent -Region us-east-1 -Filter_Region "eu-west-2","us-west-2" -Filter_StartTime @{from="3/14/2019 6:30:00AM";to="3/15/2019 5:00:00PM"} -Filter_EndTime @{from="3/21/2019 7:00:00AM";to="3/21/2019 5:00:00PM"}

Arn : arn:aws:health:us-west-2::event/RDS/AWS_RDS_HARDWARE_MAINTENANCE_SCHEDULED/AWS_RDS_HARDWARE_MAINTENANCE_SCHEDULED_USW2_20190314_20190321
AvailabilityZone :
EndTime : 3/21/2019 2:00:00 PM
EventTypeCategory : scheduledChange
EventTypeCode : AWS_RDS_HARDWARE_MAINTENANCE_SCHEDULED
LastUpdatedTime : 2/28/2019 2:26:07 PM
Region : us-west-2
Service : RDS
StartTime : 3/14/2019 2:00:00 PM
StatusCode : open
This command returns events from AWS Personal Health Dashboard. The user adds the -Region parameter to see events available to the service in the US East (N. Virginia) Region, but the -Filter_Region parameter filters for events that are logged in the EU (London) and US West (Oregon) Regions (eu-west-2 and us-west-2). The -Filter_StartTime parameter filters for a range of times that events can start, while the -Filter_EndTime parameter filters for a range of times that events can end. The result is a scheduled maintenance event for RDS that starts within the specified -Filter_StartTime range, and ends within the scheduled -Filter_EndTime range.

Supported Version

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