Skip to content

Typed dictionaries

Index > IoTSiteWise > Typed dictionaries

Auto-generated documentation for IoTSiteWise type annotations stubs module mypy-boto3-iotsitewise.

AggregatesTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import AggregatesTypeDef

def get_value() -> AggregatesTypeDef:
    return {
        "average": ...,
    }
Definition
class AggregatesTypeDef(TypedDict):
    average: NotRequired[float],
    count: NotRequired[float],
    maximum: NotRequired[float],
    minimum: NotRequired[float],
    sum: NotRequired[float],
    standardDeviation: NotRequired[float],

AlarmsTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import AlarmsTypeDef

def get_value() -> AlarmsTypeDef:
    return {
        "alarmRoleArn": ...,
    }
Definition
class AlarmsTypeDef(TypedDict):
    alarmRoleArn: str,
    notificationLambdaArn: NotRequired[str],

AssetErrorDetailsTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import AssetErrorDetailsTypeDef

def get_value() -> AssetErrorDetailsTypeDef:
    return {
        "assetId": ...,
        "code": ...,
        "message": ...,
    }
Definition
class AssetErrorDetailsTypeDef(TypedDict):
    assetId: str,
    code: AssetErrorCodeType,  # (1)
    message: str,
  1. See AssetErrorCodeType

AssetHierarchyInfoTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import AssetHierarchyInfoTypeDef

def get_value() -> AssetHierarchyInfoTypeDef:
    return {
        "parentAssetId": ...,
    }
Definition
class AssetHierarchyInfoTypeDef(TypedDict):
    parentAssetId: NotRequired[str],
    childAssetId: NotRequired[str],

AssetHierarchyTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import AssetHierarchyTypeDef

def get_value() -> AssetHierarchyTypeDef:
    return {
        "name": ...,
    }
Definition
class AssetHierarchyTypeDef(TypedDict):
    name: str,
    id: NotRequired[str],

AssetModelHierarchyDefinitionTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import AssetModelHierarchyDefinitionTypeDef

def get_value() -> AssetModelHierarchyDefinitionTypeDef:
    return {
        "name": ...,
        "childAssetModelId": ...,
    }
Definition
class AssetModelHierarchyDefinitionTypeDef(TypedDict):
    name: str,
    childAssetModelId: str,

AssetModelHierarchyTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import AssetModelHierarchyTypeDef

def get_value() -> AssetModelHierarchyTypeDef:
    return {
        "name": ...,
        "childAssetModelId": ...,
    }
Definition
class AssetModelHierarchyTypeDef(TypedDict):
    name: str,
    childAssetModelId: str,
    id: NotRequired[str],

PropertyNotificationTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import PropertyNotificationTypeDef

def get_value() -> PropertyNotificationTypeDef:
    return {
        "topic": ...,
        "state": ...,
    }
Definition
class PropertyNotificationTypeDef(TypedDict):
    topic: str,
    state: PropertyNotificationStateType,  # (1)
  1. See PropertyNotificationStateType

TimeInNanosTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import TimeInNanosTypeDef

def get_value() -> TimeInNanosTypeDef:
    return {
        "timeInSeconds": ...,
    }
Definition
class TimeInNanosTypeDef(TypedDict):
    timeInSeconds: int,
    offsetInNanos: NotRequired[int],

VariantTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import VariantTypeDef

def get_value() -> VariantTypeDef:
    return {
        "stringValue": ...,
    }
Definition
class VariantTypeDef(TypedDict):
    stringValue: NotRequired[str],
    integerValue: NotRequired[int],
    doubleValue: NotRequired[float],
    booleanValue: NotRequired[bool],

AssociateAssetsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import AssociateAssetsRequestRequestTypeDef

def get_value() -> AssociateAssetsRequestRequestTypeDef:
    return {
        "assetId": ...,
        "hierarchyId": ...,
        "childAssetId": ...,
    }
Definition
class AssociateAssetsRequestRequestTypeDef(TypedDict):
    assetId: str,
    hierarchyId: str,
    childAssetId: str,
    clientToken: NotRequired[str],

AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef

def get_value() -> AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef:
    return {
        "alias": ...,
        "assetId": ...,
        "propertyId": ...,
    }
