@aws-sdk/client-health 3.296.0 → 3.298.0

package/dist-types/commands/DescribeEventDetailsForOrganizationCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
 import { DescribeEventDetailsForOrganizationRequest, DescribeEventDetailsForOrganizationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeEventDetailsForOrganizationCommand}.
  */
 export interface DescribeEventDetailsForOrganizationCommandInput extends DescribeEventDetailsForOrganizationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeEventDetailsForOrganizationCommand}.
  */
 export interface DescribeEventDetailsForOrganizationCommandOutput extends DescribeEventDetailsForOrganizationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns detailed information about one or more specified events for one or more
  *          Amazon Web Services accounts in your organization. This information includes standard event data (such as
  *          the Amazon Web Services Region and service), an event description, and (depending on the event) possible
@@ -57,6 +62,8 @@ export interface DescribeEventDetailsForOrganizationCommandOutput extends Descri
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeEventDetailsForOrganizationCommandInput - {@link DescribeEventDetailsForOrganizationCommandInput}
+ * @returns {@link DescribeEventDetailsForOrganizationCommandOutput}
  * @see {@link DescribeEventDetailsForOrganizationCommandInput} for command's `input` shape.
  * @see {@link DescribeEventDetailsForOrganizationCommandOutput} for command's `response` shape.
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -69,11 +76,20 @@ export interface DescribeEventDetailsForOrganizationCommandOutput extends Descri
 export declare class DescribeEventDetailsForOrganizationCommand extends $Command<DescribeEventDetailsForOrganizationCommandInput, DescribeEventDetailsForOrganizationCommandOutput, HealthClientResolvedConfig> {
     readonly input: DescribeEventDetailsForOrganizationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeEventDetailsForOrganizationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventDetailsForOrganizationCommandInput, DescribeEventDetailsForOrganizationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/DescribeEventTypesCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
 import { DescribeEventTypesRequest, DescribeEventTypesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeEventTypesCommand}.
  */
 export interface DescribeEventTypesCommandInput extends DescribeEventTypesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeEventTypesCommand}.
  */
 export interface DescribeEventTypesCommandOutput extends DescribeEventTypesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns the event types that meet the specified filter criteria. You can use this API
  *          operation to find information about the Health event, such as the category, Amazon Web Services
  *          service, and event code. The metadata for each event appears in the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html">EventType</a> object. </p>
@@ -32,6 +37,8 @@ export interface DescribeEventTypesCommandOutput extends DescribeEventTypesRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeEventTypesCommandInput - {@link DescribeEventTypesCommandInput}
+ * @returns {@link DescribeEventTypesCommandOutput}
  * @see {@link DescribeEventTypesCommandInput} for command's `input` shape.
  * @see {@link DescribeEventTypesCommandOutput} for command's `response` shape.
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeEventTypesCommandOutput extends DescribeEventTypesRespo
 export declare class DescribeEventTypesCommand extends $Command<DescribeEventTypesCommandInput, DescribeEventTypesCommandOutput, HealthClientResolvedConfig> {
     readonly input: DescribeEventTypesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeEventTypesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventTypesCommandInput, DescribeEventTypesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/DescribeEventsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
 import { DescribeEventsRequest, DescribeEventsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeEventsCommand}.
  */
 export interface DescribeEventsCommandInput extends DescribeEventsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeEventsCommand}.
  */
 export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p> 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
@@ -47,6 +52,8 @@ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @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.
@@ -62,11 +69,20 @@ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __M
 export declare class DescribeEventsCommand extends $Command<DescribeEventsCommandInput, DescribeEventsCommandOutput, HealthClientResolvedConfig> {
     readonly input: DescribeEventsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeEventsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventsCommandInput, DescribeEventsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
 import { DescribeEventsForOrganizationRequest, DescribeEventsForOrganizationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeEventsForOrganizationCommand}.
  */
 export interface DescribeEventsForOrganizationCommandInput extends DescribeEventsForOrganizationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeEventsForOrganizationCommand}.
  */
 export interface DescribeEventsForOrganizationCommandOutput extends DescribeEventsForOrganizationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns information about events across your organization in 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
