@aws-sdk/client-iotsitewise 3.454.0 → 3.456.0

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

@@ -1,5 +1,12 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { IoTSiteWiseServiceException as __BaseException } from "./IoTSiteWiseServiceException";
+export declare class AccessDeniedException extends __BaseException {
+  readonly name: "AccessDeniedException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
+  );
+}
 export interface GroupIdentity {
   id: string | undefined;
 }
@@ -41,6 +48,22 @@ export interface AccessPolicySummary {
   creationDate?: Date;
   lastUpdateDate?: Date;
 }
+export interface ActionDefinition {
+  actionDefinitionId: string | undefined;
+  actionName: string | undefined;
+  actionType: string | undefined;
+}
+export interface ActionPayload {
+  stringValue: string | undefined;
+}
+export interface TargetResource {
+  assetId: string | undefined;
+}
+export interface ActionSummary {
+  actionId?: string;
+  actionDefinitionId?: string;
+  targetResource?: TargetResource;
+}
 export declare const Quality: {
   readonly BAD: "BAD";
   readonly GOOD: "GOOD";
@@ -92,6 +115,10 @@ export interface PropertyNotification {
   topic: string | undefined;
   state: PropertyNotificationState | undefined;
 }
+export interface AssetPropertyPathSegment {
+  id?: string;
+  name?: string;
+}
 export interface AssetProperty {
   id: string | undefined;
   name: string | undefined;
@@ -100,6 +127,8 @@ export interface AssetProperty {
   dataType: PropertyDataType | undefined;
   dataTypeSpec?: string;
   unit?: string;
+  path?: AssetPropertyPathSegment[];
+  externalId?: string;
 }
 export interface AssetCompositeModel {
   name: string | undefined;
@@ -107,6 +136,19 @@ export interface AssetCompositeModel {
   type: string | undefined;
   properties: AssetProperty[] | undefined;
   id?: string;
+  externalId?: string;
+}
+export interface AssetCompositeModelPathSegment {
+  id?: string;
+  name?: string;
+}
+export interface AssetCompositeModelSummary {
+  id: string | undefined;
+  externalId?: string;
+  name: string | undefined;
+  type: string | undefined;
+  description: string | undefined;
+  path: AssetCompositeModelPathSegment[] | undefined;
 }
 export declare const AssetErrorCode: {
   readonly INTERNAL_FAILURE: "INTERNAL_FAILURE";
@@ -121,11 +163,16 @@ export interface AssetErrorDetails {
 export interface AssetHierarchy {
   id?: string;
   name: string | undefined;
+  externalId?: string;
 }
 export interface AssetHierarchyInfo {
   parentAssetId?: string;
   childAssetId?: string;
 }
+export interface AssetModelPropertyPathSegment {
+  id?: string;
+  name?: string;
+}
 export interface Attribute {
   defaultValue?: string;
 }
@@ -154,8 +201,9 @@ export interface MetricProcessingConfig {
   computeLocation: ComputeLocation | undefined;
 }
 export interface VariableValue {
-  propertyId: string | undefined;
+  propertyId?: string;
   hierarchyId?: string;
+  propertyPath?: AssetModelPropertyPathSegment[];
 }
 export interface ExpressionVariable {
   name: string | undefined;
@@ -196,6 +244,8 @@ export interface AssetModelProperty {
   dataTypeSpec?: string;
   unit?: string;
   type: PropertyType | undefined;
+  path?: AssetModelPropertyPathSegment[];
+  externalId?: string;
 }
 export interface AssetModelCompositeModel {
   name: string | undefined;
@@ -203,6 +253,7 @@ export interface AssetModelCompositeModel {
   type: string | undefined;
   properties?: AssetModelProperty[];
   id?: string;
+  externalId?: string;
 }
 export interface AssetModelPropertyDefinition {
   name: string | undefined;
@@ -210,21 +261,40 @@ export interface AssetModelPropertyDefinition {
   dataTypeSpec?: string;
   unit?: string;
   type: PropertyType | undefined;
+  id?: string;
+  externalId?: string;
 }
 export interface AssetModelCompositeModelDefinition {
   name: string | undefined;
   description?: string;
   type: string | undefined;
   properties?: AssetModelPropertyDefinition[];
+  id?: string;
+  externalId?: string;
+}
+export interface AssetModelCompositeModelPathSegment {
+  id?: string;
+  name?: string;
+}
+export interface AssetModelCompositeModelSummary {
+  id: string | undefined;
+  externalId?: string;
+  name: string | undefined;
+  type: string | undefined;
+  description?: string;
+  path?: AssetModelCompositeModelPathSegment[];
 }
 export interface AssetModelHierarchy {
   id?: string;
   name: string | undefined;
   childAssetModelId: string | undefined;
+  externalId?: string;
 }
 export interface AssetModelHierarchyDefinition {
   name: string | undefined;
   childAssetModelId: string | undefined;
+  id?: string;
+  externalId?: string;
 }
 export interface AssetModelPropertySummary {
   id?: string;
@@ -234,6 +304,8 @@ export interface AssetModelPropertySummary {
   unit?: string;
   type: PropertyType | undefined;
   assetModelCompositeModelId?: string;
+  path?: AssetModelPropertyPathSegment[];
+  externalId?: string;
 }
 export declare const AssetModelState: {
   readonly ACTIVE: "ACTIVE";
@@ -269,6 +341,12 @@ export interface AssetModelStatus {
   state: AssetModelState | undefined;
   error?: ErrorDetails;
 }
+export declare const AssetModelType: {
+  readonly ASSET_MODEL: "ASSET_MODEL";
+  readonly COMPONENT_MODEL: "COMPONENT_MODEL";
+};
+export type AssetModelType =
+  (typeof AssetModelType)[keyof typeof AssetModelType];
 export interface AssetModelSummary {
   id: string | undefined;
   arn: string | undefined;
@@ -277,13 +355,17 @@ export interface AssetModelSummary {
   creationDate: Date | undefined;
   lastUpdateDate: Date | undefined;
   status: AssetModelStatus | undefined;
+  assetModelType?: AssetModelType;
+  externalId?: string;
 }
 export interface AssetPropertySummary {
-  id?: string;
+  id: string | undefined;
   alias?: string;
   unit?: string;
   notification?: PropertyNotification;
   assetCompositeModelId?: string;
+  path?: AssetPropertyPathSegment[];
+  externalId?: string;
 }
 export interface TimeInNanos {
   timeInSeconds: number | undefined;
@@ -331,6 +413,7 @@ export interface AssetSummary {
   status: AssetStatus | undefined;
   hierarchies: AssetHierarchy[] | undefined;
   description?: string;
+  externalId?: string;
 }
 export interface AssociateAssetsRequest {
   assetId: string | undefined;
@@ -401,6 +484,7 @@ export interface AssociatedAssetsSummary {
   status: AssetStatus | undefined;
   hierarchies: AssetHierarchy[] | undefined;
   description?: string;
+  externalId?: string;
 }
 export interface AssociateTimeSeriesToAssetPropertyRequest {
   alias: string | undefined;
@@ -634,6 +718,8 @@ export interface CreateAssetRequest {
   clientToken?: string;
   tags?: Record<string, string>;
   assetDescription?: string;
+  assetId?: string;
+  assetExternalId?: string;
 }
 export interface CreateAssetResponse {
   assetId: string | undefined;
@@ -648,12 +734,34 @@ export interface CreateAssetModelRequest {
   assetModelCompositeModels?: AssetModelCompositeModelDefinition[];
   clientToken?: string;
   tags?: Record<string, string>;
+  assetModelId?: string;
+  assetModelExternalId?: string;
+  assetModelType?: AssetModelType;
 }
 export interface CreateAssetModelResponse {
   assetModelId: string | undefined;
   assetModelArn: string | undefined;
   assetModelStatus: AssetModelStatus | undefined;
 }
+export interface CreateAssetModelCompositeModelRequest {
+  assetModelId: string | undefined;
+  parentAssetModelCompositeModelId?: string;
+  assetModelCompositeModelExternalId?: string;
+  assetModelCompositeModelId?: string;
+  assetModelCompositeModelDescription?: string;
+  assetModelCompositeModelName: string | undefined;
+  assetModelCompositeModelType: string | undefined;
+  clientToken?: string;
+  composedAssetModelId?: string;
+  assetModelCompositeModelProperties?: AssetModelPropertyDefinition[];
+}
+export interface CreateAssetModelCompositeModelResponse {
+  assetModelCompositeModelId: string | undefined;
+  assetModelCompositeModelPath:
+    | AssetModelCompositeModelPathSegment[]
+    | undefined;
+  assetModelStatus: AssetModelStatus | undefined;
+}
 export interface ErrorReportLocation {
   bucket: string | undefined;
   prefix: string | undefined;
@@ -675,10 +783,12 @@ export declare const ColumnName: {
 };
 export type ColumnName = (typeof ColumnName)[keyof typeof ColumnName];
 export interface Csv {
-  columnNames?: ColumnName[];
+  columnNames: ColumnName[] | undefined;
 }
+export interface Parquet {}
 export interface FileFormat {
   csv?: Csv;
+  parquet?: Parquet;
 }
 export interface JobConfiguration {
   fileFormat: FileFormat | undefined;
@@ -689,6 +799,8 @@ export interface CreateBulkImportJobRequest {
   files: File[] | undefined;
   errorReportLocation: ErrorReportLocation | undefined;
   jobConfiguration: JobConfiguration | undefined;
+  adaptiveIngestion?: boolean;
+  deleteFilesAfterImport?: boolean;
 }
 export declare const JobStatus: {
   readonly CANCELLED: "CANCELLED";
@@ -815,6 +927,14 @@ export interface DeleteAssetModelRequest {
 export interface DeleteAssetModelResponse {
   assetModelStatus: AssetModelStatus | undefined;
 }
+export interface DeleteAssetModelCompositeModelRequest {
+  assetModelId: string | undefined;
+  assetModelCompositeModelId: string | undefined;
+  clientToken?: string;
+}
+export interface DeleteAssetModelCompositeModelResponse {
+  assetModelStatus: AssetModelStatus | undefined;
+}
 export interface DeleteDashboardRequest {
   dashboardId: string | undefined;
   clientToken?: string;
@@ -853,6 +973,16 @@ export interface DescribeAccessPolicyResponse {
   accessPolicyCreationDate: Date | undefined;
   accessPolicyLastUpdateDate: Date | undefined;
 }
+export interface DescribeActionRequest {
+  actionId: string | undefined;
+}
+export interface DescribeActionResponse {
+  actionId: string | undefined;
+  targetResource: TargetResource | undefined;
+  actionDefinitionId: string | undefined;
+  actionPayload: ActionPayload | undefined;
+  executionTime: Date | undefined;
+}
 export interface DescribeAssetRequest {
   assetId: string | undefined;
   excludeProperties?: boolean;
@@ -869,6 +999,24 @@ export interface DescribeAssetResponse {
   assetLastUpdateDate: Date | undefined;
   assetStatus: AssetStatus | undefined;
   assetDescription?: string;
+  assetCompositeModelSummaries?: AssetCompositeModelSummary[];
+  assetExternalId?: string;
+}
+export interface DescribeAssetCompositeModelRequest {
+  assetId: string | undefined;
+  assetCompositeModelId: string | undefined;
+}
+export interface DescribeAssetCompositeModelResponse {
+  assetId: string | undefined;
+  assetCompositeModelId: string | undefined;
+  assetCompositeModelExternalId?: string;
+  assetCompositeModelPath: AssetCompositeModelPathSegment[] | undefined;
+  assetCompositeModelName: string | undefined;
+  assetCompositeModelDescription: string | undefined;
+  assetCompositeModelType: string | undefined;
+  assetCompositeModelProperties: AssetProperty[] | undefined;
+  assetCompositeModelSummaries: AssetCompositeModelSummary[] | undefined;
+  actionDefinitions?: ActionDefinition[];
 }
 export interface DescribeAssetModelRequest {
   assetModelId: string | undefined;
@@ -885,6 +1033,36 @@ export interface DescribeAssetModelResponse {
   assetModelCreationDate: Date | undefined;
   assetModelLastUpdateDate: Date | undefined;
   assetModelStatus: AssetModelStatus | undefined;
+  assetModelType?: AssetModelType;
+  assetModelCompositeModelSummaries?: AssetModelCompositeModelSummary[];
+  assetModelExternalId?: string;
+}
+export interface DescribeAssetModelCompositeModelRequest {
+  assetModelId: string | undefined;
+  assetModelCompositeModelId: string | undefined;
+}
+export interface CompositionRelationshipItem {
+  id?: string;
+}
+export interface CompositionDetails {
+  compositionRelationship?: CompositionRelationshipItem[];
+}
+export interface DescribeAssetModelCompositeModelResponse {
+  assetModelId: string | undefined;
+  assetModelCompositeModelId: string | undefined;
+  assetModelCompositeModelExternalId?: string;
+  assetModelCompositeModelPath:
+    | AssetModelCompositeModelPathSegment[]
+    | undefined;
+  assetModelCompositeModelName: string | undefined;
+  assetModelCompositeModelDescription: string | undefined;
+  assetModelCompositeModelType: string | undefined;
+  assetModelCompositeModelProperties: AssetModelProperty[] | undefined;
+  compositionDetails?: CompositionDetails;
+  assetModelCompositeModelSummaries:
+    | AssetModelCompositeModelSummary[]
+    | undefined;
+  actionDefinitions?: ActionDefinition[];
 }
 export interface DescribeAssetPropertyRequest {
   assetId: string | undefined;
@@ -898,12 +1076,15 @@ export interface Property {
   dataType: PropertyDataType | undefined;
   unit?: string;
   type?: PropertyType;
+  path?: AssetPropertyPathSegment[];
+  externalId?: string;
 }
 export interface CompositeModelProperty {
   name: string | undefined;
   type: string | undefined;
   assetProperty: Property | undefined;
   id?: string;
+  externalId?: string;
 }
 export interface DescribeAssetPropertyResponse {
   assetId: string | undefined;
@@ -911,6 +1092,7 @@ export interface DescribeAssetPropertyResponse {
   assetModelId: string | undefined;
   assetProperty?: Property;
   compositeModel?: CompositeModelProperty;
+  assetExternalId?: string;
 }
 export interface DescribeBulkImportJobRequest {
   jobId: string | undefined;
@@ -925,6 +1107,8 @@ export interface DescribeBulkImportJobResponse {
   jobConfiguration: JobConfiguration | undefined;
   jobCreationDate: Date | undefined;
   jobLastUpdateDate: Date | undefined;
+  adaptiveIngestion?: boolean;
+  deleteFilesAfterImport?: boolean;
 }
 export interface DescribeDashboardRequest {
   dashboardId: string | undefined;
@@ -1072,6 +1256,15 @@ export declare const StorageType: {
   readonly SITEWISE_DEFAULT_STORAGE: "SITEWISE_DEFAULT_STORAGE";
 };
 export type StorageType = (typeof StorageType)[keyof typeof StorageType];
+export declare const WarmTierState: {
+  readonly DISABLED: "DISABLED";
+  readonly ENABLED: "ENABLED";
+};
+export type WarmTierState = (typeof WarmTierState)[keyof typeof WarmTierState];
+export interface WarmTierRetentionPeriod {
+  numberOfDays?: number;
+  unlimited?: boolean;
+}
 export interface DescribeStorageConfigurationResponse {
   storageType: StorageType | undefined;
   multiLayerStorage?: MultiLayerStorage;
@@ -1079,6 +1272,8 @@ export interface DescribeStorageConfigurationResponse {
   retentionPeriod?: RetentionPeriod;
   configurationStatus: ConfigurationStatus | undefined;
   lastUpdateDate?: Date;
+  warmTier?: WarmTierState;
+  warmTierRetentionPeriod?: WarmTierRetentionPeriod;
 }
 export interface DescribeTimeSeriesRequest {
   alias?: string;
@@ -1108,6 +1303,49 @@ export interface DisassociateTimeSeriesFromAssetPropertyRequest {
   propertyId: string | undefined;
   clientToken?: string;
 }
+export interface ExecuteActionRequest {
+  targetResource: TargetResource | undefined;
+  actionDefinitionId: string | undefined;
+  actionPayload: ActionPayload | undefined;
+  clientToken?: string;
+}
+export interface ExecuteActionResponse {
+  actionId: string | undefined;
+}
+export interface ExecuteQueryRequest {
+  queryStatement: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+}
+export declare const ScalarType: {
+  readonly BOOLEAN: "BOOLEAN";
+  readonly DOUBLE: "DOUBLE";
+  readonly INT: "INT";
+  readonly STRING: "STRING";
+  readonly TIMESTAMP: "TIMESTAMP";
+};
+export type ScalarType = (typeof ScalarType)[keyof typeof ScalarType];
+export interface ColumnType {
+  scalarType?: ScalarType;
+}
+export interface ColumnInfo {
+  name?: string;
+  type?: ColumnType;
+}
+export declare class QueryTimeoutException extends __BaseException {
+  readonly name: "QueryTimeoutException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<QueryTimeoutException, __BaseException>
+  );
+}
+export declare class ValidationException extends __BaseException {
+  readonly name: "ValidationException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<ValidationException, __BaseException>
+  );
+}
 export interface GetAssetPropertyAggregatesRequest {
   assetId?: string;
   propertyId?: string;
@@ -1195,6 +1433,32 @@ export interface ListAccessPoliciesResponse {
   accessPolicySummaries: AccessPolicySummary[] | undefined;
   nextToken?: string;
 }
+export declare const TargetResourceType: {
+  readonly ASSET: "ASSET";
+};
+export type TargetResourceType =
+  (typeof TargetResourceType)[keyof typeof TargetResourceType];
+export interface ListActionsRequest {
+  targetResourceType: TargetResourceType | undefined;
+  targetResourceId: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface ListActionsResponse {
+  actionSummaries: ActionSummary[] | undefined;
+  nextToken: string | undefined;
+}
+export interface ListAssetModelCompositeModelsRequest {
+  assetModelId: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface ListAssetModelCompositeModelsResponse {
+  assetModelCompositeModelSummaries:
+    | AssetModelCompositeModelSummary[]
+    | undefined;
+  nextToken?: string;
+}
 export declare const ListAssetModelPropertiesFilter: {
   readonly ALL: "ALL";
   readonly BASE: "BASE";
@@ -1214,6 +1478,7 @@ export interface ListAssetModelPropertiesResponse {
 export interface ListAssetModelsRequest {
   nextToken?: string;
   maxResults?: number;
+  assetModelTypes?: AssetModelType[];
 }
 export interface ListAssetModelsResponse {
   assetModelSummaries: AssetModelSummary[] | undefined;
@@ -1307,6 +1572,22 @@ export interface ListBulkImportJobsResponse {
   jobSummaries: JobSummary[] | undefined;
   nextToken?: string;
 }
+export interface ListCompositionRelationshipsRequest {
+  assetModelId: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface CompositionRelationshipSummary {
+  assetModelId: string | undefined;
+  assetModelCompositeModelId: string | undefined;
+  assetModelCompositeModelType: string | undefined;
+}
+export interface ListCompositionRelationshipsResponse {
+  compositionRelationshipSummaries:
+    | CompositionRelationshipSummary[]
+    | undefined;
+  nextToken?: string;
+}
 export interface ListDashboardsRequest {
   projectId: string | undefined;
   nextToken?: string;
@@ -1423,130 +1704,3 @@ export interface ListTimeSeriesResponse {
   TimeSeriesSummaries: TimeSeriesSummary[] | undefined;
   nextToken?: string;
 }
-export interface PutDefaultEncryptionConfigurationRequest {
-  encryptionType: EncryptionType | undefined;
-  kmsKeyId?: string;
-}
-export interface PutDefaultEncryptionConfigurationResponse {
-  encryptionType: EncryptionType | undefined;
-  kmsKeyArn?: string;
-  configurationStatus: ConfigurationStatus | undefined;
-}
-export interface PutLoggingOptionsRequest {
-  loggingOptions: LoggingOptions | undefined;
-}
-export interface PutLoggingOptionsResponse {}
-export interface PutStorageConfigurationRequest {
-  storageType: StorageType | undefined;
-  multiLayerStorage?: MultiLayerStorage;
-  disassociatedDataStorage?: DisassociatedDataStorageState;
-  retentionPeriod?: RetentionPeriod;
-}
-export interface PutStorageConfigurationResponse {
-  storageType: StorageType | undefined;
-  multiLayerStorage?: MultiLayerStorage;
-  disassociatedDataStorage?: DisassociatedDataStorageState;
-  retentionPeriod?: RetentionPeriod;
-  configurationStatus: ConfigurationStatus | undefined;
-}
-export interface TagResourceRequest {
-  resourceArn: string | undefined;
-  tags: Record<string, string> | undefined;
-}
-export interface TagResourceResponse {}
-export declare class TooManyTagsException extends __BaseException {
-  readonly name: "TooManyTagsException";
-  readonly $fault: "client";
-  resourceName?: string;
-  constructor(
-    opts: __ExceptionOptionType<TooManyTagsException, __BaseException>
-  );
-}
-export interface UntagResourceRequest {
-  resourceArn: string | undefined;
-  tagKeys: string[] | undefined;
-}
-export interface UntagResourceResponse {}
-export interface UpdateAccessPolicyRequest {
-  accessPolicyId: string | undefined;
-  accessPolicyIdentity: Identity | undefined;
-  accessPolicyResource: Resource | undefined;
-  accessPolicyPermission: Permission | undefined;
-  clientToken?: string;
-}
-export interface UpdateAccessPolicyResponse {}
-export interface UpdateAssetRequest {
-  assetId: string | undefined;
-  assetName: string | undefined;
-  clientToken?: string;
-  assetDescription?: string;
-}
-export interface UpdateAssetResponse {
-  assetStatus: AssetStatus | undefined;
-}
-export interface UpdateAssetModelRequest {
-  assetModelId: string | undefined;
-  assetModelName: string | undefined;
-  assetModelDescription?: string;
-  assetModelProperties?: AssetModelProperty[];
-  assetModelHierarchies?: AssetModelHierarchy[];
-  assetModelCompositeModels?: AssetModelCompositeModel[];
-  clientToken?: string;
-}
-export interface UpdateAssetModelResponse {
-  assetModelStatus: AssetModelStatus | undefined;
-}
-export interface UpdateAssetPropertyRequest {
-  assetId: string | undefined;
-  propertyId: string | undefined;
-  propertyAlias?: string;
-  propertyNotificationState?: PropertyNotificationState;
-  clientToken?: string;
-  propertyUnit?: string;
-}
-export interface UpdateDashboardRequest {
-  dashboardId: string | undefined;
-  dashboardName: string | undefined;
-  dashboardDescription?: string;
-  dashboardDefinition: string | undefined;
-  clientToken?: string;
-}
-export interface UpdateDashboardResponse {}
-export interface UpdateGatewayRequest {
-  gatewayId: string | undefined;
-  gatewayName: string | undefined;
-}
-export interface UpdateGatewayCapabilityConfigurationRequest {
-  gatewayId: string | undefined;
-  capabilityNamespace: string | undefined;
-  capabilityConfiguration: string | undefined;
-}
-export interface UpdateGatewayCapabilityConfigurationResponse {
-  capabilityNamespace: string | undefined;
-  capabilitySyncStatus: CapabilitySyncStatus | undefined;
-}
-export interface Image {
-  id?: string;
-  file?: ImageFile;
-}
-export interface UpdatePortalRequest {
-  portalId: string | undefined;
-  portalName: string | undefined;
-  portalDescription?: string;
-  portalContactEmail: string | undefined;
-  portalLogoImage?: Image;
-  roleArn: string | undefined;
-  clientToken?: string;
-  notificationSenderEmail?: string;
-  alarms?: Alarms;
-}
-export interface UpdatePortalResponse {
-  portalStatus: PortalStatus | undefined;
-}
-export interface UpdateProjectRequest {
-  projectId: string | undefined;
-  projectName: string | undefined;
-  projectDescription?: string;
-  clientToken?: string;
-}
-export interface UpdateProjectResponse {}