aws-sdk 2.956.0 → 2.957.0

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.
package/clients/iot.d.ts CHANGED
@@ -44,11 +44,11 @@ declare class Iot extends Service {
44
44
  */
45
45
  associateTargetsWithJob(callback?: (err: AWSError, data: Iot.Types.AssociateTargetsWithJobResponse) => void): Request<Iot.Types.AssociateTargetsWithJobResponse, AWSError>;
46
46
  /**
47
- * Attaches a policy to the specified target.
47
+ * Attaches the specified policy to the specified principal (certificate or other credential).
48
48
  */
49
49
  attachPolicy(params: Iot.Types.AttachPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
50
50
  /**
51
- * Attaches a policy to the specified target.
51
+ * Attaches the specified policy to the specified principal (certificate or other credential).
52
52
  */
53
53
  attachPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
54
54
  /**
@@ -245,11 +245,11 @@ declare class IoTSiteWise extends Service {
245
245
  */
246
246
  describeProject(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeProjectResponse) => void): Request<IoTSiteWise.Types.DescribeProjectResponse, AWSError>;
247
247
  /**
248
- * Retrieves information about the storage configuration for IoT SiteWise.
248
+ * Retrieves information about the storage configuration for IoT SiteWise. Exporting data to Amazon S3 is currently in preview release and is subject to change. We recommend that you use this feature only with test data, and not in production environments.
249
249
  */
250
250
  describeStorageConfiguration(params: IoTSiteWise.Types.DescribeStorageConfigurationRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeStorageConfigurationResponse) => void): Request<IoTSiteWise.Types.DescribeStorageConfigurationResponse, AWSError>;
251
251
  /**
252
- * Retrieves information about the storage configuration for IoT SiteWise.
252
+ * Retrieves information about the storage configuration for IoT SiteWise. Exporting data to Amazon S3 is currently in preview release and is subject to change. We recommend that you use this feature only with test data, and not in production environments.
253
253
  */
254
254
  describeStorageConfiguration(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeStorageConfigurationResponse) => void): Request<IoTSiteWise.Types.DescribeStorageConfigurationResponse, AWSError>;
255
255
  /**
@@ -397,11 +397,11 @@ declare class IoTSiteWise extends Service {
397
397
  */
398
398
  putLoggingOptions(callback?: (err: AWSError, data: IoTSiteWise.Types.PutLoggingOptionsResponse) => void): Request<IoTSiteWise.Types.PutLoggingOptionsResponse, AWSError>;
399
399
  /**
400
- * Configures storage settings for IoT SiteWise.
400
+ * Configures storage settings for IoT SiteWise. Exporting data to Amazon S3 is currently in preview release and is subject to change. We recommend that you use this feature only with test data, and not in production environments.
401
401
  */
402
402
  putStorageConfiguration(params: IoTSiteWise.Types.PutStorageConfigurationRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.PutStorageConfigurationResponse) => void): Request<IoTSiteWise.Types.PutStorageConfigurationResponse, AWSError>;
403
403
  /**
404
- * Configures storage settings for IoT SiteWise.
404
+ * Configures storage settings for IoT SiteWise. Exporting data to Amazon S3 is currently in preview release and is subject to change. We recommend that you use this feature only with test data, and not in production environments.
405
405
  */
406
406
  putStorageConfiguration(callback?: (err: AWSError, data: IoTSiteWise.Types.PutStorageConfigurationResponse) => void): Request<IoTSiteWise.Types.PutStorageConfigurationResponse, AWSError>;
407
407
  /**
@@ -1087,7 +1087,7 @@ declare namespace IoTSiteWise {
1087
1087
  }
1088
1088
  export type CapabilityConfiguration = string;
1089
1089
  export type CapabilityNamespace = string;
1090
- export type CapabilitySyncStatus = "IN_SYNC"|"OUT_OF_SYNC"|"SYNC_FAILED"|string;
1090
+ export type CapabilitySyncStatus = "IN_SYNC"|"OUT_OF_SYNC"|"SYNC_FAILED"|"UNKNOWN"|string;
1091
1091
  export type ClientToken = string;
1092
1092
  export interface CompositeModelProperty {
1093
1093
  /**
@@ -1100,6 +1100,7 @@ declare namespace IoTSiteWise {
1100
1100
  type: Name;
1101
1101
  assetProperty: Property;
1102
1102
  }
1103
+ export type ComputeLocation = "EDGE"|"CLOUD"|string;
1103
1104
  export interface ConfigurationErrorDetails {
1104
1105
  /**
1105
1106
  * The error code.
@@ -1121,6 +1122,7 @@ declare namespace IoTSiteWise {
1121
1122
  */
1122
1123
  error?: ConfigurationErrorDetails;
1123
1124
  }
