cdk-comprehend-s3olap 2.0.43 → 2.0.46

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/.jsii +3 -3
  2. package/lib/cdk-comprehend-s3olap.js +2 -2
  3. package/lib/comprehend-lambdas.js +2 -2
  4. package/lib/iam-roles.js +4 -4
  5. package/node_modules/aws-sdk/CHANGELOG.md +19 -1
  6. package/node_modules/aws-sdk/README.md +1 -1
  7. package/node_modules/aws-sdk/apis/account-2021-02-01.min.json +101 -0
  8. package/node_modules/aws-sdk/apis/athena-2017-05-18.min.json +117 -6
  9. package/node_modules/aws-sdk/apis/athena-2017-05-18.paginators.json +5 -0
  10. package/node_modules/aws-sdk/apis/docdb-2014-10-31.min.json +11 -0
  11. package/node_modules/aws-sdk/apis/frauddetector-2019-11-15.min.json +249 -94
  12. package/node_modules/aws-sdk/apis/iotdeviceadvisor-2020-09-18.min.json +33 -12
  13. package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.min.json +260 -59
  14. package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.paginators.json +6 -0
  15. package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +73 -72
  16. package/node_modules/aws-sdk/apis/medialive-2017-10-14.min.json +50 -3
  17. package/node_modules/aws-sdk/apis/monitoring-2010-08-01.min.json +54 -29
  18. package/node_modules/aws-sdk/apis/network-firewall-2020-11-12.min.json +91 -48
  19. package/node_modules/aws-sdk/apis/rds-2014-10-31.min.json +143 -119
  20. package/node_modules/aws-sdk/apis/transcribe-2017-10-26.min.json +2 -1
  21. package/node_modules/aws-sdk/clients/account.d.ts +104 -6
  22. package/node_modules/aws-sdk/clients/athena.d.ts +127 -0
  23. package/node_modules/aws-sdk/clients/cloudwatch.d.ts +40 -1
  24. package/node_modules/aws-sdk/clients/dms.d.ts +2 -2
  25. package/node_modules/aws-sdk/clients/docdb.d.ts +20 -0
  26. package/node_modules/aws-sdk/clients/ec2.d.ts +1 -1
  27. package/node_modules/aws-sdk/clients/frauddetector.d.ts +176 -5
  28. package/node_modules/aws-sdk/clients/iotdeviceadvisor.d.ts +49 -0
  29. package/node_modules/aws-sdk/clients/iotsitewise.d.ts +192 -0
  30. package/node_modules/aws-sdk/clients/kendra.d.ts +12 -7
  31. package/node_modules/aws-sdk/clients/medialive.d.ts +37 -0
  32. package/node_modules/aws-sdk/clients/networkfirewall.d.ts +53 -2
  33. package/node_modules/aws-sdk/clients/rds.d.ts +137 -87
  34. package/node_modules/aws-sdk/clients/transcribeservice.d.ts +2 -2
  35. package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +1 -1
  36. package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +15 -15
  37. package/node_modules/aws-sdk/dist/aws-sdk.js +322 -157
  38. package/node_modules/aws-sdk/dist/aws-sdk.min.js +93 -93
  39. package/node_modules/aws-sdk/lib/core.js +1 -1
  40. package/node_modules/aws-sdk/package.json +1 -1
  41. package/package.json +3 -3
@@ -553,6 +553,71 @@ declare class FraudDetector extends Service {
553
553
  updateVariable(callback?: (err: AWSError, data: FraudDetector.Types.UpdateVariableResult) => void): Request<FraudDetector.Types.UpdateVariableResult, AWSError>;
554
554
  }