Definition
class AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef(TypedDict):
    alias: str,
    assetId: str,
    propertyId: str,
    clientToken: NotRequired[str],

AttributeTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import AttributeTypeDef

def get_value() -> AttributeTypeDef:
    return {
        "defaultValue": ...,
    }
Definition
class AttributeTypeDef(TypedDict):
    defaultValue: NotRequired[str],

BatchAssociateProjectAssetsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import BatchAssociateProjectAssetsRequestRequestTypeDef

def get_value() -> BatchAssociateProjectAssetsRequestRequestTypeDef:
    return {
        "projectId": ...,
        "assetIds": ...,
    }
Definition
class BatchAssociateProjectAssetsRequestRequestTypeDef(TypedDict):
    projectId: str,
    assetIds: Sequence[str],
    clientToken: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

BatchDisassociateProjectAssetsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import BatchDisassociateProjectAssetsRequestRequestTypeDef

def get_value() -> BatchDisassociateProjectAssetsRequestRequestTypeDef:
    return {
        "projectId": ...,
        "assetIds": ...,
    }
Definition
class BatchDisassociateProjectAssetsRequestRequestTypeDef(TypedDict):
    projectId: str,
    assetIds: Sequence[str],
    clientToken: NotRequired[str],

BatchGetAssetPropertyAggregatesEntryTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyAggregatesEntryTypeDef

def get_value() -> BatchGetAssetPropertyAggregatesEntryTypeDef:
    return {
        "entryId": ...,
        "aggregateTypes": ...,
        "resolution": ...,
        "startDate": ...,
        "endDate": ...,
    }
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

BatchGetAssetPropertyAggregatesErrorEntryTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyAggregatesErrorEntryTypeDef

def get_value() -> BatchGetAssetPropertyAggregatesErrorEntryTypeDef:
    return {
        "errorCode": ...,
        "errorMessage": ...,
        "entryId": ...,
    }
Definition
class BatchGetAssetPropertyAggregatesErrorEntryTypeDef(TypedDict):
    errorCode: BatchGetAssetPropertyAggregatesErrorCodeType,  # (1)
    errorMessage: str,
    entryId: str,
  1. See BatchGetAssetPropertyAggregatesErrorCodeType

BatchGetAssetPropertyAggregatesErrorInfoTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyAggregatesErrorInfoTypeDef

def get_value() -> BatchGetAssetPropertyAggregatesErrorInfoTypeDef:
    return {
        "errorCode": ...,
        "errorTimestamp": ...,
    }
Definition
class BatchGetAssetPropertyAggregatesErrorInfoTypeDef(TypedDict):
    errorCode: BatchGetAssetPropertyAggregatesErrorCodeType,  # (1)
    errorTimestamp: datetime,
  1. See BatchGetAssetPropertyAggregatesErrorCodeType

BatchGetAssetPropertyValueEntryTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueEntryTypeDef

def get_value() -> BatchGetAssetPropertyValueEntryTypeDef:
    return {
        "entryId": ...,
    }
Definition
class BatchGetAssetPropertyValueEntryTypeDef(TypedDict):
    entryId: str,
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],

BatchGetAssetPropertyValueErrorEntryTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueErrorEntryTypeDef

def get_value() -> BatchGetAssetPropertyValueErrorEntryTypeDef:
    return {
        "errorCode": ...,
        "errorMessage": ...,
        "entryId": ...,
    }
Definition
class BatchGetAssetPropertyValueErrorEntryTypeDef(TypedDict):
    errorCode: BatchGetAssetPropertyValueErrorCodeType,  # (1)
    errorMessage: str,
    entryId: str,
  1. See BatchGetAssetPropertyValueErrorCodeType

BatchGetAssetPropertyValueErrorInfoTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueErrorInfoTypeDef

def get_value() -> BatchGetAssetPropertyValueErrorInfoTypeDef:
    return {
        "errorCode": ...,
        "errorTimestamp": ...,
    }
Definition
class BatchGetAssetPropertyValueErrorInfoTypeDef(TypedDict):
    errorCode: BatchGetAssetPropertyValueErrorCodeType,  # (1)
    errorTimestamp: datetime,
  1. See BatchGetAssetPropertyValueErrorCodeType

BatchGetAssetPropertyValueHistoryEntryTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueHistoryEntryTypeDef

def get_value() -> BatchGetAssetPropertyValueHistoryEntryTypeDef:
    return {
        "entryId": ...,
    }
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

BatchGetAssetPropertyValueHistoryErrorEntryTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueHistoryErrorEntryTypeDef

def get_value() -> BatchGetAssetPropertyValueHistoryErrorEntryTypeDef:
    return {
        "errorCode": ...,
        "errorMessage": ...,
        "entryId": ...,
    }
Definition
class BatchGetAssetPropertyValueHistoryErrorEntryTypeDef(TypedDict):
    errorCode: BatchGetAssetPropertyValueHistoryErrorCodeType,  # (1)
    errorMessage: str,
    entryId: str,
  1. See BatchGetAssetPropertyValueHistoryErrorCodeType

BatchGetAssetPropertyValueHistoryErrorInfoTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueHistoryErrorInfoTypeDef

def get_value() -> BatchGetAssetPropertyValueHistoryErrorInfoTypeDef:
    return {
        "errorCode": ...,
        "errorTimestamp": ...,
    }
Definition
class BatchGetAssetPropertyValueHistoryErrorInfoTypeDef(TypedDict):
    errorCode: BatchGetAssetPropertyValueHistoryErrorCodeType,  # (1)
    errorTimestamp: datetime,
  1. See BatchGetAssetPropertyValueHistoryErrorCodeType

ConfigurationErrorDetailsTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ConfigurationErrorDetailsTypeDef

def get_value() -> ConfigurationErrorDetailsTypeDef:
    return {
        "code": ...,
        "message": ...,
    }
Definition
class ConfigurationErrorDetailsTypeDef(TypedDict):
    code: ErrorCodeType,  # (1)
    message: str,
  1. See ErrorCodeType

CreateAssetRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import CreateAssetRequestRequestTypeDef

def get_value() -> CreateAssetRequestRequestTypeDef:
    return {
        "assetName": ...,
        "assetModelId": ...,
    }
Definition
class CreateAssetRequestRequestTypeDef(TypedDict):
    assetName: str,
    assetModelId: str,
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    assetDescription: NotRequired[str],

ErrorReportLocationTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ErrorReportLocationTypeDef

def get_value() -> ErrorReportLocationTypeDef:
    return {
        "bucket": ...,
        "prefix": ...,
    }
Definition
class ErrorReportLocationTypeDef(TypedDict):
    bucket: str,
    prefix: str,

FileTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import FileTypeDef

def get_value() -> FileTypeDef:
    return {
        "bucket": ...,
        "key": ...,
    }
Definition
class FileTypeDef(TypedDict):
    bucket: str,
    key: str,
    versionId: NotRequired[str],

CreateDashboardRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import CreateDashboardRequestRequestTypeDef

def get_value() -> CreateDashboardRequestRequestTypeDef:
    return {
        "projectId": ...,
        "dashboardName": ...,
        "dashboardDefinition": ...,
    }
Definition
class CreateDashboardRequestRequestTypeDef(TypedDict):
    projectId: str,
    dashboardName: str,
    dashboardDefinition: str,
    dashboardDescription: NotRequired[str],
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

ImageFileTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ImageFileTypeDef

def get_value() -> ImageFileTypeDef:
    return {
        "data": ...,
        "type": ...,
    }
Definition
class ImageFileTypeDef(TypedDict):
    data: Union[str, bytes, IO[Any], StreamingBody],
    type: ImageFileTypeType,  # (1)
  1. See ImageFileTypeType

CreateProjectRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import CreateProjectRequestRequestTypeDef

def get_value() -> CreateProjectRequestRequestTypeDef:
    return {
        "portalId": ...,
        "projectName": ...,
    }
Definition
class CreateProjectRequestRequestTypeDef(TypedDict):
    portalId: str,
    projectName: str,
    projectDescription: NotRequired[str],
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

CsvTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import CsvTypeDef

def get_value() -> CsvTypeDef:
    return {
        "columnNames": ...,
    }
