@aws-sdk/client-health 3.36.0 → 3.39.0

package/dist-types/ts3.4/commands/DescribeEventsForOrganizationCommand.d.ts

@@ -6,60 +6,11 @@ export interface DescribeEventsForOrganizationCommandInput extends DescribeEvent
 }
 export interface DescribeEventsForOrganizationCommandOutput extends DescribeEventsForOrganizationResponse, __MetadataBearer {
 }
-/**
- * <p>Returns information about events across your organization in AWS Organizations. You can use
- *             the<code>filters</code> 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:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedAccountsForOrganization.html">DescribeAffectedAccountsForOrganization</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html">DescribeEventDetailsForOrganization</a>
- *                </p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html">DescribeAffectedEntitiesForOrganization</a>
- *                </p>
- *             </li>
- *          </ul>
- *          <p>If you don't specify a <code>filter</code>, the
- *             <code>DescribeEventsForOrganizations</code> returns all events across your organization.
- *          Results are sorted by <code>lastModifiedTime</code>, starting with the most recent event. </p>
- *          <p>For more information about the different types of AWS Health events, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
- *          <p>Before you can call this operation, you must first enable AWS Health to work with
- *          AWS Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
- *          management account.</p>
- *          <note>
- *             <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
- *          </note>
- * @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
- * const client = new HealthClient(config);
- * const command = new DescribeEventsForOrganizationCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link DescribeEventsForOrganizationCommandInput} for command's `input` shape.
- * @see {@link DescribeEventsForOrganizationCommandOutput} for command's `response` shape.
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class DescribeEventsForOrganizationCommand extends $Command<DescribeEventsForOrganizationCommandInput, DescribeEventsForOrganizationCommandOutput, HealthClientResolvedConfig> {
     readonly input: DescribeEventsForOrganizationCommandInput;
     constructor(input: DescribeEventsForOrganizationCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventsForOrganizationCommandInput, DescribeEventsForOrganizationCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/DescribeHealthServiceStatusForOrganizationCommand.d.ts

@@ -6,32 +6,11 @@ export interface DescribeHealthServiceStatusForOrganizationCommandInput {
 }
 export interface DescribeHealthServiceStatusForOrganizationCommandOutput extends DescribeHealthServiceStatusForOrganizationResponse, __MetadataBearer {
 }
-/**
- * <p>This operation provides status information on enabling or disabling AWS Health to work
- *          with your organization. To call this operation, you must sign in as an IAM user, assume
- *          an IAM role, or sign in as the root user (not recommended) in the organization's
- *          management account.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { HealthClient, DescribeHealthServiceStatusForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import
- * // const { HealthClient, DescribeHealthServiceStatusForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import
- * const client = new HealthClient(config);
- * const command = new DescribeHealthServiceStatusForOrganizationCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link DescribeHealthServiceStatusForOrganizationCommandInput} for command's `input` shape.
- * @see {@link DescribeHealthServiceStatusForOrganizationCommandOutput} for command's `response` shape.
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class DescribeHealthServiceStatusForOrganizationCommand extends $Command<DescribeHealthServiceStatusForOrganizationCommandInput, DescribeHealthServiceStatusForOrganizationCommandOutput, HealthClientResolvedConfig> {
     readonly input: DescribeHealthServiceStatusForOrganizationCommandInput;
     constructor(input: DescribeHealthServiceStatusForOrganizationCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeHealthServiceStatusForOrganizationCommandInput, DescribeHealthServiceStatusForOrganizationCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/DisableHealthServiceAccessForOrganizationCommand.d.ts

@@ -5,43 +5,11 @@ export interface DisableHealthServiceAccessForOrganizationCommandInput {
 }
 export interface DisableHealthServiceAccessForOrganizationCommandOutput extends __MetadataBearer {
 }
-/**
- * <p>Disables AWS Health from working with AWS Organizations. To call this operation, you must sign
- *          in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not
- *          recommended) in the organization's management account. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
- *             AWS Health events</a> in the
- *             <i>AWS Health User Guide</i>.</p>
- *          <p>This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or AWS Command Line Interface (AWS CLI) to
- *          remove the service-linked role. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role">Deleting a Service-Linked Role</a> in the
- *          <i>IAM User Guide</i>.</p>
- *          <note>
- *             <p>You can also disable the organizational feature by using the Organizations <a href="https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html">DisableAWSServiceAccess</a> API operation. After you call this operation,
- *             AWS Health stops aggregating events for all other AWS accounts in your organization.
- *             If you call the AWS Health API operations for organizational view, AWS Health returns
- *             an error. AWS Health continues to aggregate health events for your AWS
- *             account.</p>
- *          </note>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { HealthClient, DisableHealthServiceAccessForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import
- * // const { HealthClient, DisableHealthServiceAccessForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import
- * const client = new HealthClient(config);
- * const command = new DisableHealthServiceAccessForOrganizationCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link DisableHealthServiceAccessForOrganizationCommandInput} for command's `input` shape.
- * @see {@link DisableHealthServiceAccessForOrganizationCommandOutput} for command's `response` shape.
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class DisableHealthServiceAccessForOrganizationCommand extends $Command<DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthServiceAccessForOrganizationCommandOutput, HealthClientResolvedConfig> {
     readonly input: DisableHealthServiceAccessForOrganizationCommandInput;
     constructor(input: DisableHealthServiceAccessForOrganizationCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthServiceAccessForOrganizationCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/EnableHealthServiceAccessForOrganizationCommand.d.ts

@@ -5,51 +5,11 @@ export interface EnableHealthServiceAccessForOrganizationCommandInput {
 }
 export interface EnableHealthServiceAccessForOrganizationCommandOutput extends __MetadataBearer {
 }
-/**
- * <p>Enables AWS Health to work with AWS Organizations. You can use the organizational view feature
- *          to aggregate events from all AWS accounts in your organization in a centralized location. </p>
- *          <p>This operation also creates a service-linked role for the management account in the
- *          organization. </p>
- *          <note>
- *             <p>To call this operation, you must meet the following requirements:</p>
- *             <ul>
- *                <li>
- *                   <p>You must have a Business or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">AWS Support</a> to use the AWS Health
- *                   API. If you call the AWS Health API from an AWS account that doesn't have a
- *                   Business or Enterprise Support plan, you receive a
- *                      <code>SubscriptionRequiredException</code> error.</p>
- *                </li>
- *                <li>
- *                   <p>You must have permission to call this operation from the organization's
- *                   management account. For example IAM policies, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html">AWS Health
- *                      identity-based policy examples</a>.</p>
- *                </li>
- *             </ul>
- *          </note>
- *          <p>If you don't have the required support plan, you can instead use the AWS Health console
- *          to enable the organizational view feature. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
- *             AWS Health events</a> in the <i>AWS Health User Guide</i>.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { HealthClient, EnableHealthServiceAccessForOrganizationCommand } from "@aws-sdk/client-health"; // ES Modules import
- * // const { HealthClient, EnableHealthServiceAccessForOrganizationCommand } = require("@aws-sdk/client-health"); // CommonJS import
- * const client = new HealthClient(config);
- * const command = new EnableHealthServiceAccessForOrganizationCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link EnableHealthServiceAccessForOrganizationCommandInput} for command's `input` shape.
- * @see {@link EnableHealthServiceAccessForOrganizationCommandOutput} for command's `response` shape.
- * @see {@link HealthClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class EnableHealthServiceAccessForOrganizationCommand extends $Command<EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput, HealthClientResolvedConfig> {
     readonly input: EnableHealthServiceAccessForOrganizationCommandInput;
     constructor(input: EnableHealthServiceAccessForOrganizationCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./DescribeAffectedAccountsForOrganizationCommand";
+export * from "./DescribeAffectedEntitiesCommand";
+export * from "./DescribeAffectedEntitiesForOrganizationCommand";
+export * from "./DescribeEntityAggregatesCommand";
+export * from "./DescribeEventAggregatesCommand";
+export * from "./DescribeEventDetailsCommand";
+export * from "./DescribeEventDetailsForOrganizationCommand";
+export * from "./DescribeEventTypesCommand";
+export * from "./DescribeEventsCommand";
+export * from "./DescribeEventsForOrganizationCommand";
+export * from "./DescribeHealthServiceStatusForOrganizationCommand";
+export * from "./DisableHealthServiceAccessForOrganizationCommand";
+export * from "./EnableHealthServiceAccessForOrganizationCommand";

package/dist-types/ts3.4/index.d.ts

@@ -1,24 +1,5 @@
-export * from "./HealthClient";
 export * from "./Health";
-export * from "./commands/DescribeAffectedAccountsForOrganizationCommand";
-export * from "./pagination/DescribeAffectedAccountsForOrganizationPaginator";
-export * from "./commands/DescribeAffectedEntitiesCommand";
-export * from "./pagination/DescribeAffectedEntitiesPaginator";
-export * from "./commands/DescribeAffectedEntitiesForOrganizationCommand";
-export * from "./pagination/DescribeAffectedEntitiesForOrganizationPaginator";
-export * from "./commands/DescribeEntityAggregatesCommand";
-export * from "./commands/DescribeEventAggregatesCommand";
-export * from "./pagination/DescribeEventAggregatesPaginator";
-export * from "./commands/DescribeEventDetailsCommand";
-export * from "./commands/DescribeEventDetailsForOrganizationCommand";
-export * from "./commands/DescribeEventsCommand";
-export * from "./pagination/DescribeEventsPaginator";
-export * from "./commands/DescribeEventsForOrganizationCommand";
-export * from "./pagination/DescribeEventsForOrganizationPaginator";
-export * from "./commands/DescribeEventTypesCommand";
-export * from "./pagination/DescribeEventTypesPaginator";
-export * from "./commands/DescribeHealthServiceStatusForOrganizationCommand";
-export * from "./commands/DisableHealthServiceAccessForOrganizationCommand";
-export * from "./commands/EnableHealthServiceAccessForOrganizationCommand";
-export * from "./pagination/Interfaces";
-export * from "./models/index";
+export * from "./HealthClient";
+export * from "./commands";
+export * from "./models";
+export * from "./pagination";