@aws-sdk/client-forecast 3.42.0 → 3.43.0

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

@@ -1,55 +1,60 @@
 import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
-export declare enum DatasetType {
-    ITEM_METADATA = "ITEM_METADATA",
-    RELATED_TIME_SERIES = "RELATED_TIME_SERIES",
-    TARGET_TIME_SERIES = "TARGET_TIME_SERIES"
+
+export interface AdditionalDataset {
+    
+    Name: string | undefined;
+    
+    Configuration?: {
+        [key: string]: string[];
+    };
 }
-export declare enum Domain {
-    CUSTOM = "CUSTOM",
-    EC2_CAPACITY = "EC2_CAPACITY",
-    INVENTORY_PLANNING = "INVENTORY_PLANNING",
-    METRICS = "METRICS",
-    RETAIL = "RETAIL",
-    WEB_TRAFFIC = "WEB_TRAFFIC",
-    WORK_FORCE = "WORK_FORCE"
+export declare namespace AdditionalDataset {
+    
+    const filterSensitiveLog: (obj: AdditionalDataset) => any;
 }
 
-export interface EncryptionConfig {
+export interface AttributeConfig {
     
-    RoleArn: string | undefined;
+    AttributeName: string | undefined;
     
-    KMSKeyArn: string | undefined;
+    Transformations: {
+        [key: string]: string;
+    } | undefined;
 }
-export declare namespace EncryptionConfig {
+export declare namespace AttributeConfig {
     
-    const filterSensitiveLog: (obj: EncryptionConfig) => any;
-}
-export declare enum AttributeType {
-    FLOAT = "float",
-    GEOLOCATION = "geolocation",
-    INTEGER = "integer",
-    STRING = "string",
-    TIMESTAMP = "timestamp"
+    const filterSensitiveLog: (obj: AttributeConfig) => any;
 }
 
-export interface SchemaAttribute {
+export interface DataConfig {
     
-    AttributeName?: string;
+    DatasetGroupArn: string | undefined;
     
-    AttributeType?: AttributeType | string;
+    AttributeConfigs?: AttributeConfig[];
+    
+    AdditionalDatasets?: AdditionalDataset[];
 }
-export declare namespace SchemaAttribute {
+export declare namespace DataConfig {
     
-    const filterSensitiveLog: (obj: SchemaAttribute) => any;
+    const filterSensitiveLog: (obj: DataConfig) => any;
 }
 
-export interface Schema {
+export interface EncryptionConfig {
     
-    Attributes?: SchemaAttribute[];
+    RoleArn: string | undefined;
+    
+    KMSKeyArn: string | undefined;
 }
-export declare namespace Schema {
+export declare namespace EncryptionConfig {
     
-    const filterSensitiveLog: (obj: Schema) => any;
+    const filterSensitiveLog: (obj: EncryptionConfig) => any;
+}
+export declare enum OptimizationMetric {
+    AverageWeightedQuantileLoss = "AverageWeightedQuantileLoss",
+    MAPE = "MAPE",
+    MASE = "MASE",
+    RMSE = "RMSE",
+    WAPE = "WAPE"
 }
 
 export interface Tag {
@@ -62,33 +67,40 @@ export declare namespace Tag {
     
     const filterSensitiveLog: (obj: Tag) => any;
 }
-export interface CreateDatasetRequest {
+export interface CreateAutoPredictorRequest {
     
-    DatasetName: string | undefined;
+    PredictorName: string | undefined;
     
-    Domain: Domain | string | undefined;
+    ForecastHorizon?: number;
     
-    DatasetType: DatasetType | string | undefined;
+    ForecastTypes?: string[];
     
-    DataFrequency?: string;
+    ForecastDimensions?: string[];
     
-    Schema: Schema | undefined;
+    ForecastFrequency?: string;
+    
+    DataConfig?: DataConfig;
     
     EncryptionConfig?: EncryptionConfig;
     
+    ReferencePredictorArn?: string;
+    
+    OptimizationMetric?: OptimizationMetric | string;
+    ExplainPredictor?: boolean;
+    
     Tags?: Tag[];
 }
-export declare namespace CreateDatasetRequest {
+export declare namespace CreateAutoPredictorRequest {
     
-    const filterSensitiveLog: (obj: CreateDatasetRequest) => any;
+    const filterSensitiveLog: (obj: CreateAutoPredictorRequest) => any;
 }
-export interface CreateDatasetResponse {
+export interface CreateAutoPredictorResponse {
     
-    DatasetArn?: string;
+    PredictorArn?: string;
 }
-export declare namespace CreateDatasetResponse {
+export declare namespace CreateAutoPredictorResponse {
     
-    const filterSensitiveLog: (obj: CreateDatasetResponse) => any;
+    const filterSensitiveLog: (obj: CreateAutoPredictorResponse) => any;
 }
 
 export interface InvalidInputException extends __SmithyException, $MetadataBearer {
@@ -120,6 +132,95 @@ export declare namespace ResourceAlreadyExistsException {
     
     const filterSensitiveLog: (obj: ResourceAlreadyExistsException) => any;
 }
+
+export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
+    name: "ResourceInUseException";
+    $fault: "client";
+    Message?: string;
+}
+export declare namespace ResourceInUseException {
+    
+    const filterSensitiveLog: (obj: ResourceInUseException) => any;
+}
+
+export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
+    name: "ResourceNotFoundException";
+    $fault: "client";
+    Message?: string;
+}
+export declare namespace ResourceNotFoundException {
+    
+    const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
+}
+export declare enum DatasetType {
+    ITEM_METADATA = "ITEM_METADATA",
+    RELATED_TIME_SERIES = "RELATED_TIME_SERIES",
+    TARGET_TIME_SERIES = "TARGET_TIME_SERIES"
+}
+export declare enum Domain {
+    CUSTOM = "CUSTOM",
+    EC2_CAPACITY = "EC2_CAPACITY",
+    INVENTORY_PLANNING = "INVENTORY_PLANNING",
+    METRICS = "METRICS",
+    RETAIL = "RETAIL",
+    WEB_TRAFFIC = "WEB_TRAFFIC",
+    WORK_FORCE = "WORK_FORCE"
+}
+export declare enum AttributeType {
+    FLOAT = "float",
+    GEOLOCATION = "geolocation",
+    INTEGER = "integer",
+    STRING = "string",
+    TIMESTAMP = "timestamp"
+}
+
+export interface SchemaAttribute {
+    
+    AttributeName?: string;
+    
+    AttributeType?: AttributeType | string;
+}
+export declare namespace SchemaAttribute {
+    
+    const filterSensitiveLog: (obj: SchemaAttribute) => any;
+}
+
+export interface Schema {
+    
+    Attributes?: SchemaAttribute[];
+}
+export declare namespace Schema {
+    
+    const filterSensitiveLog: (obj: Schema) => any;
+}
+export interface CreateDatasetRequest {
+    
+    DatasetName: string | undefined;
+    
+    Domain: Domain | string | undefined;
+    
+    DatasetType: DatasetType | string | undefined;
+    
+    DataFrequency?: string;
+    
+    Schema: Schema | undefined;
+    
+    EncryptionConfig?: EncryptionConfig;
+    
+    Tags?: Tag[];
+}
+export declare namespace CreateDatasetRequest {
+    
+    const filterSensitiveLog: (obj: CreateDatasetRequest) => any;
+}
+export interface CreateDatasetResponse {
+    
+    DatasetArn?: string;
+}
+export declare namespace CreateDatasetResponse {
+    
+    const filterSensitiveLog: (obj: CreateDatasetResponse) => any;
+}
 export interface CreateDatasetGroupRequest {
     
     DatasetGroupName: string | undefined;
@@ -143,26 +244,6 @@ export declare namespace CreateDatasetGroupResponse {
     const filterSensitiveLog: (obj: CreateDatasetGroupResponse) => any;
 }
 
-export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
-    name: "ResourceInUseException";
-    $fault: "client";
-    Message?: string;
-}
-export declare namespace ResourceInUseException {
-    
-    const filterSensitiveLog: (obj: ResourceInUseException) => any;
-}
-
-export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
-    name: "ResourceNotFoundException";
-    $fault: "client";
-    Message?: string;
-}
-export declare namespace ResourceNotFoundException {
-    
-    const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
-}
-
 export interface S3Config {
     
     Path: string | undefined;
@@ -214,6 +295,88 @@ export declare namespace CreateDatasetImportJobResponse {
     
     const filterSensitiveLog: (obj: CreateDatasetImportJobResponse) => any;
 }
+export declare enum TimePointGranularity {
+    ALL = "ALL",
+    SPECIFIC = "SPECIFIC"
+}
+export declare enum TimeSeriesGranularity {
+    ALL = "ALL",
+    SPECIFIC = "SPECIFIC"
+}
+
+export interface ExplainabilityConfig {
+    
+    TimeSeriesGranularity: TimeSeriesGranularity | string | undefined;
+    
+    TimePointGranularity: TimePointGranularity | string | undefined;
+}
+export declare namespace ExplainabilityConfig {
+    
+    const filterSensitiveLog: (obj: ExplainabilityConfig) => any;
+}
+export interface CreateExplainabilityRequest {
+    
+    ExplainabilityName: string | undefined;
+    
+    ResourceArn: string | undefined;
+    
+    ExplainabilityConfig: ExplainabilityConfig | undefined;
+    
+    DataSource?: DataSource;
+    
+    Schema?: Schema;
+    
+    EnableVisualization?: boolean;
+    
+    StartDateTime?: string;
+    
+    EndDateTime?: string;
+    
+    Tags?: Tag[];
+}
+export declare namespace CreateExplainabilityRequest {
+    
+    const filterSensitiveLog: (obj: CreateExplainabilityRequest) => any;
+}
+export interface CreateExplainabilityResponse {
+    
+    ExplainabilityArn?: string;
+}
+export declare namespace CreateExplainabilityResponse {
+    
+    const filterSensitiveLog: (obj: CreateExplainabilityResponse) => any;
+}
+
+export interface DataDestination {
+    
+    S3Config: S3Config | undefined;
+}
+export declare namespace DataDestination {
+    
+    const filterSensitiveLog: (obj: DataDestination) => any;
+}
+export interface CreateExplainabilityExportRequest {
+    
+    ExplainabilityExportName: string | undefined;
+    
+    ExplainabilityArn: string | undefined;
+    
+    Destination: DataDestination | undefined;
+    
+    Tags?: Tag[];
+}
+export declare namespace CreateExplainabilityExportRequest {
+    
+    const filterSensitiveLog: (obj: CreateExplainabilityExportRequest) => any;
+}
+export interface CreateExplainabilityExportResponse {
+    
+    ExplainabilityExportArn?: string;
+}
+export declare namespace CreateExplainabilityExportResponse {
+    
+    const filterSensitiveLog: (obj: CreateExplainabilityExportResponse) => any;
+}
 export interface CreateForecastRequest {
     
     ForecastName: string | undefined;
@@ -236,15 +399,6 @@ export declare namespace CreateForecastResponse {
     
     const filterSensitiveLog: (obj: CreateForecastResponse) => any;
 }
-
-export interface DataDestination {
-    
-    S3Config: S3Config | undefined;
-}
-export declare namespace DataDestination {
-    
-    const filterSensitiveLog: (obj: DataDestination) => any;
-}
 export interface CreateForecastExportJobRequest {
     
     ForecastExportJobName: string | undefined;
@@ -268,6 +422,7 @@ export declare namespace CreateForecastExportJobResponse {
     const filterSensitiveLog: (obj: CreateForecastExportJobResponse) => any;
 }
 export declare enum AutoMLOverrideStrategy {
+    AccuracyOptimized = "AccuracyOptimized",
     LatencyOptimized = "LatencyOptimized"
 }
 
@@ -412,13 +567,6 @@ export declare namespace InputDataConfig {
     
     const filterSensitiveLog: (obj: InputDataConfig) => any;
 }
-export declare enum OptimizationMetric {
-    AverageWeightedQuantileLoss = "AverageWeightedQuantileLoss",
-    MAPE = "MAPE",
-    MASE = "MASE",
-    RMSE = "RMSE",
-    WAPE = "WAPE"
-}
 export interface CreatePredictorRequest {
     
     PredictorName: string | undefined;
@@ -511,6 +659,22 @@ export declare namespace DeleteDatasetImportJobRequest {
     
     const filterSensitiveLog: (obj: DeleteDatasetImportJobRequest) => any;
 }
+export interface DeleteExplainabilityRequest {
+    
+    ExplainabilityArn: string | undefined;
+}
+export declare namespace DeleteExplainabilityRequest {
+    
+    const filterSensitiveLog: (obj: DeleteExplainabilityRequest) => any;
+}
+export interface DeleteExplainabilityExportRequest {
+    
+    ExplainabilityExportArn: string | undefined;
+}
+export declare namespace DeleteExplainabilityExportRequest {
+    
+    const filterSensitiveLog: (obj: DeleteExplainabilityExportRequest) => any;
+}
 export interface DeleteForecastRequest {
     
     ForecastArn: string | undefined;
@@ -551,6 +715,74 @@ export declare namespace DeleteResourceTreeRequest {
     
     const filterSensitiveLog: (obj: DeleteResourceTreeRequest) => any;
 }
+export interface DescribeAutoPredictorRequest {
+    
+    PredictorArn: string | undefined;
+}
+export declare namespace DescribeAutoPredictorRequest {
+    
+    const filterSensitiveLog: (obj: DescribeAutoPredictorRequest) => any;
+}
+export interface ExplainabilityInfo {
+    ExplainabilityArn?: string;
+    Status?: string;
+}
+export declare namespace ExplainabilityInfo {
+    
+    const filterSensitiveLog: (obj: ExplainabilityInfo) => any;
+}
+export declare enum State {
+    Active = "Active",
+    Deleted = "Deleted"
+}
+
+export interface ReferencePredictorSummary {
+    
+    Arn?: string;
+    
+    State?: State | string;
+}
+export declare namespace ReferencePredictorSummary {
+    
+    const filterSensitiveLog: (obj: ReferencePredictorSummary) => any;
+}
+export interface DescribeAutoPredictorResponse {
+    
+    PredictorArn?: string;
+    
+    PredictorName?: string;
+    
+    ForecastHorizon?: number;
+    
+    ForecastTypes?: string[];
+    
+    ForecastFrequency?: string;
+    
+    DatasetImportJobArns?: string[];
+    
+    DataConfig?: DataConfig;
+    
+    EncryptionConfig?: EncryptionConfig;
+    
+    ReferencePredictorSummary?: ReferencePredictorSummary;
+    
+    EstimatedTimeRemainingInMinutes?: number;
+    
+    Status?: string;
+    
+    Message?: string;
+    
+    CreationTime?: Date;
+    
+    LastModificationTime?: Date;
+    
+    OptimizationMetric?: OptimizationMetric | string;
+    ExplainabilityInfo?: ExplainabilityInfo;
+}
+export declare namespace DescribeAutoPredictorResponse {
+    
+    const filterSensitiveLog: (obj: DescribeAutoPredictorResponse) => any;
+}
 export interface DescribeDatasetRequest {
     
     DatasetArn: string | undefined;
@@ -690,6 +922,78 @@ export declare namespace DescribeDatasetImportJobResponse {
     
     const filterSensitiveLog: (obj: DescribeDatasetImportJobResponse) => any;
 }
+export interface DescribeExplainabilityRequest {
+    
+    ExplainabilityArn: string | undefined;
+}
+export declare namespace DescribeExplainabilityRequest {
+    
+    const filterSensitiveLog: (obj: DescribeExplainabilityRequest) => any;
+}
+export interface DescribeExplainabilityResponse {
+    
+    ExplainabilityArn?: string;
+    
+    ExplainabilityName?: string;
+    
+    ResourceArn?: string;
+    
+    ExplainabilityConfig?: ExplainabilityConfig;
+    
+    EnableVisualization?: boolean;
+    
+    DataSource?: DataSource;
+    
+    Schema?: Schema;
+    
+    StartDateTime?: string;
+    
+    EndDateTime?: string;
+    
+    EstimatedTimeRemainingInMinutes?: number;
+    
+    Message?: string;
+    
+    Status?: string;
+    
+    CreationTime?: Date;
+    
+    LastModificationTime?: Date;
+}
+export declare namespace DescribeExplainabilityResponse {
+    
+    const filterSensitiveLog: (obj: DescribeExplainabilityResponse) => any;
+}
+export interface DescribeExplainabilityExportRequest {
+    
+    ExplainabilityExportArn: string | undefined;
+}
+export declare namespace DescribeExplainabilityExportRequest {
+    
+    const filterSensitiveLog: (obj: DescribeExplainabilityExportRequest) => any;
+}
+export interface DescribeExplainabilityExportResponse {
+    
+    ExplainabilityExportArn?: string;
+    
+    ExplainabilityExportName?: string;
+    
+    ExplainabilityArn?: string;
+    
+    Destination?: DataDestination;
+    
+    Message?: string;
+    
+    Status?: string;
+    
+    CreationTime?: Date;
+    
+    LastModificationTime?: Date;
+}
+export declare namespace DescribeExplainabilityExportResponse {
+    
+    const filterSensitiveLog: (obj: DescribeExplainabilityExportResponse) => any;
+}
 export interface DescribeForecastRequest {
     
     ForecastArn: string | undefined;
@@ -805,6 +1109,8 @@ export interface DescribePredictorResponse {
     
     AlgorithmArn?: string;
     
+    AutoMLAlgorithmArns?: string[];
+    
     ForecastHorizon?: number;
     
     ForecastTypes?: string[];
@@ -833,9 +1139,9 @@ export interface DescribePredictorResponse {
     
     EstimatedTimeRemainingInMinutes?: number;
     
-    DatasetImportJobArns?: string[];
+    IsAutoPredictor?: boolean;
     
-    AutoMLAlgorithmArns?: string[];
+    DatasetImportJobArns?: string[];
     
     Status?: string;
     
@@ -968,6 +1274,8 @@ export interface GetAccuracyMetricsResponse {
     
     PredictorEvaluationResults?: EvaluationResult[];
     
+    IsAutoPredictor?: boolean;
+    
     AutoMLOverrideStrategy?: AutoMLOverrideStrategy | string;
     
     OptimizationMetric?: OptimizationMetric | string;
@@ -1120,6 +1428,94 @@ export declare namespace ListDatasetsResponse {
     
     const filterSensitiveLog: (obj: ListDatasetsResponse) => any;
 }
+export interface ListExplainabilitiesRequest {
+    
+    NextToken?: string;
+    
+    MaxResults?: number;
+    
+    Filters?: Filter[];
+}
+export declare namespace ListExplainabilitiesRequest {
+    
+    const filterSensitiveLog: (obj: ListExplainabilitiesRequest) => any;
+}
+
+export interface ExplainabilitySummary {
+    
+    ExplainabilityArn?: string;
+    
+    ExplainabilityName?: string;
+    
+    ResourceArn?: string;
+    
+    ExplainabilityConfig?: ExplainabilityConfig;
+    
+    Status?: string;
+    
+    Message?: string;
+    
+    CreationTime?: Date;
+    
+    LastModificationTime?: Date;
+}
+export declare namespace ExplainabilitySummary {
+    
+    const filterSensitiveLog: (obj: ExplainabilitySummary) => any;
+}
+export interface ListExplainabilitiesResponse {
+    
+    Explainabilities?: ExplainabilitySummary[];
+    
+    NextToken?: string;
+}
+export declare namespace ListExplainabilitiesResponse {
+    
+    const filterSensitiveLog: (obj: ListExplainabilitiesResponse) => any;
+}
+export interface ListExplainabilityExportsRequest {
+    
+    NextToken?: string;
+    
+    MaxResults?: number;
+    
+    Filters?: Filter[];
+}
+export declare namespace ListExplainabilityExportsRequest {
+    
+    const filterSensitiveLog: (obj: ListExplainabilityExportsRequest) => any;
+}
+
+export interface ExplainabilityExportSummary {
+    
+    ExplainabilityExportArn?: string;
+    
+    ExplainabilityExportName?: string;
+    
+    Destination?: DataDestination;
+    
+    Status?: string;
+    
+    Message?: string;
+    
+    CreationTime?: Date;
+    
+    LastModificationTime?: Date;
+}
+export declare namespace ExplainabilityExportSummary {
+    
+    const filterSensitiveLog: (obj: ExplainabilityExportSummary) => any;
+}
+export interface ListExplainabilityExportsResponse {
+    
+    ExplainabilityExports?: ExplainabilityExportSummary[];
+    
+    NextToken?: string;
+}
+export declare namespace ListExplainabilityExportsResponse {
+    
+    const filterSensitiveLog: (obj: ListExplainabilityExportsResponse) => any;
+}
 export interface ListForecastExportJobsRequest {
     
     NextToken?: string;
@@ -1183,6 +1579,7 @@ export interface ForecastSummary {
     ForecastName?: string;
     
     PredictorArn?: string;
+    CreatedUsingAutoPredictor?: boolean;
     
     DatasetGroupArn?: string;
     
@@ -1272,6 +1669,10 @@ export interface PredictorSummary {
     
     DatasetGroupArn?: string;
     
+    IsAutoPredictor?: boolean;
+    
+    ReferencePredictorSummary?: ReferencePredictorSummary;
+    
     Status?: string;
     
     Message?: string;