Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeEventDetails

Returns detailed information about one or more specified events. Information includes standard event data (AWS Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities operation.

If a specified event can't be retrieved, an error message is returned for that event.

Note

This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide.

Request Syntax


{
   "eventArns": [ "string" ],
   "locale": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

eventArns

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"

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Maximum length of 1600.

Pattern: arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\w-]+){3}

Required: Yes

locale

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 256.

Pattern: .{2,256}

Required: No

Response Syntax


{
   "failedSet": [ 
      { 
         "errorMessage": "string",
         "errorName": "string",
         "eventArn": "string"
      }
   ],
   "successfulSet": [ 
      { 
         "event": { 
            "arn": "string",
            "availabilityZone": "string",
            "endTime": number,
            "eventScopeCode": "string",
            "eventTypeCategory": "string",
            "eventTypeCode": "string",
            "lastUpdatedTime": number,
            "region": "string",
            "service": "string",
            "startTime": number,
            "statusCode": "string"
         },
         "eventDescription": { 
            "latestDescription": "string"
         },
         "eventMetadata": { 
            "string" : "string" 
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

failedSet

Error messages for any events that could not be retrieved.

Type: Array of EventDetailsErrorItem objects

successfulSet

Information about the events that could be retrieved.

Type: Array of EventDetails objects

Errors

For information about the errors that are common to all actions, see Common Errors.

UnsupportedLocale

The specified locale is not supported.

HTTP Status Code: 400