Skip to content

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,
  1. See AssetErrorCodeType

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)
  1. See PropertyNotificationStateType

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,
  1. See BatchGetAssetPropertyAggregatesErrorCodeType

BatchGetAssetPropertyAggregatesErrorInfoTypeDef#

# BatchGetAssetPropertyAggregatesErrorInfoTypeDef definition

class BatchGetAssetPropertyAggregatesErrorInfoTypeDef(TypedDict):
    errorCode: BatchGetAssetPropertyAggregatesErrorCodeType,  # (1)
    errorTimestamp: datetime,
  1. See BatchGetAssetPropertyAggregatesErrorCodeType

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,
  1. See BatchGetAssetPropertyValueErrorCodeType

BatchGetAssetPropertyValueErrorInfoTypeDef#

# BatchGetAssetPropertyValueErrorInfoTypeDef definition

class BatchGetAssetPropertyValueErrorInfoTypeDef(TypedDict):
    errorCode: BatchGetAssetPropertyValueErrorCodeType,  # (1)
    errorTimestamp: datetime,
  1. See BatchGetAssetPropertyValueErrorCodeType

BatchGetAssetPropertyValueHistoryErrorEntryTypeDef#

# BatchGetAssetPropertyValueHistoryErrorEntryTypeDef definition

class BatchGetAssetPropertyValueHistoryErrorEntryTypeDef(TypedDict):
    errorCode: BatchGetAssetPropertyValueHistoryErrorCodeType,  # (1)
    errorMessage: str,
    entryId: str,
  1. See BatchGetAssetPropertyValueHistoryErrorCodeType

BatchGetAssetPropertyValueHistoryErrorInfoTypeDef#

# BatchGetAssetPropertyValueHistoryErrorInfoTypeDef definition

class BatchGetAssetPropertyValueHistoryErrorInfoTypeDef(TypedDict):
    errorCode: BatchGetAssetPropertyValueHistoryErrorCodeType,  # (1)
    errorTimestamp: datetime,
  1. See BatchGetAssetPropertyValueHistoryErrorCodeType

ConfigurationErrorDetailsTypeDef#

# ConfigurationErrorDetailsTypeDef definition

class ConfigurationErrorDetailsTypeDef(TypedDict):
    code: ErrorCodeType,  # (1)
    message: str,
  1. 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)
  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)
  1. See CapabilitySyncStatusType

LoggingOptionsTypeDef#

# LoggingOptionsTypeDef definition

class LoggingOptionsTypeDef(TypedDict):
    level: LoggingLevelType,  # (1)
  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,
  1. See DetailedErrorCodeType

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)
  1. See ForwardingConfigStateType

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],
  1. 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)
  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],
  1. See IdentityTypeType
  2. See ResourceTypeType

ListAssetModelPropertiesRequestRequestTypeDef#

# ListAssetModelPropertiesRequestRequestTypeDef definition

class ListAssetModelPropertiesRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    filter: NotRequired[ListAssetModelPropertiesFilterType],  # (1)
  1. See ListAssetModelPropertiesFilterType

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)
  1. See ListAssetPropertiesFilterType

ListAssetRelationshipsRequestRequestTypeDef#

# ListAssetRelationshipsRequestRequestTypeDef definition

class ListAssetRelationshipsRequestRequestTypeDef(TypedDict):
    assetId: str,
    traversalType: TraversalTypeType,  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See TraversalTypeType

ListAssetsRequestRequestTypeDef#

# ListAssetsRequestRequestTypeDef definition

class ListAssetsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    assetModelId: NotRequired[str],
    filter: NotRequired[ListAssetsFilterType],  # (1)
  1. See ListAssetsFilterType

ListAssociatedAssetsRequestRequestTypeDef#

# ListAssociatedAssetsRequestRequestTypeDef definition

class ListAssociatedAssetsRequestRequestTypeDef(TypedDict):
    assetId: str,
    hierarchyId: NotRequired[str],
    traversalDirection: NotRequired[TraversalDirectionType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See TraversalDirectionType

ListBulkImportJobsRequestRequestTypeDef#

# ListBulkImportJobsRequestRequestTypeDef definition

class ListBulkImportJobsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    filter: NotRequired[ListBulkImportJobsFilterType],  # (1)
  1. See ListBulkImportJobsFilterType

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)
  1. See ListTimeSeriesTypeType

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],
  1. See PropertyDataTypeType

MetricProcessingConfigTypeDef#

# MetricProcessingConfigTypeDef definition

class MetricProcessingConfigTypeDef(TypedDict):
    computeLocation: ComputeLocationType,  # (1)
  1. See ComputeLocationType

TumblingWindowTypeDef#

# TumblingWindowTypeDef definition

class TumblingWindowTypeDef(TypedDict):
    interval: str,
    offset: NotRequired[str],

MonitorErrorDetailsTypeDef#

# MonitorErrorDetailsTypeDef definition

class MonitorErrorDetailsTypeDef(TypedDict):
    code: NotRequired[MonitorErrorCodeType],  # (1)
    message: NotRequired[str],
  1. See MonitorErrorCodeType

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],
  1. See EncryptionTypeType

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],
  1. See PropertyNotificationStateType

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)
  1. See QualityType
  2. See AggregatesTypeDef

AssetRelationshipSummaryTypeDef#

# AssetRelationshipSummaryTypeDef definition

class AssetRelationshipSummaryTypeDef(TypedDict):
    relationshipType: AssetRelationshipTypeType,  # (2)
    hierarchyInfo: NotRequired[AssetHierarchyInfoTypeDef],  # (1)
  1. See AssetHierarchyInfoTypeDef
  2. See AssetRelationshipTypeType

AssetPropertySummaryTypeDef#

# AssetPropertySummaryTypeDef definition

