Skip to main content

events

Creates, updates, deletes, gets or lists an events resource.

Overview​

Nameevents
TypeResource
Idaws.health.events

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
actionabilitystringThe actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with INFORMATIONAL actionability are provided for awareness and do not require immediate action. (ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED, INFORMATIONAL)
arnstringThe unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format. For example, an event ARN might look like the following: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456 (pattern: <code>arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]:[^:]:event(?:/[\w-]+){3}</code>)
availability_zonestringThe Amazon Web Services Availability Zone of the event. For example, us-east-1a. (pattern: <code>[a-z]{2,4}-[0-9a-z-]{4,16}</code>)
end_timestring (date-time)The date and time that the event ended.
event_scope_codestringThis parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event. If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty. If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response. If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist. (PUBLIC, ACCOUNT_SPECIFIC, NONE)
event_type_categorystringA list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time. (issue, accountNotification, scheduledChange, investigation)
event_type_codestringThe unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. (pattern: <code>[a-zA-Z0-9_-]{3,100}</code>)
last_updated_timestring (date-time)The most recent date and time that the event was updated.
personasarrayA list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.
regionstringThe Amazon Web Services Region name of the event. (pattern: <code>[^:/]{2,25}</code>)
servicestringThe Amazon Web Services service that is affected by the event. For example, EC2, RDS. (pattern: <code>[^:/]{2,30}</code>)
start_timestring (date-time)The date and time that the event began.
status_codestringThe most recent status of the event. Possible values are open, closed, and upcoming. (open, closed, upcoming)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_eventsselectregionReturns 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 event. When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

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 event. When you call the DescribeEvents operation and specify an entity for the entityValues parameter, Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

SELECT
actionability,
arn,
availability_zone,
end_time,
event_scope_code,
event_type_category,
event_type_code,
last_updated_time,
personas,
region,
service,
start_time,
status_code
FROM aws.health.events
WHERE region = '{{ region }}' -- required
;
Last updated on