Definition
class CsvTypeDef(TypedDict):
    columnNames: NotRequired[Sequence[ColumnNameType]],  # (1)
  1. See ColumnNameType

CustomerManagedS3StorageTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import CustomerManagedS3StorageTypeDef

def get_value() -> CustomerManagedS3StorageTypeDef:
    return {
        "s3ResourceArn": ...,
        "roleArn": ...,
    }
Definition
class CustomerManagedS3StorageTypeDef(TypedDict):
    s3ResourceArn: str,
    roleArn: str,

DashboardSummaryTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DashboardSummaryTypeDef

def get_value() -> DashboardSummaryTypeDef:
    return {
        "id": ...,
        "name": ...,
    }
Definition
class DashboardSummaryTypeDef(TypedDict):
    id: str,
    name: str,
    description: NotRequired[str],
    creationDate: NotRequired[datetime],
    lastUpdateDate: NotRequired[datetime],

DeleteAccessPolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DeleteAccessPolicyRequestRequestTypeDef

def get_value() -> DeleteAccessPolicyRequestRequestTypeDef:
    return {
        "accessPolicyId": ...,
    }
Definition
class DeleteAccessPolicyRequestRequestTypeDef(TypedDict):
    accessPolicyId: str,
    clientToken: NotRequired[str],

DeleteAssetModelRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DeleteAssetModelRequestRequestTypeDef

def get_value() -> DeleteAssetModelRequestRequestTypeDef:
    return {
        "assetModelId": ...,
    }
Definition
class DeleteAssetModelRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    clientToken: NotRequired[str],

DeleteAssetRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DeleteAssetRequestRequestTypeDef

def get_value() -> DeleteAssetRequestRequestTypeDef:
    return {
        "assetId": ...,
    }
Definition
class DeleteAssetRequestRequestTypeDef(TypedDict):
    assetId: str,
    clientToken: NotRequired[str],

DeleteDashboardRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DeleteDashboardRequestRequestTypeDef

def get_value() -> DeleteDashboardRequestRequestTypeDef:
    return {
        "dashboardId": ...,
    }
Definition
class DeleteDashboardRequestRequestTypeDef(TypedDict):
    dashboardId: str,
    clientToken: NotRequired[str],

DeleteGatewayRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DeleteGatewayRequestRequestTypeDef

def get_value() -> DeleteGatewayRequestRequestTypeDef:
    return {
        "gatewayId": ...,
    }
Definition
class DeleteGatewayRequestRequestTypeDef(TypedDict):
    gatewayId: str,

DeletePortalRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DeletePortalRequestRequestTypeDef

def get_value() -> DeletePortalRequestRequestTypeDef:
    return {
        "portalId": ...,
    }
Definition
class DeletePortalRequestRequestTypeDef(TypedDict):
    portalId: str,
    clientToken: NotRequired[str],

DeleteProjectRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DeleteProjectRequestRequestTypeDef

def get_value() -> DeleteProjectRequestRequestTypeDef:
    return {
        "projectId": ...,
    }
Definition
class DeleteProjectRequestRequestTypeDef(TypedDict):
    projectId: str,
    clientToken: NotRequired[str],

DeleteTimeSeriesRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DeleteTimeSeriesRequestRequestTypeDef

def get_value() -> DeleteTimeSeriesRequestRequestTypeDef:
    return {
        "alias": ...,
    }
Definition
class DeleteTimeSeriesRequestRequestTypeDef(TypedDict):
    alias: NotRequired[str],
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    clientToken: NotRequired[str],

DescribeAccessPolicyRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DescribeAccessPolicyRequestRequestTypeDef

def get_value() -> DescribeAccessPolicyRequestRequestTypeDef:
    return {
        "accessPolicyId": ...,
    }
Definition
class DescribeAccessPolicyRequestRequestTypeDef(TypedDict):
    accessPolicyId: str,

WaiterConfigTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import WaiterConfigTypeDef

def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }
Definition
class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeAssetModelRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DescribeAssetModelRequestRequestTypeDef

def get_value() -> DescribeAssetModelRequestRequestTypeDef:
    return {
        "assetModelId": ...,
    }
Definition
class DescribeAssetModelRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    excludeProperties: NotRequired[bool],

DescribeAssetPropertyRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DescribeAssetPropertyRequestRequestTypeDef

def get_value() -> DescribeAssetPropertyRequestRequestTypeDef:
    return {
        "assetId": ...,
        "propertyId": ...,
    }
Definition
class DescribeAssetPropertyRequestRequestTypeDef(TypedDict):
    assetId: str,
    propertyId: str,

DescribeAssetRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DescribeAssetRequestRequestTypeDef

def get_value() -> DescribeAssetRequestRequestTypeDef:
    return {
        "assetId": ...,
    }
Definition
class DescribeAssetRequestRequestTypeDef(TypedDict):
    assetId: str,
    excludeProperties: NotRequired[bool],

DescribeBulkImportJobRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DescribeBulkImportJobRequestRequestTypeDef

def get_value() -> DescribeBulkImportJobRequestRequestTypeDef:
    return {
        "jobId": ...,
    }
Definition
class DescribeBulkImportJobRequestRequestTypeDef(TypedDict):
    jobId: str,

DescribeDashboardRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DescribeDashboardRequestRequestTypeDef

def get_value() -> DescribeDashboardRequestRequestTypeDef:
    return {
        "dashboardId": ...,
    }
Definition
class DescribeDashboardRequestRequestTypeDef(TypedDict):
    dashboardId: str,

DescribeGatewayCapabilityConfigurationRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DescribeGatewayCapabilityConfigurationRequestRequestTypeDef

def get_value() -> DescribeGatewayCapabilityConfigurationRequestRequestTypeDef:
    return {
        "gatewayId": ...,
        "capabilityNamespace": ...,
    }
Definition
class DescribeGatewayCapabilityConfigurationRequestRequestTypeDef(TypedDict):
    gatewayId: str,
    capabilityNamespace: str,

DescribeGatewayRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DescribeGatewayRequestRequestTypeDef

def get_value() -> DescribeGatewayRequestRequestTypeDef:
    return {
        "gatewayId": ...,
    }
Definition
class DescribeGatewayRequestRequestTypeDef(TypedDict):
    gatewayId: str,

GatewayCapabilitySummaryTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import GatewayCapabilitySummaryTypeDef

def get_value() -> GatewayCapabilitySummaryTypeDef:
    return {
        "capabilityNamespace": ...,
        "capabilitySyncStatus": ...,
    }
Definition
class GatewayCapabilitySummaryTypeDef(TypedDict):
    capabilityNamespace: str,
    capabilitySyncStatus: CapabilitySyncStatusType,  # (1)
  1. See CapabilitySyncStatusType

LoggingOptionsTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import LoggingOptionsTypeDef

def get_value() -> LoggingOptionsTypeDef:
    return {
        "level": ...,
    }
Definition
class LoggingOptionsTypeDef(TypedDict):
    level: LoggingLevelType,  # (1)
  1. See LoggingLevelType

DescribePortalRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DescribePortalRequestRequestTypeDef

def get_value() -> DescribePortalRequestRequestTypeDef:
    return {
        "portalId": ...,
    }
Definition
class DescribePortalRequestRequestTypeDef(TypedDict):
    portalId: str,

ImageLocationTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ImageLocationTypeDef

def get_value() -> ImageLocationTypeDef:
    return {
        "id": ...,
        "url": ...,
    }
Definition
class ImageLocationTypeDef(TypedDict):
    id: str,
    url: str,

DescribeProjectRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DescribeProjectRequestRequestTypeDef

def get_value() -> DescribeProjectRequestRequestTypeDef:
    return {
        "projectId": ...,
    }
Definition
class DescribeProjectRequestRequestTypeDef(TypedDict):
    projectId: str,

RetentionPeriodTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import RetentionPeriodTypeDef

def get_value() -> RetentionPeriodTypeDef:
    return {
        "numberOfDays": ...,
    }
Definition
class RetentionPeriodTypeDef(TypedDict):
    numberOfDays: NotRequired[int],
    unlimited: NotRequired[bool],

DescribeTimeSeriesRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DescribeTimeSeriesRequestRequestTypeDef

def get_value() -> DescribeTimeSeriesRequestRequestTypeDef:
    return {
        "alias": ...,
    }