class AssetPropertySummaryTypeDef(TypedDict):
    id: NotRequired[str],
    alias: NotRequired[str],
    unit: NotRequired[str],
    notification: NotRequired[PropertyNotificationTypeDef],  # (1)
    assetCompositeModelId: NotRequired[str],
  1. See PropertyNotificationTypeDef

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],
  1. See PropertyNotificationTypeDef
  2. See PropertyDataTypeType

BatchPutAssetPropertyErrorTypeDef#

# BatchPutAssetPropertyErrorTypeDef definition

class BatchPutAssetPropertyErrorTypeDef(TypedDict):
    errorCode: BatchPutAssetPropertyValueErrorCodeType,  # (1)
    errorMessage: str,
    timestamps: List[TimeInNanosTypeDef],  # (2)
  1. See BatchPutAssetPropertyValueErrorCodeType
  2. See TimeInNanosTypeDef

AssetPropertyValueTypeDef#

# AssetPropertyValueTypeDef definition

class AssetPropertyValueTypeDef(TypedDict):
    value: VariantTypeDef,  # (1)
    timestamp: TimeInNanosTypeDef,  # (2)
    quality: NotRequired[QualityType],  # (3)
  1. See VariantTypeDef
  2. See TimeInNanosTypeDef
  3. See QualityType

InterpolatedAssetPropertyValueTypeDef#

# InterpolatedAssetPropertyValueTypeDef definition

class InterpolatedAssetPropertyValueTypeDef(TypedDict):
    timestamp: TimeInNanosTypeDef,  # (1)
    value: VariantTypeDef,  # (2)
  1. See TimeInNanosTypeDef
  2. See VariantTypeDef

BatchAssociateProjectAssetsResponseTypeDef#

# BatchAssociateProjectAssetsResponseTypeDef definition

class BatchAssociateProjectAssetsResponseTypeDef(TypedDict):
    errors: List[AssetErrorDetailsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetErrorDetailsTypeDef
  2. See ResponseMetadataTypeDef

BatchDisassociateProjectAssetsResponseTypeDef#

# BatchDisassociateProjectAssetsResponseTypeDef definition

class BatchDisassociateProjectAssetsResponseTypeDef(TypedDict):
    errors: List[AssetErrorDetailsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetErrorDetailsTypeDef
  2. See ResponseMetadataTypeDef

CreateAccessPolicyResponseTypeDef#

# CreateAccessPolicyResponseTypeDef definition

class CreateAccessPolicyResponseTypeDef(TypedDict):
    accessPolicyId: str,
    accessPolicyArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBulkImportJobResponseTypeDef#

# CreateBulkImportJobResponseTypeDef definition

class CreateBulkImportJobResponseTypeDef(TypedDict):
    jobId: str,
    jobName: str,
    jobStatus: JobStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobStatusType
  2. See ResponseMetadataTypeDef

CreateDashboardResponseTypeDef#

# CreateDashboardResponseTypeDef definition

class CreateDashboardResponseTypeDef(TypedDict):
    dashboardId: str,
    dashboardArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateGatewayResponseTypeDef#

# CreateGatewayResponseTypeDef definition

class CreateGatewayResponseTypeDef(TypedDict):
    gatewayId: str,
    gatewayArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateProjectResponseTypeDef#

# CreateProjectResponseTypeDef definition

class CreateProjectResponseTypeDef(TypedDict):
    projectId: str,
    projectArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

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)
  1. See ResponseMetadataTypeDef

DescribeGatewayCapabilityConfigurationResponseTypeDef#

# DescribeGatewayCapabilityConfigurationResponseTypeDef definition

class DescribeGatewayCapabilityConfigurationResponseTypeDef(TypedDict):
    gatewayId: str,
    capabilityNamespace: str,
    capabilityConfiguration: str,
    capabilitySyncStatus: CapabilitySyncStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CapabilitySyncStatusType
  2. See ResponseMetadataTypeDef

DescribeProjectResponseTypeDef#

# DescribeProjectResponseTypeDef definition

class DescribeProjectResponseTypeDef(TypedDict):
    projectId: str,
    projectArn: str,
    projectName: str,
    portalId: str,
    projectDescription: str,
    projectCreationDate: datetime,
    projectLastUpdateDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

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)
  1. See PropertyDataTypeType
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListProjectAssetsResponseTypeDef#

# ListProjectAssetsResponseTypeDef definition

class ListProjectAssetsResponseTypeDef(TypedDict):
    assetIds: List[str],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateGatewayCapabilityConfigurationResponseTypeDef#

# UpdateGatewayCapabilityConfigurationResponseTypeDef definition

class UpdateGatewayCapabilityConfigurationResponseTypeDef(TypedDict):
    capabilityNamespace: str,
    capabilitySyncStatus: CapabilitySyncStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CapabilitySyncStatusType
  2. See ResponseMetadataTypeDef

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)
  1. See AggregateTypeType
  2. See QualityType
  3. 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)
  1. See QualityType
  2. 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],
  1. See AggregateTypeType
  2. See QualityType
  3. 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],
  1. See QualityType
  2. See TimeOrderingType

BatchGetAssetPropertyAggregatesSkippedEntryTypeDef#

# BatchGetAssetPropertyAggregatesSkippedEntryTypeDef definition

class BatchGetAssetPropertyAggregatesSkippedEntryTypeDef(TypedDict):
    entryId: str,
    completionStatus: BatchEntryCompletionStatusType,  # (1)
    errorInfo: NotRequired[BatchGetAssetPropertyAggregatesErrorInfoTypeDef],  # (2)
  1. See BatchEntryCompletionStatusType
  2. See BatchGetAssetPropertyAggregatesErrorInfoTypeDef

BatchGetAssetPropertyValueRequestRequestTypeDef#

# BatchGetAssetPropertyValueRequestRequestTypeDef definition

class BatchGetAssetPropertyValueRequestRequestTypeDef(TypedDict):
    entries: Sequence[BatchGetAssetPropertyValueEntryTypeDef],  # (1)
    nextToken: NotRequired[str],
  1. See BatchGetAssetPropertyValueEntryTypeDef