1125
+ export type CoreDeviceThingName = string;
1124
1126
  export interface CreateAccessPolicyRequest {
1125
1127
  /**
1126
1128
  * The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user.
@@ -1924,6 +1926,19 @@ declare namespace IoTSiteWise {
1924
1926
  lastUpdateDate?: Timestamp;
1925
1927
  }
1926
1928
  export type Description = string;
1929
+ export interface DetailedError {
1930
+ /**
1931
+ * The error code.
1932
+ */
1933
+ code: DetailedErrorCode;
1934
+ /**
1935
+ * The error message.
1936
+ */
1937
+ message: DetailedErrorMessage;
1938
+ }
1939
+ export type DetailedErrorCode = "INCOMPATIBLE_COMPUTE_LOCATION"|"INCOMPATIBLE_FORWARDING_CONFIGURATION"|string;
1940
+ export type DetailedErrorMessage = string;
1941
+ export type DetailedErrors = DetailedError[];
1927
1942
  export interface DisassociateAssetsRequest {
1928
1943
  /**
1929
1944
  * The ID of the parent asset from which to disassociate the child asset.
@@ -1955,6 +1970,10 @@ declare namespace IoTSiteWise {
1955
1970
  * The error message.
1956
1971
  */
1957
1972
  message: ErrorMessage;
1973
+ /**
1974
+ * A list of detailed errors.
1975
+ */
1976
+ details?: DetailedErrors;
1958
1977
  }
1959
1978
  export type ErrorMessage = string;
1960
1979
  export type Expression = string;
@@ -1969,6 +1988,13 @@ declare namespace IoTSiteWise {
1969
1988
  value: VariableValue;
1970
1989
  }
1971
1990
  export type ExpressionVariables = ExpressionVariable[];
1991
+ export interface ForwardingConfig {
1992
+ /**
1993
+ * The forwarding state for the given property.
1994
+ */
1995
+ state: ForwardingConfigState;
1996
+ }
1997
+ export type ForwardingConfigState = "DISABLED"|"ENABLED"|string;
1972
1998
  export type GatewayCapabilitySummaries = GatewayCapabilitySummary[];
1973
1999
  export interface GatewayCapabilitySummary {
1974
2000
  /**
@@ -1984,7 +2010,11 @@ declare namespace IoTSiteWise {
1984
2010
  /**
1985
2011
  * A gateway that runs on IoT Greengrass.
1986
2012
  */
1987
- greengrass: Greengrass;
2013
+ greengrass?: Greengrass;
2014
+ /**
2015
+ * A gateway that runs on IoT Greengrass V2.
2016
+ */
2017
+ greengrassV2?: GreengrassV2;
1988
2018
  }
1989
2019
  export type GatewaySummaries = GatewaySummary[];
1990
2020
  export interface GatewaySummary {
@@ -1996,6 +2026,7 @@ declare namespace IoTSiteWise {
1996
2026
  * The name of the asset.
1997
2027
  */
1998
2028
  gatewayName: Name;
2029
+ gatewayPlatform?: GatewayPlatform;
1999
2030
  /**
2000
2031
  * A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
2001
2032
  */
@@ -2199,6 +2230,12 @@ declare namespace IoTSiteWise {
2199
2230
  */
2200
2231
  groupArn: ARN;
2201
2232
  }
2233
+ export interface GreengrassV2 {
2234
+ /**
2235
+ * The name of the IoT thing for your IoT Greengrass V2 core device.
2236
+ */
2237
+ coreDeviceThingName: CoreDeviceThingName;
2238
+ }
2202
2239
  export interface GroupIdentity {
2203
2240
  /**
2204
2241
  * The Amazon Web Services SSO ID of the group.
@@ -2561,6 +2598,16 @@ declare namespace IoTSiteWise {
2561
2598
  export type MaxInterpolatedResults = number;
2562
2599
  export type MaxResults = number;
2563
2600
  export interface Measurement {
2601
+ /**
2602
+ * The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.
2603
+ */
2604
+ processingConfig?: MeasurementProcessingConfig;
2605
+ }
2606
+ export interface MeasurementProcessingConfig {
2607
+ /**
2608
+ * The forwarding configuration for the given measurement property.
2609
+ */
2610
+ forwardingConfig: ForwardingConfig;
2564
2611
  }
2565
2612
  export interface Metric {
2566
2613
  /**
@@ -2575,6 +2622,16 @@ declare namespace IoTSiteWise {
2575
2622
  * The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window.
2576
2623
  */
2577
2624
  window: MetricWindow;
2625
+ /**
2626
+ * The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.
2627
+ */
2628
+ processingConfig?: MetricProcessingConfig;
2629
+ }
2630
+ export interface MetricProcessingConfig {
2631
+ /**
2632
+ * The compute location for the given metric property.
2633
+ */
2634
+ computeLocation: ComputeLocation;
2578
2635
  }
2579
2636
  export interface MetricWindow {
2580
2637
  /**
@@ -2881,6 +2938,17 @@ declare namespace IoTSiteWise {
2881
2938
  * The list of variables used in the expression.
2882
2939
  */
2883
2940
  variables: ExpressionVariables;
2941
+ /**
2942
+ * The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.
2943
+ */
2944
+ processingConfig?: TransformProcessingConfig;
2945
+ }
2946
+ export interface TransformProcessingConfig {
2947
+ /**
2948
+ * The compute location for the given transform property.
2949
+ */
2950
+ computeLocation: ComputeLocation;
2951
+ forwardingConfig?: ForwardingConfig;
2884
2952
  }
2885
2953
  export type TraversalDirection = "PARENT"|"CHILD"|string;
2886
2954
  export type TraversalType = "PATH_TO_ROOT"|string;
@@ -83,7 +83,7 @@ return /******/ (function(modules) { // webpackBootstrap
83
83
  /**
84
84
  * @constant
85
85
  */
86
- VERSION: '2.956.0',
86
+ VERSION: '2.957.0',
87
87
 
88
88
  /**
89
89
  * @api private