Type definitions#
Index > IoTSiteWise > Type definitions
Auto-generated documentation for IoTSiteWise type annotations stubs module types-aiobotocore-iotsitewise.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
BlobTypeDef#
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
AggregatesTypeDef#
# AggregatesTypeDef definition
class AggregatesTypeDef(TypedDict):
average: NotRequired[float],
count: NotRequired[float],
maximum: NotRequired[float],
minimum: NotRequired[float],
sum: NotRequired[float],
standardDeviation: NotRequired[float],
AlarmsTypeDef#
# AlarmsTypeDef definition
class AlarmsTypeDef(TypedDict):
alarmRoleArn: str,
notificationLambdaArn: NotRequired[str],
AssetErrorDetailsTypeDef#
# AssetErrorDetailsTypeDef definition
class AssetErrorDetailsTypeDef(TypedDict):
assetId: str,
code: AssetErrorCodeType, # (1)
message: str,
AssetHierarchyInfoTypeDef#
# AssetHierarchyInfoTypeDef definition
class AssetHierarchyInfoTypeDef(TypedDict):
parentAssetId: NotRequired[str],
childAssetId: NotRequired[str],
AssetHierarchyTypeDef#
# AssetHierarchyTypeDef definition
class AssetHierarchyTypeDef(TypedDict):
name: str,
id: NotRequired[str],
AssetModelHierarchyDefinitionTypeDef#
# AssetModelHierarchyDefinitionTypeDef definition
class AssetModelHierarchyDefinitionTypeDef(TypedDict):
name: str,
childAssetModelId: str,
AssetModelHierarchyTypeDef#
# AssetModelHierarchyTypeDef definition
class AssetModelHierarchyTypeDef(TypedDict):
name: str,
childAssetModelId: str,
id: NotRequired[str],
PropertyNotificationTypeDef#
# PropertyNotificationTypeDef definition
class PropertyNotificationTypeDef(TypedDict):
topic: str,
state: PropertyNotificationStateType, # (1)
TimeInNanosTypeDef#
# TimeInNanosTypeDef definition
class TimeInNanosTypeDef(TypedDict):
timeInSeconds: int,
offsetInNanos: NotRequired[int],
VariantTypeDef#
# VariantTypeDef definition
class VariantTypeDef(TypedDict):
stringValue: NotRequired[str],
integerValue: NotRequired[int],
doubleValue: NotRequired[float],
booleanValue: NotRequired[bool],
AssociateAssetsRequestRequestTypeDef#
# AssociateAssetsRequestRequestTypeDef definition
class AssociateAssetsRequestRequestTypeDef(TypedDict):
assetId: str,
hierarchyId: str,
childAssetId: str,
clientToken: NotRequired[str],
AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef#
# AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef definition
class AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef(TypedDict):
alias: str,
assetId: str,
propertyId: str,
clientToken: NotRequired[str],
AttributeTypeDef#
# AttributeTypeDef definition
class AttributeTypeDef(TypedDict):
defaultValue: NotRequired[str],
BatchAssociateProjectAssetsRequestRequestTypeDef#
# BatchAssociateProjectAssetsRequestRequestTypeDef definition
class BatchAssociateProjectAssetsRequestRequestTypeDef(TypedDict):
projectId: str,
assetIds: Sequence[str],
clientToken: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
BatchDisassociateProjectAssetsRequestRequestTypeDef#
# BatchDisassociateProjectAssetsRequestRequestTypeDef definition
class BatchDisassociateProjectAssetsRequestRequestTypeDef(TypedDict):
projectId: str,
assetIds: Sequence[str],
clientToken: NotRequired[str],
BatchGetAssetPropertyAggregatesErrorEntryTypeDef#
# BatchGetAssetPropertyAggregatesErrorEntryTypeDef definition
class BatchGetAssetPropertyAggregatesErrorEntryTypeDef(TypedDict):
errorCode: BatchGetAssetPropertyAggregatesErrorCodeType, # (1)
errorMessage: str,
entryId: str,
BatchGetAssetPropertyAggregatesErrorInfoTypeDef#
# BatchGetAssetPropertyAggregatesErrorInfoTypeDef definition
class BatchGetAssetPropertyAggregatesErrorInfoTypeDef(TypedDict):
errorCode: BatchGetAssetPropertyAggregatesErrorCodeType, # (1)
errorTimestamp: datetime,
BatchGetAssetPropertyValueEntryTypeDef#
# BatchGetAssetPropertyValueEntryTypeDef definition
class BatchGetAssetPropertyValueEntryTypeDef(TypedDict):
entryId: str,
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],
BatchGetAssetPropertyValueErrorEntryTypeDef#
# BatchGetAssetPropertyValueErrorEntryTypeDef definition
class BatchGetAssetPropertyValueErrorEntryTypeDef(TypedDict):
errorCode: BatchGetAssetPropertyValueErrorCodeType, # (1)
errorMessage: str,
entryId: str,
BatchGetAssetPropertyValueErrorInfoTypeDef#
# BatchGetAssetPropertyValueErrorInfoTypeDef definition
class BatchGetAssetPropertyValueErrorInfoTypeDef(TypedDict):
errorCode: BatchGetAssetPropertyValueErrorCodeType, # (1)
errorTimestamp: datetime,
BatchGetAssetPropertyValueHistoryErrorEntryTypeDef#
# BatchGetAssetPropertyValueHistoryErrorEntryTypeDef definition
class BatchGetAssetPropertyValueHistoryErrorEntryTypeDef(TypedDict):
errorCode: BatchGetAssetPropertyValueHistoryErrorCodeType, # (1)
errorMessage: str,
entryId: str,
BatchGetAssetPropertyValueHistoryErrorInfoTypeDef#
# BatchGetAssetPropertyValueHistoryErrorInfoTypeDef definition
class BatchGetAssetPropertyValueHistoryErrorInfoTypeDef(TypedDict):
errorCode: BatchGetAssetPropertyValueHistoryErrorCodeType, # (1)
errorTimestamp: datetime,
ConfigurationErrorDetailsTypeDef#
# ConfigurationErrorDetailsTypeDef definition
class ConfigurationErrorDetailsTypeDef(TypedDict):
code: ErrorCodeType, # (1)
message: str,
- See ErrorCodeType
CreateAssetRequestRequestTypeDef#
# CreateAssetRequestRequestTypeDef definition
class CreateAssetRequestRequestTypeDef(TypedDict):
assetName: str,
assetModelId: str,
clientToken: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
assetDescription: NotRequired[str],
ErrorReportLocationTypeDef#
# ErrorReportLocationTypeDef definition
class ErrorReportLocationTypeDef(TypedDict):
bucket: str,
prefix: str,
FileTypeDef#
# FileTypeDef definition
class FileTypeDef(TypedDict):
bucket: str,
key: str,
versionId: NotRequired[str],
CreateDashboardRequestRequestTypeDef#
# CreateDashboardRequestRequestTypeDef definition
class CreateDashboardRequestRequestTypeDef(TypedDict):
projectId: str,
dashboardName: str,
dashboardDefinition: str,
dashboardDescription: NotRequired[str],
clientToken: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
CreateProjectRequestRequestTypeDef#
# CreateProjectRequestRequestTypeDef definition
class CreateProjectRequestRequestTypeDef(TypedDict):
portalId: str,
projectName: str,
projectDescription: NotRequired[str],
clientToken: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
CsvTypeDef#
# CsvTypeDef definition
class CsvTypeDef(TypedDict):
columnNames: NotRequired[Sequence[ColumnNameType]], # (1)
- See ColumnNameType
CustomerManagedS3StorageTypeDef#
# CustomerManagedS3StorageTypeDef definition
class CustomerManagedS3StorageTypeDef(TypedDict):
s3ResourceArn: str,
roleArn: str,
DashboardSummaryTypeDef#
# DashboardSummaryTypeDef definition
class DashboardSummaryTypeDef(TypedDict):
id: str,
name: str,
description: NotRequired[str],
creationDate: NotRequired[datetime],
lastUpdateDate: NotRequired[datetime],
DeleteAccessPolicyRequestRequestTypeDef#
# DeleteAccessPolicyRequestRequestTypeDef definition
class DeleteAccessPolicyRequestRequestTypeDef(TypedDict):
accessPolicyId: str,
clientToken: NotRequired[str],
DeleteAssetModelRequestRequestTypeDef#
# DeleteAssetModelRequestRequestTypeDef definition
class DeleteAssetModelRequestRequestTypeDef(TypedDict):
assetModelId: str,
clientToken: NotRequired[str],
DeleteAssetRequestRequestTypeDef#
# DeleteAssetRequestRequestTypeDef definition
class DeleteAssetRequestRequestTypeDef(TypedDict):
assetId: str,
clientToken: NotRequired[str],
DeleteDashboardRequestRequestTypeDef#
# DeleteDashboardRequestRequestTypeDef definition
class DeleteDashboardRequestRequestTypeDef(TypedDict):
dashboardId: str,
clientToken: NotRequired[str],
DeleteGatewayRequestRequestTypeDef#
# DeleteGatewayRequestRequestTypeDef definition
class DeleteGatewayRequestRequestTypeDef(TypedDict):
gatewayId: str,
DeletePortalRequestRequestTypeDef#
# DeletePortalRequestRequestTypeDef definition
class DeletePortalRequestRequestTypeDef(TypedDict):
portalId: str,
clientToken: NotRequired[str],
DeleteProjectRequestRequestTypeDef#
# DeleteProjectRequestRequestTypeDef definition
class DeleteProjectRequestRequestTypeDef(TypedDict):
projectId: str,
clientToken: NotRequired[str],
DeleteTimeSeriesRequestRequestTypeDef#
# DeleteTimeSeriesRequestRequestTypeDef definition
class DeleteTimeSeriesRequestRequestTypeDef(TypedDict):
alias: NotRequired[str],
assetId: NotRequired[str],
propertyId: NotRequired[str],
clientToken: NotRequired[str],
DescribeAccessPolicyRequestRequestTypeDef#
# DescribeAccessPolicyRequestRequestTypeDef definition
class DescribeAccessPolicyRequestRequestTypeDef(TypedDict):
accessPolicyId: str,
WaiterConfigTypeDef#
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
DescribeAssetModelRequestRequestTypeDef#
# DescribeAssetModelRequestRequestTypeDef definition
class DescribeAssetModelRequestRequestTypeDef(TypedDict):
assetModelId: str,
excludeProperties: NotRequired[bool],
DescribeAssetPropertyRequestRequestTypeDef#
# DescribeAssetPropertyRequestRequestTypeDef definition
class DescribeAssetPropertyRequestRequestTypeDef(TypedDict):
assetId: str,
propertyId: str,
DescribeAssetRequestRequestTypeDef#
# DescribeAssetRequestRequestTypeDef definition
class DescribeAssetRequestRequestTypeDef(TypedDict):
assetId: str,
excludeProperties: NotRequired[bool],
DescribeBulkImportJobRequestRequestTypeDef#
# DescribeBulkImportJobRequestRequestTypeDef definition
class DescribeBulkImportJobRequestRequestTypeDef(TypedDict):
jobId: str,
DescribeDashboardRequestRequestTypeDef#
# DescribeDashboardRequestRequestTypeDef definition
class DescribeDashboardRequestRequestTypeDef(TypedDict):
dashboardId: str,
DescribeGatewayCapabilityConfigurationRequestRequestTypeDef#
# DescribeGatewayCapabilityConfigurationRequestRequestTypeDef definition
class DescribeGatewayCapabilityConfigurationRequestRequestTypeDef(TypedDict):
gatewayId: str,
capabilityNamespace: str,
DescribeGatewayRequestRequestTypeDef#
# DescribeGatewayRequestRequestTypeDef definition
class DescribeGatewayRequestRequestTypeDef(TypedDict):
gatewayId: str,
GatewayCapabilitySummaryTypeDef#
# GatewayCapabilitySummaryTypeDef definition
class GatewayCapabilitySummaryTypeDef(TypedDict):
capabilityNamespace: str,
capabilitySyncStatus: CapabilitySyncStatusType, # (1)
LoggingOptionsTypeDef#
# LoggingOptionsTypeDef definition
class LoggingOptionsTypeDef(TypedDict):
level: LoggingLevelType, # (1)
- See LoggingLevelType
DescribePortalRequestRequestTypeDef#
# DescribePortalRequestRequestTypeDef definition
class DescribePortalRequestRequestTypeDef(TypedDict):
portalId: str,
ImageLocationTypeDef#
# ImageLocationTypeDef definition
class ImageLocationTypeDef(TypedDict):
id: str,
url: str,
DescribeProjectRequestRequestTypeDef#
# DescribeProjectRequestRequestTypeDef definition
class DescribeProjectRequestRequestTypeDef(TypedDict):
projectId: str,
RetentionPeriodTypeDef#
# RetentionPeriodTypeDef definition
class RetentionPeriodTypeDef(TypedDict):
numberOfDays: NotRequired[int],
unlimited: NotRequired[bool],
DescribeTimeSeriesRequestRequestTypeDef#
# DescribeTimeSeriesRequestRequestTypeDef definition
class DescribeTimeSeriesRequestRequestTypeDef(TypedDict):
alias: NotRequired[str],
assetId: NotRequired[str],
propertyId: NotRequired[str],
DetailedErrorTypeDef#
# DetailedErrorTypeDef definition
class DetailedErrorTypeDef(TypedDict):
code: DetailedErrorCodeType, # (1)
message: str,
DisassociateAssetsRequestRequestTypeDef#
# DisassociateAssetsRequestRequestTypeDef definition
class DisassociateAssetsRequestRequestTypeDef(TypedDict):
assetId: str,
hierarchyId: str,
childAssetId: str,
clientToken: NotRequired[str],
DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef#
# DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef definition
class DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef(TypedDict):
alias: str,
assetId: str,
propertyId: str,
clientToken: NotRequired[str],
VariableValueTypeDef#
# VariableValueTypeDef definition
class VariableValueTypeDef(TypedDict):
propertyId: str,
hierarchyId: NotRequired[str],
ForwardingConfigTypeDef#
# ForwardingConfigTypeDef definition
class ForwardingConfigTypeDef(TypedDict):
state: ForwardingConfigStateType, # (1)
GreengrassTypeDef#
# GreengrassTypeDef definition
class GreengrassTypeDef(TypedDict):
groupArn: str,
GreengrassV2TypeDef#
# GreengrassV2TypeDef definition
class GreengrassV2TypeDef(TypedDict):
coreDeviceThingName: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
GetAssetPropertyValueRequestRequestTypeDef#
# GetAssetPropertyValueRequestRequestTypeDef definition
class GetAssetPropertyValueRequestRequestTypeDef(TypedDict):
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],
GetInterpolatedAssetPropertyValuesRequestRequestTypeDef#
# GetInterpolatedAssetPropertyValuesRequestRequestTypeDef definition
class GetInterpolatedAssetPropertyValuesRequestRequestTypeDef(TypedDict):
startTimeInSeconds: int,
endTimeInSeconds: int,
quality: QualityType, # (1)
intervalInSeconds: int,
type: str,
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],
startTimeOffsetInNanos: NotRequired[int],
endTimeOffsetInNanos: NotRequired[int],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
intervalWindowInSeconds: NotRequired[int],
- See QualityType
GroupIdentityTypeDef#
# GroupIdentityTypeDef definition
class GroupIdentityTypeDef(TypedDict):
id: str,
IAMRoleIdentityTypeDef#
# IAMRoleIdentityTypeDef definition
class IAMRoleIdentityTypeDef(TypedDict):
arn: str,
IAMUserIdentityTypeDef#
# IAMUserIdentityTypeDef definition
class IAMUserIdentityTypeDef(TypedDict):
arn: str,
UserIdentityTypeDef#
# UserIdentityTypeDef definition
class UserIdentityTypeDef(TypedDict):
id: str,
JobSummaryTypeDef#
# JobSummaryTypeDef definition
class JobSummaryTypeDef(TypedDict):
id: str,
name: str,
status: JobStatusType, # (1)
- See JobStatusType
ListAccessPoliciesRequestRequestTypeDef#
# ListAccessPoliciesRequestRequestTypeDef definition
class ListAccessPoliciesRequestRequestTypeDef(TypedDict):
identityType: NotRequired[IdentityTypeType], # (1)
identityId: NotRequired[str],
resourceType: NotRequired[ResourceTypeType], # (2)
resourceId: NotRequired[str],
iamArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
- See IdentityTypeType
- See ResourceTypeType
ListAssetModelPropertiesRequestRequestTypeDef#
# ListAssetModelPropertiesRequestRequestTypeDef definition
class ListAssetModelPropertiesRequestRequestTypeDef(TypedDict):
assetModelId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
filter: NotRequired[ListAssetModelPropertiesFilterType], # (1)
ListAssetModelsRequestRequestTypeDef#
# ListAssetModelsRequestRequestTypeDef definition
class ListAssetModelsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListAssetPropertiesRequestRequestTypeDef#
# ListAssetPropertiesRequestRequestTypeDef definition
class ListAssetPropertiesRequestRequestTypeDef(TypedDict):
assetId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
filter: NotRequired[ListAssetPropertiesFilterType], # (1)
ListAssetRelationshipsRequestRequestTypeDef#
# ListAssetRelationshipsRequestRequestTypeDef definition
class ListAssetRelationshipsRequestRequestTypeDef(TypedDict):
assetId: str,
traversalType: TraversalTypeType, # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListAssetsRequestRequestTypeDef#
# ListAssetsRequestRequestTypeDef definition
class ListAssetsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
assetModelId: NotRequired[str],
filter: NotRequired[ListAssetsFilterType], # (1)
ListAssociatedAssetsRequestRequestTypeDef#
# ListAssociatedAssetsRequestRequestTypeDef definition
class ListAssociatedAssetsRequestRequestTypeDef(TypedDict):
assetId: str,
hierarchyId: NotRequired[str],
traversalDirection: NotRequired[TraversalDirectionType], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListBulkImportJobsRequestRequestTypeDef#
# ListBulkImportJobsRequestRequestTypeDef definition
class ListBulkImportJobsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
filter: NotRequired[ListBulkImportJobsFilterType], # (1)
ListDashboardsRequestRequestTypeDef#
# ListDashboardsRequestRequestTypeDef definition
class ListDashboardsRequestRequestTypeDef(TypedDict):
projectId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListGatewaysRequestRequestTypeDef#
# ListGatewaysRequestRequestTypeDef definition
class ListGatewaysRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListPortalsRequestRequestTypeDef#
# ListPortalsRequestRequestTypeDef definition
class ListPortalsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListProjectAssetsRequestRequestTypeDef#
# ListProjectAssetsRequestRequestTypeDef definition
class ListProjectAssetsRequestRequestTypeDef(TypedDict):
projectId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListProjectsRequestRequestTypeDef#
# ListProjectsRequestRequestTypeDef definition
class ListProjectsRequestRequestTypeDef(TypedDict):
portalId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ProjectSummaryTypeDef#
# ProjectSummaryTypeDef definition
class ProjectSummaryTypeDef(TypedDict):
id: str,
name: str,
description: NotRequired[str],
creationDate: NotRequired[datetime],
lastUpdateDate: NotRequired[datetime],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
ListTimeSeriesRequestRequestTypeDef#
# ListTimeSeriesRequestRequestTypeDef definition
class ListTimeSeriesRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
assetId: NotRequired[str],
aliasPrefix: NotRequired[str],
timeSeriesType: NotRequired[ListTimeSeriesTypeType], # (1)
TimeSeriesSummaryTypeDef#
# TimeSeriesSummaryTypeDef definition
class TimeSeriesSummaryTypeDef(TypedDict):
timeSeriesId: str,
dataType: PropertyDataTypeType, # (1)
timeSeriesCreationDate: datetime,
timeSeriesLastUpdateDate: datetime,
timeSeriesArn: str,
assetId: NotRequired[str],
propertyId: NotRequired[str],
alias: NotRequired[str],
dataTypeSpec: NotRequired[str],
MetricProcessingConfigTypeDef#
# MetricProcessingConfigTypeDef definition
class MetricProcessingConfigTypeDef(TypedDict):
computeLocation: ComputeLocationType, # (1)
TumblingWindowTypeDef#
# TumblingWindowTypeDef definition
class TumblingWindowTypeDef(TypedDict):
interval: str,
offset: NotRequired[str],
MonitorErrorDetailsTypeDef#
# MonitorErrorDetailsTypeDef definition
class MonitorErrorDetailsTypeDef(TypedDict):
code: NotRequired[MonitorErrorCodeType], # (1)
message: NotRequired[str],
PortalResourceTypeDef#
# PortalResourceTypeDef definition
class PortalResourceTypeDef(TypedDict):
id: str,
ProjectResourceTypeDef#
# ProjectResourceTypeDef definition
class ProjectResourceTypeDef(TypedDict):
id: str,
PutDefaultEncryptionConfigurationRequestRequestTypeDef#
# PutDefaultEncryptionConfigurationRequestRequestTypeDef definition
class PutDefaultEncryptionConfigurationRequestRequestTypeDef(TypedDict):
encryptionType: EncryptionTypeType, # (1)
kmsKeyId: NotRequired[str],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
UpdateAssetPropertyRequestRequestTypeDef#
# UpdateAssetPropertyRequestRequestTypeDef definition
class UpdateAssetPropertyRequestRequestTypeDef(TypedDict):
assetId: str,
propertyId: str,
propertyAlias: NotRequired[str],
propertyNotificationState: NotRequired[PropertyNotificationStateType], # (1)
clientToken: NotRequired[str],
propertyUnit: NotRequired[str],
UpdateAssetRequestRequestTypeDef#
# UpdateAssetRequestRequestTypeDef definition
class UpdateAssetRequestRequestTypeDef(TypedDict):
assetId: str,
assetName: str,
clientToken: NotRequired[str],
assetDescription: NotRequired[str],
UpdateDashboardRequestRequestTypeDef#
# UpdateDashboardRequestRequestTypeDef definition
class UpdateDashboardRequestRequestTypeDef(TypedDict):
dashboardId: str,
dashboardName: str,
dashboardDefinition: str,
dashboardDescription: NotRequired[str],
clientToken: NotRequired[str],
UpdateGatewayCapabilityConfigurationRequestRequestTypeDef#
# UpdateGatewayCapabilityConfigurationRequestRequestTypeDef definition
class UpdateGatewayCapabilityConfigurationRequestRequestTypeDef(TypedDict):
gatewayId: str,
capabilityNamespace: str,
capabilityConfiguration: str,
UpdateGatewayRequestRequestTypeDef#
# UpdateGatewayRequestRequestTypeDef definition
class UpdateGatewayRequestRequestTypeDef(TypedDict):
gatewayId: str,
gatewayName: str,
UpdateProjectRequestRequestTypeDef#
# UpdateProjectRequestRequestTypeDef definition
class UpdateProjectRequestRequestTypeDef(TypedDict):
projectId: str,
projectName: str,
projectDescription: NotRequired[str],
clientToken: NotRequired[str],
AggregatedValueTypeDef#
# AggregatedValueTypeDef definition
class AggregatedValueTypeDef(TypedDict):
timestamp: datetime,
value: AggregatesTypeDef, # (2)
quality: NotRequired[QualityType], # (1)
- See QualityType
- See AggregatesTypeDef
AssetRelationshipSummaryTypeDef#
# AssetRelationshipSummaryTypeDef definition
class AssetRelationshipSummaryTypeDef(TypedDict):
relationshipType: AssetRelationshipTypeType, # (2)
hierarchyInfo: NotRequired[AssetHierarchyInfoTypeDef], # (1)
AssetPropertySummaryTypeDef#
# AssetPropertySummaryTypeDef definition
class AssetPropertySummaryTypeDef(TypedDict):
id: NotRequired[str],
alias: NotRequired[str],
unit: NotRequired[str],
notification: NotRequired[PropertyNotificationTypeDef], # (1)
assetCompositeModelId: NotRequired[str],
AssetPropertyTypeDef#
# AssetPropertyTypeDef definition
class AssetPropertyTypeDef(TypedDict):
id: str,
name: str,
dataType: PropertyDataTypeType, # (2)
alias: NotRequired[str],
notification: NotRequired[PropertyNotificationTypeDef], # (1)
dataTypeSpec: NotRequired[str],
unit: NotRequired[str],
BatchPutAssetPropertyErrorTypeDef#
# BatchPutAssetPropertyErrorTypeDef definition
class BatchPutAssetPropertyErrorTypeDef(TypedDict):
errorCode: BatchPutAssetPropertyValueErrorCodeType, # (1)
errorMessage: str,
timestamps: List[TimeInNanosTypeDef], # (2)
AssetPropertyValueTypeDef#
# AssetPropertyValueTypeDef definition
class AssetPropertyValueTypeDef(TypedDict):
value: VariantTypeDef, # (1)
timestamp: TimeInNanosTypeDef, # (2)
quality: NotRequired[QualityType], # (3)
- See VariantTypeDef
- See TimeInNanosTypeDef
- See QualityType
InterpolatedAssetPropertyValueTypeDef#
# InterpolatedAssetPropertyValueTypeDef definition
class InterpolatedAssetPropertyValueTypeDef(TypedDict):
timestamp: TimeInNanosTypeDef, # (1)
value: VariantTypeDef, # (2)
- See TimeInNanosTypeDef
- See VariantTypeDef
BatchAssociateProjectAssetsResponseTypeDef#
# BatchAssociateProjectAssetsResponseTypeDef definition
class BatchAssociateProjectAssetsResponseTypeDef(TypedDict):
errors: List[AssetErrorDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchDisassociateProjectAssetsResponseTypeDef#
# BatchDisassociateProjectAssetsResponseTypeDef definition
class BatchDisassociateProjectAssetsResponseTypeDef(TypedDict):
errors: List[AssetErrorDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateAccessPolicyResponseTypeDef#
# CreateAccessPolicyResponseTypeDef definition
class CreateAccessPolicyResponseTypeDef(TypedDict):
accessPolicyId: str,
accessPolicyArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBulkImportJobResponseTypeDef#
# CreateBulkImportJobResponseTypeDef definition
class CreateBulkImportJobResponseTypeDef(TypedDict):
jobId: str,
jobName: str,
jobStatus: JobStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See JobStatusType
- See ResponseMetadataTypeDef
CreateDashboardResponseTypeDef#
# CreateDashboardResponseTypeDef definition
class CreateDashboardResponseTypeDef(TypedDict):
dashboardId: str,
dashboardArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateGatewayResponseTypeDef#
# CreateGatewayResponseTypeDef definition
class CreateGatewayResponseTypeDef(TypedDict):
gatewayId: str,
gatewayArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProjectResponseTypeDef#
# CreateProjectResponseTypeDef definition
class CreateProjectResponseTypeDef(TypedDict):
projectId: str,
projectArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeDashboardResponseTypeDef#
# DescribeDashboardResponseTypeDef definition
class DescribeDashboardResponseTypeDef(TypedDict):
dashboardId: str,
dashboardArn: str,
dashboardName: str,
projectId: str,
dashboardDescription: str,
dashboardDefinition: str,
dashboardCreationDate: datetime,
dashboardLastUpdateDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeGatewayCapabilityConfigurationResponseTypeDef#
# DescribeGatewayCapabilityConfigurationResponseTypeDef definition
class DescribeGatewayCapabilityConfigurationResponseTypeDef(TypedDict):
gatewayId: str,
capabilityNamespace: str,
capabilityConfiguration: str,
capabilitySyncStatus: CapabilitySyncStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeProjectResponseTypeDef#
# DescribeProjectResponseTypeDef definition
class DescribeProjectResponseTypeDef(TypedDict):
projectId: str,
projectArn: str,
projectName: str,
portalId: str,
projectDescription: str,
projectCreationDate: datetime,
projectLastUpdateDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeTimeSeriesResponseTypeDef#
# DescribeTimeSeriesResponseTypeDef definition
class DescribeTimeSeriesResponseTypeDef(TypedDict):
assetId: str,
propertyId: str,
alias: str,
timeSeriesId: str,
dataType: PropertyDataTypeType, # (1)
dataTypeSpec: str,
timeSeriesCreationDate: datetime,
timeSeriesLastUpdateDate: datetime,
timeSeriesArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListProjectAssetsResponseTypeDef#
# ListProjectAssetsResponseTypeDef definition
class ListProjectAssetsResponseTypeDef(TypedDict):
assetIds: List[str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateGatewayCapabilityConfigurationResponseTypeDef#
# UpdateGatewayCapabilityConfigurationResponseTypeDef definition
class UpdateGatewayCapabilityConfigurationResponseTypeDef(TypedDict):
capabilityNamespace: str,
capabilitySyncStatus: CapabilitySyncStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetAssetPropertyAggregatesEntryTypeDef#
# BatchGetAssetPropertyAggregatesEntryTypeDef definition
class BatchGetAssetPropertyAggregatesEntryTypeDef(TypedDict):
entryId: str,
aggregateTypes: Sequence[AggregateTypeType], # (1)
resolution: str,
startDate: Union[datetime, str],
endDate: Union[datetime, str],
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],
qualities: NotRequired[Sequence[QualityType]], # (2)
timeOrdering: NotRequired[TimeOrderingType], # (3)
- See AggregateTypeType
- See QualityType
- See TimeOrderingType
BatchGetAssetPropertyValueHistoryEntryTypeDef#
# BatchGetAssetPropertyValueHistoryEntryTypeDef definition
class BatchGetAssetPropertyValueHistoryEntryTypeDef(TypedDict):
entryId: str,
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],
startDate: NotRequired[Union[datetime, str]],
endDate: NotRequired[Union[datetime, str]],
qualities: NotRequired[Sequence[QualityType]], # (1)
timeOrdering: NotRequired[TimeOrderingType], # (2)
- See QualityType
- See TimeOrderingType
GetAssetPropertyAggregatesRequestRequestTypeDef#
# GetAssetPropertyAggregatesRequestRequestTypeDef definition
class GetAssetPropertyAggregatesRequestRequestTypeDef(TypedDict):
aggregateTypes: Sequence[AggregateTypeType], # (1)
resolution: str,
startDate: Union[datetime, str],
endDate: Union[datetime, str],
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],
qualities: NotRequired[Sequence[QualityType]], # (2)
timeOrdering: NotRequired[TimeOrderingType], # (3)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
- See AggregateTypeType
- See QualityType
- See TimeOrderingType
GetAssetPropertyValueHistoryRequestRequestTypeDef#
# GetAssetPropertyValueHistoryRequestRequestTypeDef definition
class GetAssetPropertyValueHistoryRequestRequestTypeDef(TypedDict):
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],
startDate: NotRequired[Union[datetime, str]],
endDate: NotRequired[Union[datetime, str]],
qualities: NotRequired[Sequence[QualityType]], # (1)
timeOrdering: NotRequired[TimeOrderingType], # (2)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
- See QualityType
- See TimeOrderingType
BatchGetAssetPropertyAggregatesSkippedEntryTypeDef#
# BatchGetAssetPropertyAggregatesSkippedEntryTypeDef definition
class BatchGetAssetPropertyAggregatesSkippedEntryTypeDef(TypedDict):
entryId: str,
completionStatus: BatchEntryCompletionStatusType, # (1)
errorInfo: NotRequired[BatchGetAssetPropertyAggregatesErrorInfoTypeDef], # (2)
BatchGetAssetPropertyValueRequestRequestTypeDef#
# BatchGetAssetPropertyValueRequestRequestTypeDef definition
class BatchGetAssetPropertyValueRequestRequestTypeDef(TypedDict):
entries: Sequence[BatchGetAssetPropertyValueEntryTypeDef], # (1)
nextToken: NotRequired[str],
BatchGetAssetPropertyValueSkippedEntryTypeDef#
# BatchGetAssetPropertyValueSkippedEntryTypeDef definition
class BatchGetAssetPropertyValueSkippedEntryTypeDef(TypedDict):
entryId: str,
completionStatus: BatchEntryCompletionStatusType, # (1)
errorInfo: NotRequired[BatchGetAssetPropertyValueErrorInfoTypeDef], # (2)
BatchGetAssetPropertyValueHistorySkippedEntryTypeDef#
# BatchGetAssetPropertyValueHistorySkippedEntryTypeDef definition
class BatchGetAssetPropertyValueHistorySkippedEntryTypeDef(TypedDict):
entryId: str,
completionStatus: BatchEntryCompletionStatusType, # (1)
errorInfo: NotRequired[BatchGetAssetPropertyValueHistoryErrorInfoTypeDef], # (2)
ImageFileTypeDef#
# ImageFileTypeDef definition
class ImageFileTypeDef(TypedDict):
data: Union[str, bytes, IO[Any], StreamingBody],
type: ImageFileTypeType, # (1)
ConfigurationStatusTypeDef#
# ConfigurationStatusTypeDef definition
class ConfigurationStatusTypeDef(TypedDict):
state: ConfigurationStateType, # (1)
error: NotRequired[ConfigurationErrorDetailsTypeDef], # (2)
FileFormatTypeDef#
# FileFormatTypeDef definition
class FileFormatTypeDef(TypedDict):
csv: NotRequired[CsvTypeDef], # (1)
- See CsvTypeDef
MultiLayerStorageTypeDef#
# MultiLayerStorageTypeDef definition
class MultiLayerStorageTypeDef(TypedDict):
customerManagedS3Storage: CustomerManagedS3StorageTypeDef, # (1)
ListDashboardsResponseTypeDef#
# ListDashboardsResponseTypeDef definition
class ListDashboardsResponseTypeDef(TypedDict):
dashboardSummaries: List[DashboardSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAssetModelRequestAssetModelActiveWaitTypeDef#
# DescribeAssetModelRequestAssetModelActiveWaitTypeDef definition
class DescribeAssetModelRequestAssetModelActiveWaitTypeDef(TypedDict):
assetModelId: str,
excludeProperties: NotRequired[bool],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeAssetModelRequestAssetModelNotExistsWaitTypeDef#
# DescribeAssetModelRequestAssetModelNotExistsWaitTypeDef definition
class DescribeAssetModelRequestAssetModelNotExistsWaitTypeDef(TypedDict):
assetModelId: str,
excludeProperties: NotRequired[bool],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeAssetRequestAssetActiveWaitTypeDef#
# DescribeAssetRequestAssetActiveWaitTypeDef definition
class DescribeAssetRequestAssetActiveWaitTypeDef(TypedDict):
assetId: str,
excludeProperties: NotRequired[bool],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeAssetRequestAssetNotExistsWaitTypeDef#
# DescribeAssetRequestAssetNotExistsWaitTypeDef definition
class DescribeAssetRequestAssetNotExistsWaitTypeDef(TypedDict):
assetId: str,
excludeProperties: NotRequired[bool],
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribePortalRequestPortalActiveWaitTypeDef#
# DescribePortalRequestPortalActiveWaitTypeDef definition
class DescribePortalRequestPortalActiveWaitTypeDef(TypedDict):
portalId: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribePortalRequestPortalNotExistsWaitTypeDef#
# DescribePortalRequestPortalNotExistsWaitTypeDef definition
class DescribePortalRequestPortalNotExistsWaitTypeDef(TypedDict):
portalId: str,
WaiterConfig: NotRequired[WaiterConfigTypeDef], # (1)
DescribeLoggingOptionsResponseTypeDef#
# DescribeLoggingOptionsResponseTypeDef definition
class DescribeLoggingOptionsResponseTypeDef(TypedDict):
loggingOptions: LoggingOptionsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutLoggingOptionsRequestRequestTypeDef#
# PutLoggingOptionsRequestRequestTypeDef definition
class PutLoggingOptionsRequestRequestTypeDef(TypedDict):
loggingOptions: LoggingOptionsTypeDef, # (1)
ErrorDetailsTypeDef#
# ErrorDetailsTypeDef definition
class ErrorDetailsTypeDef(TypedDict):
code: ErrorCodeType, # (1)
message: str,
details: NotRequired[List[DetailedErrorTypeDef]], # (2)
- See ErrorCodeType
- See DetailedErrorTypeDef
ExpressionVariableTypeDef#
# ExpressionVariableTypeDef definition
class ExpressionVariableTypeDef(TypedDict):
name: str,
value: VariableValueTypeDef, # (1)
MeasurementProcessingConfigTypeDef#
# MeasurementProcessingConfigTypeDef definition
class MeasurementProcessingConfigTypeDef(TypedDict):
forwardingConfig: ForwardingConfigTypeDef, # (1)
TransformProcessingConfigTypeDef#
# TransformProcessingConfigTypeDef definition
class TransformProcessingConfigTypeDef(TypedDict):
computeLocation: ComputeLocationType, # (1)
forwardingConfig: NotRequired[ForwardingConfigTypeDef], # (2)
GatewayPlatformTypeDef#
# GatewayPlatformTypeDef definition
class GatewayPlatformTypeDef(TypedDict):
greengrass: NotRequired[GreengrassTypeDef], # (1)
greengrassV2: NotRequired[GreengrassV2TypeDef], # (2)
- See GreengrassTypeDef
- See GreengrassV2TypeDef
GetAssetPropertyAggregatesRequestGetAssetPropertyAggregatesPaginateTypeDef#
# GetAssetPropertyAggregatesRequestGetAssetPropertyAggregatesPaginateTypeDef definition
class GetAssetPropertyAggregatesRequestGetAssetPropertyAggregatesPaginateTypeDef(TypedDict):
aggregateTypes: Sequence[AggregateTypeType], # (1)
resolution: str,
startDate: Union[datetime, str],
endDate: Union[datetime, str],
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],
qualities: NotRequired[Sequence[QualityType]], # (2)
timeOrdering: NotRequired[TimeOrderingType], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See AggregateTypeType
- See QualityType
- See TimeOrderingType
- See PaginatorConfigTypeDef
GetAssetPropertyValueHistoryRequestGetAssetPropertyValueHistoryPaginateTypeDef#
# GetAssetPropertyValueHistoryRequestGetAssetPropertyValueHistoryPaginateTypeDef definition
class GetAssetPropertyValueHistoryRequestGetAssetPropertyValueHistoryPaginateTypeDef(TypedDict):
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],
startDate: NotRequired[Union[datetime, str]],
endDate: NotRequired[Union[datetime, str]],
qualities: NotRequired[Sequence[QualityType]], # (1)
timeOrdering: NotRequired[TimeOrderingType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See QualityType
- See TimeOrderingType
- See PaginatorConfigTypeDef
GetInterpolatedAssetPropertyValuesRequestGetInterpolatedAssetPropertyValuesPaginateTypeDef#
# GetInterpolatedAssetPropertyValuesRequestGetInterpolatedAssetPropertyValuesPaginateTypeDef definition
class GetInterpolatedAssetPropertyValuesRequestGetInterpolatedAssetPropertyValuesPaginateTypeDef(TypedDict):
startTimeInSeconds: int,
endTimeInSeconds: int,
quality: QualityType, # (1)
intervalInSeconds: int,
type: str,
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],
startTimeOffsetInNanos: NotRequired[int],
endTimeOffsetInNanos: NotRequired[int],
intervalWindowInSeconds: NotRequired[int],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See QualityType
- See PaginatorConfigTypeDef
ListAccessPoliciesRequestListAccessPoliciesPaginateTypeDef#
# ListAccessPoliciesRequestListAccessPoliciesPaginateTypeDef definition
class ListAccessPoliciesRequestListAccessPoliciesPaginateTypeDef(TypedDict):
identityType: NotRequired[IdentityTypeType], # (1)
identityId: NotRequired[str],
resourceType: NotRequired[ResourceTypeType], # (2)
resourceId: NotRequired[str],
iamArn: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See IdentityTypeType
- See ResourceTypeType
- See PaginatorConfigTypeDef
ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef#
# ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef definition
class ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef(TypedDict):
assetModelId: str,
filter: NotRequired[ListAssetModelPropertiesFilterType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListAssetModelsRequestListAssetModelsPaginateTypeDef#
# ListAssetModelsRequestListAssetModelsPaginateTypeDef definition
class ListAssetModelsRequestListAssetModelsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef#
# ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef definition
class ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef(TypedDict):
assetId: str,
filter: NotRequired[ListAssetPropertiesFilterType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef#
# ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef definition
class ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef(TypedDict):
assetId: str,
traversalType: TraversalTypeType, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListAssetsRequestListAssetsPaginateTypeDef#
# ListAssetsRequestListAssetsPaginateTypeDef definition
class ListAssetsRequestListAssetsPaginateTypeDef(TypedDict):
assetModelId: NotRequired[str],
filter: NotRequired[ListAssetsFilterType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef#
# ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef definition
class ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef(TypedDict):
assetId: str,
hierarchyId: NotRequired[str],
traversalDirection: NotRequired[TraversalDirectionType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef#
# ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef definition
class ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef(TypedDict):
filter: NotRequired[ListBulkImportJobsFilterType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListDashboardsRequestListDashboardsPaginateTypeDef#
# ListDashboardsRequestListDashboardsPaginateTypeDef definition
class ListDashboardsRequestListDashboardsPaginateTypeDef(TypedDict):
projectId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListGatewaysRequestListGatewaysPaginateTypeDef#
# ListGatewaysRequestListGatewaysPaginateTypeDef definition
class ListGatewaysRequestListGatewaysPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPortalsRequestListPortalsPaginateTypeDef#
# ListPortalsRequestListPortalsPaginateTypeDef definition
class ListPortalsRequestListPortalsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListProjectAssetsRequestListProjectAssetsPaginateTypeDef#
# ListProjectAssetsRequestListProjectAssetsPaginateTypeDef definition
class ListProjectAssetsRequestListProjectAssetsPaginateTypeDef(TypedDict):
projectId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListProjectsRequestListProjectsPaginateTypeDef#
# ListProjectsRequestListProjectsPaginateTypeDef definition
class ListProjectsRequestListProjectsPaginateTypeDef(TypedDict):
portalId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTimeSeriesRequestListTimeSeriesPaginateTypeDef#
# ListTimeSeriesRequestListTimeSeriesPaginateTypeDef definition
class ListTimeSeriesRequestListTimeSeriesPaginateTypeDef(TypedDict):
assetId: NotRequired[str],
aliasPrefix: NotRequired[str],
timeSeriesType: NotRequired[ListTimeSeriesTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
IdentityTypeDef#
# IdentityTypeDef definition
class IdentityTypeDef(TypedDict):
user: NotRequired[UserIdentityTypeDef], # (1)
group: NotRequired[GroupIdentityTypeDef], # (2)
iamUser: NotRequired[IAMUserIdentityTypeDef], # (3)
iamRole: NotRequired[IAMRoleIdentityTypeDef], # (4)
- See UserIdentityTypeDef
- See GroupIdentityTypeDef
- See IAMUserIdentityTypeDef
- See IAMRoleIdentityTypeDef
ListBulkImportJobsResponseTypeDef#
# ListBulkImportJobsResponseTypeDef definition
class ListBulkImportJobsResponseTypeDef(TypedDict):
jobSummaries: List[JobSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListProjectsResponseTypeDef#
# ListProjectsResponseTypeDef definition
class ListProjectsResponseTypeDef(TypedDict):
projectSummaries: List[ProjectSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTimeSeriesResponseTypeDef#
# ListTimeSeriesResponseTypeDef definition
class ListTimeSeriesResponseTypeDef(TypedDict):
TimeSeriesSummaries: List[TimeSeriesSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MetricWindowTypeDef#
# MetricWindowTypeDef definition
class MetricWindowTypeDef(TypedDict):
tumbling: NotRequired[TumblingWindowTypeDef], # (1)
PortalStatusTypeDef#
# PortalStatusTypeDef definition
class PortalStatusTypeDef(TypedDict):
state: PortalStateType, # (1)
error: NotRequired[MonitorErrorDetailsTypeDef], # (2)
ResourceTypeDef#
# ResourceTypeDef definition
class ResourceTypeDef(TypedDict):
portal: NotRequired[PortalResourceTypeDef], # (1)
project: NotRequired[ProjectResourceTypeDef], # (2)
BatchGetAssetPropertyAggregatesSuccessEntryTypeDef#
# BatchGetAssetPropertyAggregatesSuccessEntryTypeDef definition
class BatchGetAssetPropertyAggregatesSuccessEntryTypeDef(TypedDict):
entryId: str,
aggregatedValues: List[AggregatedValueTypeDef], # (1)
GetAssetPropertyAggregatesResponseTypeDef#
# GetAssetPropertyAggregatesResponseTypeDef definition
class GetAssetPropertyAggregatesResponseTypeDef(TypedDict):
aggregatedValues: List[AggregatedValueTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAssetRelationshipsResponseTypeDef#
# ListAssetRelationshipsResponseTypeDef definition
class ListAssetRelationshipsResponseTypeDef(TypedDict):
assetRelationshipSummaries: List[AssetRelationshipSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAssetPropertiesResponseTypeDef#
# ListAssetPropertiesResponseTypeDef definition
class ListAssetPropertiesResponseTypeDef(TypedDict):
assetPropertySummaries: List[AssetPropertySummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssetCompositeModelTypeDef#
# AssetCompositeModelTypeDef definition
class AssetCompositeModelTypeDef(TypedDict):
name: str,
type: str,
properties: List[AssetPropertyTypeDef], # (1)
description: NotRequired[str],
id: NotRequired[str],
BatchPutAssetPropertyErrorEntryTypeDef#
# BatchPutAssetPropertyErrorEntryTypeDef definition
class BatchPutAssetPropertyErrorEntryTypeDef(TypedDict):
entryId: str,
errors: List[BatchPutAssetPropertyErrorTypeDef], # (1)
BatchGetAssetPropertyValueHistorySuccessEntryTypeDef#
# BatchGetAssetPropertyValueHistorySuccessEntryTypeDef definition
class BatchGetAssetPropertyValueHistorySuccessEntryTypeDef(TypedDict):
entryId: str,
assetPropertyValueHistory: List[AssetPropertyValueTypeDef], # (1)
BatchGetAssetPropertyValueSuccessEntryTypeDef#
# BatchGetAssetPropertyValueSuccessEntryTypeDef definition
class BatchGetAssetPropertyValueSuccessEntryTypeDef(TypedDict):
entryId: str,
assetPropertyValue: NotRequired[AssetPropertyValueTypeDef], # (1)
GetAssetPropertyValueHistoryResponseTypeDef#
# GetAssetPropertyValueHistoryResponseTypeDef definition
class GetAssetPropertyValueHistoryResponseTypeDef(TypedDict):
assetPropertyValueHistory: List[AssetPropertyValueTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAssetPropertyValueResponseTypeDef#
# GetAssetPropertyValueResponseTypeDef definition
class GetAssetPropertyValueResponseTypeDef(TypedDict):
propertyValue: AssetPropertyValueTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutAssetPropertyValueEntryTypeDef#
# PutAssetPropertyValueEntryTypeDef definition
class PutAssetPropertyValueEntryTypeDef(TypedDict):
entryId: str,
propertyValues: Sequence[AssetPropertyValueTypeDef], # (1)
assetId: NotRequired[str],
propertyId: NotRequired[str],
propertyAlias: NotRequired[str],
GetInterpolatedAssetPropertyValuesResponseTypeDef#
# GetInterpolatedAssetPropertyValuesResponseTypeDef definition
class GetInterpolatedAssetPropertyValuesResponseTypeDef(TypedDict):
interpolatedAssetPropertyValues: List[InterpolatedAssetPropertyValueTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetAssetPropertyAggregatesRequestRequestTypeDef#
# BatchGetAssetPropertyAggregatesRequestRequestTypeDef definition
class BatchGetAssetPropertyAggregatesRequestRequestTypeDef(TypedDict):
entries: Sequence[BatchGetAssetPropertyAggregatesEntryTypeDef], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
BatchGetAssetPropertyValueHistoryRequestRequestTypeDef#
# BatchGetAssetPropertyValueHistoryRequestRequestTypeDef definition
class BatchGetAssetPropertyValueHistoryRequestRequestTypeDef(TypedDict):
entries: Sequence[BatchGetAssetPropertyValueHistoryEntryTypeDef], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
CreatePortalRequestRequestTypeDef#
# CreatePortalRequestRequestTypeDef definition
class CreatePortalRequestRequestTypeDef(TypedDict):
portalName: str,
portalContactEmail: str,
roleArn: str,
portalDescription: NotRequired[str],
clientToken: NotRequired[str],
portalLogoImageFile: NotRequired[ImageFileTypeDef], # (1)
tags: NotRequired[Mapping[str, str]],
portalAuthMode: NotRequired[AuthModeType], # (2)
notificationSenderEmail: NotRequired[str],
alarms: NotRequired[AlarmsTypeDef], # (3)
- See ImageFileTypeDef
- See AuthModeType
- See AlarmsTypeDef
ImageTypeDef#
# ImageTypeDef definition
class ImageTypeDef(TypedDict):
id: NotRequired[str],
file: NotRequired[ImageFileTypeDef], # (1)
- See ImageFileTypeDef
DescribeDefaultEncryptionConfigurationResponseTypeDef#
# DescribeDefaultEncryptionConfigurationResponseTypeDef definition
class DescribeDefaultEncryptionConfigurationResponseTypeDef(TypedDict):
encryptionType: EncryptionTypeType, # (1)
kmsKeyArn: str,
configurationStatus: ConfigurationStatusTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
PutDefaultEncryptionConfigurationResponseTypeDef#
# PutDefaultEncryptionConfigurationResponseTypeDef definition
class PutDefaultEncryptionConfigurationResponseTypeDef(TypedDict):
encryptionType: EncryptionTypeType, # (1)
kmsKeyArn: str,
configurationStatus: ConfigurationStatusTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
JobConfigurationTypeDef#
# JobConfigurationTypeDef definition
class JobConfigurationTypeDef(TypedDict):
fileFormat: FileFormatTypeDef, # (1)
DescribeStorageConfigurationResponseTypeDef#
# DescribeStorageConfigurationResponseTypeDef definition
class DescribeStorageConfigurationResponseTypeDef(TypedDict):
storageType: StorageTypeType, # (1)
multiLayerStorage: MultiLayerStorageTypeDef, # (2)
disassociatedDataStorage: DisassociatedDataStorageStateType, # (3)
retentionPeriod: RetentionPeriodTypeDef, # (4)
configurationStatus: ConfigurationStatusTypeDef, # (5)
lastUpdateDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See StorageTypeType
- See MultiLayerStorageTypeDef
- See DisassociatedDataStorageStateType
- See RetentionPeriodTypeDef
- See ConfigurationStatusTypeDef
- See ResponseMetadataTypeDef
PutStorageConfigurationRequestRequestTypeDef#
# PutStorageConfigurationRequestRequestTypeDef definition
class PutStorageConfigurationRequestRequestTypeDef(TypedDict):
storageType: StorageTypeType, # (1)
multiLayerStorage: NotRequired[MultiLayerStorageTypeDef], # (2)
disassociatedDataStorage: NotRequired[DisassociatedDataStorageStateType], # (3)
retentionPeriod: NotRequired[RetentionPeriodTypeDef], # (4)
- See StorageTypeType
- See MultiLayerStorageTypeDef
- See DisassociatedDataStorageStateType
- See RetentionPeriodTypeDef
PutStorageConfigurationResponseTypeDef#
# PutStorageConfigurationResponseTypeDef definition
class PutStorageConfigurationResponseTypeDef(TypedDict):
storageType: StorageTypeType, # (1)
multiLayerStorage: MultiLayerStorageTypeDef, # (2)
disassociatedDataStorage: DisassociatedDataStorageStateType, # (3)
retentionPeriod: RetentionPeriodTypeDef, # (4)
configurationStatus: ConfigurationStatusTypeDef, # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See StorageTypeType
- See MultiLayerStorageTypeDef
- See DisassociatedDataStorageStateType
- See RetentionPeriodTypeDef
- See ConfigurationStatusTypeDef
- See ResponseMetadataTypeDef
AssetModelStatusTypeDef#
# AssetModelStatusTypeDef definition
class AssetModelStatusTypeDef(TypedDict):
state: AssetModelStateType, # (1)
error: NotRequired[ErrorDetailsTypeDef], # (2)
AssetStatusTypeDef#
# AssetStatusTypeDef definition
class AssetStatusTypeDef(TypedDict):
state: AssetStateType, # (1)
error: NotRequired[ErrorDetailsTypeDef], # (2)
- See AssetStateType
- See ErrorDetailsTypeDef
MeasurementTypeDef#
# MeasurementTypeDef definition
class MeasurementTypeDef(TypedDict):
processingConfig: NotRequired[MeasurementProcessingConfigTypeDef], # (1)
TransformTypeDef#
# TransformTypeDef definition
class TransformTypeDef(TypedDict):
expression: str,
variables: Sequence[ExpressionVariableTypeDef], # (1)
processingConfig: NotRequired[TransformProcessingConfigTypeDef], # (2)
CreateGatewayRequestRequestTypeDef#
# CreateGatewayRequestRequestTypeDef definition
class CreateGatewayRequestRequestTypeDef(TypedDict):
gatewayName: str,
gatewayPlatform: GatewayPlatformTypeDef, # (1)
tags: NotRequired[Mapping[str, str]],
DescribeGatewayResponseTypeDef#
# DescribeGatewayResponseTypeDef definition
class DescribeGatewayResponseTypeDef(TypedDict):
gatewayId: str,
gatewayName: str,
gatewayArn: str,
gatewayPlatform: GatewayPlatformTypeDef, # (1)
gatewayCapabilitySummaries: List[GatewayCapabilitySummaryTypeDef], # (2)
creationDate: datetime,
lastUpdateDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GatewaySummaryTypeDef#
# GatewaySummaryTypeDef definition
class GatewaySummaryTypeDef(TypedDict):
gatewayId: str,
gatewayName: str,
creationDate: datetime,
lastUpdateDate: datetime,
gatewayPlatform: NotRequired[GatewayPlatformTypeDef], # (1)
gatewayCapabilitySummaries: NotRequired[List[GatewayCapabilitySummaryTypeDef]], # (2)
MetricTypeDef#
# MetricTypeDef definition
class MetricTypeDef(TypedDict):
expression: str,
variables: Sequence[ExpressionVariableTypeDef], # (1)
window: MetricWindowTypeDef, # (2)
processingConfig: NotRequired[MetricProcessingConfigTypeDef], # (3)
CreatePortalResponseTypeDef#
# CreatePortalResponseTypeDef definition
class CreatePortalResponseTypeDef(TypedDict):
portalId: str,
portalArn: str,
portalStartUrl: str,
portalStatus: PortalStatusTypeDef, # (1)
ssoApplicationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeletePortalResponseTypeDef#
# DeletePortalResponseTypeDef definition
class DeletePortalResponseTypeDef(TypedDict):
portalStatus: PortalStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribePortalResponseTypeDef#
# DescribePortalResponseTypeDef definition
class DescribePortalResponseTypeDef(TypedDict):
portalId: str,
portalArn: str,
portalName: str,
portalDescription: str,
portalClientId: str,
portalStartUrl: str,
portalContactEmail: str,
portalStatus: PortalStatusTypeDef, # (1)
portalCreationDate: datetime,
portalLastUpdateDate: datetime,
portalLogoImageLocation: ImageLocationTypeDef, # (2)
roleArn: str,
portalAuthMode: AuthModeType, # (3)
notificationSenderEmail: str,
alarms: AlarmsTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See PortalStatusTypeDef
- See ImageLocationTypeDef
- See AuthModeType
- See AlarmsTypeDef
- See ResponseMetadataTypeDef
PortalSummaryTypeDef#
# PortalSummaryTypeDef definition
class PortalSummaryTypeDef(TypedDict):
id: str,
name: str,
startUrl: str,
status: PortalStatusTypeDef, # (1)
description: NotRequired[str],
creationDate: NotRequired[datetime],
lastUpdateDate: NotRequired[datetime],
roleArn: NotRequired[str],
UpdatePortalResponseTypeDef#
# UpdatePortalResponseTypeDef definition
class UpdatePortalResponseTypeDef(TypedDict):
portalStatus: PortalStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AccessPolicySummaryTypeDef#
# AccessPolicySummaryTypeDef definition
class AccessPolicySummaryTypeDef(TypedDict):
id: str,
identity: IdentityTypeDef, # (1)
resource: ResourceTypeDef, # (2)
permission: PermissionType, # (3)
creationDate: NotRequired[datetime],
lastUpdateDate: NotRequired[datetime],
- See IdentityTypeDef
- See ResourceTypeDef
- See PermissionType
CreateAccessPolicyRequestRequestTypeDef#
# CreateAccessPolicyRequestRequestTypeDef definition
class CreateAccessPolicyRequestRequestTypeDef(TypedDict):
accessPolicyIdentity: IdentityTypeDef, # (1)
accessPolicyResource: ResourceTypeDef, # (2)
accessPolicyPermission: PermissionType, # (3)
clientToken: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
- See IdentityTypeDef
- See ResourceTypeDef
- See PermissionType
DescribeAccessPolicyResponseTypeDef#
# DescribeAccessPolicyResponseTypeDef definition
class DescribeAccessPolicyResponseTypeDef(TypedDict):
accessPolicyId: str,
accessPolicyArn: str,
accessPolicyIdentity: IdentityTypeDef, # (1)
accessPolicyResource: ResourceTypeDef, # (2)
accessPolicyPermission: PermissionType, # (3)
accessPolicyCreationDate: datetime,
accessPolicyLastUpdateDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See IdentityTypeDef
- See ResourceTypeDef
- See PermissionType
- See ResponseMetadataTypeDef
UpdateAccessPolicyRequestRequestTypeDef#
# UpdateAccessPolicyRequestRequestTypeDef definition
class UpdateAccessPolicyRequestRequestTypeDef(TypedDict):
accessPolicyId: str,
accessPolicyIdentity: IdentityTypeDef, # (1)
accessPolicyResource: ResourceTypeDef, # (2)
accessPolicyPermission: PermissionType, # (3)
clientToken: NotRequired[str],
- See IdentityTypeDef
- See ResourceTypeDef
- See PermissionType
BatchGetAssetPropertyAggregatesResponseTypeDef#
# BatchGetAssetPropertyAggregatesResponseTypeDef definition
class BatchGetAssetPropertyAggregatesResponseTypeDef(TypedDict):
errorEntries: List[BatchGetAssetPropertyAggregatesErrorEntryTypeDef], # (1)
successEntries: List[BatchGetAssetPropertyAggregatesSuccessEntryTypeDef], # (2)
skippedEntries: List[BatchGetAssetPropertyAggregatesSkippedEntryTypeDef], # (3)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See BatchGetAssetPropertyAggregatesErrorEntryTypeDef
- See BatchGetAssetPropertyAggregatesSuccessEntryTypeDef
- See BatchGetAssetPropertyAggregatesSkippedEntryTypeDef
- See ResponseMetadataTypeDef
BatchPutAssetPropertyValueResponseTypeDef#
# BatchPutAssetPropertyValueResponseTypeDef definition
class BatchPutAssetPropertyValueResponseTypeDef(TypedDict):
errorEntries: List[BatchPutAssetPropertyErrorEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetAssetPropertyValueHistoryResponseTypeDef#
# BatchGetAssetPropertyValueHistoryResponseTypeDef definition
class BatchGetAssetPropertyValueHistoryResponseTypeDef(TypedDict):
errorEntries: List[BatchGetAssetPropertyValueHistoryErrorEntryTypeDef], # (1)
successEntries: List[BatchGetAssetPropertyValueHistorySuccessEntryTypeDef], # (2)
skippedEntries: List[BatchGetAssetPropertyValueHistorySkippedEntryTypeDef], # (3)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See BatchGetAssetPropertyValueHistoryErrorEntryTypeDef
- See BatchGetAssetPropertyValueHistorySuccessEntryTypeDef
- See BatchGetAssetPropertyValueHistorySkippedEntryTypeDef
- See ResponseMetadataTypeDef
BatchGetAssetPropertyValueResponseTypeDef#
# BatchGetAssetPropertyValueResponseTypeDef definition
class BatchGetAssetPropertyValueResponseTypeDef(TypedDict):
errorEntries: List[BatchGetAssetPropertyValueErrorEntryTypeDef], # (1)
successEntries: List[BatchGetAssetPropertyValueSuccessEntryTypeDef], # (2)
skippedEntries: List[BatchGetAssetPropertyValueSkippedEntryTypeDef], # (3)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See BatchGetAssetPropertyValueErrorEntryTypeDef
- See BatchGetAssetPropertyValueSuccessEntryTypeDef
- See BatchGetAssetPropertyValueSkippedEntryTypeDef
- See ResponseMetadataTypeDef
BatchPutAssetPropertyValueRequestRequestTypeDef#
# BatchPutAssetPropertyValueRequestRequestTypeDef definition
class BatchPutAssetPropertyValueRequestRequestTypeDef(TypedDict):
entries: Sequence[PutAssetPropertyValueEntryTypeDef], # (1)
UpdatePortalRequestRequestTypeDef#
# UpdatePortalRequestRequestTypeDef definition
class UpdatePortalRequestRequestTypeDef(TypedDict):
portalId: str,
portalName: str,
portalContactEmail: str,
roleArn: str,
portalDescription: NotRequired[str],
portalLogoImage: NotRequired[ImageTypeDef], # (1)
clientToken: NotRequired[str],
notificationSenderEmail: NotRequired[str],
alarms: NotRequired[AlarmsTypeDef], # (2)
- See ImageTypeDef
- See AlarmsTypeDef
CreateBulkImportJobRequestRequestTypeDef#
# CreateBulkImportJobRequestRequestTypeDef definition
class CreateBulkImportJobRequestRequestTypeDef(TypedDict):
jobName: str,
jobRoleArn: str,
files: Sequence[FileTypeDef], # (1)
errorReportLocation: ErrorReportLocationTypeDef, # (2)
jobConfiguration: JobConfigurationTypeDef, # (3)
DescribeBulkImportJobResponseTypeDef#
# DescribeBulkImportJobResponseTypeDef definition
class DescribeBulkImportJobResponseTypeDef(TypedDict):
jobId: str,
jobName: str,
jobStatus: JobStatusType, # (1)
jobRoleArn: str,
files: List[FileTypeDef], # (2)
errorReportLocation: ErrorReportLocationTypeDef, # (3)
jobConfiguration: JobConfigurationTypeDef, # (4)
jobCreationDate: datetime,
jobLastUpdateDate: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See JobStatusType
- See FileTypeDef
- See ErrorReportLocationTypeDef
- See JobConfigurationTypeDef
- See ResponseMetadataTypeDef
AssetModelSummaryTypeDef#
# AssetModelSummaryTypeDef definition
class AssetModelSummaryTypeDef(TypedDict):
id: str,
arn: str,
name: str,
description: str,
creationDate: datetime,
lastUpdateDate: datetime,
status: AssetModelStatusTypeDef, # (1)
CreateAssetModelResponseTypeDef#
# CreateAssetModelResponseTypeDef definition
class CreateAssetModelResponseTypeDef(TypedDict):
assetModelId: str,
assetModelArn: str,
assetModelStatus: AssetModelStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteAssetModelResponseTypeDef#
# DeleteAssetModelResponseTypeDef definition
class DeleteAssetModelResponseTypeDef(TypedDict):
assetModelStatus: AssetModelStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateAssetModelResponseTypeDef#
# UpdateAssetModelResponseTypeDef definition
class UpdateAssetModelResponseTypeDef(TypedDict):
assetModelStatus: AssetModelStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssetSummaryTypeDef#
# AssetSummaryTypeDef definition
class AssetSummaryTypeDef(TypedDict):
id: str,
arn: str,
name: str,
assetModelId: str,
creationDate: datetime,
lastUpdateDate: datetime,
status: AssetStatusTypeDef, # (1)
hierarchies: List[AssetHierarchyTypeDef], # (2)
description: NotRequired[str],
AssociatedAssetsSummaryTypeDef#
# AssociatedAssetsSummaryTypeDef definition
class AssociatedAssetsSummaryTypeDef(TypedDict):
id: str,
arn: str,
name: str,
assetModelId: str,
creationDate: datetime,
lastUpdateDate: datetime,
status: AssetStatusTypeDef, # (1)
hierarchies: List[AssetHierarchyTypeDef], # (2)
description: NotRequired[str],
CreateAssetResponseTypeDef#
# CreateAssetResponseTypeDef definition
class CreateAssetResponseTypeDef(TypedDict):
assetId: str,
assetArn: str,
assetStatus: AssetStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteAssetResponseTypeDef#
# DeleteAssetResponseTypeDef definition
class DeleteAssetResponseTypeDef(TypedDict):
assetStatus: AssetStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAssetResponseTypeDef#
# DescribeAssetResponseTypeDef definition
class DescribeAssetResponseTypeDef(TypedDict):
assetId: str,
assetArn: str,
assetName: str,
assetModelId: str,
assetProperties: List[AssetPropertyTypeDef], # (1)
assetHierarchies: List[AssetHierarchyTypeDef], # (2)
assetCompositeModels: List[AssetCompositeModelTypeDef], # (3)
assetCreationDate: datetime,
assetLastUpdateDate: datetime,
assetStatus: AssetStatusTypeDef, # (4)
assetDescription: str,
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See AssetPropertyTypeDef
- See AssetHierarchyTypeDef
- See AssetCompositeModelTypeDef
- See AssetStatusTypeDef
- See ResponseMetadataTypeDef
UpdateAssetResponseTypeDef#
# UpdateAssetResponseTypeDef definition
class UpdateAssetResponseTypeDef(TypedDict):
assetStatus: AssetStatusTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListGatewaysResponseTypeDef#
# ListGatewaysResponseTypeDef definition
class ListGatewaysResponseTypeDef(TypedDict):
gatewaySummaries: List[GatewaySummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PropertyTypeTypeDef#
# PropertyTypeTypeDef definition
class PropertyTypeTypeDef(TypedDict):
attribute: NotRequired[AttributeTypeDef], # (1)
measurement: NotRequired[MeasurementTypeDef], # (2)
transform: NotRequired[TransformTypeDef], # (3)
metric: NotRequired[MetricTypeDef], # (4)
- See AttributeTypeDef
- See MeasurementTypeDef
- See TransformTypeDef
- See MetricTypeDef
ListPortalsResponseTypeDef#
# ListPortalsResponseTypeDef definition
class ListPortalsResponseTypeDef(TypedDict):
portalSummaries: List[PortalSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAccessPoliciesResponseTypeDef#
# ListAccessPoliciesResponseTypeDef definition
class ListAccessPoliciesResponseTypeDef(TypedDict):
accessPolicySummaries: List[AccessPolicySummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAssetModelsResponseTypeDef#
# ListAssetModelsResponseTypeDef definition
class ListAssetModelsResponseTypeDef(TypedDict):
assetModelSummaries: List[AssetModelSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAssetsResponseTypeDef#
# ListAssetsResponseTypeDef definition
class ListAssetsResponseTypeDef(TypedDict):
assetSummaries: List[AssetSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAssociatedAssetsResponseTypeDef#
# ListAssociatedAssetsResponseTypeDef definition
class ListAssociatedAssetsResponseTypeDef(TypedDict):
assetSummaries: List[AssociatedAssetsSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssetModelPropertyDefinitionTypeDef#
# AssetModelPropertyDefinitionTypeDef definition
class AssetModelPropertyDefinitionTypeDef(TypedDict):
name: str,
dataType: PropertyDataTypeType, # (1)
type: PropertyTypeTypeDef, # (2)
dataTypeSpec: NotRequired[str],
unit: NotRequired[str],
AssetModelPropertySummaryTypeDef#
# AssetModelPropertySummaryTypeDef definition
class AssetModelPropertySummaryTypeDef(TypedDict):
name: str,
dataType: PropertyDataTypeType, # (1)
type: PropertyTypeTypeDef, # (2)
id: NotRequired[str],
dataTypeSpec: NotRequired[str],
unit: NotRequired[str],
assetModelCompositeModelId: NotRequired[str],
AssetModelPropertyTypeDef#
# AssetModelPropertyTypeDef definition
class AssetModelPropertyTypeDef(TypedDict):
name: str,
dataType: PropertyDataTypeType, # (1)
type: PropertyTypeTypeDef, # (2)
id: NotRequired[str],
dataTypeSpec: NotRequired[str],
unit: NotRequired[str],
PropertyTypeDef#
# PropertyTypeDef definition
class PropertyTypeDef(TypedDict):
id: str,
name: str,
dataType: PropertyDataTypeType, # (2)
alias: NotRequired[str],
notification: NotRequired[PropertyNotificationTypeDef], # (1)
unit: NotRequired[str],
type: NotRequired[PropertyTypeTypeDef], # (3)
AssetModelCompositeModelDefinitionTypeDef#
# AssetModelCompositeModelDefinitionTypeDef definition
class AssetModelCompositeModelDefinitionTypeDef(TypedDict):
name: str,
type: str,
description: NotRequired[str],
properties: NotRequired[Sequence[AssetModelPropertyDefinitionTypeDef]], # (1)
ListAssetModelPropertiesResponseTypeDef#
# ListAssetModelPropertiesResponseTypeDef definition
class ListAssetModelPropertiesResponseTypeDef(TypedDict):
assetModelPropertySummaries: List[AssetModelPropertySummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssetModelCompositeModelTypeDef#
# AssetModelCompositeModelTypeDef definition
class AssetModelCompositeModelTypeDef(TypedDict):
name: str,
type: str,
description: NotRequired[str],
properties: NotRequired[List[AssetModelPropertyTypeDef]], # (1)
id: NotRequired[str],
CompositeModelPropertyTypeDef#
# CompositeModelPropertyTypeDef definition
class CompositeModelPropertyTypeDef(TypedDict):
name: str,
type: str,
assetProperty: PropertyTypeDef, # (1)
id: NotRequired[str],
- See PropertyTypeDef
CreateAssetModelRequestRequestTypeDef#
# CreateAssetModelRequestRequestTypeDef definition
class CreateAssetModelRequestRequestTypeDef(TypedDict):
assetModelName: str,
assetModelDescription: NotRequired[str],
assetModelProperties: NotRequired[Sequence[AssetModelPropertyDefinitionTypeDef]], # (1)
assetModelHierarchies: NotRequired[Sequence[AssetModelHierarchyDefinitionTypeDef]], # (2)
assetModelCompositeModels: NotRequired[Sequence[AssetModelCompositeModelDefinitionTypeDef]], # (3)
clientToken: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
- See AssetModelPropertyDefinitionTypeDef
- See AssetModelHierarchyDefinitionTypeDef
- See AssetModelCompositeModelDefinitionTypeDef
DescribeAssetModelResponseTypeDef#
# DescribeAssetModelResponseTypeDef definition
class DescribeAssetModelResponseTypeDef(TypedDict):
assetModelId: str,
assetModelArn: str,
assetModelName: str,
assetModelDescription: str,
assetModelProperties: List[AssetModelPropertyTypeDef], # (1)
assetModelHierarchies: List[AssetModelHierarchyTypeDef], # (2)
assetModelCompositeModels: List[AssetModelCompositeModelTypeDef], # (3)
assetModelCreationDate: datetime,
assetModelLastUpdateDate: datetime,
assetModelStatus: AssetModelStatusTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See AssetModelPropertyTypeDef
- See AssetModelHierarchyTypeDef
- See AssetModelCompositeModelTypeDef
- See AssetModelStatusTypeDef
- See ResponseMetadataTypeDef
UpdateAssetModelRequestRequestTypeDef#
# UpdateAssetModelRequestRequestTypeDef definition
class UpdateAssetModelRequestRequestTypeDef(TypedDict):
assetModelId: str,
assetModelName: str,
assetModelDescription: NotRequired[str],
assetModelProperties: NotRequired[Sequence[AssetModelPropertyTypeDef]], # (1)
assetModelHierarchies: NotRequired[Sequence[AssetModelHierarchyTypeDef]], # (2)
assetModelCompositeModels: NotRequired[Sequence[AssetModelCompositeModelTypeDef]], # (3)
clientToken: NotRequired[str],
DescribeAssetPropertyResponseTypeDef#
# DescribeAssetPropertyResponseTypeDef definition
class DescribeAssetPropertyResponseTypeDef(TypedDict):
assetId: str,
assetName: str,
assetModelId: str,
assetProperty: PropertyTypeDef, # (1)
compositeModel: CompositeModelPropertyTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)