@aws-sdk/client-dataexchange 3.437.0 → 3.439.0

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

@@ -0,0 +1,138 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { DataExchangeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DataExchangeClient";
+import { SendDataSetNotificationRequest, SendDataSetNotificationResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link SendDataSetNotificationCommand}.
+ */
+export interface SendDataSetNotificationCommandInput extends SendDataSetNotificationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link SendDataSetNotificationCommand}.
+ */
+export interface SendDataSetNotificationCommandOutput extends SendDataSetNotificationResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>The type of event associated with the data set.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { DataExchangeClient, SendDataSetNotificationCommand } from "@aws-sdk/client-dataexchange"; // ES Modules import
+ * // const { DataExchangeClient, SendDataSetNotificationCommand } = require("@aws-sdk/client-dataexchange"); // CommonJS import
+ * const client = new DataExchangeClient(config);
+ * const input = { // SendDataSetNotificationRequest
+ *   Scope: { // ScopeDetails
+ *     LakeFormationTagPolicies: [ // ListOfLakeFormationTagPolicies
+ *       { // LakeFormationTagPolicyDetails
+ *         Database: "STRING_VALUE",
+ *         Table: "STRING_VALUE",
+ *       },
+ *     ],
+ *     RedshiftDataShares: [ // ListOfRedshiftDataShares
+ *       { // RedshiftDataShareDetails
+ *         Arn: "STRING_VALUE", // required
+ *         Database: "STRING_VALUE", // required
+ *         Function: "STRING_VALUE",
+ *         Table: "STRING_VALUE",
+ *         Schema: "STRING_VALUE",
+ *         View: "STRING_VALUE",
+ *       },
+ *     ],
+ *     S3DataAccesses: [ // ListOfS3DataAccesses
+ *       { // S3DataAccessDetails
+ *         KeyPrefixes: [ // ListOf__string
+ *           "STRING_VALUE",
+ *         ],
+ *         Keys: [
+ *           "STRING_VALUE",
+ *         ],
+ *       },
+ *     ],
+ *   },
+ *   ClientToken: "STRING_VALUE",
+ *   Comment: "STRING_VALUE",
+ *   DataSetId: "STRING_VALUE", // required
+ *   Details: { // NotificationDetails
+ *     DataUpdate: { // DataUpdateRequestDetails
+ *       DataUpdatedAt: new Date("TIMESTAMP"),
+ *     },
+ *     Deprecation: { // DeprecationRequestDetails
+ *       DeprecationAt: new Date("TIMESTAMP"), // required
+ *     },
+ *     SchemaChange: { // SchemaChangeRequestDetails
+ *       Changes: [ // ListOfSchemaChangeDetails
+ *         { // SchemaChangeDetails
+ *           Name: "STRING_VALUE", // required
+ *           Type: "STRING_VALUE", // required
+ *           Description: "STRING_VALUE",
+ *         },
+ *       ],
+ *       SchemaChangeAt: new Date("TIMESTAMP"), // required
+ *     },
+ *   },
+ *   Type: "STRING_VALUE", // required
+ * };
+ * const command = new SendDataSetNotificationCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param SendDataSetNotificationCommandInput - {@link SendDataSetNotificationCommandInput}
+ * @returns {@link SendDataSetNotificationCommandOutput}
+ * @see {@link SendDataSetNotificationCommandInput} for command's `input` shape.
+ * @see {@link SendDataSetNotificationCommandOutput} for command's `response` shape.
+ * @see {@link DataExchangeClientResolvedConfig | config} for DataExchangeClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>Access to the resource is denied.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An exception occurred with the service.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource couldn't be found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The limit on the number of requests per second was exceeded.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The request was invalid.</p>
+ *
+ * @throws {@link DataExchangeServiceException}
+ * <p>Base exception class for all service exceptions from DataExchange service.</p>
+ *
+ */
+export declare class SendDataSetNotificationCommand extends $Command<SendDataSetNotificationCommandInput, SendDataSetNotificationCommandOutput, DataExchangeClientResolvedConfig> {
+    readonly input: SendDataSetNotificationCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: SendDataSetNotificationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: DataExchangeClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendDataSetNotificationCommandInput, SendDataSetNotificationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -20,6 +20,7 @@ export * from "./ListRevisionAssetsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./RevokeRevisionCommand";
 export * from "./SendApiAssetCommand";
+export * from "./SendDataSetNotificationCommand";
 export * from "./StartJobCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";

package/dist-types/index.d.ts

@@ -24,4 +24,5 @@ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
 export * from "./commands";
 export * from "./pagination";
 export * from "./models";
+import "@aws-sdk/util-endpoints";
 export { DataExchangeServiceException } from "./models/DataExchangeServiceException";

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

@@ -2878,6 +2878,291 @@ export interface SendApiAssetResponse {
      */
     ResponseHeaders?: Record<string, string>;
 }
+/**
+ * @public
+ * <p>Extra details specific to a data update type notification.</p>
+ */
+export interface DataUpdateRequestDetails {
+    /**
+     * @public
+     * <p>A
+     *          datetime in the past when the data was updated. This typically means that the underlying
+     *          resource supporting the data set was updated.</p>
+     */
+    DataUpdatedAt?: Date;
+}
+/**
+ * @public
+ * <p>Extra details specific to a deprecation type notification.</p>
+ */
+export interface DeprecationRequestDetails {
+    /**
+     * @public
+     * <p>A
+     *          datetime in the future when the data set will be deprecated.</p>
+     */
+    DeprecationAt: Date | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const SchemaChangeType: {
+    readonly ADD: "ADD";
+    readonly MODIFY: "MODIFY";
+    readonly REMOVE: "REMOVE";
+};
+/**
+ * @public
+ */
+export type SchemaChangeType = (typeof SchemaChangeType)[keyof typeof SchemaChangeType];
+/**
+ * @public
+ * <p>Object encompassing information about a schema change to a single, particular field,
+ *          a notification can have up to 100 of these.</p>
+ */
+export interface SchemaChangeDetails {
+    /**
+     * @public
+     * <p>Name
+     *          of the changing
+     *          field. This value
+     *          can be up to 255 characters long.</p>
+     */
+    Name: string | undefined;
+    /**
+     * @public
+     * <p>Is
+     *          the field being added, removed, or modified?</p>
+     */
+    Type: SchemaChangeType | undefined;
+    /**
+     * @public
+     * <p>Description
+     *          of what's changing about this
+     *          field. This value
+     *          can be up to 512 characters long.</p>
+     */
+    Description?: string;
+}
+/**
+ * @public
+ * <p>Extra details specific to this schema change type notification.</p>
+ */
+export interface SchemaChangeRequestDetails {
+    /**
+     * @public
+     * <p>List
+     *          of schema changes happening in the scope of this
+     *          notification. This
+     *          can have up to 100 entries.</p>
+     */
+    Changes?: SchemaChangeDetails[];
+    /**
+     * @public
+     * <p>A
+     *          date in the future when the schema change is taking effect.</p>
+     */
+    SchemaChangeAt: Date | undefined;
+}
+/**
+ * @public
+ * <p>Extra details specific to this notification.</p>
+ */
+export interface NotificationDetails {
+    /**
+     * @public
+     * <p>Extra
+     *          details specific to a data update type notification.</p>
+     */
+    DataUpdate?: DataUpdateRequestDetails;
+    /**
+     * @public
+     * <p>Extra
+     *          details specific to a deprecation type notification.</p>
+     */
+    Deprecation?: DeprecationRequestDetails;
+    /**
+     * @public
+     * <p>Extra
+     *          details specific to a schema change type notification.</p>
+     */
+    SchemaChange?: SchemaChangeRequestDetails;
+}
+/**
+ * @public
+ * <p>Extra details specific to the affected scope in
+ *          this LF data set.</p>
+ */
+export interface LakeFormationTagPolicyDetails {
+    /**
+     * @public
+     * <p>The
+     *          underlying Glue database that the notification is referring to.</p>
+     */
+    Database?: string;
+    /**
+     * @public
+     * <p>The
+     *          underlying Glue table that the notification is referring to.</p>
+     */
+    Table?: string;
+}
+/**
+ * @public
+ * <p>Extra details specific to the affected scope
+ *          in this Redshift data set.</p>
+ */
+export interface RedshiftDataShareDetails {
+    /**
+     * @public
+     * <p>The
+     *          ARN of the underlying Redshift data share that is being affected by this
+     *          notification.</p>
+     */
+    Arn: string | undefined;
+    /**
+     * @public
+     * <p>The
+     *          database name in the Redshift data share that is being affected by this
+     *          notification.</p>
+     */
+    Database: string | undefined;
+    /**
+     * @public
+     * <p>A
+     *          function name in the Redshift database that is being affected by this notification.</p>
+     */
+    Function?: string;
+    /**
+     * @public
+     * <p>A
+     *          table name in the Redshift database that is being affected by this notification.</p>
+     */
+    Table?: string;
+    /**
+     * @public
+     * <p>A
+     *          schema name in the Redshift database that is being affected by this notification.</p>
+     */
+    Schema?: string;
+    /**
+     * @public
+     * <p>A
+     *          view name in the Redshift database that is being affected by this notification.</p>
+     */
+    View?: string;
+}
+/**
+ * @public
+ * <p>Extra details specific to the affected scope in this S3 Data
+ *          Access data set.</p>
+ */
+export interface S3DataAccessDetails {
+    /**
+     * @public
+     * <p>A
+     *          list of the key prefixes affected by this
+     *          notification. This
+     *          can have up to 50 entries.</p>
+     */
+    KeyPrefixes?: string[];
+    /**
+     * @public
+     * <p>A
+     *          list of the keys affected by this
+     *          notification. This
+     *          can have up to 50 entries.</p>
+     */
+    Keys?: string[];
+}
+/**
+ * @public
+ * <p>Details about the scope of the notifications such as the affected resources.</p>
+ */
+export interface ScopeDetails {
+    /**
+     * @public
+     * <p>Underlying
+     *          LF resources that will be affected by this notification.</p>
+     */
+    LakeFormationTagPolicies?: LakeFormationTagPolicyDetails[];
+    /**
+     * @public
+     * <p>Underlying
+     *          Redshift resources that will be affected by this notification.</p>
+     */
+    RedshiftDataShares?: RedshiftDataShareDetails[];
+    /**
+     * @public
+     * <p>Underlying
+     *          S3 resources that will be affected by this notification.</p>
+     */
+    S3DataAccesses?: S3DataAccessDetails[];
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const NotificationType: {
+    readonly DATA_DELAY: "DATA_DELAY";
+    readonly DATA_UPDATE: "DATA_UPDATE";
+    readonly DEPRECATION: "DEPRECATION";
+    readonly SCHEMA_CHANGE: "SCHEMA_CHANGE";
+};
+/**
+ * @public
+ */
+export type NotificationType = (typeof NotificationType)[keyof typeof NotificationType];
+/**
+ * @public
+ */
+export interface SendDataSetNotificationRequest {
+    /**
+     * @public
+     * <p>Affected
+     *          scope of this notification such as the underlying resources affected by the notification
+     *          event.</p>
+     */
+    Scope?: ScopeDetails;
+    /**
+     * @public
+     * <p>Idempotency
+     *          key for the notification, this key allows us to deduplicate notifications that are sent in
+     *          quick succession erroneously.</p>
+     */
+    ClientToken?: string;
+    /**
+     * @public
+     * <p>Free-form
+     *          text field for providers to add information about their notifications.</p>
+     */
+    Comment?: string;
+    /**
+     * @public
+     * <p>Affected
+     *          data set of the notification.</p>
+     */
+    DataSetId: string | undefined;
+    /**
+     * @public
+     * <p>Extra
+     *          details specific to this notification type.</p>
+     */
+    Details?: NotificationDetails;
+    /**
+     * @public
+     * <p>The
+     *          type of the notification. Describing the kind of event the notification is alerting you
+     *          to.</p>
+     */
+    Type: NotificationType | undefined;
+}
+/**
+ * @public
+ */
+export interface SendDataSetNotificationResponse {
+}
 /**
  * @public
  */

package/dist-types/protocols/Aws_restJson1.d.ts

@@ -22,6 +22,7 @@ import { ListRevisionAssetsCommandInput, ListRevisionAssetsCommandOutput } from
 import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
 import { RevokeRevisionCommandInput, RevokeRevisionCommandOutput } from "../commands/RevokeRevisionCommand";
 import { SendApiAssetCommandInput, SendApiAssetCommandOutput } from "../commands/SendApiAssetCommand";
+import { SendDataSetNotificationCommandInput, SendDataSetNotificationCommandOutput } from "../commands/SendDataSetNotificationCommand";
 import { StartJobCommandInput, StartJobCommandOutput } from "../commands/StartJobCommand";
 import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
@@ -117,6 +118,10 @@ export declare const se_RevokeRevisionCommand: (input: RevokeRevisionCommandInpu
  * serializeAws_restJson1SendApiAssetCommand
  */
 export declare const se_SendApiAssetCommand: (input: SendApiAssetCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_restJson1SendDataSetNotificationCommand
+ */
+export declare const se_SendDataSetNotificationCommand: (input: SendDataSetNotificationCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_restJson1StartJobCommand
  */
@@ -233,6 +238,10 @@ export declare const de_RevokeRevisionCommand: (output: __HttpResponse, context:
  * deserializeAws_restJson1SendApiAssetCommand
  */
 export declare const de_SendApiAssetCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SendApiAssetCommandOutput>;
+/**
+ * deserializeAws_restJson1SendDataSetNotificationCommand
+ */
+export declare const de_SendDataSetNotificationCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SendDataSetNotificationCommandOutput>;
 /**
  * deserializeAws_restJson1StartJobCommand
  */

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

@@ -87,6 +87,10 @@ import {
   SendApiAssetCommandInput,
   SendApiAssetCommandOutput,
 } from "./commands/SendApiAssetCommand";
+import {
+  SendDataSetNotificationCommandInput,
+  SendDataSetNotificationCommandOutput,
+} from "./commands/SendDataSetNotificationCommand";
 import {
   StartJobCommandInput,
   StartJobCommandOutput,
@@ -403,6 +407,19 @@ export interface DataExchange {
     options: __HttpHandlerOptions,
     cb: (err: any, data?: SendApiAssetCommandOutput) => void
   ): void;
+  sendDataSetNotification(
+    args: SendDataSetNotificationCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<SendDataSetNotificationCommandOutput>;
+  sendDataSetNotification(
+    args: SendDataSetNotificationCommandInput,
+    cb: (err: any, data?: SendDataSetNotificationCommandOutput) => void
+  ): void;
+  sendDataSetNotification(
+    args: SendDataSetNotificationCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: SendDataSetNotificationCommandOutput) => void
+  ): void;
   startJob(
     args: StartJobCommandInput,
     options?: __HttpHandlerOptions

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

@@ -133,6 +133,10 @@ import {
   SendApiAssetCommandInput,
   SendApiAssetCommandOutput,
 } from "./commands/SendApiAssetCommand";
+import {
+  SendDataSetNotificationCommandInput,
+  SendDataSetNotificationCommandOutput,
+} from "./commands/SendDataSetNotificationCommand";
 import {
   StartJobCommandInput,
   StartJobCommandOutput,
@@ -191,6 +195,7 @@ export type ServiceInputTypes =
   | ListTagsForResourceCommandInput
   | RevokeRevisionCommandInput
   | SendApiAssetCommandInput
+  | SendDataSetNotificationCommandInput
   | StartJobCommandInput
   | TagResourceCommandInput
   | UntagResourceCommandInput
@@ -221,6 +226,7 @@ export type ServiceOutputTypes =
   | ListTagsForResourceCommandOutput
   | RevokeRevisionCommandOutput
   | SendApiAssetCommandOutput
+  | SendDataSetNotificationCommandOutput
   | StartJobCommandOutput
   | TagResourceCommandOutput
   | UntagResourceCommandOutput

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

@@ -0,0 +1,42 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import {
+  Handler,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+} from "@smithy/types";
+import {
+  DataExchangeClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../DataExchangeClient";
+import {
+  SendDataSetNotificationRequest,
+  SendDataSetNotificationResponse,
+} from "../models/models_0";
+export { __MetadataBearer, $Command };
+export interface SendDataSetNotificationCommandInput
+  extends SendDataSetNotificationRequest {}
+export interface SendDataSetNotificationCommandOutput
+  extends SendDataSetNotificationResponse,
+    __MetadataBearer {}
+export declare class SendDataSetNotificationCommand extends $Command<
+  SendDataSetNotificationCommandInput,
+  SendDataSetNotificationCommandOutput,
+  DataExchangeClientResolvedConfig
+> {
+  readonly input: SendDataSetNotificationCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: SendDataSetNotificationCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: DataExchangeClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<
+    SendDataSetNotificationCommandInput,
+    SendDataSetNotificationCommandOutput
+  >;
+  private serialize;
+  private deserialize;
+}

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

@@ -20,6 +20,7 @@ export * from "./ListRevisionAssetsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./RevokeRevisionCommand";
 export * from "./SendApiAssetCommand";
+export * from "./SendDataSetNotificationCommand";
 export * from "./StartJobCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";

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

@@ -4,4 +4,5 @@ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
 export * from "./commands";
 export * from "./pagination";
 export * from "./models";
+import "@aws-sdk/util-endpoints";
 export { DataExchangeServiceException } from "./models/DataExchangeServiceException";

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

@@ -777,6 +777,71 @@ export interface SendApiAssetResponse {
   Body?: string;
   ResponseHeaders?: Record<string, string>;
 }
+export interface DataUpdateRequestDetails {
+  DataUpdatedAt?: Date;
+}
+export interface DeprecationRequestDetails {
+  DeprecationAt: Date | undefined;
+}
+export declare const SchemaChangeType: {
+  readonly ADD: "ADD";
+  readonly MODIFY: "MODIFY";
+  readonly REMOVE: "REMOVE";
+};
+export type SchemaChangeType =
+  (typeof SchemaChangeType)[keyof typeof SchemaChangeType];
+export interface SchemaChangeDetails {
+  Name: string | undefined;
+  Type: SchemaChangeType | undefined;
+  Description?: string;
+}
+export interface SchemaChangeRequestDetails {
+  Changes?: SchemaChangeDetails[];
+  SchemaChangeAt: Date | undefined;
+}
+export interface NotificationDetails {
+  DataUpdate?: DataUpdateRequestDetails;
+  Deprecation?: DeprecationRequestDetails;
+  SchemaChange?: SchemaChangeRequestDetails;
+}
+export interface LakeFormationTagPolicyDetails {
+  Database?: string;
+  Table?: string;
+}
+export interface RedshiftDataShareDetails {
+  Arn: string | undefined;
+  Database: string | undefined;
+  Function?: string;
+  Table?: string;
+  Schema?: string;
+  View?: string;
+}
+export interface S3DataAccessDetails {
+  KeyPrefixes?: string[];
+  Keys?: string[];
+}
+export interface ScopeDetails {
+  LakeFormationTagPolicies?: LakeFormationTagPolicyDetails[];
+  RedshiftDataShares?: RedshiftDataShareDetails[];
+  S3DataAccesses?: S3DataAccessDetails[];
+}
+export declare const NotificationType: {
+  readonly DATA_DELAY: "DATA_DELAY";
+  readonly DATA_UPDATE: "DATA_UPDATE";
+  readonly DEPRECATION: "DEPRECATION";
+  readonly SCHEMA_CHANGE: "SCHEMA_CHANGE";
+};
+export type NotificationType =
+  (typeof NotificationType)[keyof typeof NotificationType];
+export interface SendDataSetNotificationRequest {
+  Scope?: ScopeDetails;
+  ClientToken?: string;
+  Comment?: string;
+  DataSetId: string | undefined;
+  Details?: NotificationDetails;
+  Type: NotificationType | undefined;
+}
+export interface SendDataSetNotificationResponse {}
 export interface StartJobRequest {
   JobId: string | undefined;
 }