import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeAffectedEntitiesForOrganizationRequest, DescribeAffectedEntitiesForOrganizationResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeAffectedEntitiesForOrganizationCommand}. */ export interface DescribeAffectedEntitiesForOrganizationCommandInput extends DescribeAffectedEntitiesForOrganizationRequest { } /** * @public * * The output of {@link DescribeAffectedEntitiesForOrganizationCommand}. */ export interface DescribeAffectedEntitiesForOrganizationCommandOutput extends DescribeAffectedEntitiesForOrganizationResponse, __MetadataBearer { } declare const DescribeAffectedEntitiesForOrganizationCommand_base: { new (input: DescribeAffectedEntitiesForOrganizationCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeAffectedEntitiesForOrganizationCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns a list of entities that have been affected by one or more events for one or more * accounts in your organization in Organizations, based on the filter criteria. Entities can refer * to individual customer resources, groups of customer resources, or any other construct, * depending on the Amazon Web Services service.

*

At least one event Amazon Resource Name (ARN) and account ID are required.

*

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.

    *
  • *
  • *

    This operation doesn't support resource-level permissions. You can't 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, DescribeAffectedEntitiesForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import * // const { HealthClient, DescribeAffectedEntitiesForOrganizationCommand } = 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 = { // DescribeAffectedEntitiesForOrganizationRequest * organizationEntityFilters: [ // OrganizationEntityFiltersList * { // EventAccountFilter * eventArn: "STRING_VALUE", // required * awsAccountId: "STRING_VALUE", * }, * ], * locale: "STRING_VALUE", * nextToken: "STRING_VALUE", * maxResults: Number("int"), * organizationEntityAccountFilters: [ // OrganizationEntityAccountFiltersList * { // EntityAccountFilter * eventArn: "STRING_VALUE", // required * awsAccountId: "STRING_VALUE", * statusCodes: [ // entityStatusCodeList * "IMPAIRED" || "UNIMPAIRED" || "UNKNOWN" || "PENDING" || "RESOLVED", * ], * }, * ], * }; * const command = new DescribeAffectedEntitiesForOrganizationCommand(input); * const response = await client.send(command); * // { // DescribeAffectedEntitiesForOrganizationResponse * // 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", * // }, * // }, * // ], * // failedSet: [ // DescribeAffectedEntitiesForOrganizationFailedSet * // { // OrganizationAffectedEntitiesErrorItem * // awsAccountId: "STRING_VALUE", * // eventArn: "STRING_VALUE", * // errorName: "STRING_VALUE", * // errorMessage: "STRING_VALUE", * // }, * // ], * // nextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeAffectedEntitiesForOrganizationCommandInput - {@link DescribeAffectedEntitiesForOrganizationCommandInput} * @returns {@link DescribeAffectedEntitiesForOrganizationCommandOutput} * @see {@link DescribeAffectedEntitiesForOrganizationCommandInput} for command's `input` shape. * @see {@link DescribeAffectedEntitiesForOrganizationCommandOutput} 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 DescribeAffectedEntitiesForOrganizationCommand extends DescribeAffectedEntitiesForOrganizationCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeAffectedEntitiesForOrganizationRequest; output: DescribeAffectedEntitiesForOrganizationResponse; }; sdk: { input: DescribeAffectedEntitiesForOrganizationCommandInput; output: DescribeAffectedEntitiesForOrganizationCommandOutput; }; }; }