feat(client-lookoutmetrics): Adding AthenaSourceConfig for MetricSet APIs to support Athena as a data source.

Author: awstools

clients/client-lookoutmetrics/src/models/models_0.ts

@@ -70,7 +70,7 @@ export interface SNSConfiguration {
   SnsTopicArn: string | undefined;
 
   /**
-   * <p>The text format for alerts.</p>
+   * <p>The format of the SNS topic.</p>
    */
   SnsFormat?: SnsFormat | string;
 }
@@ -875,6 +875,74 @@ export namespace AppFlowConfig {
   });
 }
 
+/**
+ * <p>Settings for backtest mode.</p>
+ */
+export interface BackTestConfiguration {
+  /**
+   * <p>Run a backtest instead of monitoring new data.</p>
+   */
+  RunBackTestMode: boolean | undefined;
+}
+
+export namespace BackTestConfiguration {
+  /**
+   * @internal
+   */
+  export const filterSensitiveLog = (obj: BackTestConfiguration): any => ({
+    ...obj,
+  });
+}
+
+/**
+ * <p>Details about an Amazon Athena datasource.</p>
+ */
+export interface AthenaSourceConfig {
+  /**
+   * <p>An IAM role that gives Amazon Lookout for Metrics permission to access the data.</p>
+   */
+  RoleArn?: string;
+
+  /**
+   * <p>The database's name.</p>
+   */
+  DatabaseName?: string;
+
+  /**
+   * <p>The database's data catalog.</p>
+   */
+  DataCatalog?: string;
+
+  /**
+   * <p>The database's table name.</p>
+   */
+  TableName?: string;
+
+  /**
+   * <p>The database's work group name.</p>
+   */
+  WorkGroupName?: string;
+
+  /**
+   * <p>The database's results path.</p>
+   */
+  S3ResultsPath?: string;
+
+  /**
+   * <p>Settings for backtest mode.</p>
+   */
+  BackTestConfiguration?: BackTestConfiguration;
+}
+
+export namespace AthenaSourceConfig {
+  /**
+   * @internal
+   */
+  export const filterSensitiveLog = (obj: AthenaSourceConfig): any => ({
+    ...obj,
+  });
+}
+
 /**
  * <p>An attribute value.</p>
  */