BatchGetAssetPropertyValueSkippedEntryTypeDef#

# BatchGetAssetPropertyValueSkippedEntryTypeDef definition

class BatchGetAssetPropertyValueSkippedEntryTypeDef(TypedDict):
    entryId: str,
    completionStatus: BatchEntryCompletionStatusType,  # (1)
    errorInfo: NotRequired[BatchGetAssetPropertyValueErrorInfoTypeDef],  # (2)
  1. See BatchEntryCompletionStatusType
  2. See BatchGetAssetPropertyValueErrorInfoTypeDef

BatchGetAssetPropertyValueHistorySkippedEntryTypeDef#

# BatchGetAssetPropertyValueHistorySkippedEntryTypeDef definition

class BatchGetAssetPropertyValueHistorySkippedEntryTypeDef(TypedDict):
    entryId: str,
    completionStatus: BatchEntryCompletionStatusType,  # (1)
    errorInfo: NotRequired[BatchGetAssetPropertyValueHistoryErrorInfoTypeDef],  # (2)
  1. See BatchEntryCompletionStatusType
  2. See BatchGetAssetPropertyValueHistoryErrorInfoTypeDef

ImageFileTypeDef#

# ImageFileTypeDef definition

class ImageFileTypeDef(TypedDict):
    data: Union[str, bytes, IO[Any], StreamingBody],
    type: ImageFileTypeType,  # (1)
  1. See ImageFileTypeType

ConfigurationStatusTypeDef#

# ConfigurationStatusTypeDef definition

class ConfigurationStatusTypeDef(TypedDict):
    state: ConfigurationStateType,  # (1)
    error: NotRequired[ConfigurationErrorDetailsTypeDef],  # (2)
  1. See ConfigurationStateType
  2. See ConfigurationErrorDetailsTypeDef

FileFormatTypeDef#

# FileFormatTypeDef definition

class FileFormatTypeDef(TypedDict):
    csv: NotRequired[CsvTypeDef],  # (1)
  1. See CsvTypeDef

MultiLayerStorageTypeDef#

# MultiLayerStorageTypeDef definition

class MultiLayerStorageTypeDef(TypedDict):
    customerManagedS3Storage: CustomerManagedS3StorageTypeDef,  # (1)
  1. See CustomerManagedS3StorageTypeDef

ListDashboardsResponseTypeDef#

# ListDashboardsResponseTypeDef definition

class ListDashboardsResponseTypeDef(TypedDict):
    dashboardSummaries: List[DashboardSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DashboardSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeAssetModelRequestAssetModelActiveWaitTypeDef#

# DescribeAssetModelRequestAssetModelActiveWaitTypeDef definition

class DescribeAssetModelRequestAssetModelActiveWaitTypeDef(TypedDict):
    assetModelId: str,
    excludeProperties: NotRequired[bool],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeAssetModelRequestAssetModelNotExistsWaitTypeDef#

# DescribeAssetModelRequestAssetModelNotExistsWaitTypeDef definition

class DescribeAssetModelRequestAssetModelNotExistsWaitTypeDef(TypedDict):
    assetModelId: str,
    excludeProperties: NotRequired[bool],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeAssetRequestAssetActiveWaitTypeDef#

# DescribeAssetRequestAssetActiveWaitTypeDef definition

class DescribeAssetRequestAssetActiveWaitTypeDef(TypedDict):
    assetId: str,
    excludeProperties: NotRequired[bool],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeAssetRequestAssetNotExistsWaitTypeDef#

# DescribeAssetRequestAssetNotExistsWaitTypeDef definition

class DescribeAssetRequestAssetNotExistsWaitTypeDef(TypedDict):
    assetId: str,
    excludeProperties: NotRequired[bool],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribePortalRequestPortalActiveWaitTypeDef#

# DescribePortalRequestPortalActiveWaitTypeDef definition

class DescribePortalRequestPortalActiveWaitTypeDef(TypedDict):
    portalId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribePortalRequestPortalNotExistsWaitTypeDef#

# DescribePortalRequestPortalNotExistsWaitTypeDef definition

class DescribePortalRequestPortalNotExistsWaitTypeDef(TypedDict):
    portalId: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeLoggingOptionsResponseTypeDef#

# DescribeLoggingOptionsResponseTypeDef definition

class DescribeLoggingOptionsResponseTypeDef(TypedDict):
    loggingOptions: LoggingOptionsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoggingOptionsTypeDef
  2. See ResponseMetadataTypeDef

PutLoggingOptionsRequestRequestTypeDef#

# PutLoggingOptionsRequestRequestTypeDef definition

class PutLoggingOptionsRequestRequestTypeDef(TypedDict):
    loggingOptions: LoggingOptionsTypeDef,  # (1)
  1. See LoggingOptionsTypeDef

ErrorDetailsTypeDef#

# ErrorDetailsTypeDef definition

class ErrorDetailsTypeDef(TypedDict):
    code: ErrorCodeType,  # (1)
    message: str,
    details: NotRequired[List[DetailedErrorTypeDef]],  # (2)
  1. See ErrorCodeType
  2. See DetailedErrorTypeDef

ExpressionVariableTypeDef#

# ExpressionVariableTypeDef definition

class ExpressionVariableTypeDef(TypedDict):
    name: str,
    value: VariableValueTypeDef,  # (1)
  1. See VariableValueTypeDef

MeasurementProcessingConfigTypeDef#

# MeasurementProcessingConfigTypeDef definition

class MeasurementProcessingConfigTypeDef(TypedDict):
    forwardingConfig: ForwardingConfigTypeDef,  # (1)
  1. See ForwardingConfigTypeDef

TransformProcessingConfigTypeDef#

# TransformProcessingConfigTypeDef definition

class TransformProcessingConfigTypeDef(TypedDict):
    computeLocation: ComputeLocationType,  # (1)
    forwardingConfig: NotRequired[ForwardingConfigTypeDef],  # (2)
  1. See ComputeLocationType
  2. See ForwardingConfigTypeDef

GatewayPlatformTypeDef#

# GatewayPlatformTypeDef definition

class GatewayPlatformTypeDef(TypedDict):
    greengrass: NotRequired[GreengrassTypeDef],  # (1)
    greengrassV2: NotRequired[GreengrassV2TypeDef],  # (2)
  1. See GreengrassTypeDef
  2. 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)
  1. See AggregateTypeType
  2. See QualityType
  3. See TimeOrderingType
  4. 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)
  1. See QualityType
  2. See TimeOrderingType
  3. 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)
  1. See QualityType
  2. 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)
  1. See IdentityTypeType
  2. See ResourceTypeType
  3. See PaginatorConfigTypeDef

ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef#

# ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef definition

class ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef(TypedDict):
    assetModelId: str,
    filter: NotRequired[ListAssetModelPropertiesFilterType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ListAssetModelPropertiesFilterType
  2. See PaginatorConfigTypeDef

ListAssetModelsRequestListAssetModelsPaginateTypeDef#

# ListAssetModelsRequestListAssetModelsPaginateTypeDef definition

class ListAssetModelsRequestListAssetModelsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef#

# ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef definition

class ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef(TypedDict):
    assetId: str,
    filter: NotRequired[ListAssetPropertiesFilterType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ListAssetPropertiesFilterType
  2. See PaginatorConfigTypeDef

ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef#

# ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef definition

class ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef(TypedDict):
    assetId: str,
    traversalType: TraversalTypeType,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See TraversalTypeType
  2. See PaginatorConfigTypeDef

ListAssetsRequestListAssetsPaginateTypeDef#

# ListAssetsRequestListAssetsPaginateTypeDef definition

class ListAssetsRequestListAssetsPaginateTypeDef(TypedDict):
    assetModelId: NotRequired[str],
    filter: NotRequired[ListAssetsFilterType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ListAssetsFilterType
  2. See PaginatorConfigTypeDef

ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef#

# ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef definition

class ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef(TypedDict):
    assetId: str,
    hierarchyId: NotRequired[str],
    traversalDirection: NotRequired[TraversalDirectionType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See TraversalDirectionType
  2. See PaginatorConfigTypeDef

ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef#

# ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef definition

class ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef(TypedDict):
    filter: NotRequired[ListBulkImportJobsFilterType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ListBulkImportJobsFilterType
  2. See PaginatorConfigTypeDef

ListDashboardsRequestListDashboardsPaginateTypeDef#

# ListDashboardsRequestListDashboardsPaginateTypeDef definition

class ListDashboardsRequestListDashboardsPaginateTypeDef(TypedDict):
    projectId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListGatewaysRequestListGatewaysPaginateTypeDef#

# ListGatewaysRequestListGatewaysPaginateTypeDef definition

class ListGatewaysRequestListGatewaysPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPortalsRequestListPortalsPaginateTypeDef#

# ListPortalsRequestListPortalsPaginateTypeDef definition

class ListPortalsRequestListPortalsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListProjectAssetsRequestListProjectAssetsPaginateTypeDef#

# ListProjectAssetsRequestListProjectAssetsPaginateTypeDef definition

class ListProjectAssetsRequestListProjectAssetsPaginateTypeDef(TypedDict):
    projectId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListProjectsRequestListProjectsPaginateTypeDef#

# ListProjectsRequestListProjectsPaginateTypeDef definition

class ListProjectsRequestListProjectsPaginateTypeDef(TypedDict):
    portalId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTimeSeriesRequestListTimeSeriesPaginateTypeDef#

# ListTimeSeriesRequestListTimeSeriesPaginateTypeDef definition

class ListTimeSeriesRequestListTimeSeriesPaginateTypeDef(TypedDict):
    assetId: NotRequired[str],
    aliasPrefix: NotRequired[str],
    timeSeriesType: NotRequired[ListTimeSeriesTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ListTimeSeriesTypeType
  2. See PaginatorConfigTypeDef

IdentityTypeDef#

# IdentityTypeDef definition

class IdentityTypeDef(TypedDict):
    user: NotRequired[UserIdentityTypeDef],  # (1)
    group: NotRequired[GroupIdentityTypeDef],  # (2)
    iamUser: NotRequired[IAMUserIdentityTypeDef],  # (3)
    iamRole: NotRequired[IAMRoleIdentityTypeDef],  # (4)
  1. See UserIdentityTypeDef
  2. See GroupIdentityTypeDef
  3. See IAMUserIdentityTypeDef
  4. See IAMRoleIdentityTypeDef

ListBulkImportJobsResponseTypeDef#

# ListBulkImportJobsResponseTypeDef definition

class ListBulkImportJobsResponseTypeDef(TypedDict):
    jobSummaries: List[JobSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListProjectsResponseTypeDef#

# ListProjectsResponseTypeDef definition

class ListProjectsResponseTypeDef(TypedDict):
    projectSummaries: List[ProjectSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTimeSeriesResponseTypeDef#

# ListTimeSeriesResponseTypeDef definition

class ListTimeSeriesResponseTypeDef(TypedDict):
    TimeSeriesSummaries: List[TimeSeriesSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TimeSeriesSummaryTypeDef
  2. See ResponseMetadataTypeDef

MetricWindowTypeDef#

# MetricWindowTypeDef definition

class MetricWindowTypeDef(TypedDict):
    tumbling: NotRequired[TumblingWindowTypeDef],  # (1)
  1. See TumblingWindowTypeDef

PortalStatusTypeDef#

# PortalStatusTypeDef definition

class PortalStatusTypeDef(TypedDict):
    state: PortalStateType,  # (1)
    error: NotRequired[MonitorErrorDetailsTypeDef],  # (2)
  1. See PortalStateType
  2. See MonitorErrorDetailsTypeDef

ResourceTypeDef#

# ResourceTypeDef definition

class ResourceTypeDef(TypedDict):
    portal: NotRequired[PortalResourceTypeDef],  # (1)
    project: NotRequired[ProjectResourceTypeDef],  # (2)
  1. See PortalResourceTypeDef
  2. See ProjectResourceTypeDef

BatchGetAssetPropertyAggregatesSuccessEntryTypeDef#

# BatchGetAssetPropertyAggregatesSuccessEntryTypeDef definition

class BatchGetAssetPropertyAggregatesSuccessEntryTypeDef(TypedDict):
    entryId: str,
    aggregatedValues: List[AggregatedValueTypeDef],  # (1)
  1. See AggregatedValueTypeDef

GetAssetPropertyAggregatesResponseTypeDef#

# GetAssetPropertyAggregatesResponseTypeDef definition

class GetAssetPropertyAggregatesResponseTypeDef(TypedDict):
    aggregatedValues: List[AggregatedValueTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AggregatedValueTypeDef
  2. See ResponseMetadataTypeDef

ListAssetRelationshipsResponseTypeDef#

# ListAssetRelationshipsResponseTypeDef definition

class ListAssetRelationshipsResponseTypeDef(TypedDict):
    assetRelationshipSummaries: List[AssetRelationshipSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetRelationshipSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAssetPropertiesResponseTypeDef#

# ListAssetPropertiesResponseTypeDef definition

class ListAssetPropertiesResponseTypeDef(TypedDict):
    assetPropertySummaries: List[AssetPropertySummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetPropertySummaryTypeDef
  2. See ResponseMetadataTypeDef

AssetCompositeModelTypeDef#

# AssetCompositeModelTypeDef definition

class AssetCompositeModelTypeDef(TypedDict):
    name: str,
    type: str,
    properties: List[AssetPropertyTypeDef],  # (1)
    description: NotRequired[str],
    id: NotRequired[str],
  1. See AssetPropertyTypeDef

BatchPutAssetPropertyErrorEntryTypeDef#

# BatchPutAssetPropertyErrorEntryTypeDef definition

class BatchPutAssetPropertyErrorEntryTypeDef(TypedDict):
    entryId: str,
    errors: List[BatchPutAssetPropertyErrorTypeDef],  # (1)
  1. See BatchPutAssetPropertyErrorTypeDef

BatchGetAssetPropertyValueHistorySuccessEntryTypeDef#

# BatchGetAssetPropertyValueHistorySuccessEntryTypeDef definition

class BatchGetAssetPropertyValueHistorySuccessEntryTypeDef(TypedDict):
    entryId: str,
    assetPropertyValueHistory: List[AssetPropertyValueTypeDef],  # (1)
  1. See AssetPropertyValueTypeDef

BatchGetAssetPropertyValueSuccessEntryTypeDef#

# BatchGetAssetPropertyValueSuccessEntryTypeDef definition

class BatchGetAssetPropertyValueSuccessEntryTypeDef(TypedDict):
    entryId: str,
    assetPropertyValue: NotRequired[AssetPropertyValueTypeDef],  # (1)
  1. See AssetPropertyValueTypeDef

GetAssetPropertyValueHistoryResponseTypeDef#

# GetAssetPropertyValueHistoryResponseTypeDef definition

class GetAssetPropertyValueHistoryResponseTypeDef(TypedDict):
    assetPropertyValueHistory: List[AssetPropertyValueTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetPropertyValueTypeDef
  2. See ResponseMetadataTypeDef

GetAssetPropertyValueResponseTypeDef#

# GetAssetPropertyValueResponseTypeDef definition

class GetAssetPropertyValueResponseTypeDef(TypedDict):
    propertyValue: AssetPropertyValueTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetPropertyValueTypeDef
  2. See ResponseMetadataTypeDef

PutAssetPropertyValueEntryTypeDef#

# PutAssetPropertyValueEntryTypeDef definition

class PutAssetPropertyValueEntryTypeDef(TypedDict):
    entryId: str,
    propertyValues: Sequence[AssetPropertyValueTypeDef],  # (1)
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],
  1. See AssetPropertyValueTypeDef

GetInterpolatedAssetPropertyValuesResponseTypeDef#

# GetInterpolatedAssetPropertyValuesResponseTypeDef definition

class GetInterpolatedAssetPropertyValuesResponseTypeDef(TypedDict):
    interpolatedAssetPropertyValues: List[InterpolatedAssetPropertyValueTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InterpolatedAssetPropertyValueTypeDef
  2. See ResponseMetadataTypeDef

BatchGetAssetPropertyAggregatesRequestRequestTypeDef#

# BatchGetAssetPropertyAggregatesRequestRequestTypeDef definition

class BatchGetAssetPropertyAggregatesRequestRequestTypeDef(TypedDict):
    entries: Sequence[BatchGetAssetPropertyAggregatesEntryTypeDef],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See BatchGetAssetPropertyAggregatesEntryTypeDef

BatchGetAssetPropertyValueHistoryRequestRequestTypeDef#

# BatchGetAssetPropertyValueHistoryRequestRequestTypeDef definition

class BatchGetAssetPropertyValueHistoryRequestRequestTypeDef(TypedDict):
    entries: Sequence[BatchGetAssetPropertyValueHistoryEntryTypeDef],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See BatchGetAssetPropertyValueHistoryEntryTypeDef

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)
  1. See ImageFileTypeDef
  2. See AuthModeType
  3. See AlarmsTypeDef

ImageTypeDef#

# ImageTypeDef definition

class ImageTypeDef(TypedDict):
    id: NotRequired[str],
    file: NotRequired[ImageFileTypeDef],  # (1)
  1. See ImageFileTypeDef

DescribeDefaultEncryptionConfigurationResponseTypeDef#

# DescribeDefaultEncryptionConfigurationResponseTypeDef definition

class DescribeDefaultEncryptionConfigurationResponseTypeDef(TypedDict):
    encryptionType: EncryptionTypeType,  # (1)
    kmsKeyArn: str,
    configurationStatus: ConfigurationStatusTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See EncryptionTypeType
  2. See ConfigurationStatusTypeDef
  3. See ResponseMetadataTypeDef

PutDefaultEncryptionConfigurationResponseTypeDef#

# PutDefaultEncryptionConfigurationResponseTypeDef definition

class PutDefaultEncryptionConfigurationResponseTypeDef(TypedDict):
    encryptionType: EncryptionTypeType,  # (1)
    kmsKeyArn: str,
    configurationStatus: ConfigurationStatusTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See EncryptionTypeType
  2. See ConfigurationStatusTypeDef
  3. See ResponseMetadataTypeDef

JobConfigurationTypeDef#

# JobConfigurationTypeDef definition

class JobConfigurationTypeDef(TypedDict):
    fileFormat: FileFormatTypeDef,  # (1)
  1. See FileFormatTypeDef

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)
  1. See StorageTypeType
  2. See MultiLayerStorageTypeDef
  3. See DisassociatedDataStorageStateType
  4. See RetentionPeriodTypeDef
  5. See ConfigurationStatusTypeDef
  6. See ResponseMetadataTypeDef

PutStorageConfigurationRequestRequestTypeDef#

# PutStorageConfigurationRequestRequestTypeDef definition

class PutStorageConfigurationRequestRequestTypeDef(TypedDict):
    storageType: StorageTypeType,  # (1)
    multiLayerStorage: NotRequired[MultiLayerStorageTypeDef],  # (2)
    disassociatedDataStorage: NotRequired[DisassociatedDataStorageStateType],  # (3)
    retentionPeriod: NotRequired[RetentionPeriodTypeDef],  # (4)
  1. See StorageTypeType
  2. See MultiLayerStorageTypeDef
  3. See DisassociatedDataStorageStateType
  4. 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)
  1. See StorageTypeType
  2. See MultiLayerStorageTypeDef
  3. See DisassociatedDataStorageStateType
  4. See RetentionPeriodTypeDef
  5. See ConfigurationStatusTypeDef
  6. See ResponseMetadataTypeDef

AssetModelStatusTypeDef#

# AssetModelStatusTypeDef definition

class AssetModelStatusTypeDef(TypedDict):
    state: AssetModelStateType,  # (1)
    error: NotRequired[ErrorDetailsTypeDef],  # (2)
  1. See AssetModelStateType
  2. See ErrorDetailsTypeDef

AssetStatusTypeDef#

# AssetStatusTypeDef definition

class AssetStatusTypeDef(TypedDict):
    state: AssetStateType,  # (1)
    error: NotRequired[ErrorDetailsTypeDef],  # (2)
  1. See AssetStateType
  2. See ErrorDetailsTypeDef

MeasurementTypeDef#

# MeasurementTypeDef definition

class MeasurementTypeDef(TypedDict):
    processingConfig: NotRequired[MeasurementProcessingConfigTypeDef],  # (1)
  1. See MeasurementProcessingConfigTypeDef

TransformTypeDef#

# TransformTypeDef definition

class TransformTypeDef(TypedDict):
    expression: str,
    variables: Sequence[ExpressionVariableTypeDef],  # (1)
    processingConfig: NotRequired[TransformProcessingConfigTypeDef],  # (2)
  1. See ExpressionVariableTypeDef
  2. See TransformProcessingConfigTypeDef

CreateGatewayRequestRequestTypeDef#

# CreateGatewayRequestRequestTypeDef definition

class CreateGatewayRequestRequestTypeDef(TypedDict):
    gatewayName: str,
    gatewayPlatform: GatewayPlatformTypeDef,  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See GatewayPlatformTypeDef

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)
  1. See GatewayPlatformTypeDef
  2. See GatewayCapabilitySummaryTypeDef
  3. See ResponseMetadataTypeDef

GatewaySummaryTypeDef#

# GatewaySummaryTypeDef definition

class GatewaySummaryTypeDef(TypedDict):
    gatewayId: str,
    gatewayName: str,
    creationDate: datetime,
    lastUpdateDate: datetime,
    gatewayPlatform: NotRequired[GatewayPlatformTypeDef],  # (1)
    gatewayCapabilitySummaries: NotRequired[List[GatewayCapabilitySummaryTypeDef]],  # (2)
  1. See GatewayPlatformTypeDef
  2. See GatewayCapabilitySummaryTypeDef

MetricTypeDef#

# MetricTypeDef definition

class MetricTypeDef(TypedDict):
    expression: str,
    variables: Sequence[ExpressionVariableTypeDef],  # (1)
    window: MetricWindowTypeDef,  # (2)
    processingConfig: NotRequired[MetricProcessingConfigTypeDef],  # (3)
  1. See ExpressionVariableTypeDef
  2. See MetricWindowTypeDef
  3. See MetricProcessingConfigTypeDef

CreatePortalResponseTypeDef#

# CreatePortalResponseTypeDef definition

class CreatePortalResponseTypeDef(TypedDict):
    portalId: str,
    portalArn: str,
    portalStartUrl: str,
    portalStatus: PortalStatusTypeDef,  # (1)
    ssoApplicationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PortalStatusTypeDef
  2. See ResponseMetadataTypeDef

DeletePortalResponseTypeDef#

# DeletePortalResponseTypeDef definition

class DeletePortalResponseTypeDef(TypedDict):
    portalStatus: PortalStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PortalStatusTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See PortalStatusTypeDef
  2. See ImageLocationTypeDef
  3. See AuthModeType
  4. See AlarmsTypeDef
  5. 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],
  1. See PortalStatusTypeDef

UpdatePortalResponseTypeDef#

# UpdatePortalResponseTypeDef definition

class UpdatePortalResponseTypeDef(TypedDict):
    portalStatus: PortalStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PortalStatusTypeDef
  2. See ResponseMetadataTypeDef

AccessPolicySummaryTypeDef#

# AccessPolicySummaryTypeDef definition

class AccessPolicySummaryTypeDef(TypedDict):
    id: str,
    identity: IdentityTypeDef,  # (1)
    resource: ResourceTypeDef,  # (2)
    permission: PermissionType,  # (3)
    creationDate: NotRequired[datetime],
    lastUpdateDate: NotRequired[datetime],
  1. See IdentityTypeDef
  2. See ResourceTypeDef
  3. 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]],
  1. See IdentityTypeDef
  2. See ResourceTypeDef
  3. 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)
  1. See IdentityTypeDef
  2. See ResourceTypeDef
  3. See PermissionType
  4. See ResponseMetadataTypeDef

UpdateAccessPolicyRequestRequestTypeDef#

# UpdateAccessPolicyRequestRequestTypeDef definition

class UpdateAccessPolicyRequestRequestTypeDef(TypedDict):
    accessPolicyId: str,
    accessPolicyIdentity: IdentityTypeDef,  # (1)
    accessPolicyResource: ResourceTypeDef,  # (2)
    accessPolicyPermission: PermissionType,  # (3)
    clientToken: NotRequired[str],
  1. See IdentityTypeDef
  2. See ResourceTypeDef
  3. 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)
  1. See BatchGetAssetPropertyAggregatesErrorEntryTypeDef
  2. See BatchGetAssetPropertyAggregatesSuccessEntryTypeDef
  3. See BatchGetAssetPropertyAggregatesSkippedEntryTypeDef
  4. See ResponseMetadataTypeDef

BatchPutAssetPropertyValueResponseTypeDef#

# BatchPutAssetPropertyValueResponseTypeDef definition

class BatchPutAssetPropertyValueResponseTypeDef(TypedDict):
    errorEntries: List[BatchPutAssetPropertyErrorEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchPutAssetPropertyErrorEntryTypeDef
  2. See ResponseMetadataTypeDef

BatchGetAssetPropertyValueHistoryResponseTypeDef#

# BatchGetAssetPropertyValueHistoryResponseTypeDef definition

class BatchGetAssetPropertyValueHistoryResponseTypeDef(TypedDict):
    errorEntries: List[BatchGetAssetPropertyValueHistoryErrorEntryTypeDef],  # (1)
    successEntries: List[BatchGetAssetPropertyValueHistorySuccessEntryTypeDef],  # (2)
    skippedEntries: List[BatchGetAssetPropertyValueHistorySkippedEntryTypeDef],  # (3)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See BatchGetAssetPropertyValueHistoryErrorEntryTypeDef
  2. See BatchGetAssetPropertyValueHistorySuccessEntryTypeDef
  3. See BatchGetAssetPropertyValueHistorySkippedEntryTypeDef
  4. 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)
  1. See BatchGetAssetPropertyValueErrorEntryTypeDef
  2. See BatchGetAssetPropertyValueSuccessEntryTypeDef
  3. See BatchGetAssetPropertyValueSkippedEntryTypeDef
  4. See ResponseMetadataTypeDef

BatchPutAssetPropertyValueRequestRequestTypeDef#

# BatchPutAssetPropertyValueRequestRequestTypeDef definition

class BatchPutAssetPropertyValueRequestRequestTypeDef(TypedDict):
    entries: Sequence[PutAssetPropertyValueEntryTypeDef],  # (1)
  1. See PutAssetPropertyValueEntryTypeDef

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)
  1. See ImageTypeDef
  2. See AlarmsTypeDef

CreateBulkImportJobRequestRequestTypeDef#

# CreateBulkImportJobRequestRequestTypeDef definition

class CreateBulkImportJobRequestRequestTypeDef(TypedDict):
    jobName: str,
    jobRoleArn: str,
    files: Sequence[FileTypeDef],  # (1)
    errorReportLocation: ErrorReportLocationTypeDef,  # (2)
    jobConfiguration: JobConfigurationTypeDef,  # (3)
  1. See FileTypeDef
  2. See ErrorReportLocationTypeDef
  3. See JobConfigurationTypeDef

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)
  1. See JobStatusType
  2. See FileTypeDef
  3. See ErrorReportLocationTypeDef
  4. See JobConfigurationTypeDef
  5. See ResponseMetadataTypeDef

AssetModelSummaryTypeDef#

# AssetModelSummaryTypeDef definition

class AssetModelSummaryTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    description: str,
    creationDate: datetime,
    lastUpdateDate: datetime,
    status: AssetModelStatusTypeDef,  # (1)
  1. See AssetModelStatusTypeDef

CreateAssetModelResponseTypeDef#

# CreateAssetModelResponseTypeDef definition

class CreateAssetModelResponseTypeDef(TypedDict):
    assetModelId: str,
    assetModelArn: str,
    assetModelStatus: AssetModelStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetModelStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteAssetModelResponseTypeDef#

# DeleteAssetModelResponseTypeDef definition

class DeleteAssetModelResponseTypeDef(TypedDict):
    assetModelStatus: AssetModelStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetModelStatusTypeDef
  2. See ResponseMetadataTypeDef

UpdateAssetModelResponseTypeDef#

# UpdateAssetModelResponseTypeDef definition

class UpdateAssetModelResponseTypeDef(TypedDict):
    assetModelStatus: AssetModelStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetModelStatusTypeDef
  2. See ResponseMetadataTypeDef

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],
  1. See AssetStatusTypeDef
  2. See AssetHierarchyTypeDef

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],
  1. See AssetStatusTypeDef
  2. See AssetHierarchyTypeDef