Definition
class DescribeTimeSeriesRequestRequestTypeDef(TypedDict):
    alias: NotRequired[str],
    assetId: NotRequired[str],
    propertyId: NotRequired[str],

DetailedErrorTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DetailedErrorTypeDef

def get_value() -> DetailedErrorTypeDef:
    return {
        "code": ...,
        "message": ...,
    }
Definition
class DetailedErrorTypeDef(TypedDict):
    code: DetailedErrorCodeType,  # (1)
    message: str,
  1. See DetailedErrorCodeType

DisassociateAssetsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DisassociateAssetsRequestRequestTypeDef

def get_value() -> DisassociateAssetsRequestRequestTypeDef:
    return {
        "assetId": ...,
        "hierarchyId": ...,
        "childAssetId": ...,
    }
Definition
class DisassociateAssetsRequestRequestTypeDef(TypedDict):
    assetId: str,
    hierarchyId: str,
    childAssetId: str,
    clientToken: NotRequired[str],

DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef

def get_value() -> DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef:
    return {
        "alias": ...,
        "assetId": ...,
        "propertyId": ...,
    }
Definition
class DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef(TypedDict):
    alias: str,
    assetId: str,
    propertyId: str,
    clientToken: NotRequired[str],

VariableValueTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import VariableValueTypeDef

def get_value() -> VariableValueTypeDef:
    return {
        "propertyId": ...,
    }
Definition
class VariableValueTypeDef(TypedDict):
    propertyId: str,
    hierarchyId: NotRequired[str],

ForwardingConfigTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ForwardingConfigTypeDef

def get_value() -> ForwardingConfigTypeDef:
    return {
        "state": ...,
    }
Definition
class ForwardingConfigTypeDef(TypedDict):
    state: ForwardingConfigStateType,  # (1)
  1. See ForwardingConfigStateType

GreengrassTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import GreengrassTypeDef

def get_value() -> GreengrassTypeDef:
    return {
        "groupArn": ...,
    }
Definition
class GreengrassTypeDef(TypedDict):
    groupArn: str,

GreengrassV2TypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import GreengrassV2TypeDef

def get_value() -> GreengrassV2TypeDef:
    return {
        "coreDeviceThingName": ...,
    }
Definition
class GreengrassV2TypeDef(TypedDict):
    coreDeviceThingName: str,

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetAssetPropertyAggregatesRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import GetAssetPropertyAggregatesRequestRequestTypeDef

def get_value() -> GetAssetPropertyAggregatesRequestRequestTypeDef:
    return {
        "aggregateTypes": ...,
        "resolution": ...,
        "startDate": ...,
        "endDate": ...,
    }
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

Usage Example
from mypy_boto3_iotsitewise.type_defs import GetAssetPropertyValueHistoryRequestRequestTypeDef

def get_value() -> GetAssetPropertyValueHistoryRequestRequestTypeDef:
    return {
        "assetId": ...,
    }
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

GetAssetPropertyValueRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import GetAssetPropertyValueRequestRequestTypeDef

def get_value() -> GetAssetPropertyValueRequestRequestTypeDef:
    return {
        "assetId": ...,
    }
Definition
class GetAssetPropertyValueRequestRequestTypeDef(TypedDict):
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],

GetInterpolatedAssetPropertyValuesRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import GetInterpolatedAssetPropertyValuesRequestRequestTypeDef

def get_value() -> GetInterpolatedAssetPropertyValuesRequestRequestTypeDef:
    return {
        "startTimeInSeconds": ...,
        "endTimeInSeconds": ...,
        "quality": ...,
        "intervalInSeconds": ...,
        "type": ...,
    }
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

Usage Example
from mypy_boto3_iotsitewise.type_defs import GroupIdentityTypeDef

def get_value() -> GroupIdentityTypeDef:
    return {
        "id": ...,
    }
Definition
class GroupIdentityTypeDef(TypedDict):
    id: str,

IAMRoleIdentityTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import IAMRoleIdentityTypeDef

def get_value() -> IAMRoleIdentityTypeDef:
    return {
        "arn": ...,
    }
Definition
class IAMRoleIdentityTypeDef(TypedDict):
    arn: str,

IAMUserIdentityTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import IAMUserIdentityTypeDef

def get_value() -> IAMUserIdentityTypeDef:
    return {
        "arn": ...,
    }
Definition
class IAMUserIdentityTypeDef(TypedDict):
    arn: str,

UserIdentityTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import UserIdentityTypeDef

def get_value() -> UserIdentityTypeDef:
    return {
        "id": ...,
    }
Definition
class UserIdentityTypeDef(TypedDict):
    id: str,

JobSummaryTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import JobSummaryTypeDef

def get_value() -> JobSummaryTypeDef:
    return {
        "id": ...,
        "name": ...,
        "status": ...,
    }
Definition
class JobSummaryTypeDef(TypedDict):
    id: str,
    name: str,
    status: JobStatusType,  # (1)
  1. See JobStatusType

ListAccessPoliciesRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListAccessPoliciesRequestRequestTypeDef

def get_value() -> ListAccessPoliciesRequestRequestTypeDef:
    return {
        "identityType": ...,
    }
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

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListAssetModelPropertiesRequestRequestTypeDef

def get_value() -> ListAssetModelPropertiesRequestRequestTypeDef:
    return {
        "assetModelId": ...,
    }
Definition
class ListAssetModelPropertiesRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    filter: NotRequired[ListAssetModelPropertiesFilterType],  # (1)
  1. See ListAssetModelPropertiesFilterType

ListAssetModelsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListAssetModelsRequestRequestTypeDef

def get_value() -> ListAssetModelsRequestRequestTypeDef:
    return {
        "nextToken": ...,
    }
Definition
class ListAssetModelsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListAssetPropertiesRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListAssetPropertiesRequestRequestTypeDef

def get_value() -> ListAssetPropertiesRequestRequestTypeDef:
    return {
        "assetId": ...,
    }
Definition
class ListAssetPropertiesRequestRequestTypeDef(TypedDict):
    assetId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    filter: NotRequired[ListAssetPropertiesFilterType],  # (1)
  1. See ListAssetPropertiesFilterType

ListAssetRelationshipsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListAssetRelationshipsRequestRequestTypeDef

def get_value() -> ListAssetRelationshipsRequestRequestTypeDef:
    return {
        "assetId": ...,
        "traversalType": ...,
    }
Definition
class ListAssetRelationshipsRequestRequestTypeDef(TypedDict):
    assetId: str,
    traversalType: TraversalTypeType,  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See TraversalTypeType

ListAssetsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListAssetsRequestRequestTypeDef

def get_value() -> ListAssetsRequestRequestTypeDef:
    return {
        "nextToken": ...,
    }
Definition
class ListAssetsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    assetModelId: NotRequired[str],
    filter: NotRequired[ListAssetsFilterType],  # (1)
  1. See ListAssetsFilterType

ListAssociatedAssetsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListAssociatedAssetsRequestRequestTypeDef

def get_value() -> ListAssociatedAssetsRequestRequestTypeDef:
    return {
        "assetId": ...,
    }
