aws-sdk 2.737.0 → 2.741.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/CHANGELOG.md +22 -1
- package/README.md +1 -1
- package/apis/apigatewayv2-2018-11-29.min.json +42 -0
- package/apis/appflow-2020-08-23.examples.json +5 -0
- package/apis/appflow-2020-08-23.min.json +1541 -0
- package/apis/appflow-2020-08-23.paginators.json +23 -0
- package/apis/dms-2016-01-01.min.json +9 -0
- package/apis/ec2-2016-11-15.min.json +717 -468
- package/apis/ec2-2016-11-15.paginators.json +6 -0
- package/apis/gamelift-2015-10-01.min.json +192 -161
- package/apis/gamelift-2015-10-01.paginators.json +120 -0
- package/apis/iotsitewise-2019-12-02.min.json +11 -4
- package/apis/kafka-2018-11-14.min.json +98 -19
- package/apis/mediaconvert-2017-08-29.min.json +91 -79
- package/apis/metadata.json +3 -0
- package/apis/route53resolver-2018-04-01.min.json +292 -24
- package/apis/route53resolver-2018-04-01.paginators.json +26 -4
- package/apis/xray-2016-04-12.min.json +144 -55
- package/clients/accessanalyzer.d.ts +1 -1
- package/clients/acm.d.ts +1 -1
- package/clients/acmpca.d.ts +1 -1
- package/clients/alexaforbusiness.d.ts +1 -1
- package/clients/all.d.ts +1 -0
- package/clients/all.js +2 -1
- package/clients/amplify.d.ts +1 -1
- package/clients/apigateway.d.ts +1 -1
- package/clients/apigatewaymanagementapi.d.ts +1 -1
- package/clients/apigatewayv2.d.ts +67 -43
- package/clients/appconfig.d.ts +1 -1
- package/clients/appflow.d.ts +1967 -0
- package/clients/appflow.js +18 -0
- package/clients/applicationautoscaling.d.ts +1 -1
- package/clients/applicationinsights.d.ts +1 -1
- package/clients/appmesh.d.ts +1 -1
- package/clients/appstream.d.ts +1 -1
- package/clients/appsync.d.ts +1 -1
- package/clients/athena.d.ts +1 -1
- package/clients/augmentedairuntime.d.ts +1 -1
- package/clients/autoscaling.d.ts +1 -1
- package/clients/autoscalingplans.d.ts +1 -1
- package/clients/backup.d.ts +1 -1
- package/clients/batch.d.ts +1 -1
- package/clients/braket.d.ts +1 -1
- package/clients/budgets.d.ts +1 -1
- package/clients/chime.d.ts +4 -4
- package/clients/cloud9.d.ts +1 -1
- package/clients/clouddirectory.d.ts +1 -1
- package/clients/cloudformation.d.ts +1 -1
- package/clients/cloudfront.d.ts +1 -1
- package/clients/cloudhsm.d.ts +1 -1
- package/clients/cloudhsmv2.d.ts +1 -1
- package/clients/cloudsearch.d.ts +1 -1
- package/clients/cloudsearchdomain.d.ts +1 -1
- package/clients/cloudtrail.d.ts +1 -1
- package/clients/cloudwatch.d.ts +1 -1
- package/clients/cloudwatchevents.d.ts +1 -1
- package/clients/cloudwatchlogs.d.ts +102 -57
- package/clients/codeartifact.d.ts +1 -1
- package/clients/codebuild.d.ts +1 -1
- package/clients/codecommit.d.ts +1 -1
- package/clients/codedeploy.d.ts +1 -1
- package/clients/codeguruprofiler.d.ts +1 -1
- package/clients/codegurureviewer.d.ts +1 -1
- package/clients/codepipeline.d.ts +1 -1
- package/clients/codestar.d.ts +1 -1
- package/clients/codestarconnections.d.ts +1 -1
- package/clients/codestarnotifications.d.ts +1 -1
- package/clients/cognitoidentity.d.ts +1 -1
- package/clients/cognitoidentityserviceprovider.d.ts +1 -1
- package/clients/cognitosync.d.ts +1 -1
- package/clients/comprehend.d.ts +1 -1
- package/clients/comprehendmedical.d.ts +1 -1
- package/clients/computeoptimizer.d.ts +1 -1
- package/clients/configservice.d.ts +1 -1
- package/clients/connect.d.ts +1 -1
- package/clients/connectparticipant.d.ts +1 -1
- package/clients/costexplorer.d.ts +1 -1
- package/clients/cur.d.ts +1 -1
- package/clients/dataexchange.d.ts +1 -1
- package/clients/datapipeline.d.ts +1 -1
- package/clients/datasync.d.ts +1 -1
- package/clients/dax.d.ts +1 -1
- package/clients/detective.d.ts +1 -1
- package/clients/devicefarm.d.ts +1 -1
- package/clients/directconnect.d.ts +1 -1
- package/clients/directoryservice.d.ts +1 -1
- package/clients/discovery.d.ts +1 -1
- package/clients/dlm.d.ts +1 -1
- package/clients/dms.d.ts +50 -38
- package/clients/docdb.d.ts +1 -1
- package/clients/dynamodb.d.ts +1 -1
- package/clients/dynamodbstreams.d.ts +1 -1
- package/clients/ebs.d.ts +1 -1
- package/clients/ec2.d.ts +391 -53
- package/clients/ec2instanceconnect.d.ts +1 -1
- package/clients/ecr.d.ts +1 -1
- package/clients/ecs.d.ts +1 -1
- package/clients/efs.d.ts +1 -1
- package/clients/eks.d.ts +1 -1
- package/clients/elasticache.d.ts +1 -1
- package/clients/elasticbeanstalk.d.ts +1 -1
- package/clients/elasticinference.d.ts +1 -1
- package/clients/elastictranscoder.d.ts +1 -1
- package/clients/elb.d.ts +1 -1
- package/clients/elbv2.d.ts +1 -1
- package/clients/emr.d.ts +1 -1
- package/clients/es.d.ts +1 -1
- package/clients/eventbridge.d.ts +1 -1
- package/clients/firehose.d.ts +1 -1
- package/clients/fms.d.ts +1 -1
- package/clients/forecastqueryservice.d.ts +1 -1
- package/clients/forecastservice.d.ts +1 -1
- package/clients/frauddetector.d.ts +1 -1
- package/clients/fsx.d.ts +16 -16
- package/clients/gamelift.d.ts +245 -205
- package/clients/glacier.d.ts +1 -1
- package/clients/globalaccelerator.d.ts +1 -1
- package/clients/glue.d.ts +1 -1
- package/clients/greengrass.d.ts +1 -1
- package/clients/groundstation.d.ts +1 -1
- package/clients/guardduty.d.ts +1 -1
- package/clients/health.d.ts +1 -1
- package/clients/honeycode.d.ts +1 -1
- package/clients/iam.d.ts +1 -1
- package/clients/identitystore.d.ts +1 -1
- package/clients/imagebuilder.d.ts +1 -1
- package/clients/importexport.d.ts +1 -1
- package/clients/inspector.d.ts +1 -1
- package/clients/iot.d.ts +1 -1
- package/clients/iot1clickdevicesservice.d.ts +1 -1
- package/clients/iot1clickprojects.d.ts +1 -1
- package/clients/iotanalytics.d.ts +1 -1
- package/clients/iotdata.d.ts +1 -1
- package/clients/iotevents.d.ts +1 -1
- package/clients/ioteventsdata.d.ts +1 -1
- package/clients/iotjobsdataplane.d.ts +1 -1
- package/clients/iotsecuretunneling.d.ts +1 -1
- package/clients/iotsitewise.d.ts +74 -68
- package/clients/iotthingsgraph.d.ts +1 -1
- package/clients/ivs.d.ts +1 -1
- package/clients/kafka.d.ts +101 -1
- package/clients/kendra.d.ts +1 -1
- package/clients/kinesis.d.ts +1 -1
- package/clients/kinesisanalytics.d.ts +1 -1
- package/clients/kinesisanalyticsv2.d.ts +1 -1
- package/clients/kinesisvideo.d.ts +1 -1
- package/clients/kinesisvideoarchivedmedia.d.ts +1 -1
- package/clients/kinesisvideomedia.d.ts +1 -1
- package/clients/kinesisvideosignalingchannels.d.ts +1 -1
- package/clients/kms.d.ts +1 -1
- package/clients/lakeformation.d.ts +1 -1
- package/clients/lambda.d.ts +1 -1
- package/clients/lexmodelbuildingservice.d.ts +1 -1
- package/clients/lexruntime.d.ts +1 -1
- package/clients/licensemanager.d.ts +1 -1
- package/clients/lightsail.d.ts +1 -1
- package/clients/machinelearning.d.ts +1 -1
- package/clients/macie.d.ts +1 -1
- package/clients/macie2.d.ts +1 -1
- package/clients/managedblockchain.d.ts +1 -1
- package/clients/marketplacecatalog.d.ts +1 -1
- package/clients/marketplacecommerceanalytics.d.ts +1 -1
- package/clients/marketplaceentitlementservice.d.ts +1 -1
- package/clients/marketplacemetering.d.ts +1 -1
- package/clients/mediaconnect.d.ts +1 -1
- package/clients/mediaconvert.d.ts +22 -6
- package/clients/medialive.d.ts +1 -1
- package/clients/mediapackage.d.ts +1 -1
- package/clients/mediapackagevod.d.ts +1 -1
- package/clients/mediastore.d.ts +1 -1
- package/clients/mediastoredata.d.ts +1 -1
- package/clients/mediatailor.d.ts +1 -1
- package/clients/migrationhub.d.ts +1 -1
- package/clients/migrationhubconfig.d.ts +1 -1
- package/clients/mobile.d.ts +1 -1
- package/clients/mobileanalytics.d.ts +1 -1
- package/clients/mq.d.ts +1 -1
- package/clients/mturk.d.ts +1 -1
- package/clients/neptune.d.ts +1 -1
- package/clients/networkmanager.d.ts +1 -1
- package/clients/opsworks.d.ts +1 -1
- package/clients/opsworkscm.d.ts +1 -1
- package/clients/organizations.d.ts +1 -1
- package/clients/outposts.d.ts +1 -1
- package/clients/personalize.d.ts +1 -1
- package/clients/personalizeevents.d.ts +1 -1
- package/clients/personalizeruntime.d.ts +1 -1
- package/clients/pi.d.ts +1 -1
- package/clients/pinpoint.d.ts +1 -1
- package/clients/pinpointemail.d.ts +1 -1
- package/clients/pinpointsmsvoice.d.ts +1 -1
- package/clients/polly.d.ts +1 -1
- package/clients/pricing.d.ts +1 -1
- package/clients/qldb.d.ts +1 -1
- package/clients/qldbsession.d.ts +1 -1
- package/clients/quicksight.d.ts +1 -1
- package/clients/ram.d.ts +1 -1
- package/clients/rds.d.ts +1 -1
- package/clients/rdsdataservice.d.ts +1 -1
- package/clients/redshift.d.ts +7 -7
- package/clients/rekognition.d.ts +1 -1
- package/clients/resourcegroups.d.ts +1 -1
- package/clients/resourcegroupstaggingapi.d.ts +1 -1
- package/clients/robomaker.d.ts +1 -1
- package/clients/route53.d.ts +1 -1
- package/clients/route53domains.d.ts +1 -1
- package/clients/route53resolver.d.ts +491 -119
- package/clients/s3.d.ts +1 -1
- package/clients/s3control.d.ts +1 -1
- package/clients/sagemaker.d.ts +1 -1
- package/clients/sagemakerruntime.d.ts +1 -1
- package/clients/savingsplans.d.ts +1 -1
- package/clients/schemas.d.ts +1 -1
- package/clients/secretsmanager.d.ts +1 -1
- package/clients/securityhub.d.ts +1 -1
- package/clients/serverlessapplicationrepository.d.ts +1 -1
- package/clients/servicecatalog.d.ts +1 -1
- package/clients/servicediscovery.d.ts +1 -1
- package/clients/servicequotas.d.ts +1 -1
- package/clients/ses.d.ts +1 -1
- package/clients/sesv2.d.ts +1 -1
- package/clients/shield.d.ts +1 -1
- package/clients/signer.d.ts +1 -1
- package/clients/simpledb.d.ts +1 -1
- package/clients/sms.d.ts +1 -1
- package/clients/snowball.d.ts +1 -1
- package/clients/sns.d.ts +1 -1
- package/clients/sqs.d.ts +1 -1
- package/clients/ssm.d.ts +12 -12
- package/clients/sso.d.ts +1 -1
- package/clients/ssooidc.d.ts +1 -1
- package/clients/stepfunctions.d.ts +1 -1
- package/clients/storagegateway.d.ts +1 -1
- package/clients/sts.d.ts +1 -1
- package/clients/support.d.ts +1 -1
- package/clients/swf.d.ts +1 -1
- package/clients/synthetics.d.ts +1 -1
- package/clients/textract.d.ts +1 -1
- package/clients/transcribeservice.d.ts +1 -1
- package/clients/transfer.d.ts +1 -1
- package/clients/translate.d.ts +1 -1
- package/clients/waf.d.ts +1 -1
- package/clients/wafregional.d.ts +1 -1
- package/clients/wafv2.d.ts +1 -1
- package/clients/workdocs.d.ts +1 -1
- package/clients/worklink.d.ts +1 -1
- package/clients/workmail.d.ts +1 -1
- package/clients/workmailmessageflow.d.ts +1 -1
- package/clients/workspaces.d.ts +1 -1
- package/clients/xray.d.ts +56 -1
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +53 -16
- package/dist/aws-sdk.js +1191 -689
- package/dist/aws-sdk.min.js +58 -58
- package/lib/config-base.d.ts +267 -0
- package/lib/config.d.ts +1 -266
- package/lib/config_service_placeholders.d.ts +2 -0
- package/lib/core.d.ts +1 -1
- package/lib/core.js +1 -1
- package/lib/credentials/cognito_identity_credentials.d.ts +1 -1
- package/lib/credentials/process_credentials.d.ts +1 -1
- package/lib/credentials/shared_ini_file_credentials.d.ts +1 -1
- package/lib/credentials/token_file_web_identity_credentials.d.ts +1 -1
- package/lib/credentials/web_identity_credentials.d.ts +1 -1
- package/lib/service.d.ts +1 -1
- package/package.json +1 -1
- package/scripts/lib/ts-generator.js +1 -1
package/clients/iotsitewise.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ import {AWSError} from '../lib/error';
|
|
|
4
4
|
import {Service} from '../lib/service';
|
|
5
5
|
import {WaiterConfiguration} from '../lib/service';
|
|
6
6
|
import {ServiceConfigurationOptions} from '../lib/service';
|
|
7
|
-
import {ConfigBase as Config} from '../lib/config';
|
|
7
|
+
import {ConfigBase as Config} from '../lib/config-base';
|
|
8
8
|
interface Blob {}
|
|
9
9
|
declare class IoTSiteWise extends Service {
|
|
10
10
|
/**
|
|
@@ -13,11 +13,11 @@ declare class IoTSiteWise extends Service {
|
|
|
13
13
|
constructor(options?: IoTSiteWise.Types.ClientConfiguration)
|
|
14
14
|
config: Config & IoTSiteWise.Types.ClientConfiguration;
|
|
15
15
|
/**
|
|
16
|
-
* Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating
|
|
16
|
+
* Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the AWS IoT SiteWise User Guide.
|
|
17
17
|
*/
|
|
18
18
|
associateAssets(params: IoTSiteWise.Types.AssociateAssetsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
19
19
|
/**
|
|
20
|
-
* Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating
|
|
20
|
+
* Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the AWS IoT SiteWise User Guide.
|
|
21
21
|
*/
|
|
22
22
|
associateAssets(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
23
23
|
/**
|
|
@@ -37,11 +37,11 @@ declare class IoTSiteWise extends Service {
|
|
|
37
37
|
*/
|
|
38
38
|
batchDisassociateProjectAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.BatchDisassociateProjectAssetsResponse) => void): Request<IoTSiteWise.Types.BatchDisassociateProjectAssetsResponse, AWSError>;
|
|
39
39
|
/**
|
|
40
|
-
* Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting
|
|
40
|
+
* Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 15 minutes in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-15, +5] minutes and returns a TimestampOutOfRangeException error. For each asset property, AWS IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV. AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the AWS IoT SiteWise User Guide.
|
|
41
41
|
*/
|
|
42
42
|
batchPutAssetPropertyValue(params: IoTSiteWise.Types.BatchPutAssetPropertyValueRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.BatchPutAssetPropertyValueResponse) => void): Request<IoTSiteWise.Types.BatchPutAssetPropertyValueResponse, AWSError>;
|
|
43
43
|
/**
|
|
44
|
-
* Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting
|
|
44
|
+
* Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 15 minutes in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-15, +5] minutes and returns a TimestampOutOfRangeException error. For each asset property, AWS IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV. AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the AWS IoT SiteWise User Guide.
|
|
45
45
|
*/
|
|
46
46
|
batchPutAssetPropertyValue(callback?: (err: AWSError, data: IoTSiteWise.Types.BatchPutAssetPropertyValueResponse) => void): Request<IoTSiteWise.Types.BatchPutAssetPropertyValueResponse, AWSError>;
|
|
47
47
|
/**
|
|
@@ -53,19 +53,19 @@ declare class IoTSiteWise extends Service {
|
|
|
53
53
|
*/
|
|
54
54
|
createAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAccessPolicyResponse) => void): Request<IoTSiteWise.Types.CreateAccessPolicyResponse, AWSError>;
|
|
55
55
|
/**
|
|
56
|
-
* Creates an asset from an existing asset model. For more information, see Creating
|
|
56
|
+
* Creates an asset from an existing asset model. For more information, see Creating assets in the AWS IoT SiteWise User Guide.
|
|
57
57
|
*/
|
|
58
58
|
createAsset(params: IoTSiteWise.Types.CreateAssetRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetResponse) => void): Request<IoTSiteWise.Types.CreateAssetResponse, AWSError>;
|
|
59
59
|
/**
|
|
60
|
-
* Creates an asset from an existing asset model. For more information, see Creating
|
|
60
|
+
* Creates an asset from an existing asset model. For more information, see Creating assets in the AWS IoT SiteWise User Guide.
|
|
61
61
|
*/
|
|
62
62
|
createAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetResponse) => void): Request<IoTSiteWise.Types.CreateAssetResponse, AWSError>;
|
|
63
63
|
/**
|
|
64
|
-
* 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
|
|
64
|
+
* 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 AWS IoT SiteWise User Guide.
|
|
65
65
|
*/
|
|
66
66
|
createAssetModel(params: IoTSiteWise.Types.CreateAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetModelResponse) => void): Request<IoTSiteWise.Types.CreateAssetModelResponse, AWSError>;
|
|
67
67
|
/**
|
|
68
|
-
* 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
|
|
68
|
+
* 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 AWS IoT SiteWise User Guide.
|
|
69
69
|
*/
|
|
70
70
|
createAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetModelResponse) => void): Request<IoTSiteWise.Types.CreateAssetModelResponse, AWSError>;
|
|
71
71
|
/**
|
|
@@ -85,11 +85,11 @@ declare class IoTSiteWise extends Service {
|
|
|
85
85
|
*/
|
|
86
86
|
createGateway(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateGatewayResponse) => void): Request<IoTSiteWise.Types.CreateGatewayResponse, AWSError>;
|
|
87
87
|
/**
|
|
88
|
-
* Creates a portal, which can contain projects and dashboards. Before you can create a portal, you must
|
|
88
|
+
* Creates a portal, which can contain projects and dashboards. Before you can create a portal, you must enable AWS Single Sign-On. AWS IoT SiteWise Monitor uses AWS SSO to manage user permissions. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. Before you can sign in to a new portal, you must add at least one AWS SSO user or group to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide.
|
|
89
89
|
*/
|
|
90
90
|
createPortal(params: IoTSiteWise.Types.CreatePortalRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreatePortalResponse) => void): Request<IoTSiteWise.Types.CreatePortalResponse, AWSError>;
|
|
91
91
|
/**
|
|
92
|
-
* Creates a portal, which can contain projects and dashboards. Before you can create a portal, you must
|
|
92
|
+
* Creates a portal, which can contain projects and dashboards. Before you can create a portal, you must enable AWS Single Sign-On. AWS IoT SiteWise Monitor uses AWS SSO to manage user permissions. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. Before you can sign in to a new portal, you must add at least one AWS SSO user or group to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide.
|
|
93
93
|
*/
|
|
94
94
|
createPortal(callback?: (err: AWSError, data: IoTSiteWise.Types.CreatePortalResponse) => void): Request<IoTSiteWise.Types.CreatePortalResponse, AWSError>;
|
|
95
95
|
/**
|
|
@@ -109,19 +109,19 @@ declare class IoTSiteWise extends Service {
|
|
|
109
109
|
*/
|
|
110
110
|
deleteAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAccessPolicyResponse) => void): Request<IoTSiteWise.Types.DeleteAccessPolicyResponse, AWSError>;
|
|
111
111
|
/**
|
|
112
|
-
* Deletes an asset. This action can't be undone. For more information, see Deleting
|
|
112
|
+
* Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide. You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
|
|
113
113
|
*/
|
|
114
114
|
deleteAsset(params: IoTSiteWise.Types.DeleteAssetRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetResponse) => void): Request<IoTSiteWise.Types.DeleteAssetResponse, AWSError>;
|
|
115
115
|
/**
|
|
116
|
-
* Deletes an asset. This action can't be undone. For more information, see Deleting
|
|
116
|
+
* Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide. You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
|
|
117
117
|
*/
|
|
118
118
|
deleteAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetResponse) => void): Request<IoTSiteWise.Types.DeleteAssetResponse, AWSError>;
|
|
119
119
|
/**
|
|
120
|
-
* Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting
|
|
120
|
+
* Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide.
|
|
121
121
|
*/
|
|
122
122
|
deleteAssetModel(params: IoTSiteWise.Types.DeleteAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetModelResponse) => void): Request<IoTSiteWise.Types.DeleteAssetModelResponse, AWSError>;
|
|
123
123
|
/**
|
|
124
|
-
* Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting
|
|
124
|
+
* Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide.
|
|
125
125
|
*/
|
|
126
126
|
deleteAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetModelResponse) => void): Request<IoTSiteWise.Types.DeleteAssetModelResponse, AWSError>;
|
|
127
127
|
/**
|
|
@@ -181,11 +181,11 @@ declare class IoTSiteWise extends Service {
|
|
|
181
181
|
*/
|
|
182
182
|
describeAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>;
|
|
183
183
|
/**
|
|
184
|
-
* Retrieves information about an asset's property.
|
|
184
|
+
* 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.
|
|
185
185
|
*/
|
|
186
186
|
describeAssetProperty(params: IoTSiteWise.Types.DescribeAssetPropertyRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetPropertyResponse) => void): Request<IoTSiteWise.Types.DescribeAssetPropertyResponse, AWSError>;
|
|
187
187
|
/**
|
|
188
|
-
* Retrieves information about an asset's property.
|
|
188
|
+
* 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.
|
|
189
189
|
*/
|
|
190
190
|
describeAssetProperty(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetPropertyResponse) => void): Request<IoTSiteWise.Types.DescribeAssetPropertyResponse, AWSError>;
|
|
191
191
|
/**
|
|
@@ -245,27 +245,27 @@ declare class IoTSiteWise extends Service {
|
|
|
245
245
|
*/
|
|
246
246
|
disassociateAssets(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
247
247
|
/**
|
|
248
|
-
* Gets aggregated values for an asset property. For more information, see Querying
|
|
248
|
+
* Gets aggregated values for an asset property. For more information, see Querying aggregates in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
|
|
249
249
|
*/
|
|
250
250
|
getAssetPropertyAggregates(params: IoTSiteWise.Types.GetAssetPropertyAggregatesRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyAggregatesResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyAggregatesResponse, AWSError>;
|
|
251
251
|
/**
|
|
252
|
-
* Gets aggregated values for an asset property. For more information, see Querying
|
|
252
|
+
* Gets aggregated values for an asset property. For more information, see Querying aggregates in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
|
|
253
253
|
*/
|
|
254
254
|
getAssetPropertyAggregates(callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyAggregatesResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyAggregatesResponse, AWSError>;
|
|
255
255
|
/**
|
|
256
|
-
* Gets an asset property's current value. For more information, see Querying
|
|
256
|
+
* Gets an asset property's current value. For more information, see Querying current values in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
|
|
257
257
|
*/
|
|
258
258
|
getAssetPropertyValue(params: IoTSiteWise.Types.GetAssetPropertyValueRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyValueResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyValueResponse, AWSError>;
|
|
259
259
|
/**
|
|
260
|
-
* Gets an asset property's current value. For more information, see Querying
|
|
260
|
+
* Gets an asset property's current value. For more information, see Querying current values in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
|
|
261
261
|
*/
|
|
262
262
|
getAssetPropertyValue(callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyValueResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyValueResponse, AWSError>;
|
|
263
263
|
/**
|
|
264
|
-
* Gets the history of an asset property's values. For more information, see Querying
|
|
264
|
+
* Gets the history of an asset property's values. For more information, see Querying historical values in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
|
|
265
265
|
*/
|
|
266
266
|
getAssetPropertyValueHistory(params: IoTSiteWise.Types.GetAssetPropertyValueHistoryRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyValueHistoryResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyValueHistoryResponse, AWSError>;
|
|
267
267
|
/**
|
|
268
|
-
* Gets the history of an asset property's values. For more information, see Querying
|
|
268
|
+
* Gets the history of an asset property's values. For more information, see Querying historical values in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
|
|
269
269
|
*/
|
|
270
270
|
getAssetPropertyValueHistory(callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyValueHistoryResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyValueHistoryResponse, AWSError>;
|
|
271
271
|
/**
|
|
@@ -293,11 +293,11 @@ declare class IoTSiteWise extends Service {
|
|
|
293
293
|
*/
|
|
294
294
|
listAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssetsResponse, AWSError>;
|
|
295
295
|
/**
|
|
296
|
-
* Retrieves a paginated list of the assets associated to a parent asset
|
|
296
|
+
* 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.
|
|
297
297
|
*/
|
|
298
298
|
listAssociatedAssets(params: IoTSiteWise.Types.ListAssociatedAssetsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssociatedAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssociatedAssetsResponse, AWSError>;
|
|
299
299
|
/**
|
|
300
|
-
* Retrieves a paginated list of the assets associated to a parent asset
|
|
300
|
+
* 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.
|
|
301
301
|
*/
|
|
302
302
|
listAssociatedAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssociatedAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssociatedAssetsResponse, AWSError>;
|
|
303
303
|
/**
|
|
@@ -381,19 +381,19 @@ declare class IoTSiteWise extends Service {
|
|
|
381
381
|
*/
|
|
382
382
|
updateAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAccessPolicyResponse) => void): Request<IoTSiteWise.Types.UpdateAccessPolicyResponse, AWSError>;
|
|
383
383
|
/**
|
|
384
|
-
* Updates an asset's name. For more information, see Updating
|
|
384
|
+
* Updates an asset's name. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide.
|
|
385
385
|
*/
|
|
386
386
|
updateAsset(params: IoTSiteWise.Types.UpdateAssetRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetResponse) => void): Request<IoTSiteWise.Types.UpdateAssetResponse, AWSError>;
|
|
387
387
|
/**
|
|
388
|
-
* Updates an asset's name. For more information, see Updating
|
|
388
|
+
* Updates an asset's name. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide.
|
|
389
389
|
*/
|
|
390
390
|
updateAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetResponse) => void): Request<IoTSiteWise.Types.UpdateAssetResponse, AWSError>;
|
|
391
391
|
/**
|
|
392
|
-
* Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating
|
|
392
|
+
* Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide. This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel. If you remove a property from an asset model or update a property's formula expression, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
|
|
393
393
|
*/
|
|
394
394
|
updateAssetModel(params: IoTSiteWise.Types.UpdateAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetModelResponse) => void): Request<IoTSiteWise.Types.UpdateAssetModelResponse, AWSError>;
|
|
395
395
|
/**
|
|
396
|
-
* Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating
|
|
396
|
+
* Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide. This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel. If you remove a property from an asset model or update a property's formula expression, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
|
|
397
397
|
*/
|
|
398
398
|
updateAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetModelResponse) => void): Request<IoTSiteWise.Types.UpdateAssetModelResponse, AWSError>;
|
|
399
399
|
/**
|
|
@@ -716,11 +716,11 @@ declare namespace IoTSiteWise {
|
|
|
716
716
|
*/
|
|
717
717
|
name: Name;
|
|
718
718
|
/**
|
|
719
|
-
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping
|
|
719
|
+
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.
|
|
720
720
|
*/
|
|
721
721
|
alias?: PropertyAlias;
|
|
722
722
|
/**
|
|
723
|
-
* The asset property's notification topic and state. For more information, see UpdateAssetProperty
|
|
723
|
+
* The asset property's notification topic and state. For more information, see UpdateAssetProperty.
|
|
724
724
|
*/
|
|
725
725
|
notification?: PropertyNotification;
|
|
726
726
|
/**
|
|
@@ -801,7 +801,7 @@ declare namespace IoTSiteWise {
|
|
|
801
801
|
*/
|
|
802
802
|
assetId: ID;
|
|
803
803
|
/**
|
|
804
|
-
* The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset
|
|
804
|
+
* The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
|
|
805
805
|
*/
|
|
806
806
|
hierarchyId: ID;
|
|
807
807
|
/**
|
|
@@ -850,7 +850,7 @@ declare namespace IoTSiteWise {
|
|
|
850
850
|
}
|
|
851
851
|
export interface Attribute {
|
|
852
852
|
/**
|
|
853
|
-
* The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating
|
|
853
|
+
* The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide.
|
|
854
854
|
*/
|
|
855
855
|
defaultValue?: DefaultValue;
|
|
856
856
|
}
|
|
@@ -981,11 +981,11 @@ declare namespace IoTSiteWise {
|
|
|
981
981
|
*/
|
|
982
982
|
assetModelDescription?: Description;
|
|
983
983
|
/**
|
|
984
|
-
* The property definitions of the asset model. For more information, see Asset
|
|
984
|
+
* The property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
|
|
985
985
|
*/
|
|
986
986
|
assetModelProperties?: AssetModelPropertyDefinitions;
|
|
987
987
|
/**
|
|
988
|
-
* The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset
|
|
988
|
+
* The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
|
|
989
989
|
*/
|
|
990
990
|
assetModelHierarchies?: AssetModelHierarchyDefinitions;
|
|
991
991
|
/**
|
|
@@ -1057,7 +1057,7 @@ declare namespace IoTSiteWise {
|
|
|
1057
1057
|
*/
|
|
1058
1058
|
dashboardDescription?: Description;
|
|
1059
1059
|
/**
|
|
1060
|
-
* The dashboard definition specified in a JSON literal. For detailed information, see Creating
|
|
1060
|
+
* The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.
|
|
1061
1061
|
*/
|
|
1062
1062
|
dashboardDefinition: DashboardDefinition;
|
|
1063
1063
|
/**
|
|
@@ -1482,7 +1482,7 @@ declare namespace IoTSiteWise {
|
|
|
1482
1482
|
*/
|
|
1483
1483
|
dashboardDescription?: Description;
|
|
1484
1484
|
/**
|
|
1485
|
-
* The dashboard's definition JSON literal. For detailed information, see Creating
|
|
1485
|
+
* The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.
|
|
1486
1486
|
*/
|
|
1487
1487
|
dashboardDefinition: DashboardDefinition;
|
|
1488
1488
|
/**
|
|
@@ -1665,7 +1665,7 @@ declare namespace IoTSiteWise {
|
|
|
1665
1665
|
*/
|
|
1666
1666
|
assetId: ID;
|
|
1667
1667
|
/**
|
|
1668
|
-
* The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset
|
|
1668
|
+
* The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
|
|
1669
1669
|
*/
|
|
1670
1670
|
hierarchyId: ID;
|
|
1671
1671
|
/**
|
|
@@ -1753,7 +1753,7 @@ declare namespace IoTSiteWise {
|
|
|
1753
1753
|
*/
|
|
1754
1754
|
propertyId?: ID;
|
|
1755
1755
|
/**
|
|
1756
|
-
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping
|
|
1756
|
+
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.
|
|
1757
1757
|
*/
|
|
1758
1758
|
propertyAlias?: AssetPropertyAlias;
|
|
1759
1759
|
/**
|
|
@@ -1777,7 +1777,7 @@ declare namespace IoTSiteWise {
|
|
|
1777
1777
|
*/
|
|
1778
1778
|
endDate: Timestamp;
|
|
1779
1779
|
/**
|
|
1780
|
-
* The chronological sorting order of the requested information.
|
|
1780
|
+
* The chronological sorting order of the requested information. Default: ASCENDING
|
|
1781
1781
|
*/
|
|
1782
1782
|
timeOrdering?: TimeOrdering;
|
|
1783
1783
|
/**
|
|
@@ -1785,7 +1785,7 @@ declare namespace IoTSiteWise {
|
|
|
1785
1785
|
*/
|
|
1786
1786
|
nextToken?: NextToken;
|
|
1787
1787
|
/**
|
|
1788
|
-
* The maximum number of results to be returned per paginated request.
|
|
1788
|
+
* The maximum number of results to be returned per paginated request. Default: 100
|
|
1789
1789
|
*/
|
|
1790
1790
|
maxResults?: MaxResults;
|
|
1791
1791
|
}
|
|
@@ -1809,7 +1809,7 @@ declare namespace IoTSiteWise {
|
|
|
1809
1809
|
*/
|
|
1810
1810
|
propertyId?: ID;
|
|
1811
1811
|
/**
|
|
1812
|
-
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping
|
|
1812
|
+
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.
|
|
1813
1813
|
*/
|
|
1814
1814
|
propertyAlias?: AssetPropertyAlias;
|
|
1815
1815
|
/**
|
|
@@ -1825,7 +1825,7 @@ declare namespace IoTSiteWise {
|
|
|
1825
1825
|
*/
|
|
1826
1826
|
qualities?: Qualities;
|
|
1827
1827
|
/**
|
|
1828
|
-
* The chronological sorting order of the requested information.
|
|
1828
|
+
* The chronological sorting order of the requested information. Default: ASCENDING
|
|
1829
1829
|
*/
|
|
1830
1830
|
timeOrdering?: TimeOrdering;
|
|
1831
1831
|
/**
|
|
@@ -1833,7 +1833,7 @@ declare namespace IoTSiteWise {
|
|
|
1833
1833
|
*/
|
|
1834
1834
|
nextToken?: NextToken;
|
|
1835
1835
|
/**
|
|
1836
|
-
* The maximum number of results to be returned per paginated request.
|
|
1836
|
+
* The maximum number of results to be returned per paginated request. Default: 100
|
|
1837
1837
|
*/
|
|
1838
1838
|
maxResults?: MaxResults;
|
|
1839
1839
|
}
|
|
@@ -1857,7 +1857,7 @@ declare namespace IoTSiteWise {
|
|
|
1857
1857
|
*/
|
|
1858
1858
|
propertyId?: ID;
|
|
1859
1859
|
/**
|
|
1860
|
-
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping
|
|
1860
|
+
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.
|
|
1861
1861
|
*/
|
|
1862
1862
|
propertyAlias?: AssetPropertyAlias;
|
|
1863
1863
|
}
|
|
@@ -1945,7 +1945,7 @@ declare namespace IoTSiteWise {
|
|
|
1945
1945
|
*/
|
|
1946
1946
|
nextToken?: NextToken;
|
|
1947
1947
|
/**
|
|
1948
|
-
* The maximum number of results to be returned per paginated request.
|
|
1948
|
+
* The maximum number of results to be returned per paginated request. Default: 50
|
|
1949
1949
|
*/
|
|
1950
1950
|
maxResults?: MaxResults;
|
|
1951
1951
|
}
|
|
@@ -1965,7 +1965,7 @@ declare namespace IoTSiteWise {
|
|
|
1965
1965
|
*/
|
|
1966
1966
|
nextToken?: NextToken;
|
|
1967
1967
|
/**
|
|
1968
|
-
* The maximum number of results to be returned per paginated request.
|
|
1968
|
+
* The maximum number of results to be returned per paginated request. Default: 50
|
|
1969
1969
|
*/
|
|
1970
1970
|
maxResults?: MaxResults;
|
|
1971
1971
|
}
|
|
@@ -1986,7 +1986,7 @@ declare namespace IoTSiteWise {
|
|
|
1986
1986
|
*/
|
|
1987
1987
|
nextToken?: NextToken;
|
|
1988
1988
|
/**
|
|
1989
|
-
* The maximum number of results to be returned per paginated request.
|
|
1989
|
+
* The maximum number of results to be returned per paginated request. Default: 50
|
|
1990
1990
|
*/
|
|
1991
1991
|
maxResults?: MaxResults;
|
|
1992
1992
|
/**
|
|
@@ -1994,7 +1994,7 @@ declare namespace IoTSiteWise {
|
|
|
1994
1994
|
*/
|
|
1995
1995
|
assetModelId?: ID;
|
|
1996
1996
|
/**
|
|
1997
|
-
* The filter for the requested list of assets. Choose one of the following options
|
|
1997
|
+
* The filter for the requested list of assets. Choose one of the following options: ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL. TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree. Default: ALL
|
|
1998
1998
|
*/
|
|
1999
1999
|
filter?: ListAssetsFilter;
|
|
2000
2000
|
}
|
|
@@ -2010,19 +2010,23 @@ declare namespace IoTSiteWise {
|
|
|
2010
2010
|
}
|
|
2011
2011
|
export interface ListAssociatedAssetsRequest {
|
|
2012
2012
|
/**
|
|
2013
|
-
* The ID of the
|
|
2013
|
+
* The ID of the asset to query.
|
|
2014
2014
|
*/
|
|
2015
2015
|
assetId: ID;
|
|
2016
2016
|
/**
|
|
2017
|
-
* The
|
|
2017
|
+
* The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
|
|
2018
2018
|
*/
|
|
2019
|
-
hierarchyId
|
|
2019
|
+
hierarchyId?: ID;
|
|
2020
|
+
/**
|
|
2021
|
+
* The direction to list associated assets. Choose one of the following options: CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD. PARENT – The list includes the asset's parent asset. Default: CHILD
|
|
2022
|
+
*/
|
|
2023
|
+
traversalDirection?: TraversalDirection;
|
|
2020
2024
|
/**
|
|
2021
2025
|
* The token to be used for the next set of paginated results.
|
|
2022
2026
|
*/
|
|
2023
2027
|
nextToken?: NextToken;
|
|
2024
2028
|
/**
|
|
2025
|
-
* The maximum number of results to be returned per paginated request.
|
|
2029
|
+
* The maximum number of results to be returned per paginated request. Default: 50
|
|
2026
2030
|
*/
|
|
2027
2031
|
maxResults?: MaxResults;
|
|
2028
2032
|
}
|
|
@@ -2046,7 +2050,7 @@ declare namespace IoTSiteWise {
|
|
|
2046
2050
|
*/
|
|
2047
2051
|
nextToken?: NextToken;
|
|
2048
2052
|
/**
|
|
2049
|
-
* The maximum number of results to be returned per paginated request.
|
|
2053
|
+
* The maximum number of results to be returned per paginated request. Default: 50
|
|
2050
2054
|
*/
|
|
2051
2055
|
maxResults?: MaxResults;
|
|
2052
2056
|
}
|
|
@@ -2066,7 +2070,7 @@ declare namespace IoTSiteWise {
|
|
|
2066
2070
|
*/
|
|
2067
2071
|
nextToken?: NextToken;
|
|
2068
2072
|
/**
|
|
2069
|
-
* The maximum number of results to be returned per paginated request.
|
|
2073
|
+
* The maximum number of results to be returned per paginated request. Default: 50
|
|
2070
2074
|
*/
|
|
2071
2075
|
maxResults?: MaxResults;
|
|
2072
2076
|
}
|
|
@@ -2086,7 +2090,7 @@ declare namespace IoTSiteWise {
|
|
|
2086
2090
|
*/
|
|
2087
2091
|
nextToken?: NextToken;
|
|
2088
2092
|
/**
|
|
2089
|
-
* The maximum number of results to be returned per paginated request.
|
|
2093
|
+
* The maximum number of results to be returned per paginated request. Default: 50
|
|
2090
2094
|
*/
|
|
2091
2095
|
maxResults?: MaxResults;
|
|
2092
2096
|
}
|
|
@@ -2110,7 +2114,7 @@ declare namespace IoTSiteWise {
|
|
|
2110
2114
|
*/
|
|
2111
2115
|
nextToken?: NextToken;
|
|
2112
2116
|
/**
|
|
2113
|
-
* The maximum number of results to be returned per paginated request.
|
|
2117
|
+
* The maximum number of results to be returned per paginated request. Default: 50
|
|
2114
2118
|
*/
|
|
2115
2119
|
maxResults?: MaxResults;
|
|
2116
2120
|
}
|
|
@@ -2134,7 +2138,7 @@ declare namespace IoTSiteWise {
|
|
|
2134
2138
|
*/
|
|
2135
2139
|
nextToken?: NextToken;
|
|
2136
2140
|
/**
|
|
2137
|
-
* The maximum number of results to be returned per paginated request.
|
|
2141
|
+
* The maximum number of results to be returned per paginated request. Default: 50
|
|
2138
2142
|
*/
|
|
2139
2143
|
maxResults?: MaxResults;
|
|
2140
2144
|
}
|
|
@@ -2191,7 +2195,7 @@ declare namespace IoTSiteWise {
|
|
|
2191
2195
|
*/
|
|
2192
2196
|
tumbling?: TumblingWindow;
|
|
2193
2197
|
}
|
|
2194
|
-
export type MonitorErrorCode = "INTERNAL_FAILURE"|string;
|
|
2198
|
+
export type MonitorErrorCode = "INTERNAL_FAILURE"|"VALIDATION_ERROR"|"LIMIT_EXCEEDED"|string;
|
|
2195
2199
|
export interface MonitorErrorDetails {
|
|
2196
2200
|
/**
|
|
2197
2201
|
* The error code.
|
|
@@ -2255,6 +2259,7 @@ declare namespace IoTSiteWise {
|
|
|
2255
2259
|
* The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.
|
|
2256
2260
|
*/
|
|
2257
2261
|
roleArn?: ARN;
|
|
2262
|
+
status: PortalStatus;
|
|
2258
2263
|
}
|
|
2259
2264
|
export interface ProjectResource {
|
|
2260
2265
|
/**
|
|
@@ -2295,11 +2300,11 @@ declare namespace IoTSiteWise {
|
|
|
2295
2300
|
*/
|
|
2296
2301
|
name: Name;
|
|
2297
2302
|
/**
|
|
2298
|
-
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping
|
|
2303
|
+
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.
|
|
2299
2304
|
*/
|
|
2300
2305
|
alias?: PropertyAlias;
|
|
2301
2306
|
/**
|
|
2302
|
-
* The asset property's notification topic and state. For more information, see UpdateAssetProperty
|
|
2307
|
+
* The asset property's notification topic and state. For more information, see UpdateAssetProperty.
|
|
2303
2308
|
*/
|
|
2304
2309
|
notification?: PropertyNotification;
|
|
2305
2310
|
/**
|
|
@@ -2367,7 +2372,7 @@ declare namespace IoTSiteWise {
|
|
|
2367
2372
|
*/
|
|
2368
2373
|
propertyId?: ID;
|
|
2369
2374
|
/**
|
|
2370
|
-
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping
|
|
2375
|
+
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.
|
|
2371
2376
|
*/
|
|
2372
2377
|
propertyAlias?: AssetPropertyAlias;
|
|
2373
2378
|
/**
|
|
@@ -2438,6 +2443,7 @@ declare namespace IoTSiteWise {
|
|
|
2438
2443
|
*/
|
|
2439
2444
|
variables: ExpressionVariables;
|
|
2440
2445
|
}
|
|
2446
|
+
export type TraversalDirection = "PARENT"|"CHILD"|string;
|
|
2441
2447
|
export interface TumblingWindow {
|
|
2442
2448
|
/**
|
|
2443
2449
|
* The time interval for the tumbling window. Note that w represents weeks, d represents days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on. When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.
|
|
@@ -2494,11 +2500,11 @@ declare namespace IoTSiteWise {
|
|
|
2494
2500
|
*/
|
|
2495
2501
|
assetModelDescription?: Description;
|
|
2496
2502
|
/**
|
|
2497
|
-
* The updated property definitions of the asset model. For more information, see Asset
|
|
2503
|
+
* The updated property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
|
|
2498
2504
|
*/
|
|
2499
2505
|
assetModelProperties?: AssetModelProperties;
|
|
2500
2506
|
/**
|
|
2501
|
-
* The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset
|
|
2507
|
+
* The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
|
|
2502
2508
|
*/
|
|
2503
2509
|
assetModelHierarchies?: AssetModelHierarchies;
|
|
2504
2510
|
/**
|
|
@@ -2522,11 +2528,11 @@ declare namespace IoTSiteWise {
|
|
|
2522
2528
|
*/
|
|
2523
2529
|
propertyId: ID;
|
|
2524
2530
|
/**
|
|
2525
|
-
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping
|
|
2531
|
+
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide. If you omit this parameter, the alias is removed from the property.
|
|
2526
2532
|
*/
|
|
2527
2533
|
propertyAlias?: PropertyAlias;
|
|
2528
2534
|
/**
|
|
2529
|
-
* The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with
|
|
2535
|
+
* The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide. If you omit this parameter, the notification state is set to DISABLED.
|
|
2530
2536
|
*/
|
|
2531
2537
|
propertyNotificationState?: PropertyNotificationState;
|
|
2532
2538
|
/**
|
|
@@ -2568,7 +2574,7 @@ declare namespace IoTSiteWise {
|
|
|
2568
2574
|
*/
|
|
2569
2575
|
dashboardDescription?: Description;
|
|
2570
2576
|
/**
|
|
2571
|
-
* The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating
|
|
2577
|
+
* The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.
|
|
2572
2578
|
*/
|
|
2573
2579
|
dashboardDefinition: DashboardDefinition;
|
|
2574
2580
|
/**
|
|
@@ -2679,7 +2685,7 @@ declare namespace IoTSiteWise {
|
|
|
2679
2685
|
*/
|
|
2680
2686
|
propertyId: Macro;
|
|
2681
2687
|
/**
|
|
2682
|
-
* The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset
|
|
2688
|
+
* The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
|
|
2683
2689
|
*/
|
|
2684
2690
|
hierarchyId?: Macro;
|
|
2685
2691
|
}
|
|
@@ -3,7 +3,7 @@ import {Response} from '../lib/response';
|
|
|
3
3
|
import {AWSError} from '../lib/error';
|
|
4
4
|
import {Service} from '../lib/service';
|
|
5
5
|
import {ServiceConfigurationOptions} from '../lib/service';
|
|
6
|
-
import {ConfigBase as Config} from '../lib/config';
|
|
6
|
+
import {ConfigBase as Config} from '../lib/config-base';
|
|
7
7
|
interface Blob {}
|
|
8
8
|
declare class IoTThingsGraph extends Service {
|
|
9
9
|
/**
|
package/clients/ivs.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ import {Response} from '../lib/response';
|
|
|
3
3
|
import {AWSError} from '../lib/error';
|
|
4
4
|
import {Service} from '../lib/service';
|
|
5
5
|
import {ServiceConfigurationOptions} from '../lib/service';
|
|
6
|
-
import {ConfigBase as Config} from '../lib/config';
|
|
6
|
+
import {ConfigBase as Config} from '../lib/config-base';
|
|
7
7
|
interface Blob {}
|
|
8
8
|
declare class IVS extends Service {
|
|
9
9
|
/**
|