@aws-sdk/client-notifications 3.698.0

package/dist-types/ts3.4/models/models_0.d.ts

@@ -0,0 +1,447 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { NotificationsServiceException as __BaseException } from "./NotificationsServiceException";
+export declare class AccessDeniedException extends __BaseException {
+  readonly name: "AccessDeniedException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
+  );
+}
+export declare const AggregationDuration: {
+  readonly LONG: "LONG";
+  readonly NONE: "NONE";
+  readonly SHORT: "SHORT";
+};
+export type AggregationDuration =
+  (typeof AggregationDuration)[keyof typeof AggregationDuration];
+export declare const AggregationEventType: {
+  readonly AGGREGATE: "AGGREGATE";
+  readonly CHILD: "CHILD";
+  readonly NONE: "NONE";
+};
+export type AggregationEventType =
+  (typeof AggregationEventType)[keyof typeof AggregationEventType];
+export interface AssociateChannelRequest {
+  arn: string | undefined;
+  notificationConfigurationArn: string | undefined;
+}
+export interface AssociateChannelResponse {}
+export declare class ConflictException extends __BaseException {
+  readonly name: "ConflictException";
+  readonly $fault: "client";
+  resourceId: string | undefined;
+  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+export declare class InternalServerException extends __BaseException {
+  readonly name: "InternalServerException";
+  readonly $fault: "server";
+  $retryable: {};
+  constructor(
+    opts: __ExceptionOptionType<InternalServerException, __BaseException>
+  );
+}
+export declare class ResourceNotFoundException extends __BaseException {
+  readonly name: "ResourceNotFoundException";
+  readonly $fault: "client";
+  resourceId: string | undefined;
+  constructor(
+    opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
+  );
+}
+export declare class ServiceQuotaExceededException extends __BaseException {
+  readonly name: "ServiceQuotaExceededException";
+  readonly $fault: "client";
+  resourceType: string | undefined;
+  resourceId?: string | undefined;
+  serviceCode?: string | undefined;
+  quotaCode?: string | undefined;
+  constructor(
+    opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
+  );
+}
+export declare class ThrottlingException extends __BaseException {
+  readonly name: "ThrottlingException";
+  readonly $fault: "client";
+  $retryable: {
+    throttling: boolean;
+  };
+  serviceCode?: string | undefined;
+  quotaCode?: string | undefined;
+  retryAfterSeconds?: number | undefined;
+  constructor(
+    opts: __ExceptionOptionType<ThrottlingException, __BaseException>
+  );
+}
+export interface ValidationExceptionField {
+  name: string | undefined;
+  message: string | undefined;
+}
+export declare const ValidationExceptionReason: {
+  readonly FIELD_VALIDATION_FAILED: "fieldValidationFailed";
+  readonly OTHER: "other";
+};
+export type ValidationExceptionReason =
+  (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
+export declare class ValidationException extends __BaseException {
+  readonly name: "ValidationException";
+  readonly $fault: "client";
+  reason?: ValidationExceptionReason | undefined;
+  fieldList?: ValidationExceptionField[] | undefined;
+  constructor(
+    opts: __ExceptionOptionType<ValidationException, __BaseException>
+  );
+}
+export interface DisassociateChannelRequest {
+  arn: string | undefined;
+  notificationConfigurationArn: string | undefined;
+}
+export interface DisassociateChannelResponse {}
+export interface ListChannelsRequest {
+  notificationConfigurationArn: string | undefined;
+  maxResults?: number | undefined;
+  nextToken?: string | undefined;
+}
+export interface ListChannelsResponse {
+  nextToken?: string | undefined;
+  channels: string[] | undefined;
+}
+export interface CreateEventRuleRequest {
+  notificationConfigurationArn: string | undefined;
+  source: string | undefined;
+  eventType: string | undefined;
+  eventPattern?: string | undefined;
+  regions: string[] | undefined;
+}
+export declare const EventRuleStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly CREATING: "CREATING";
+  readonly DELETING: "DELETING";
+  readonly INACTIVE: "INACTIVE";
+  readonly UPDATING: "UPDATING";
+};
+export type EventRuleStatus =
+  (typeof EventRuleStatus)[keyof typeof EventRuleStatus];
+export interface EventRuleStatusSummary {
+  status: EventRuleStatus | undefined;
+  reason: string | undefined;
+}
+export interface CreateEventRuleResponse {
+  arn: string | undefined;
+  notificationConfigurationArn: string | undefined;
+  statusSummaryByRegion: Record<string, EventRuleStatusSummary> | undefined;
+}
+export interface CreateNotificationConfigurationRequest {
+  name: string | undefined;
+  description: string | undefined;
+  aggregationDuration?: AggregationDuration | undefined;
+  tags?: Record<string, string> | undefined;
+}
+export declare const NotificationConfigurationStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly DELETING: "DELETING";
+  readonly INACTIVE: "INACTIVE";
+  readonly PARTIALLY_ACTIVE: "PARTIALLY_ACTIVE";
+};
+export type NotificationConfigurationStatus =
+  (typeof NotificationConfigurationStatus)[keyof typeof NotificationConfigurationStatus];
+export interface CreateNotificationConfigurationResponse {
+  arn: string | undefined;
+  status: NotificationConfigurationStatus | undefined;
+}
+export interface DeleteEventRuleRequest {
+  arn: string | undefined;
+}
+export interface DeleteEventRuleResponse {}
+export interface DeleteNotificationConfigurationRequest {
+  arn: string | undefined;
+}
+export interface DeleteNotificationConfigurationResponse {}
+export interface DeregisterNotificationHubRequest {
+  notificationHubRegion: string | undefined;
+}
+export declare const NotificationHubStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly DEREGISTERING: "DEREGISTERING";
+  readonly INACTIVE: "INACTIVE";
+  readonly REGISTERING: "REGISTERING";
+};
+export type NotificationHubStatus =
+  (typeof NotificationHubStatus)[keyof typeof NotificationHubStatus];
+export interface NotificationHubStatusSummary {
+  status: NotificationHubStatus | undefined;
+  reason: string | undefined;
+}
+export interface DeregisterNotificationHubResponse {
+  notificationHubRegion: string | undefined;
+  statusSummary: NotificationHubStatusSummary | undefined;
+}
+export interface Dimension {
+  name: string | undefined;
+  value: string | undefined;
+}
+export interface GetEventRuleRequest {
+  arn: string | undefined;
+}
+export interface GetEventRuleResponse {
+  arn: string | undefined;
+  notificationConfigurationArn: string | undefined;
+  creationTime: Date | undefined;
+  source: string | undefined;
+  eventType: string | undefined;
+  eventPattern: string | undefined;
+  regions: string[] | undefined;
+  managedRules: string[] | undefined;
+  statusSummaryByRegion: Record<string, EventRuleStatusSummary> | undefined;
+}
+export interface ListEventRulesRequest {
+  notificationConfigurationArn: string | undefined;
+  maxResults?: number | undefined;
+  nextToken?: string | undefined;
+}
+export interface EventRuleStructure {
+  arn: string | undefined;
+  notificationConfigurationArn: string | undefined;
+  creationTime: Date | undefined;
+  source: string | undefined;
+  eventType: string | undefined;
+  eventPattern: string | undefined;
+  regions: string[] | undefined;
+  managedRules: string[] | undefined;
+  statusSummaryByRegion: Record<string, EventRuleStatusSummary> | undefined;
+}
+export interface ListEventRulesResponse {
+  nextToken?: string | undefined;
+  eventRules: EventRuleStructure[] | undefined;
+}
+export interface UpdateEventRuleRequest {
+  arn: string | undefined;
+  eventPattern?: string | undefined;
+  regions?: string[] | undefined;
+}
+export interface UpdateEventRuleResponse {
+  arn: string | undefined;
+  notificationConfigurationArn: string | undefined;
+  statusSummaryByRegion: Record<string, EventRuleStatusSummary> | undefined;
+}
+export declare const EventStatus: {
+  readonly HEALTHY: "HEALTHY";
+  readonly UNHEALTHY: "UNHEALTHY";
+};
+export type EventStatus = (typeof EventStatus)[keyof typeof EventStatus];
+export interface GetNotificationConfigurationRequest {
+  arn: string | undefined;
+}
+export interface GetNotificationConfigurationResponse {
+  arn: string | undefined;
+  name: string | undefined;
+  description: string | undefined;
+  status: NotificationConfigurationStatus | undefined;
+  creationTime: Date | undefined;
+  aggregationDuration?: AggregationDuration | undefined;
+}
+export declare const LocaleCode: {
+  readonly de_DE: "de_DE";
+  readonly en_CA: "en_CA";
+  readonly en_UK: "en_UK";
+  readonly en_US: "en_US";
+  readonly es_ES: "es_ES";
+  readonly fr_CA: "fr_CA";
+  readonly fr_FR: "fr_FR";
+  readonly id_ID: "id_ID";
+  readonly it_IT: "it_IT";
+  readonly ja_JP: "ja_JP";
+  readonly ko_KR: "ko_KR";
+  readonly pt_BR: "pt_BR";
+  readonly tr_TR: "tr_TR";
+  readonly zh_CN: "zh_CN";
+  readonly zh_TW: "zh_TW";
+};
+export type LocaleCode = (typeof LocaleCode)[keyof typeof LocaleCode];
+export interface GetNotificationEventRequest {
+  arn: string | undefined;
+  locale?: LocaleCode | undefined;
+}
+export declare const MediaElementType: {
+  readonly IMAGE: "IMAGE";
+};
+export type MediaElementType =
+  (typeof MediaElementType)[keyof typeof MediaElementType];
+export interface MediaElement {
+  mediaId: string | undefined;
+  type: MediaElementType | undefined;
+  url: string | undefined;
+  caption: string | undefined;
+}
+export interface MessageComponents {
+  headline?: string | undefined;
+  paragraphSummary?: string | undefined;
+  completeDescription?: string | undefined;
+  dimensions?: Dimension[] | undefined;
+}
+export declare const NotificationType: {
+  readonly ALERT: "ALERT";
+  readonly ANNOUNCEMENT: "ANNOUNCEMENT";
+  readonly INFORMATIONAL: "INFORMATIONAL";
+  readonly WARNING: "WARNING";
+};
+export type NotificationType =
+  (typeof NotificationType)[keyof typeof NotificationType];
+export declare const SchemaVersion: {
+  readonly SCHEMA_VERSION_1_0: "v1.0";
+};
+export type SchemaVersion = (typeof SchemaVersion)[keyof typeof SchemaVersion];
+export interface Resource {
+  id?: string | undefined;
+  arn?: string | undefined;
+  detailUrl?: string | undefined;
+  tags?: string[] | undefined;
+}
+export interface SourceEventMetadata {
+  eventTypeVersion: string | undefined;
+  sourceEventId: string | undefined;
+  eventOriginRegion?: string | undefined;
+  relatedAccount: string | undefined;
+  source: string | undefined;
+  eventOccurrenceTime: Date | undefined;
+  eventType: string | undefined;
+  relatedResources: Resource[] | undefined;
+}
+export declare const TextPartType: {
+  readonly LOCALIZED_TEXT: "LOCALIZED_TEXT";
+  readonly PLAIN_TEXT: "PLAIN_TEXT";
+  readonly URL: "URL";
+};
+export type TextPartType = (typeof TextPartType)[keyof typeof TextPartType];
+export interface TextPartValue {
+  type: TextPartType | undefined;
+  displayText?: string | undefined;
+  textByLocale?: Partial<Record<LocaleCode, string>> | undefined;
+  url?: string | undefined;
+}
+export interface NotificationEventSchema {
+  schemaVersion: SchemaVersion | undefined;
+  id: string | undefined;
+  sourceEventMetadata: SourceEventMetadata | undefined;
+  messageComponents: MessageComponents | undefined;
+  sourceEventDetailUrl?: string | undefined;
+  sourceEventDetailUrlDisplayText?: string | undefined;
+  notificationType: NotificationType | undefined;
+  eventStatus?: EventStatus | undefined;
+  aggregationEventType?: AggregationEventType | undefined;
+  aggregateNotificationEventArn?: string | undefined;
+  startTime?: Date | undefined;
+  endTime?: Date | undefined;
+  textParts: Record<string, TextPartValue> | undefined;
+  media: MediaElement[] | undefined;
+}
+export interface GetNotificationEventResponse {
+  arn: string | undefined;
+  notificationConfigurationArn: string | undefined;
+  creationTime: Date | undefined;
+  content: NotificationEventSchema | undefined;
+}
+export interface ListNotificationConfigurationsRequest {
+  eventRuleSource?: string | undefined;
+  channelArn?: string | undefined;
+  status?: NotificationConfigurationStatus | undefined;
+  maxResults?: number | undefined;
+  nextToken?: string | undefined;
+}
+export interface NotificationConfigurationStructure {
+  arn: string | undefined;
+  name: string | undefined;
+  description: string | undefined;
+  status: NotificationConfigurationStatus | undefined;
+  creationTime: Date | undefined;
+  aggregationDuration?: AggregationDuration | undefined;
+}
+export interface ListNotificationConfigurationsResponse {
+  nextToken?: string | undefined;
+  notificationConfigurations: NotificationConfigurationStructure[] | undefined;
+}
+export interface ListNotificationEventsRequest {
+  startTime?: Date | undefined;
+  endTime?: Date | undefined;
+  locale?: LocaleCode | undefined;
+  source?: string | undefined;
+  includeChildEvents?: boolean | undefined;
+  aggregateNotificationEventArn?: string | undefined;
+  maxResults?: number | undefined;
+  nextToken?: string | undefined;
+}
+export interface MessageComponentsSummary {
+  headline: string | undefined;
+}
+export interface SourceEventMetadataSummary {
+  eventOriginRegion?: string | undefined;
+  source: string | undefined;
+  eventType: string | undefined;
+}
+export interface NotificationEventSummary {
+  schemaVersion: SchemaVersion | undefined;
+  sourceEventMetadata: SourceEventMetadataSummary | undefined;
+  messageComponents: MessageComponentsSummary | undefined;
+  eventStatus: EventStatus | undefined;
+  notificationType: NotificationType | undefined;
+}
+export interface NotificationEventOverview {
+  arn: string | undefined;
+  notificationConfigurationArn: string | undefined;
+  relatedAccount: string | undefined;
+  creationTime: Date | undefined;
+  notificationEvent: NotificationEventSummary | undefined;
+  aggregationEventType?: AggregationEventType | undefined;
+  aggregateNotificationEventArn?: string | undefined;
+}
+export interface ListNotificationEventsResponse {
+  nextToken?: string | undefined;
+  notificationEvents: NotificationEventOverview[] | undefined;
+}
+export interface ListNotificationHubsRequest {
+  maxResults?: number | undefined;
+  nextToken?: string | undefined;
+}
+export interface NotificationHubOverview {
+  notificationHubRegion: string | undefined;
+  statusSummary: NotificationHubStatusSummary | undefined;
+  creationTime: Date | undefined;
+  lastActivationTime?: Date | undefined;
+}
+export interface ListNotificationHubsResponse {
+  notificationHubs: NotificationHubOverview[] | undefined;
+  nextToken?: string | undefined;
+}
+export interface ListTagsForResourceRequest {
+  arn: string | undefined;
+}
+export interface ListTagsForResourceResponse {
+  tags?: Record<string, string> | undefined;
+}
+export interface UpdateNotificationConfigurationRequest {
+  arn: string | undefined;
+  name?: string | undefined;
+  description?: string | undefined;
+  aggregationDuration?: AggregationDuration | undefined;
+}
+export interface UpdateNotificationConfigurationResponse {
+  arn: string | undefined;
+}
+export interface RegisterNotificationHubRequest {
+  notificationHubRegion: string | undefined;
+}
+export interface RegisterNotificationHubResponse {
+  notificationHubRegion: string | undefined;
+  statusSummary: NotificationHubStatusSummary | undefined;
+  creationTime: Date | undefined;
+  lastActivationTime?: Date | undefined;
+}
+export interface TagResourceRequest {
+  arn: string | undefined;
+  tags: Record<string, string> | undefined;
+}
+export interface TagResourceResponse {}
+export interface UntagResourceRequest {
+  arn: string | undefined;
+  tagKeys: string[] | undefined;
+}
+export interface UntagResourceResponse {}