Definition
class ListAssociatedAssetsRequestRequestTypeDef(TypedDict):
    assetId: str,
    hierarchyId: NotRequired[str],
    traversalDirection: NotRequired[TraversalDirectionType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See TraversalDirectionType

ListBulkImportJobsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListBulkImportJobsRequestRequestTypeDef

def get_value() -> ListBulkImportJobsRequestRequestTypeDef:
    return {
        "nextToken": ...,
    }
Definition
class ListBulkImportJobsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    filter: NotRequired[ListBulkImportJobsFilterType],  # (1)
  1. See ListBulkImportJobsFilterType

ListDashboardsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListDashboardsRequestRequestTypeDef

def get_value() -> ListDashboardsRequestRequestTypeDef:
    return {
        "projectId": ...,
    }
Definition
class ListDashboardsRequestRequestTypeDef(TypedDict):
    projectId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListGatewaysRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListGatewaysRequestRequestTypeDef

def get_value() -> ListGatewaysRequestRequestTypeDef:
    return {
        "nextToken": ...,
    }
Definition
class ListGatewaysRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListPortalsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListPortalsRequestRequestTypeDef

def get_value() -> ListPortalsRequestRequestTypeDef:
    return {
        "nextToken": ...,
    }
Definition
class ListPortalsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListProjectAssetsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListProjectAssetsRequestRequestTypeDef

def get_value() -> ListProjectAssetsRequestRequestTypeDef:
    return {
        "projectId": ...,
    }
Definition
class ListProjectAssetsRequestRequestTypeDef(TypedDict):
    projectId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListProjectsRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListProjectsRequestRequestTypeDef

def get_value() -> ListProjectsRequestRequestTypeDef:
    return {
        "portalId": ...,
    }
Definition
class ListProjectsRequestRequestTypeDef(TypedDict):
    portalId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ProjectSummaryTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ProjectSummaryTypeDef

def get_value() -> ProjectSummaryTypeDef:
    return {
        "id": ...,
        "name": ...,
    }
Definition
class ProjectSummaryTypeDef(TypedDict):
    id: str,
    name: str,
    description: NotRequired[str],
    creationDate: NotRequired[datetime],
    lastUpdateDate: NotRequired[datetime],

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTimeSeriesRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ListTimeSeriesRequestRequestTypeDef

def get_value() -> ListTimeSeriesRequestRequestTypeDef:
    return {
        "nextToken": ...,
    }
Definition
class ListTimeSeriesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    assetId: NotRequired[str],
    aliasPrefix: NotRequired[str],
    timeSeriesType: NotRequired[ListTimeSeriesTypeType],  # (1)
  1. See ListTimeSeriesTypeType

TimeSeriesSummaryTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import TimeSeriesSummaryTypeDef

def get_value() -> TimeSeriesSummaryTypeDef:
    return {
        "timeSeriesId": ...,
        "dataType": ...,
        "timeSeriesCreationDate": ...,
        "timeSeriesLastUpdateDate": ...,
    }
Definition
class TimeSeriesSummaryTypeDef(TypedDict):
    timeSeriesId: str,
    dataType: PropertyDataTypeType,  # (1)
    timeSeriesCreationDate: datetime,
    timeSeriesLastUpdateDate: datetime,
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    alias: NotRequired[str],
    dataTypeSpec: NotRequired[str],
  1. See PropertyDataTypeType

MetricProcessingConfigTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import MetricProcessingConfigTypeDef

def get_value() -> MetricProcessingConfigTypeDef:
    return {
        "computeLocation": ...,
    }
Definition
class MetricProcessingConfigTypeDef(TypedDict):
    computeLocation: ComputeLocationType,  # (1)
  1. See ComputeLocationType

TumblingWindowTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import TumblingWindowTypeDef

def get_value() -> TumblingWindowTypeDef:
    return {
        "interval": ...,
    }
Definition
class TumblingWindowTypeDef(TypedDict):
    interval: str,
    offset: NotRequired[str],

MonitorErrorDetailsTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import MonitorErrorDetailsTypeDef

def get_value() -> MonitorErrorDetailsTypeDef:
    return {
        "code": ...,
    }
Definition
class MonitorErrorDetailsTypeDef(TypedDict):
    code: NotRequired[MonitorErrorCodeType],  # (1)
    message: NotRequired[str],
  1. See MonitorErrorCodeType

PortalResourceTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import PortalResourceTypeDef

def get_value() -> PortalResourceTypeDef:
    return {
        "id": ...,
    }
Definition
class PortalResourceTypeDef(TypedDict):
    id: str,

ProjectResourceTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import ProjectResourceTypeDef

def get_value() -> ProjectResourceTypeDef:
    return {
        "id": ...,
    }
Definition
class ProjectResourceTypeDef(TypedDict):
    id: str,

PutDefaultEncryptionConfigurationRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import PutDefaultEncryptionConfigurationRequestRequestTypeDef

def get_value() -> PutDefaultEncryptionConfigurationRequestRequestTypeDef:
    return {
        "encryptionType": ...,
    }
Definition
class PutDefaultEncryptionConfigurationRequestRequestTypeDef(TypedDict):
    encryptionType: EncryptionTypeType,  # (1)
    kmsKeyId: NotRequired[str],
  1. See EncryptionTypeType

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_iotsitewise.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef<