import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeEventsForOrganizationRequest, DescribeEventsForOrganizationResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeEventsForOrganizationCommand}. */ export interface DescribeEventsForOrganizationCommandInput extends DescribeEventsForOrganizationRequest { } /** * @public * * The output of {@link DescribeEventsForOrganizationCommand}. */ export interface DescribeEventsForOrganizationCommandOutput extends DescribeEventsForOrganizationResponse, __MetadataBearer { } declare const DescribeEventsForOrganizationCommand_base: { new (input: DescribeEventsForOrganizationCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeEventsForOrganizationCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns information about events across your organization in Organizations. You can use * thefilters parameter to specify the events that you want to return. Events * are returned in a summary form and don't include the affected accounts, detailed * description, any additional metadata that depends on the event type, or any affected * resources. To retrieve that information, use the following operations:

* *

If you don't specify a filter, the * DescribeEventsForOrganizations returns all events across your organization. * Results are sorted by lastModifiedTime, starting with the most recent event.

*

For more information about the different types of Health events, see Event.

*

Before you can call this operation, you must first enable Health to work with * Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's * management account.

* *

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, DescribeEventsForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import * // const { HealthClient, DescribeEventsForOrganizationCommand } = 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 = { // DescribeEventsForOrganizationRequest * filter: { // OrganizationEventFilter * actionabilities: [ // EventActionabilityList * "ACTION_REQUIRED" || "ACTION_MAY_BE_REQUIRED" || "INFORMATIONAL", * ], * eventTypeCodes: [ // eventTypeList2 * "STRING_VALUE", * ], * awsAccountIds: [ // awsAccountIdsList * "STRING_VALUE", * ], * services: [ // serviceList * "STRING_VALUE", * ], * regions: [ // regionList * "STRING_VALUE", * ], * startTime: { // DateTimeRange * from: new Date("TIMESTAMP"), * to: new Date("TIMESTAMP"), * }, * endTime: { * from: new Date("TIMESTAMP"), * to: new Date("TIMESTAMP"), * }, * lastUpdatedTime: { * from: new Date("TIMESTAMP"), * to: new Date("TIMESTAMP"), * }, * entityArns: [ // entityArnList * "STRING_VALUE", * ], * entityValues: [ // entityValueList * "STRING_VALUE", * ], * eventTypeCategories: [ // eventTypeCategoryList2 * "issue" || "accountNotification" || "scheduledChange" || "investigation", * ], * eventStatusCodes: [ // eventStatusCodeList * "open" || "closed" || "upcoming", * ], * personas: [ // EventPersonaList * "OPERATIONS" || "SECURITY" || "BILLING", * ], * }, * nextToken: "STRING_VALUE", * maxResults: Number("int"), * locale: "STRING_VALUE", * }; * const command = new DescribeEventsForOrganizationCommand(input); * const response = await client.send(command); * // { // DescribeEventsForOrganizationResponse * // events: [ // OrganizationEventList * // { // OrganizationEvent * // arn: "STRING_VALUE", * // service: "STRING_VALUE", * // eventTypeCode: "STRING_VALUE", * // eventTypeCategory: "issue" || "accountNotification" || "scheduledChange" || "investigation", * // eventScopeCode: "PUBLIC" || "ACCOUNT_SPECIFIC" || "NONE", * // region: "STRING_VALUE", * // startTime: new Date("TIMESTAMP"), * // endTime: new Date("TIMESTAMP"), * // lastUpdatedTime: new Date("TIMESTAMP"), * // statusCode: "open" || "closed" || "upcoming", * // actionability: "ACTION_REQUIRED" || "ACTION_MAY_BE_REQUIRED" || "INFORMATIONAL", * // personas: [ // EventPersonaList * // "OPERATIONS" || "SECURITY" || "BILLING", * // ], * // }, * // ], * // nextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeEventsForOrganizationCommandInput - {@link DescribeEventsForOrganizationCommandInput} * @returns {@link DescribeEventsForOrganizationCommandOutput} * @see {@link DescribeEventsForOrganizationCommandInput} for command's `input` shape. * @see {@link DescribeEventsForOrganizationCommandOutput} 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 DescribeEventsForOrganizationCommand extends DescribeEventsForOrganizationCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeEventsForOrganizationRequest; output: DescribeEventsForOrganizationResponse; }; sdk: { input: DescribeEventsForOrganizationCommandInput; output: DescribeEventsForOrganizationCommandOutput; }; }; }