package/dist-types/ts3.4/pagination/Interfaces.d.ts

@@ -0,0 +1,6 @@
+import { PaginationConfiguration } from "@smithy/types";
+import { NotificationsClient } from "../NotificationsClient";
+export interface NotificationsPaginationConfiguration
+  extends PaginationConfiguration {
+  client: NotificationsClient;
+}

package/dist-types/ts3.4/pagination/ListChannelsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListChannelsCommandInput,
+  ListChannelsCommandOutput,
+} from "../commands/ListChannelsCommand";
+import { NotificationsPaginationConfiguration } from "./Interfaces";
+export declare const paginateListChannels: (
+  config: NotificationsPaginationConfiguration,
+  input: ListChannelsCommandInput,
+  ...rest: any[]
+) => Paginator<ListChannelsCommandOutput>;

package/dist-types/ts3.4/pagination/ListEventRulesPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListEventRulesCommandInput,
+  ListEventRulesCommandOutput,
+} from "../commands/ListEventRulesCommand";
+import { NotificationsPaginationConfiguration } from "./Interfaces";
+export declare const paginateListEventRules: (
+  config: NotificationsPaginationConfiguration,
+  input: ListEventRulesCommandInput,
+  ...rest: any[]
+) => Paginator<ListEventRulesCommandOutput>;

