import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeAffectedEntitiesRequest, DescribeAffectedEntitiesResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeAffectedEntitiesCommand}. */ export interface DescribeAffectedEntitiesCommandInput extends DescribeAffectedEntitiesRequest { } /** * @public * * The output of {@link DescribeAffectedEntitiesCommand}. */ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedEntitiesResponse, __MetadataBearer { } declare const DescribeAffectedEntitiesCommand_base: { new (input: DescribeAffectedEntitiesCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeAffectedEntitiesCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns a list of entities that have been affected by the specified events, based on the * specified filter criteria. Entities can refer to individual customer resources, groups of * customer resources, or any other construct, depending on the Amazon Web Services service. Events that * have impact beyond that of the affected entities, or where the extent of impact is unknown, * include at least one entity indicating this.

*

At least one event ARN is required.

* *
    *
  • *

    This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

    *
  • *
  • *

    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 * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { HealthClient, DescribeAffectedEntitiesCommand } from "@aws-sdk/client-health"; // ES Modules import * // const { HealthClient, DescribeAffectedEntitiesCommand } = 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 = { // DescribeAffectedEntitiesRequest * filter: { // EntityFilter * eventArns: [ // eventArnList // required * "STRING_VALUE", * ], * entityArns: [ // entityArnList * "STRING_VALUE", * ], * entityValues: [ // entityValueList * "STRING_VALUE", * ], * lastUpdatedTimes: [ // dateTimeRangeList * { // DateTimeRange * from: new Date("TIMESTAMP"), * to: new Date("TIMESTAMP"), * }, * ], * tags: [ // tagFilter * { // tagSet * "": "STRING_VALUE", * }, * ], * statusCodes: [ // entityStatusCodeList * "IMPAIRED" || "UNIMPAIRED" || "UNKNOWN" || "PENDING" || "RESOLVED", * ], * }, * locale: "STRING_VALUE", * nextToken: "STRING_VALUE", * maxResults: Number("int"), * }; * const command = new DescribeAffectedEntitiesCommand(input); * const response = await client.send(command); * // { // DescribeAffectedEntitiesResponse * // entities: [ // EntityList * // { // AffectedEntity * // entityArn: "STRING_VALUE", * // eventArn: "STRING_VALUE", * // entityValue: "STRING_VALUE", * // entityUrl: "STRING_VALUE", * // awsAccountId: "STRING_VALUE", * // lastUpdatedTime: new Date("TIMESTAMP"), * // statusCode: "IMPAIRED" || "UNIMPAIRED" || "UNKNOWN" || "PENDING" || "RESOLVED", * // tags: { // tagSet * // "": "STRING_VALUE", * // }, * // entityMetadata: { // entityMetadata * // "": "STRING_VALUE", * // }, * // }, * // ], * // nextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeAffectedEntitiesCommandInput - {@link DescribeAffectedEntitiesCommandInput} * @returns {@link DescribeAffectedEntitiesCommandOutput} * @see {@link DescribeAffectedEntitiesCommandInput} for command's `input` shape. * @see {@link DescribeAffectedEntitiesCommandOutput} 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 DescribeAffectedEntitiesCommand extends DescribeAffectedEntitiesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeAffectedEntitiesRequest; output: DescribeAffectedEntitiesResponse; }; sdk: { input: DescribeAffectedEntitiesCommandInput; output: DescribeAffectedEntitiesCommandOutput; }; }; }