555
555
  declare namespace FraudDetector {
556
+ export interface ATIMetricDataPoint {
557
+ /**
558
+ * The challenge rate. This indicates the percentage of login events that the model recommends to challenge such as one-time password, multi-factor authentication, and investigations.
559
+ */
560
+ cr?: float;
561
+ /**
562
+ * The anomaly discovery rate. This metric quantifies the percentage of anomalies that can be detected by the model at the selected score threshold. A lower score threshold increases the percentage of anomalies captured by the model, but would also require challenging a larger percentage of login events, leading to a higher customer friction.
563
+ */
564
+ adr?: float;
565
+ /**
566
+ * The model's threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is labeled as fraud.
567
+ */
568
+ threshold?: float;
569
+ /**
570
+ * The account takeover discovery rate. This metric quantifies the percentage of account compromise events that can be detected by the model at the selected score threshold. This metric is only available if 50 or more entities with at-least one labeled account takeover event is present in the ingested dataset.
571
+ */
572
+ atodr?: float;
573
+ }
574
+ export type ATIMetricDataPointsList = ATIMetricDataPoint[];
575
+ export interface ATIModelPerformance {
576
+ /**
577
+ * The anomaly separation index (ASI) score. This metric summarizes the overall ability of the model to separate anomalous activities from the normal behavior. Depending on the business, a large fraction of these anomalous activities can be malicious and correspond to the account takeover attacks. A model with no separability power will have the lowest possible ASI score of 0.5, whereas the a model with a high separability power will have the highest possible ASI score of 1.0
578
+ */
579
+ asi?: float;
580
+ }
581
+ export interface ATITrainingMetricsValue {
582
+ /**
583
+ * The model's performance metrics data points.
584
+ */
585
+ metricDataPoints?: ATIMetricDataPointsList;
586
+ /**
587
+ * The model's overall performance scores.
588
+ */
589
+ modelPerformance?: ATIModelPerformance;
590
+ }
591
+ export interface AggregatedLogOddsMetric {
592
+ /**
593
+ * The names of all the variables.
594
+ */
595
+ variableNames: ListOfStrings;
596
+ /**
597
+ * The relative importance of the variables in the list to the other event variable.
598
+ */
599
+ aggregatedVariablesImportance: float;
600
+ }
601
+ export interface AggregatedVariablesImpactExplanation {
602
+ /**
603
+ * The names of all the event variables that were used to derive the aggregated variables.
604
+ */
605
+ eventVariableNames?: ListOfStrings;
606
+ /**
607
+ * The relative impact of the aggregated variables in terms of magnitude on the prediction scores.
608
+ */
609
+ relativeImpact?: string;
610
+ /**
611
+ * The raw, uninterpreted value represented as log-odds of the fraud. These values are usually between -10 to +10, but range from -infinity to +infinity. A positive value indicates that the variables drove the risk score up. A negative value indicates that the variables drove the risk score down.
612
+ */
613
+ logOddsImpact?: float;
614
+ }
615
+ export interface AggregatedVariablesImportanceMetrics {
616
+ /**
617
+ * List of variables' metrics.
618
+ */
619
+ logOddsMetrics?: ListOfAggregatedLogOddsMetrics;
620
+ }
556
621
  export type AsyncJobStatus = "IN_PROGRESS_INITIALIZING"|"IN_PROGRESS"|"CANCEL_IN_PROGRESS"|"CANCELED"|"COMPLETE"|"FAILED"|string;
557
622
  export interface BatchCreateVariableError {
558
623
  /**
@@ -1004,7 +1069,7 @@ declare namespace FraudDetector {
1004
1069
  export type DataType = "STRING"|"INTEGER"|"FLOAT"|"BOOLEAN"|string;
1005
1070
  export interface DataValidationMetrics {
1006
1071
  /**
1007
- * The file-specific model training validation messages.
1072
+ * The file-specific model training data validation messages.
1008
1073
  */
1009
1074
  fileLevelMessages?: fileValidationMessageList;
1010
1075
  /**
@@ -2231,7 +2296,7 @@ declare namespace FraudDetector {
2231
2296
  /**
2232
2297
  * The label mapper maps the Amazon Fraud Detector supported model classification labels (FRAUD, LEGIT) to the appropriate event type labels. For example, if "FRAUD" and "LEGIT" are Amazon Fraud Detector supported labels, this mapper could be: {"FRAUD" =&gt; ["0"], "LEGIT" =&gt; ["1"]} or {"FRAUD" =&gt; ["false"], "LEGIT" =&gt; ["true"]} or {"FRAUD" =&gt; ["fraud", "abuse"], "LEGIT" =&gt; ["legit", "safe"]}. The value part of the mapper is a list, because you may have multiple label variants from your event type for a single Amazon Fraud Detector label.
2233
2298
  */
2234
- labelMapper: labelMapper;
2299
+ labelMapper?: labelMapper;
2235
2300
  /**
2236
2301
  * The action to take for unlabeled events.
2237
2302
  */
@@ -2278,6 +2343,8 @@ declare namespace FraudDetector {
2278
2343
  */
2279
2344
  nextToken?: string;
2280
2345
  }
2346
+ export type ListOfAggregatedLogOddsMetrics = AggregatedLogOddsMetric[];
2347
+ export type ListOfAggregatedVariablesImpactExplanations = AggregatedVariablesImpactExplanation[];
2281
2348
  export type ListOfEvaluatedExternalModels = EvaluatedExternalModel[];
2282
2349
  export type ListOfEvaluatedModelVersions = EvaluatedModelVersion[];
2283
2350
  export type ListOfEventPredictionSummaries = EventPredictionSummary[];
@@ -2438,7 +2505,7 @@ declare namespace FraudDetector {
2438
2505
  scores?: ModelPredictionMap;
2439
2506
  }
2440
2507
  export type ModelSource = "SAGEMAKER"|string;
2441
- export type ModelTypeEnum = "ONLINE_FRAUD_INSIGHTS"|"TRANSACTION_FRAUD_INSIGHTS"|string;
2508
+ export type ModelTypeEnum = "ONLINE_FRAUD_INSIGHTS"|"TRANSACTION_FRAUD_INSIGHTS"|"ACCOUNT_TAKEOVER_INSIGHTS"|string;
2442
2509
  export interface ModelVersion {
2443
2510
  /**
2444
2511
  * The model ID.
@@ -2506,6 +2573,10 @@ declare namespace FraudDetector {
2506
2573
  * The model version ARN.
2507
2574
  */
2508
2575
  arn?: fraudDetectorArn;
2576
+ /**
2577
+ * The training result details. The details include the relative importance of the variables.
2578
+ */
2579
+ trainingResultV2?: TrainingResultV2;
2509
2580
  }
2510
2581
  export interface ModelVersionEvaluation {
2511
2582
  /**
@@ -2524,6 +2595,41 @@ declare namespace FraudDetector {
2524
2595
  export type ModelVersionStatus = "ACTIVE"|"INACTIVE"|"TRAINING_CANCELLED"|string;
2525
2596
  export type NameList = string[];
2526
2597
  export type NonEmptyListOfStrings = string[];
2598
+ export interface OFIMetricDataPoint {
2599
+ /**
2600
+ * The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.
2601
+ */
2602
+ fpr?: float;
2603
+ /**
2604
+ * The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.
2605
+ */
2606
+ precision?: float;
2607
+ /**
2608
+ * The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
2609
+ */
2610
+ tpr?: float;
2611
+ /**
2612
+ * The model threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is labeled as fraud.
2613
+ */
2614
+ threshold?: float;
2615
+ }
2616
+ export type OFIMetricDataPointsList = OFIMetricDataPoint[];
2617
+ export interface OFIModelPerformance {
2618
+ /**
2619
+ * The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR) across all possible model score thresholds.
2620
+ */
2621
+ auc?: float;
2622
+ }
2623
+ export interface OFITrainingMetricsValue {
2624
+ /**
2625
+ * The model's performance metrics data points.
2626
+ */
2627
+ metricDataPoints?: OFIMetricDataPointsList;
2628
+ /**
2629
+ * The model's overall performance score.
2630
+ */
2631
+ modelPerformance?: OFIModelPerformance;
2632
+ }
2527
2633
  export interface Outcome {
2528
2634
  /**
2529
2635
  * The outcome name.
@@ -2553,6 +2659,10 @@ declare namespace FraudDetector {
2553
2659
  * The details of the event variable's impact on the prediction score.
2554
2660
  */
2555
2661
  variableImpactExplanations?: listOfVariableImpactExplanations;
2662
+ /**
2663
+ * The details of the aggregated variables impact on the prediction score. Account Takeover Insights (ATI) model uses event variables from the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.
2664
+ */
2665
+ aggregatedVariablesImpactExplanations?: ListOfAggregatedVariablesImpactExplanations;
2556
2666
  }
2557
2667
  export interface PredictionTimeRange {
2558
2668
  /**
@@ -2806,6 +2916,41 @@ declare namespace FraudDetector {
2806
2916
  }
2807
2917
  export interface SendEventResult {
2808
2918
  }
2919
+ export interface TFIMetricDataPoint {
2920
+ /**
2921
+ * The false positive rate. This is the percentage of total legitimate events that are incorrectly predicted as fraud.
2922
+ */
2923
+ fpr?: float;
2924
+ /**
2925
+ * The percentage of fraud events correctly predicted as fraudulent as compared to all events predicted as fraudulent.
2926
+ */
2927
+ precision?: float;
2928
+ /**
2929
+ * The true positive rate. This is the percentage of total fraud the model detects. Also known as capture rate.
2930
+ */
2931
+ tpr?: float;
2932
+ /**
2933
+ * The model threshold that specifies an acceptable fraud capture rate. For example, a threshold of 500 means any model score 500 or above is labeled as fraud.
2934
+ */
2935
+ threshold?: float;
2936
+ }
2937
+ export type TFIMetricDataPointsList = TFIMetricDataPoint[];
2938
+ export interface TFIModelPerformance {
2939
+ /**
2940
+ * The area under the curve (auc). This summarizes the total positive rate (tpr) and false positive rate (FPR) across all possible model score thresholds.
2941
+ */
2942
+ auc?: float;
2943
+ }
2944
+ export interface TFITrainingMetricsValue {
2945
+ /**
2946
+ * The model's performance metrics data points.
2947
+ */
2948
+ metricDataPoints?: TFIMetricDataPointsList;
2949
+ /**
2950
+ * The model performance score.
2951
+ */
2952
+ modelPerformance?: TFIModelPerformance;
2953
+ }
2809
2954
  export interface Tag {
2810
2955
  /**
2811
2956
  * A tag key.
@@ -2834,7 +2979,7 @@ declare namespace FraudDetector {
2834
2979
  * The training data schema variables.
2835
2980
  */
2836
2981
  modelVariables: ListOfStrings;
2837
- labelSchema: LabelSchema;
2982
+ labelSchema?: LabelSchema;
2838
2983
  }
2839
2984
  export type TrainingDataSourceEnum = "EXTERNAL_EVENTS"|"INGESTED_EVENTS"|string;
2840
2985
  export interface TrainingMetrics {
@@ -2847,6 +2992,20 @@ declare namespace FraudDetector {
2847
2992
  */
2848
2993
  metricDataPoints?: metricDataPointsList;
2849
2994
  }
2995
+ export interface TrainingMetricsV2 {
2996
+ /**
2997
+ * The Online Fraud Insights (OFI) model training metric details.
2998
+ */
2999
+ ofi?: OFITrainingMetricsValue;
3000
+ /**
3001
+ * The Transaction Fraud Insights (TFI) model training metric details.
3002
+ */
3003
+ tfi?: TFITrainingMetricsValue;
3004
+ /**
3005
+ * The Account Takeover Insights (ATI) model training metric details.
3006
+ */
3007
+ ati?: ATITrainingMetricsValue;
3008
+ }
2850
3009
  export interface TrainingResult {
2851
3010
  /**
2852
3011
  * The validation metrics.
@@ -2861,6 +3020,18 @@ declare namespace FraudDetector {
2861
3020
  */
2862
3021
  variableImportanceMetrics?: VariableImportanceMetrics;
2863
3022
  }
3023
+ export interface TrainingResultV2 {
3024
+ dataValidationMetrics?: DataValidationMetrics;
3025
+ /**
3026
+ * The training metric details.
3027
+ */
3028
+ trainingMetricsV2?: TrainingMetricsV2;
3029
+ variableImportanceMetrics?: VariableImportanceMetrics;
3030
+ /**
3031
+ * The variable importance metrics of the aggregated variables. Account Takeover Insights (ATI) model uses event variables from the login data you provide to continuously calculate a set of variables (aggregated variables) based on historical events. For example, your ATI model might calculate the number of times an user has logged in using the same IP address. In this case, event variables used to derive the aggregated variables are IP address and user.
3032
+ */
3033
+ aggregatedVariablesImportanceMetrics?: AggregatedVariablesImportanceMetrics;
3034
+ }
2864
3035
  export type UnlabeledEventsTreatment = "IGNORE"|"FRAUD"|"LEGIT"|string;
2865
3036
  export interface UntagResourceRequest {
2866
3037
  /**
@@ -3212,7 +3383,7 @@ declare namespace FraudDetector {
3212
3383
  export type identifier = string;
3213
3384
  export type integer = number;
3214
3385
  export type labelList = Label[];
3215
- export type labelMapper = {[key: string]: NonEmptyListOfStrings};
3386
+ export type labelMapper = {[key: string]: ListOfStrings};
3216
3387
  export type labelsMaxResults = number;
3217
3388
  export type listOfEntities = Entity[];
3218
3389
  export type listOfVariableImpactExplanations = VariableImpactExplanation[];
@@ -325,6 +325,7 @@ declare namespace IotDeviceAdvisor {
325
325
  }
326
326
  export type GroupResultList = GroupResult[];
327
327
  export type IntendedForQualificationBoolean = boolean;
328
+ export type IsLongDurationTestBoolean = boolean;
328
329
  export interface ListSuiteDefinitionsRequest {
329
330
  /**
330
331
  * The maximum number of results to return at once.
@@ -388,6 +389,7 @@ declare namespace IotDeviceAdvisor {
388
389
  export type LogUrl = string;
389
390
  export type MaxResults = number;
390
391
  export type ParallelRun = boolean;
392
+ export type Protocol = "MqttV3_1_1"|"MqttV5"|string;
391
393
  export type QualificationReportDownloadUrl = string;
392
394
  export type RootGroup = string;
393
395
  export type SelectedTestList = UUID[];
@@ -451,6 +453,10 @@ declare namespace IotDeviceAdvisor {
451
453
  * Gets the tests intended for qualification in a suite.
452
454
  */
453
455
  intendedForQualification?: IntendedForQualificationBoolean;
456
+ /**
457
+ * Verifies if the test suite is a long duration test.
458
+ */
459
+ isLongDurationTest?: IsLongDurationTestBoolean;
454
460
  /**
455
461
  * Gets test suite root group.
456
462
  */
@@ -459,6 +465,10 @@ declare namespace IotDeviceAdvisor {
459
465
  * Gets the device permission ARN.
460
466
  */
461
467
  devicePermissionRoleArn?: AmazonResourceName;
468
+ /**
469
+ * Gets the MQTT protocol that is configured in the suite definition.
470
+ */
471
+ protocol?: Protocol;
462
472
  }
463
473
  export interface SuiteDefinitionInformation {
464
474
  /**
@@ -477,6 +487,14 @@ declare namespace IotDeviceAdvisor {
477
487
  * Specifies if the test suite is intended for qualification.
478
488
  */
479
489
  intendedForQualification?: IntendedForQualificationBoolean;
490
+ /**
491
+ * Verifies if the test suite is a long duration test.
492
+ */
493
+ isLongDurationTest?: IsLongDurationTestBoolean;
494
+ /**
495
+ * Gets the MQTT protocol that is configured in the suite definition.
496
+ */
497
+ protocol?: Protocol;
480
498
  /**
481
499
  * Date (in Unix epoch time) when the test suite was created.
482
500
  */
@@ -544,6 +562,7 @@ declare namespace IotDeviceAdvisor {
544
562
  export type SuiteRunResultCount = number;
545
563
  export type SuiteRunStatus = "PASS"|"FAIL"|"CANCELED"|"PENDING"|"RUNNING"|"STOPPING"|"STOPPED"|"PASS_WITH_WARNINGS"|"ERROR"|string;
546
564
  export type SuiteRunsList = SuiteRunInformation[];
565
+ export type SystemMessage = string;
547
566
  export type TagKeyList = String128[];
548
567
  export type TagMap = {[key: string]: String256};
549
568
  export interface TagResourceRequest {
@@ -596,8 +615,38 @@ declare namespace IotDeviceAdvisor {
596
615
  * Provides test case run failure result.
597
616
  */
598
617
  failure?: Failure;
618
+ /**
619
+ * Provides the test scenarios for the test case run.
620
+ */
621
+ testScenarios?: TestCaseScenariosList;
599
622
  }
600
623
  export type TestCaseRuns = TestCaseRun[];
624
+ export interface TestCaseScenario {
625
+ /**
626
+ * Provides test case scenario ID.
627
+ */
628
+ testCaseScenarioId?: TestCaseScenarioId;
629
+ /**
630
+ * Provides test case scenario type. Type is one of the following: Advanced Basic
631
+ */
632
+ testCaseScenarioType?: TestCaseScenarioType;
633
+ /**
634
+ * Provides the test case scenario status. Status is one of the following: PASS: Test passed. FAIL: Test failed. PENDING: Test has not started running but is scheduled. RUNNING: Test is running. STOPPING: Test is performing cleanup steps. You will see this status only if you stop a suite run. STOPPED Test is stopped. You will see this status only if you stop a suite run. PASS_WITH_WARNINGS: Test passed with warnings. ERORR: Test faced an error when running due to an internal issue.
635
+ */
636
+ status?: TestCaseScenarioStatus;
637
+ /**
638
+ * Provides test case scenario failure result.
639
+ */
640
+ failure?: Failure;
641
+ /**
642
+ *
643
+ */
644
+ systemMessage?: SystemMessage;
645
+ }
646
+ export type TestCaseScenarioId = string;
647
+ export type TestCaseScenarioStatus = "PASS"|"FAIL"|"CANCELED"|"PENDING"|"RUNNING"|"STOPPING"|"STOPPED"|"PASS_WITH_WARNINGS"|"ERROR"|string;
648
+ export type TestCaseScenarioType = "Advanced"|"Basic"|string;
649
+ export type TestCaseScenariosList = TestCaseScenario[];
601
650
  export interface TestResult {
602
651
  /**
603
652
  * Show each group of test results.
@@ -100,6 +100,14 @@ declare class IoTSiteWise extends Service {
100
100
  * Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.
101
101
  */
102
102
  createAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetModelResponse) => void): Request<IoTSiteWise.Types.CreateAssetModelResponse, AWSError>;
103
+ /**
104
+ * This API operation is in preview release for IoT SiteWise and is subject to change. We recommend that you use this operation only with test data, and not in production environments. Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration.
105
+ */
106
+ createBulkImportJob(params: IoTSiteWise.Types.CreateBulkImportJobRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateBulkImportJobResponse) => void): Request<IoTSiteWise.Types.CreateBulkImportJobResponse, AWSError>;
107
+ /**
108
+ * This API operation is in preview release for IoT SiteWise and is subject to change. We recommend that you use this operation only with test data, and not in production environments. Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide. You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more information about how to configure storage settings, see PutStorageConfiguration.
109
+ */
110
+ createBulkImportJob(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateBulkImportJobResponse) => void): Request<IoTSiteWise.Types.CreateBulkImportJobResponse, AWSError>;
103
111
  /**
104
112
  * Creates a dashboard in an IoT SiteWise Monitor project.
105
113
  */
@@ -228,6 +236,14 @@ declare class IoTSiteWise extends Service {
228
236
  * Retrieves information about an asset property. When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value. This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.
229
237
  */
230
238
  describeAssetProperty(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetPropertyResponse) => void): Request<IoTSiteWise.Types.DescribeAssetPropertyResponse, AWSError>;
239
+ /**
240
+ * This API operation is in preview release for IoT SiteWise and is subject to change. We recommend that you use this operation only with test data, and not in production environments. Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
241
+ */
242
+ describeBulkImportJob(params: IoTSiteWise.Types.DescribeBulkImportJobRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeBulkImportJobResponse) => void): Request<IoTSiteWise.Types.DescribeBulkImportJobResponse, AWSError>;
243
+ /**
244
+ * This API operation is in preview release for IoT SiteWise and is subject to change. We recommend that you use this operation only with test data, and not in production environments. Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.
245
+ */
246
+ describeBulkImportJob(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeBulkImportJobResponse) => void): Request<IoTSiteWise.Types.DescribeBulkImportJobResponse, AWSError>;
231
247
  /**
232
248
  * Retrieves information about a dashboard.
233
249
  */
@@ -388,6 +404,14 @@ declare class IoTSiteWise extends Service {
388
404
  * Retrieves a paginated list of associated assets. You can use this operation to do the following: List child assets associated to a parent asset by a hierarchy that you specify. List an asset's parent asset.
389
405
  */
390
406
  listAssociatedAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssociatedAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssociatedAssetsResponse, AWSError>;
407
+ /**
408
+ * This API operation is in preview release for IoT SiteWise and is subject to change. We recommend that you use this operation only with test data, and not in production environments. Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the Amazon Simple Storage Service User Guide.
409
+ */
410
+ listBulkImportJobs(params: IoTSiteWise.Types.ListBulkImportJobsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListBulkImportJobsResponse) => void): Request<IoTSiteWise.Types.ListBulkImportJobsResponse, AWSError>;
411
+ /**
412
+ * This API operation is in preview release for IoT SiteWise and is subject to change. We recommend that you use this operation only with test data, and not in production environments. Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the Amazon Simple Storage Service User Guide.
413
+ */
414
+ listBulkImportJobs(callback?: (err: AWSError, data: IoTSiteWise.Types.ListBulkImportJobsResponse) => void): Request<IoTSiteWise.Types.ListBulkImportJobsResponse, AWSError>;
391
415
  /**
392
416
  * Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
393
417
  */
@@ -1520,10 +1544,13 @@ declare namespace IoTSiteWise {
1520
1544
  */
1521
1545
  errorEntries: BatchPutAssetPropertyErrorEntries;
1522
1546
  }
1547
+ export type Bucket = string;
1523
1548
  export type CapabilityConfiguration = string;
1524
1549
  export type CapabilityNamespace = string;
1525
1550
  export type CapabilitySyncStatus = "IN_SYNC"|"OUT_OF_SYNC"|"SYNC_FAILED"|"UNKNOWN"|string;
1526
1551
  export type ClientToken = string;
1552
+ export type ColumnName = "ALIAS"|"ASSET_ID"|"PROPERTY_ID"|"DATA_TYPE"|"TIMESTAMP_SECONDS"|"TIMESTAMP_NANO_OFFSET"|"QUALITY"|"VALUE"|string;
1553
+ export type ColumnNames = ColumnName[];
1527
1554
  export interface CompositeModelProperty {
1528
1555
  /**
1529
1556
  * The name of the property.
@@ -1670,6 +1697,42 @@ declare namespace IoTSiteWise {
1670
1697
  */
1671
1698
  assetStatus: AssetStatus;
1672
1699
  }
1700
+ export interface CreateBulkImportJobRequest {
1701
+ /**
1702
+ * The unique name that helps identify the job request.
1703
+ */
1704
+ jobName: Name;
1705
+ /**
1706
+ * The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
1707
+ */
1708
+ jobRoleArn: ARN;
1709
+ /**
1710
+ * The files in the specified Amazon S3 bucket that contain your data.
1711
+ */
1712
+ files: Files;
1713
+ /**
1714
+ * The Amazon S3 destination where errors associated with the job creation request are saved.
1715
+ */
1716
+ errorReportLocation: ErrorReportLocation;
1717
+ /**
1718
+ * Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
1719
+ */
1720
+ jobConfiguration: JobConfiguration;
1721
+ }
1722
+ export interface CreateBulkImportJobResponse {
1723
+ /**
1724
+ * The ID of the job.
1725
+ */
1726
+ jobId: ID;
1727
+ /**
1728
+ * The unique name that helps identify the job request.
1729
+ */
1730
+ jobName: Name;
1731
+ /**
1732
+ * The status of the bulk import job can be one of following values. PENDING – IoT SiteWise is waiting for the current bulk import job to finish. CANCELLED – The bulk import job has been canceled. RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3. COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3. FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
1733
+ */
1734
+ jobStatus: JobStatus;
1735
+ }
1673
1736
  export interface CreateDashboardRequest {
1674
1737
  /**
1675
1738
  * The ID of the project in which to create the dashboard.
@@ -1826,6 +1889,12 @@ declare namespace IoTSiteWise {
1826
1889
  */
1827
1890
  projectArn: ARN;
1828
1891
  }
1892
+ export interface Csv {
1893
+ /**
1894
+ * The column names specified in the .csv file.
1895
+ */
1896
+ columnNames?: ColumnNames;
1897
+ }
1829
1898
  export interface CustomerManagedS3Storage {
1830
1899
  /**
1831
1900
  * The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide.
@@ -2137,6 +2206,50 @@ declare namespace IoTSiteWise {
2137
2206
  */
2138
2207
  assetDescription?: Description;
2139
2208
  }
2209
+ export interface DescribeBulkImportJobRequest {
2210
+ /**
2211
+ * The ID of the job.
2212
+ */
2213
+ jobId: ID;
2214
+ }
2215
+ export interface DescribeBulkImportJobResponse {
2216
+ /**
2217
+ * The ID of the job.
2218
+ */
2219
+ jobId: ID;
2220
+ /**
2221
+ * The unique name that helps identify the job request.
2222
+ */
2223
+ jobName: Name;
2224
+ /**
2225
+ * The status of the bulk import job can be one of following values. PENDING – IoT SiteWise is waiting for the current bulk import job to finish. CANCELLED – The bulk import job has been canceled. RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3. COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3. FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
2226
+ */
2227
+ jobStatus: JobStatus;
2228
+ /**
2229
+ * The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.
2230
+ */
2231
+ jobRoleArn: ARN;
2232
+ /**
2233
+ * The files in the specified Amazon S3 bucket that contain your data.
2234
+ */
2235
+ files: Files;
2236
+ /**
2237
+ * The Amazon S3 destination where errors associated with the job creation request are saved.
2238
+ */
2239
+ errorReportLocation: ErrorReportLocation;
2240
+ /**
2241
+ * Contains the configuration information of a job, such as the file format used to save data in Amazon S3.
2242
+ */
2243
+ jobConfiguration: JobConfiguration;
2244
+ /**
2245
+ * The date the job was created, in Unix epoch TIME.
2246
+ */
2247
+ jobCreationDate: Timestamp;
2248
+ /**
2249
+ * The date the job was last updated, in Unix epoch time.
2250
+ */
2251
+ jobLastUpdateDate: Timestamp;
2252
+ }
2140
2253
  export interface DescribeDashboardRequest {
2141
2254
  /**
2142
2255
  * The ID of the dashboard.
@@ -2512,6 +2625,16 @@ declare namespace IoTSiteWise {
2512
2625
  details?: DetailedErrors;
2513
2626
  }
2514
2627
  export type ErrorMessage = string;
2628
+ export interface ErrorReportLocation {
2629
+ /**
2630
+ * The name of the Amazon S3 bucket to which errors associated with the bulk import job are sent.
2631
+ */
2632
+ bucket: Bucket;
2633
+ /**
2634
+ * Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each Amazon S3 object has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.
2635
+ */
2636
+ prefix: String;
2637
+ }
2515
2638
  export type Expression = string;
2516
2639
  export interface ExpressionVariable {
2517
2640
  /**
@@ -2524,6 +2647,27 @@ declare namespace IoTSiteWise {
2524
2647
  value: VariableValue;
2525
2648
  }
2526
2649
  export type ExpressionVariables = ExpressionVariable[];
2650
+ export interface File {
2651
+ /**
2652
+ * The name of the Amazon S3 bucket from which data is imported.
2653
+ */
2654
+ bucket: Bucket;
2655
+ /**
2656
+ * The key of the Amazon S3 object that contains your data. Each object has a key that is a unique identifier. Each object has exactly one key.
2657
+ */
2658
+ key: String;
2659
+ /**
2660
+ * The version ID to identify a specific version of the Amazon S3 object that contains your data.
2661
+ */
2662
+ versionId?: String;
2663
+ }
2664
+ export interface FileFormat {
2665
+ /**
2666
+ * The .csv file format.
2667
+ */
2668
+ csv?: Csv;
2669
+ }
2670
+ export type Files = File[];
2527
2671
  export interface ForwardingConfig {
2528
2672
  /**
2529
2673
  * The forwarding state for the given property.
@@ -2854,6 +2998,28 @@ declare namespace IoTSiteWise {
2854
2998
  export type Interval = string;
2855
2999
  export type IntervalInSeconds = number;
2856
3000
  export type IntervalWindowInSeconds = number;
3001
+ export interface JobConfiguration {
3002
+ /**
3003
+ * The file format of the data in Amazon S3.
3004
+ */
3005
+ fileFormat: FileFormat;
3006
+ }
3007
+ export type JobStatus = "PENDING"|"CANCELLED"|"RUNNING"|"COMPLETED"|"FAILED"|"COMPLETED_WITH_FAILURES"|string;
3008
+ export type JobSummaries = JobSummary[];
3009
+ export interface JobSummary {
3010
+ /**
3011
+ * The ID of the job.
3012
+ */
3013
+ id: ID;
3014
+ /**
3015
+ * The unique name that helps identify the job request.
3016
+ */
3017
+ name: Name;
3018
+ /**
3019
+ * The status of the bulk import job can be one of following values. PENDING – IoT SiteWise is waiting for the current bulk import job to finish. CANCELLED – The bulk import job has been canceled. RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3. COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3. FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues. COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.
3020
+ */
3021
+ status: JobStatus;
3022
+ }
2857
3023
  export type KmsKeyId = string;
2858
3024
  export interface ListAccessPoliciesRequest {
2859
3025
  /**
@@ -3004,6 +3170,31 @@ declare namespace IoTSiteWise {
3004
3170
  */
3005
3171
  nextToken?: NextToken;
3006
3172
  }
3173
+ export type ListBulkImportJobsFilter = "ALL"|"PENDING"|"RUNNING"|"CANCELLED"|"FAILED"|"COMPLETED_WITH_FAILURES"|"COMPLETED"|string;
3174
+ export interface ListBulkImportJobsRequest {
3175
+ /**
3176
+ * The token to be used for the next set of paginated results.
3177
+ */
3178
+ nextToken?: NextToken;
3179
+ /**
3180
+ * The maximum number of results to return for each paginated request.
3181
+ */
3182
+ maxResults?: MaxResults;
3183
+ /**
3184
+ * You can use a filter to select the bulk import jobs that you want to retrieve.
3185
+ */
3186
+ filter?: ListBulkImportJobsFilter;
3187
+ }
3188
+ export interface ListBulkImportJobsResponse {
3189
+ /**
3190
+ * One or more job summaries to list.
3191
+ */
3192
+ jobSummaries: JobSummaries;
3193
+ /**
3194
+ * The token for the next set of results, or null if there are no additional results.
3195
+ */
3196
+ nextToken?: NextToken;
3197
+ }
3007
3198
  export interface ListDashboardsRequest {
3008
3199
  /**
3009
3200
  * The ID of the project.
@@ -3495,6 +3686,7 @@ declare namespace IoTSiteWise {
3495
3686
  }
3496
3687
  export type SSOApplicationId = string;
3497
3688
  export type StorageType = "SITEWISE_DEFAULT_STORAGE"|"MULTI_LAYER_STORAGE"|string;
3689
+ export type String = string;
3498
3690
  export type TagKey = string;
3499
3691
  export type TagKeyList = TagKey[];
3500
3692
  export type TagMap = {[key: string]: TagValue};