package/dist-types/ts3.4/pagination/ListNotificationConfigurationsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListNotificationConfigurationsCommandInput,
+  ListNotificationConfigurationsCommandOutput,
+} from "../commands/ListNotificationConfigurationsCommand";
+import { NotificationsPaginationConfiguration } from "./Interfaces";
+export declare const paginateListNotificationConfigurations: (
+  config: NotificationsPaginationConfiguration,
+  input: ListNotificationConfigurationsCommandInput,
+  ...rest: any[]
+) => Paginator<ListNotificationConfigurationsCommandOutput>;

package/dist-types/ts3.4/pagination/ListNotificationEventsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListNotificationEventsCommandInput,
+  ListNotificationEventsCommandOutput,
+} from "../commands/ListNotificationEventsCommand";
+import { NotificationsPaginationConfiguration } from "./Interfaces";
+export declare const paginateListNotificationEvents: (
+  config: NotificationsPaginationConfiguration,
+  input: ListNotificationEventsCommandInput,
+  ...rest: any[]
+) => Paginator<ListNotificationEventsCommandOutput>;

package/dist-types/ts3.4/pagination/ListNotificationHubsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListNotificationHubsCommandInput,
+  ListNotificationHubsCommandOutput,
+} from "../commands/ListNotificationHubsCommand";
+import { NotificationsPaginationConfiguration } from "./Interfaces";
+export declare const paginateListNotificationHubs: (
+  config: NotificationsPaginationConfiguration,
+  input: ListNotificationHubsCommandInput,
+  ...rest: any[]
+) => Paginator<ListNotificationHubsCommandOutput>;

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

@@ -0,0 +1,6 @@
+export * from "./Interfaces";
+export * from "./ListChannelsPaginator";
+export * from "./ListEventRulesPaginator";
+export * from "./ListNotificationConfigurationsPaginator";
+export * from "./ListNotificationEventsPaginator";
+export * from "./ListNotificationHubsPaginator";