import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeEventsRequest, DescribeEventsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeEventsCommand}. */ export interface DescribeEventsCommandInput extends DescribeEventsRequest { } /** * @public * * The output of {@link DescribeEventsCommand}. */ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __MetadataBearer { } declare const DescribeEventsCommand_base: { new (input: DescribeEventsCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeEventsCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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.

    *
  • *
*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { HealthClient, DescribeEventsCommand } from "@aws-sdk/client-health"; // ES Modules import * // const { HealthClient, DescribeEventsCommand } = require("@aws-sdk/client-health"); // CommonJS import * // import type { HealthClientConfig } from "@aws-sdk/client-health"; * const config = {}; // type is HealthClientConfig * const client = new HealthClient(config); * const input = { // DescribeEventsRequest * filter: { // EventFilter * actionabilities: [ // EventActionabilityList * "ACTION_REQUIRED" || "ACTION_MAY_BE_REQUIRED" || "INFORMATIONAL", * ], * eventArns: [ // eventArnList * "STRING_VALUE", * ], * eventTypeCodes: [ // eventTypeList2 * "STRING_VALUE", * ], * services: [ // serviceList * "STRING_VALUE", * ], * regions: [ // regionList * "STRING_VALUE", * ], * availabilityZones: [ // availabilityZones * "STRING_VALUE", * ], * startTimes: [ // dateTimeRangeList * { // DateTimeRange * from: new Date("TIMESTAMP"), * to: new Date("TIMESTAMP"), * }, * ], * endTimes: [ * { * from: new Date("TIMESTAMP"), * to: new Date("TIMESTAMP"), * }, * ], * lastUpdatedTimes: [ * { * from: new Date("TIMESTAMP"), * to: new Date("TIMESTAMP"), * }, * ], * entityArns: [ // entityArnList * "STRING_VALUE", * ], * entityValues: [ // entityValueList * "STRING_VALUE", * ], * eventTypeCategories: [ // eventTypeCategoryList2 * "issue" || "accountNotification" || "scheduledChange" || "investigation", * ], * tags: [ // tagFilter * { // tagSet * "": "STRING_VALUE", * }, * ], * eventStatusCodes: [ // eventStatusCodeList * "open" || "closed" || "upcoming", * ], * personas: [ // EventPersonaList * "OPERATIONS" || "SECURITY" || "BILLING", * ], * }, * nextToken: "STRING_VALUE", * maxResults: Number("int"), * locale: "STRING_VALUE", * }; * const command = new DescribeEventsCommand(input); * const response = await client.send(command); * // { // DescribeEventsResponse * // events: [ // EventList * // { // 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", * // actionability: "ACTION_REQUIRED" || "ACTION_MAY_BE_REQUIRED" || "INFORMATIONAL", * // personas: [ // EventPersonaList * // "OPERATIONS" || "SECURITY" || "BILLING", * // ], * // }, * // ], * // nextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeEventsCommandInput - {@link DescribeEventsCommandInput} * @returns {@link DescribeEventsCommandOutput} * @see {@link DescribeEventsCommandInput} for command's `input` shape. * @see {@link DescribeEventsCommandOutput} for command's `response` shape. * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape. * * @throws {@link InvalidPaginationToken} (client fault) *

The specified pagination token (nextToken) is not valid.

* * @throws {@link UnsupportedLocale} (client fault) *

The specified locale is not supported.

* * @throws {@link HealthServiceException} *

Base exception class for all service exceptions from Health service.

* * * @public */ export declare class DescribeEventsCommand extends DescribeEventsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeEventsRequest; output: DescribeEventsResponse; }; sdk: { input: DescribeEventsCommandInput; output: DescribeEventsCommandOutput; }; }; }