CreateAssetResponseTypeDef#

# CreateAssetResponseTypeDef definition

class CreateAssetResponseTypeDef(TypedDict):
    assetId: str,
    assetArn: str,
    assetStatus: AssetStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetStatusTypeDef
  2. See ResponseMetadataTypeDef

DeleteAssetResponseTypeDef#

# DeleteAssetResponseTypeDef definition

class DeleteAssetResponseTypeDef(TypedDict):
    assetStatus: AssetStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetStatusTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See AssetPropertyTypeDef
  2. See AssetHierarchyTypeDef
  3. See AssetCompositeModelTypeDef
  4. See AssetStatusTypeDef
  5. See ResponseMetadataTypeDef

UpdateAssetResponseTypeDef#

# UpdateAssetResponseTypeDef definition

class UpdateAssetResponseTypeDef(TypedDict):
    assetStatus: AssetStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetStatusTypeDef
  2. See ResponseMetadataTypeDef

ListGatewaysResponseTypeDef#

# ListGatewaysResponseTypeDef definition

class ListGatewaysResponseTypeDef(TypedDict):
    gatewaySummaries: List[GatewaySummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GatewaySummaryTypeDef
  2. See ResponseMetadataTypeDef

PropertyTypeTypeDef#

# PropertyTypeTypeDef definition

class PropertyTypeTypeDef(TypedDict):
    attribute: NotRequired[AttributeTypeDef],  # (1)
    measurement: NotRequired[MeasurementTypeDef],  # (2)
    transform: NotRequired[TransformTypeDef],  # (3)
    metric: NotRequired[MetricTypeDef],  # (4)
  1. See AttributeTypeDef
  2. See MeasurementTypeDef
  3. See TransformTypeDef
  4. See MetricTypeDef

ListPortalsResponseTypeDef#

# ListPortalsResponseTypeDef definition

class ListPortalsResponseTypeDef(TypedDict):
    portalSummaries: List[PortalSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PortalSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAccessPoliciesResponseTypeDef#

# ListAccessPoliciesResponseTypeDef definition

class ListAccessPoliciesResponseTypeDef(TypedDict):
    accessPolicySummaries: List[AccessPolicySummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccessPolicySummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAssetModelsResponseTypeDef#

# ListAssetModelsResponseTypeDef definition

class ListAssetModelsResponseTypeDef(TypedDict):
    assetModelSummaries: List[AssetModelSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetModelSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAssetsResponseTypeDef#

# ListAssetsResponseTypeDef definition

class ListAssetsResponseTypeDef(TypedDict):
    assetSummaries: List[AssetSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAssociatedAssetsResponseTypeDef#

# ListAssociatedAssetsResponseTypeDef definition

class ListAssociatedAssetsResponseTypeDef(TypedDict):
    assetSummaries: List[AssociatedAssetsSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssociatedAssetsSummaryTypeDef
  2. See ResponseMetadataTypeDef

AssetModelPropertyDefinitionTypeDef#

# AssetModelPropertyDefinitionTypeDef definition

class AssetModelPropertyDefinitionTypeDef(TypedDict):
    name: str,
    dataType: PropertyDataTypeType,  # (1)
    type: PropertyTypeTypeDef,  # (2)
    dataTypeSpec: NotRequired[str],
    unit: NotRequired[str],
  1. See PropertyDataTypeType
  2. See PropertyTypeTypeDef

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],
  1. See PropertyDataTypeType
  2. See PropertyTypeTypeDef

AssetModelPropertyTypeDef#

# AssetModelPropertyTypeDef definition

class AssetModelPropertyTypeDef(TypedDict):
    name: str,
    dataType: PropertyDataTypeType,  # (1)
    type: PropertyTypeTypeDef,  # (2)
    id: NotRequired[str],
    dataTypeSpec: NotRequired[str],
    unit: NotRequired[str],
  1. See PropertyDataTypeType
  2. See PropertyTypeTypeDef

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)
  1. See PropertyNotificationTypeDef
  2. See PropertyDataTypeType
  3. See PropertyTypeTypeDef

AssetModelCompositeModelDefinitionTypeDef#

# AssetModelCompositeModelDefinitionTypeDef definition

class AssetModelCompositeModelDefinitionTypeDef(TypedDict):
    name: str,
    type: str,
    description: NotRequired[str],
    properties: NotRequired[Sequence[AssetModelPropertyDefinitionTypeDef]],  # (1)
  1. See AssetModelPropertyDefinitionTypeDef

ListAssetModelPropertiesResponseTypeDef#

# ListAssetModelPropertiesResponseTypeDef definition

class ListAssetModelPropertiesResponseTypeDef(TypedDict):
    assetModelPropertySummaries: List[AssetModelPropertySummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AssetModelPropertySummaryTypeDef
  2. See ResponseMetadataTypeDef

AssetModelCompositeModelTypeDef#

# AssetModelCompositeModelTypeDef definition

class AssetModelCompositeModelTypeDef(TypedDict):
    name: str,
    type: str,
    description: NotRequired[str],
    properties: NotRequired[List[AssetModelPropertyTypeDef]],  # (1)
    id: NotRequired[str],
  1. See AssetModelPropertyTypeDef

CompositeModelPropertyTypeDef#

# CompositeModelPropertyTypeDef definition

class CompositeModelPropertyTypeDef(TypedDict):
    name: str,
    type: str,
    assetProperty: PropertyTypeDef,  # (1)
    id: NotRequired[str],
  1. 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]],
  1. See AssetModelPropertyDefinitionTypeDef
  2. See AssetModelHierarchyDefinitionTypeDef
  3. 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)
  1. See AssetModelPropertyTypeDef
  2. See AssetModelHierarchyTypeDef
  3. See AssetModelCompositeModelTypeDef
  4. See AssetModelStatusTypeDef
  5. 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],
  1. See AssetModelPropertyTypeDef
  2. See AssetModelHierarchyTypeDef
  3. See AssetModelCompositeModelTypeDef

DescribeAssetPropertyResponseTypeDef#

# DescribeAssetPropertyResponseTypeDef definition

class DescribeAssetPropertyResponseTypeDef(TypedDict):
    assetId: str,
    assetName: str,
    assetModelId: str,
    assetProperty: PropertyTypeDef,  # (1)
    compositeModel: CompositeModelPropertyTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PropertyTypeDef
  2. See CompositeModelPropertyTypeDef
  3. See ResponseMetadataTypeDef