# Amazon Health examples using Amazon CLI
The following code examples show you how to perform actions and implement common scenarios by using the Amazon Command Line Interface with Amazon Health.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `describe-affected-entities`
The following code example shows how to use `describe-affected-entities`.
**Amazon CLI**
**To list the entities that are affected by a specified Amazon Health event**
The following `describe-affected-entities` example lists the entities that are affected by the specified Amazon Health event. This event is a billing notification for the Amazon account.
```
aws health describe-affected-entities \
--filter "eventArns=arn:aws:health:global::event/BILLING/AWS_BILLING_NOTIFICATION/AWS_BILLING_NOTIFICATION_6ce1d874-e995-40e2-99cd-EXAMPLE11145" \
--region us-east-1
```
Output:
```
{
"entities": [
{
"entityArn": "arn:aws:health:global:123456789012:entity/EXAMPLEimSMoULmWHpb",
"eventArn": "arn:aws:health:global::event/BILLING/AWS_BILLING_NOTIFICATION/AWS_BILLING_NOTIFICATION_6ce1d874-e995-40e2-99cd-EXAMPLE11145",
"entityValue": "AWS_ACCOUNT",
"awsAccountId": "123456789012",
"lastUpdatedTime": 1588356454.08
}
]
}
```
For more information, see [Event log](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html#event-log) in the *Amazon Health User Guide*.
+ For API details, see [DescribeAffectedEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/health/describe-affected-entities.html) in *Amazon CLI Command Reference*.
### `describe-event-details`
The following code example shows how to use `describe-event-details`.
**Amazon CLI**
**To list information about an Amazon Health event**
The following `describe-event-details` example lists information about the specified Amazon Health event.
```
aws health describe-event-details \
--event-arns "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_VKTXI_EXAMPLE111" \
--region us-east-1
```
Output:
```
{
"successfulSet": [
{
"event": {
"arn": "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_VKTXI_EXAMPLE111",
"service": "EC2",
"eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE",
"eventTypeCategory": "issue",
"region": "us-east-1",
"startTime": 1587462325.096,
"endTime": 1587464204.774,
"lastUpdatedTime": 1587464204.865,
"statusCode": "closed"
},
"eventDescription": {
"latestDescription": "[RESOLVED] Increased API Error Rates and Latencies\n\n[02:45 AM PDT] We are investigating increased API error rates and latencies in the US-EAST-1 Region.\n\n[03:16 AM PDT] Between 2:10 AM and 2:59 AM PDT we experienced increased API error rates and latencies in the US-EAST-1 Region. The issue has been resolved and the service is operating normally."
}
}
],
"failedSet": []
}
```
For more information, see [Event details pane](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html#event-details) in the *Amazon Health User Guide*.
+ For API details, see [DescribeEventDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/health/describe-event-details.html) in *Amazon CLI Command Reference*.
### `describe-events`
The following code example shows how to use `describe-events`.
**Amazon CLI**
**Example 1: To list Amazon Health events**
The following `describe-events` example lists recent Amazon Health events.
```
aws health describe-events \
--region us-east-1
```
Output:
```
{
"events": [
{
"arn": "arn:aws:health:us-west-1::event/ECS/AWS_ECS_OPERATIONAL_ISSUE/AWS_ECS_OPERATIONAL_ISSUE_KWQPY_EXAMPLE111",
"service": "ECS",
"eventTypeCode": "AWS_ECS_OPERATIONAL_ISSUE",
"eventTypeCategory": "issue",
"region": "us-west-1",
"startTime": 1589077890.53,
"endTime": 1589086345.597,
"lastUpdatedTime": 1589086345.905,
"statusCode": "closed",
"eventScopeCode": "PUBLIC"
},
{
"arn": "arn:aws:health:global::event/BILLING/AWS_BILLING_NOTIFICATION/AWS_BILLING_NOTIFICATION_6ce1d874-e995-40e2-99cd-EXAMPLE1118b",
"service": "BILLING",
"eventTypeCode": "AWS_BILLING_NOTIFICATION",
"eventTypeCategory": "accountNotification",
"region": "global",
"startTime": 1588356000.0,
"lastUpdatedTime": 1588356524.358,
"statusCode": "open",
"eventScopeCode": "ACCOUNT_SPECIFIC"
},
{
"arn": "arn:aws:health:us-west-2::event/CLOUDFORMATION/AWS_CLOUDFORMATION_OPERATIONAL_ISSUE/AWS_CLOUDFORMATION_OPERATIONAL_ISSUE_OHTWY_EXAMPLE111",
"service": "CLOUDFORMATION",
"eventTypeCode": "AWS_CLOUDFORMATION_OPERATIONAL_ISSUE",
"eventTypeCategory": "issue",
"region": "us-west-2",
"startTime": 1588279630.761,
"endTime": 1588284650.0,
"lastUpdatedTime": 1588284691.941,
"statusCode": "closed",
"eventScopeCode": "PUBLIC"
},
{
"arn": "arn:aws:health:ap-northeast-1::event/LAMBDA/AWS_LAMBDA_OPERATIONAL_ISSUE/AWS_LAMBDA_OPERATIONAL_ISSUE_JZDND_EXAMPLE111",
"service": "LAMBDA",
"eventTypeCode": "AWS_LAMBDA_OPERATIONAL_ISSUE",
"eventTypeCategory": "issue",
"region": "ap-northeast-1",
"startTime": 1587379534.08,
"endTime": 1587391771.0,
"lastUpdatedTime": 1587395689.316,
"statusCode": "closed",
"eventScopeCode": "PUBLIC"
},
{
"arn": "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_COBXJ_EXAMPLE111",
"service": "EC2",
"eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE",
"eventTypeCategory": "issue",
"region": "us-east-1",
"startTime": 1586473044.284,
"endTime": 1586479706.091,
"lastUpdatedTime": 1586479706.153,
"statusCode": "closed",
"eventScopeCode": "PUBLIC"
},
{
"arn": "arn:aws:health:global::event/SECURITY/AWS_SECURITY_NOTIFICATION/AWS_SECURITY_NOTIFICATION_42007387-8129-42da-8c88-EXAMPLE11139",
"service": "SECURITY",
"eventTypeCode": "AWS_SECURITY_NOTIFICATION",
"eventTypeCategory": "accountNotification",
"region": "global",
"startTime": 1585674000.0,
"lastUpdatedTime": 1585674004.132,
"statusCode": "open",
"eventScopeCode": "PUBLIC"
},
{
"arn": "arn:aws:health:global::event/CLOUDFRONT/AWS_CLOUDFRONT_OPERATIONAL_ISSUE/AWS_CLOUDFRONT_OPERATIONAL_ISSUE_FRQXG_EXAMPLE111",
"service": "CLOUDFRONT",
"eventTypeCode": "AWS_CLOUDFRONT_OPERATIONAL_ISSUE",
"eventTypeCategory": "issue",
"region": "global",
"startTime": 1585610898.589,
"endTime": 1585617671.0,
"lastUpdatedTime": 1585620638.869,
"statusCode": "closed",
"eventScopeCode": "PUBLIC"
},
{
"arn": "arn:aws:health:us-east-1::event/SES/AWS_SES_OPERATIONAL_ISSUE/AWS_SES_OPERATIONAL_ISSUE_URNDF_EXAMPLE111",
"service": "SES",
"eventTypeCode": "AWS_SES_OPERATIONAL_ISSUE",
"eventTypeCategory": "issue",
"region": "us-east-1",
"startTime": 1585342008.46,
"endTime": 1585344017.0,
"lastUpdatedTime": 1585344355.989,
"statusCode": "closed",
"eventScopeCode": "PUBLIC"
},
{
"arn": "arn:aws:health:global::event/IAM/AWS_IAM_OPERATIONAL_NOTIFICATION/AWS_IAM_OPERATIONAL_NOTIFICATION_b6771c34-6ecd-4aea-9d3e-EXAMPLE1117e",
"service": "IAM",
"eventTypeCode": "AWS_IAM_OPERATIONAL_NOTIFICATION",
"eventTypeCategory": "accountNotification",
"region": "global",
"startTime": 1584978300.0,
"lastUpdatedTime": 1584978553.572,
"statusCode": "open",
"eventScopeCode": "ACCOUNT_SPECIFIC"
},
{
"arn": "arn:aws:health:ap-southeast-2::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_HNGHE_EXAMPLE111",
"service": "EC2",
"eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE",
"eventTypeCategory": "issue",
"region": "ap-southeast-2",
"startTime": 1583881487.483,
"endTime": 1583885056.785,
"lastUpdatedTime": 1583885057.052,
"statusCode": "closed",
"eventScopeCode": "PUBLIC"
}
]
}
```
For more information, see [Getting started with the Amazon Personal Health Dashboard](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html) in the *Amazon Health User Guide*.
**Example 2: To list Amazon Health events by service and event status code**
The following `describe-events` example lists Amazon Health events for Amazon Elastic Compute Cloud (Amazon EC2) where the event status is closed.
```
aws health describe-events \
--filter "services=EC2,eventStatusCodes=closed"
```
Output:
```
{
"events": [
{
"arn": "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_VKTXI_EXAMPLE111",
"service": "EC2",
"eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE",
"eventTypeCategory": "issue",
"region": "us-east-1",
"startTime": 1587462325.096,
"endTime": 1587464204.774,
"lastUpdatedTime": 1587464204.865,
"statusCode": "closed",
"eventScopeCode": "PUBLIC"
},
{
"arn": "arn:aws:health:us-east-1::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_COBXJ_EXAMPLE111",
"service": "EC2",
"eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE",
"eventTypeCategory": "issue",
"region": "us-east-1",
"startTime": 1586473044.284,
"endTime": 1586479706.091,
"lastUpdatedTime": 1586479706.153,
"statusCode": "closed",
"eventScopeCode": "PUBLIC"
},
{
"arn": "arn:aws:health:ap-southeast-2::event/EC2/AWS_EC2_OPERATIONAL_ISSUE/AWS_EC2_OPERATIONAL_ISSUE_HNGHE_EXAMPLE111",
"service": "EC2",
"eventTypeCode": "AWS_EC2_OPERATIONAL_ISSUE",
"eventTypeCategory": "issue",
"region": "ap-southeast-2",
"startTime": 1583881487.483,
"endTime": 1583885056.785,
"lastUpdatedTime": 1583885057.052,
"statusCode": "closed",
"eventScopeCode": "PUBLIC"
}
]
}
```
For more information, see [Getting started with the Amazon Personal Health Dashboard](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html) in the *Amazon Health User Guide*.
+ For API details, see [DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/health/describe-events.html) in *Amazon CLI Command Reference*.