@@ -1465,7 +1533,7 @@ export namespace S3SourceConfig {
 }
 
 /**
- * <p>Contains information about source data used to generate a metric.</p>
+ * <p>Contains information about source data used to generate metrics.</p>
  */
 export interface MetricSource {
   /**
@@ -1474,24 +1542,29 @@ export interface MetricSource {
   S3SourceConfig?: S3SourceConfig;
 
   /**
-   * <p>An object containing information about the AppFlow configuration.</p>
+   * <p>Details about an AppFlow datasource.</p>
    */
   AppFlowConfig?: AppFlowConfig;
 
   /**
-   * <p>An object containing information about the Amazon CloudWatch monitoring configuration.</p>
+   * <p>Details about an Amazon CloudWatch monitoring datasource.</p>
    */
   CloudWatchConfig?: CloudWatchConfig;
 
   /**
-   * <p>An object containing information about the Amazon Relational Database Service (RDS) configuration.</p>
+   * <p>Details about an Amazon Relational Database Service (RDS) datasource.</p>
    */
   RDSSourceConfig?: RDSSourceConfig;
 
   /**
-   * <p>An object containing information about the Amazon Redshift database configuration.</p>
+   * <p>Details about an Amazon Redshift database datasource.</p>
    */
   RedshiftSourceConfig?: RedshiftSourceConfig;
+
+  /**
+   * <p>Details about an Amazon Athena datasource.</p>
+   */
+  AthenaSourceConfig?: AthenaSourceConfig;
 }
 
 export namespace MetricSource {
@@ -3074,7 +3147,7 @@ export interface UpdateMetricSetRequest {
   MetricSetFrequency?: Frequency | string;
 
   /**
-   * <p>Contains information about source data used to generate a metric.</p>
+   * <p>Contains information about source data used to generate metrics.</p>
    */
   MetricSource?: MetricSource;
 }

clients/client-lookoutmetrics/src/protocols/Aws_restJson1.ts

@@ -103,9 +103,11 @@ import {
   AnomalyGroupTimeSeries,
   AnomalyGroupTimeSeriesFeedback,
   AppFlowConfig,
+  AthenaSourceConfig,
   AttributeValue,
   AutoDetectionMetricSource,
   AutoDetectionS3SourceConfig,
+  BackTestConfiguration,
   CloudWatchConfig,
   ConflictException,
   ContributionMatrix,
@@ -2866,6 +2868,21 @@ const serializeAws_restJson1AppFlowConfig = (input: AppFlowConfig, context: __Se
   };
 };
 
+const serializeAws_restJson1AthenaSourceConfig = (input: AthenaSourceConfig, context: __SerdeContext): any => {
+  return {
+    ...(input.BackTestConfiguration !== undefined &&
+      input.BackTestConfiguration !== null && {
+        BackTestConfiguration: serializeAws_restJson1BackTestConfiguration(input.BackTestConfiguration, context),
+      }),
+    ...(input.DataCatalog !== undefined && input.DataCatalog !== null && { DataCatalog: input.DataCatalog }),
+    ...(input.DatabaseName !== undefined && input.DatabaseName !== null && { DatabaseName: input.DatabaseName }),
+    ...(input.RoleArn !== undefined && input.RoleArn !== null && { RoleArn: input.RoleArn }),
+    ...(input.S3ResultsPath !== undefined && input.S3ResultsPath !== null && { S3ResultsPath: input.S3ResultsPath }),
+    ...(input.TableName !== undefined && input.TableName !== null && { TableName: input.TableName }),
+    ...(input.WorkGroupName !== undefined && input.WorkGroupName !== null && { WorkGroupName: input.WorkGroupName }),
+  };
+};
+
 const serializeAws_restJson1AutoDetectionMetricSource = (
   input: AutoDetectionMetricSource,
   context: __SerdeContext
@@ -2894,6 +2911,13 @@ const serializeAws_restJson1AutoDetectionS3SourceConfig = (
   };
 };
 
+const serializeAws_restJson1BackTestConfiguration = (input: BackTestConfiguration, context: __SerdeContext): any => {
+  return {
+    ...(input.RunBackTestMode !== undefined &&
+      input.RunBackTestMode !== null && { RunBackTestMode: input.RunBackTestMode }),
+  };
+};
+
 const serializeAws_restJson1CloudWatchConfig = (input: CloudWatchConfig, context: __SerdeContext): any => {
   return {
     ...(input.RoleArn !== undefined && input.RoleArn !== null && { RoleArn: input.RoleArn }),
@@ -3001,6 +3025,10 @@ const serializeAws_restJson1MetricSource = (input: MetricSource, context: __Serd
       input.AppFlowConfig !== null && {
         AppFlowConfig: serializeAws_restJson1AppFlowConfig(input.AppFlowConfig, context),
       }),
+    ...(input.AthenaSourceConfig !== undefined &&
+      input.AthenaSourceConfig !== null && {
+        AthenaSourceConfig: serializeAws_restJson1AthenaSourceConfig(input.AthenaSourceConfig, context),
+      }),
     ...(input.CloudWatchConfig !== undefined &&
       input.CloudWatchConfig !== null && {
         CloudWatchConfig: serializeAws_restJson1CloudWatchConfig(input.CloudWatchConfig, context),
@@ -3346,6 +3374,21 @@ const deserializeAws_restJson1AppFlowConfig = (output: any, context: __SerdeCont
   } as any;
 };
 
+const deserializeAws_restJson1AthenaSourceConfig = (output: any, context: __SerdeContext): AthenaSourceConfig => {
+  return {
+    BackTestConfiguration:
+      output.BackTestConfiguration !== undefined && output.BackTestConfiguration !== null
+        ? deserializeAws_restJson1BackTestConfiguration(output.BackTestConfiguration, context)
+        : undefined,
+    DataCatalog: __expectString(output.DataCatalog),
+    DatabaseName: __expectString(output.DatabaseName),
+    RoleArn: __expectString(output.RoleArn),
+    S3ResultsPath: __expectString(output.S3ResultsPath),
+    TableName: __expectString(output.TableName),
+    WorkGroupName: __expectString(output.WorkGroupName),
+  } as any;
+};
+
 const deserializeAws_restJson1AttributeValue = (output: any, context: __SerdeContext): AttributeValue => {
   return {
     B: __expectString(output.B),
@@ -3366,6 +3409,12 @@ const deserializeAws_restJson1AttributeValue = (output: any, context: __SerdeCon
   } as any;
 };
 
+const deserializeAws_restJson1BackTestConfiguration = (output: any, context: __SerdeContext): BackTestConfiguration => {
+  return {
+    RunBackTestMode: __expectBoolean(output.RunBackTestMode),
+  } as any;
+};
+
 const deserializeAws_restJson1BinaryListAttributeValue = (output: any, context: __SerdeContext): string[] => {
   const retVal = (output || [])
     .filter((e: any) => e != null)
@@ -3818,6 +3867,10 @@ const deserializeAws_restJson1MetricSource = (output: any, context: __SerdeConte
       output.AppFlowConfig !== undefined && output.AppFlowConfig !== null
         ? deserializeAws_restJson1AppFlowConfig(output.AppFlowConfig, context)
         : undefined,
+    AthenaSourceConfig:
+      output.AthenaSourceConfig !== undefined && output.AthenaSourceConfig !== null
+        ? deserializeAws_restJson1AthenaSourceConfig(output.AthenaSourceConfig, context)
+        : undefined,
     CloudWatchConfig:
       output.CloudWatchConfig !== undefined && output.CloudWatchConfig !== null
         ? deserializeAws_restJson1CloudWatchConfig(output.CloudWatchConfig, context)