@@ -56,6 +61,8 @@ export interface DescribeEventsForOrganizationCommandOutput extends DescribeEven
  * const response = await client.send(command);
  * ```
  *
+ * @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.
@@ -71,11 +78,20 @@ export interface DescribeEventsForOrganizationCommandOutput extends DescribeEven
 export declare class DescribeEventsForOrganizationCommand extends $Command<DescribeEventsForOrganizationCommandInput, DescribeEventsForOrganizationCommandOutput, HealthClientResolvedConfig> {
     readonly input: DescribeEventsForOrganizationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeEventsForOrganizationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeEventsForOrganizationCommandInput, DescribeEventsForOrganizationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
 import { DescribeHealthServiceStatusForOrganizationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeHealthServiceStatusForOrganizationCommand}.
  */
 export interface DescribeHealthServiceStatusForOrganizationCommandInput {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeHealthServiceStatusForOrganizationCommand}.
  */
 export interface DescribeHealthServiceStatusForOrganizationCommandOutput extends DescribeHealthServiceStatusForOrganizationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>This operation provides status information on enabling or disabling 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
@@ -28,6 +33,8 @@ export interface DescribeHealthServiceStatusForOrganizationCommandOutput extends
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeHealthServiceStatusForOrganizationCommandInput - {@link DescribeHealthServiceStatusForOrganizationCommandInput}
+ * @returns {@link DescribeHealthServiceStatusForOrganizationCommandOutput}
  * @see {@link DescribeHealthServiceStatusForOrganizationCommandInput} for command's `input` shape.
  * @see {@link DescribeHealthServiceStatusForOrganizationCommandOutput} for command's `response` shape.
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -37,11 +44,20 @@ export interface DescribeHealthServiceStatusForOrganizationCommandOutput extends
 export declare class DescribeHealthServiceStatusForOrganizationCommand extends $Command<DescribeHealthServiceStatusForOrganizationCommandInput, DescribeHealthServiceStatusForOrganizationCommandOutput, HealthClientResolvedConfig> {
     readonly input: DescribeHealthServiceStatusForOrganizationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeHealthServiceStatusForOrganizationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeHealthServiceStatusForOrganizationCommandInput, DescribeHealthServiceStatusForOrganizationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -3,16 +3,21 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
 import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
 /**
+ * @public
+ *
  * The input for {@link DisableHealthServiceAccessForOrganizationCommand}.
  */
 export interface DisableHealthServiceAccessForOrganizationCommandInput {
 }
 /**
+ * @public
+ *
  * The output of {@link DisableHealthServiceAccessForOrganizationCommand}.
  */
 export interface DisableHealthServiceAccessForOrganizationCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Disables Health from working with Organizations. To call this operation, you must sign
  *          in as an 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
@@ -38,6 +43,8 @@ export interface DisableHealthServiceAccessForOrganizationCommandOutput extends
  * const response = await client.send(command);
  * ```
  *
+ * @param DisableHealthServiceAccessForOrganizationCommandInput - {@link DisableHealthServiceAccessForOrganizationCommandInput}
+ * @returns {@link DisableHealthServiceAccessForOrganizationCommandOutput}
  * @see {@link DisableHealthServiceAccessForOrganizationCommandInput} for command's `input` shape.
  * @see {@link DisableHealthServiceAccessForOrganizationCommandOutput} for command's `response` shape.
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -52,11 +59,20 @@ export interface DisableHealthServiceAccessForOrganizationCommandOutput extends
 export declare class DisableHealthServiceAccessForOrganizationCommand extends $Command<DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthServiceAccessForOrganizationCommandOutput, HealthClientResolvedConfig> {
     readonly input: DisableHealthServiceAccessForOrganizationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DisableHealthServiceAccessForOrganizationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthServiceAccessForOrganizationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -3,16 +3,21 @@ import { Command as $Command } from "@aws-sdk/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
 import { HealthClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../HealthClient";
 /**
+ * @public
+ *
  * The input for {@link EnableHealthServiceAccessForOrganizationCommand}.
  */
 export interface EnableHealthServiceAccessForOrganizationCommandInput {
 }
 /**
+ * @public
+ *
  * The output of {@link EnableHealthServiceAccessForOrganizationCommand}.
  */
 export interface EnableHealthServiceAccessForOrganizationCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Enables Health to work with Organizations. You can use the organizational view feature
  *          to aggregate events from all Amazon Web Services accounts in your organization in a centralized location. </p>
  *          <p>This operation also creates a service-linked role for the management account in the
@@ -46,6 +51,8 @@ export interface EnableHealthServiceAccessForOrganizationCommandOutput extends _
  * const response = await client.send(command);
  * ```
  *
+ * @param EnableHealthServiceAccessForOrganizationCommandInput - {@link EnableHealthServiceAccessForOrganizationCommandInput}
+ * @returns {@link EnableHealthServiceAccessForOrganizationCommandOutput}
  * @see {@link EnableHealthServiceAccessForOrganizationCommandInput} for command's `input` shape.
  * @see {@link EnableHealthServiceAccessForOrganizationCommandOutput} for command's `response` shape.
  * @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
@@ -60,11 +67,20 @@ export interface EnableHealthServiceAccessForOrganizationCommandOutput extends _
 export declare class EnableHealthServiceAccessForOrganizationCommand extends $Command<EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput, HealthClientResolvedConfig> {
     readonly input: EnableHealthServiceAccessForOrganizationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: EnableHealthServiceAccessForOrganizationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: HealthClientResolvedConfig, options?: __HttpHandlerOptions): Handler<EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/HealthServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from Health service.
  */
 export declare class HealthServiceException extends __ServiceException {