@aws-sdk/client-notifications 3.698.0

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

@@ -0,0 +1,100 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateEventRuleRequest, UpdateEventRuleResponse } from "../models/models_0";
+import { NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NotificationsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateEventRuleCommand}.
+ */
+export interface UpdateEventRuleCommandInput extends UpdateEventRuleRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateEventRuleCommand}.
+ */
+export interface UpdateEventRuleCommandOutput extends UpdateEventRuleResponse, __MetadataBearer {
+}
+declare const UpdateEventRuleCommand_base: {
+    new (input: UpdateEventRuleCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateEventRuleCommandInput, UpdateEventRuleCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateEventRuleCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateEventRuleCommandInput, UpdateEventRuleCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates an existing EventRule.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { NotificationsClient, UpdateEventRuleCommand } from "@aws-sdk/client-notifications"; // ES Modules import
+ * // const { NotificationsClient, UpdateEventRuleCommand } = require("@aws-sdk/client-notifications"); // CommonJS import
+ * const client = new NotificationsClient(config);
+ * const input = { // UpdateEventRuleRequest
+ *   arn: "STRING_VALUE", // required
+ *   eventPattern: "STRING_VALUE",
+ *   regions: [ // Regions
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new UpdateEventRuleCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateEventRuleResponse
+ * //   arn: "STRING_VALUE", // required
+ * //   notificationConfigurationArn: "STRING_VALUE", // required
+ * //   statusSummaryByRegion: { // StatusSummaryByRegion // required
+ * //     "<keys>": { // EventRuleStatusSummary
+ * //       status: "STRING_VALUE", // required
+ * //       reason: "STRING_VALUE", // required
+ * //     },
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateEventRuleCommandInput - {@link UpdateEventRuleCommandInput}
+ * @returns {@link UpdateEventRuleCommandOutput}
+ * @see {@link UpdateEventRuleCommandInput} for command's `input` shape.
+ * @see {@link UpdateEventRuleCommandOutput} for command's `response` shape.
+ * @see {@link NotificationsClientResolvedConfig | config} for NotificationsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>User does not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error during processing of request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource which does not exist. </p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Request was denied due to request throttling. </p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>This exception is thrown when the notification event fails validation.</p>
+ *
+ * @throws {@link NotificationsServiceException}
+ * <p>Base exception class for all service exceptions from Notifications service.</p>
+ *
+ * @public
+ */
+export declare class UpdateEventRuleCommand extends UpdateEventRuleCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateEventRuleRequest;
+            output: UpdateEventRuleResponse;
+        };
+        sdk: {
+            input: UpdateEventRuleCommandInput;
+            output: UpdateEventRuleCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,92 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateNotificationConfigurationRequest, UpdateNotificationConfigurationResponse } from "../models/models_0";
+import { NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NotificationsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateNotificationConfigurationCommand}.
+ */
+export interface UpdateNotificationConfigurationCommandInput extends UpdateNotificationConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateNotificationConfigurationCommand}.
+ */
+export interface UpdateNotificationConfigurationCommandOutput extends UpdateNotificationConfigurationResponse, __MetadataBearer {
+}
+declare const UpdateNotificationConfigurationCommand_base: {
+    new (input: UpdateNotificationConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateNotificationConfigurationCommandInput, UpdateNotificationConfigurationCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateNotificationConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateNotificationConfigurationCommandInput, UpdateNotificationConfigurationCommandOutput, NotificationsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates a NotificationConfiguration.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { NotificationsClient, UpdateNotificationConfigurationCommand } from "@aws-sdk/client-notifications"; // ES Modules import
+ * // const { NotificationsClient, UpdateNotificationConfigurationCommand } = require("@aws-sdk/client-notifications"); // CommonJS import
+ * const client = new NotificationsClient(config);
+ * const input = { // UpdateNotificationConfigurationRequest
+ *   arn: "STRING_VALUE", // required
+ *   name: "STRING_VALUE",
+ *   description: "STRING_VALUE",
+ *   aggregationDuration: "STRING_VALUE",
+ * };
+ * const command = new UpdateNotificationConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateNotificationConfigurationResponse
+ * //   arn: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateNotificationConfigurationCommandInput - {@link UpdateNotificationConfigurationCommandInput}
+ * @returns {@link UpdateNotificationConfigurationCommandOutput}
+ * @see {@link UpdateNotificationConfigurationCommandInput} for command's `input` shape.
+ * @see {@link UpdateNotificationConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link NotificationsClientResolvedConfig | config} for NotificationsClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>User does not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>Updating or deleting a resource can cause an inconsistent state.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>Unexpected error during processing of request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>Request references a resource which does not exist. </p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Request was denied due to request throttling. </p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>This exception is thrown when the notification event fails validation.</p>
+ *
+ * @throws {@link NotificationsServiceException}
+ * <p>Base exception class for all service exceptions from Notifications service.</p>
+ *
+ * @public
+ */
+export declare class UpdateNotificationConfigurationCommand extends UpdateNotificationConfigurationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateNotificationConfigurationRequest;
+            output: UpdateNotificationConfigurationResponse;
+        };
+        sdk: {
+            input: UpdateNotificationConfigurationCommandInput;
+            output: UpdateNotificationConfigurationCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,21 @@
+export * from "./AssociateChannelCommand";
+export * from "./CreateEventRuleCommand";
+export * from "./CreateNotificationConfigurationCommand";
+export * from "./DeleteEventRuleCommand";
+export * from "./DeleteNotificationConfigurationCommand";
+export * from "./DeregisterNotificationHubCommand";
+export * from "./DisassociateChannelCommand";
+export * from "./GetEventRuleCommand";
+export * from "./GetNotificationConfigurationCommand";
+export * from "./GetNotificationEventCommand";
+export * from "./ListChannelsCommand";
+export * from "./ListEventRulesCommand";
+export * from "./ListNotificationConfigurationsCommand";
+export * from "./ListNotificationEventsCommand";
+export * from "./ListNotificationHubsCommand";
+export * from "./ListTagsForResourceCommand";
+export * from "./RegisterNotificationHubCommand";
+export * from "./TagResourceCommand";
+export * from "./UntagResourceCommand";
+export * from "./UpdateEventRuleCommand";
+export * from "./UpdateNotificationConfigurationCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,34 @@
+import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    useFipsEndpoint?: boolean | Provider<boolean>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+    region?: string | Provider<string>;
+}
+export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {
+    defaultSigningName: string;
+};
+export declare const commonParams: {
+    readonly UseFIPS: {
+        readonly type: "builtInParams";
+        readonly name: "useFipsEndpoint";
+    };
+    readonly Endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+    readonly Region: {
+        readonly type: "builtInParams";
+        readonly name: "region";
+    };
+};
+export interface EndpointParameters extends __EndpointParameters {
+    UseFIPS?: boolean;
+    Endpoint?: string;
+    Region?: string;
+}

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,5 @@
+import { EndpointV2, Logger } from "@smithy/types";
+import { EndpointParameters } from "./EndpointParameters";
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/endpoint/ruleset.d.ts

@@ -0,0 +1,2 @@
+import { RuleSetObject } from "@smithy/types";
+export declare const ruleSet: RuleSetObject;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,9 @@
+import { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
+import { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
+import { DefaultExtensionConfiguration } from "@smithy/types";
+import { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface NotificationsExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * <p>The <i>AWS User Notifications API Reference</i> provides descriptions, API request parameters, and the JSON response for each of the User Notification API actions.</p>
+ *          <p>User Notification control APIs are currently available in US East (Virginia) - <code>us-east-1</code>.</p>
+ *          <p>
+ *             <a href="https://docs.aws.amazon.com/notifications/latest/APIReference/API_GetNotificationEvent.html">GetNotificationEvent</a>
+ * 	 and <a href="https://docs.aws.amazon.com/notifications/latest/APIReference/API_ListNotificationEvents.html">ListNotificationEvents</a> APIs are currently available in
+ * 	 <a href="https://docs.aws.amazon.com/notifications/latest/userguide/supported-regions.html">commercial partition Regions</a> and only return notifications stored in the same Region in which they're called.</p>
+ *          <p>The User Notifications console can only be used in US East (Virginia). Your data however, is stored in each Region chosen as a
+ * 	 <a href="https://docs.aws.amazon.com/notifications/latest/userguide/notification-hubs.html&gt;">notification hub</a> in addition to US East (Virginia).</p>
+ *
+ * @packageDocumentation
+ */
+export * from "./NotificationsClient";
+export * from "./Notifications";
+export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { NotificationsExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./pagination";
+export * from "./models";
+export { NotificationsServiceException } from "./models/NotificationsServiceException";

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

@@ -0,0 +1,14 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@smithy/smithy-client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from Notifications service.
+ */
+export declare class NotificationsServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

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

@@ -0,0 +1 @@
+export * from "./models_0";