- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeEventDetailsCommand
Returns detailed information about one or more specified events. Information includes standard event data (Amazon Web Services 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.
This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { HealthClient, DescribeEventDetailsCommand } from "@aws-sdk/client-health"; // ES Modules import
// const { HealthClient, DescribeEventDetailsCommand } = require("@aws-sdk/client-health"); // CommonJS import
const client = new HealthClient(config);
const input = { // DescribeEventDetailsRequest
eventArns: [ // eventArnList // required
"STRING_VALUE",
],
locale: "STRING_VALUE",
};
const command = new DescribeEventDetailsCommand(input);
const response = await client.send(command);
// { // DescribeEventDetailsResponse
// successfulSet: [ // DescribeEventDetailsSuccessfulSet
// { // EventDetails
// event: { // Event
// arn: "STRING_VALUE",
// service: "STRING_VALUE",
// eventTypeCode: "STRING_VALUE",
// eventTypeCategory: "issue" || "accountNotification" || "scheduledChange" || "investigation",
// region: "STRING_VALUE",
// availabilityZone: "STRING_VALUE",
// startTime: new Date("TIMESTAMP"),
// endTime: new Date("TIMESTAMP"),
// lastUpdatedTime: new Date("TIMESTAMP"),
// statusCode: "open" || "closed" || "upcoming",
// eventScopeCode: "PUBLIC" || "ACCOUNT_SPECIFIC" || "NONE",
// },
// eventDescription: { // EventDescription
// latestDescription: "STRING_VALUE",
// },
// eventMetadata: { // eventMetadata
// "<keys>": "STRING_VALUE",
// },
// },
// ],
// failedSet: [ // DescribeEventDetailsFailedSet
// { // EventDetailsErrorItem
// eventArn: "STRING_VALUE",
// errorName: "STRING_VALUE",
// errorMessage: "STRING_VALUE",
// },
// ],
// };
DescribeEventDetailsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
eventArns Required | string[] | undefined | A list of event ARNs (unique identifiers). For example: |
locale | string | undefined | The locale (language) to return information in. English (en) is the default and the only supported value at this time. |
DescribeEventDetailsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
failedSet | EventDetailsErrorItem[] | undefined | Error messages for any events that could not be retrieved. |
successfulSet | EventDetails[] | undefined | Information about the events that could be retrieved. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
UnsupportedLocale | client | The specified locale is not supported. |
HealthServiceException | Base exception class for all service exceptions from Health service. |