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:
    return {
        "resourceArn": ...,
        "tagKeys": ...,
    }

Definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateAssetPropertyRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdateAssetPropertyRequestRequestTypeDef

def get_value() -> UpdateAssetPropertyRequestRequestTypeDef:
    return {
        "assetId": ...,
        "propertyId": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdateAssetRequestRequestTypeDef

def get_value() -> UpdateAssetRequestRequestTypeDef:
    return {
        "assetId": ...,
        "assetName": ...,
    }

Definition

class UpdateAssetRequestRequestTypeDef(TypedDict):
    assetId: str,
    assetName: str,
    clientToken: NotRequired[str],
    assetDescription: NotRequired[str],

UpdateDashboardRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdateDashboardRequestRequestTypeDef

def get_value() -> UpdateDashboardRequestRequestTypeDef:
    return {
        "dashboardId": ...,
        "dashboardName": ...,
        "dashboardDefinition": ...,
    }

Definition

class UpdateDashboardRequestRequestTypeDef(TypedDict):
    dashboardId: str,
    dashboardName: str,
    dashboardDefinition: str,
    dashboardDescription: NotRequired[str],
    clientToken: NotRequired[str],

UpdateGatewayCapabilityConfigurationRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdateGatewayCapabilityConfigurationRequestRequestTypeDef

def get_value() -> UpdateGatewayCapabilityConfigurationRequestRequestTypeDef:
    return {
        "gatewayId": ...,
        "capabilityNamespace": ...,
        "capabilityConfiguration": ...,
    }

Definition

class UpdateGatewayCapabilityConfigurationRequestRequestTypeDef(TypedDict):
    gatewayId: str,
    capabilityNamespace: str,
    capabilityConfiguration: str,

UpdateGatewayRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdateGatewayRequestRequestTypeDef

def get_value() -> UpdateGatewayRequestRequestTypeDef:
    return {
        "gatewayId": ...,
        "gatewayName": ...,
    }

Definition

class UpdateGatewayRequestRequestTypeDef(TypedDict):
    gatewayId: str,
    gatewayName: str,

UpdateProjectRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdateProjectRequestRequestTypeDef

def get_value() -> UpdateProjectRequestRequestTypeDef:
    return {
        "projectId": ...,
        "projectName": ...,
    }

Definition

class UpdateProjectRequestRequestTypeDef(TypedDict):
    projectId: str,
    projectName: str,
    projectDescription: NotRequired[str],
    clientToken: NotRequired[str],

AggregatedValueTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import AggregatedValueTypeDef

def get_value() -> AggregatedValueTypeDef:
    return {
        "timestamp": ...,
        "value": ...,
    }

Definition

class AggregatedValueTypeDef(TypedDict):
    timestamp: datetime,
    value: AggregatesTypeDef,  # (2)
    quality: NotRequired[QualityType],  # (1)

1. See QualityType
2. See AggregatesTypeDef

AssetRelationshipSummaryTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetRelationshipSummaryTypeDef

def get_value() -> AssetRelationshipSummaryTypeDef:
    return {
        "relationshipType": ...,
    }

Definition

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

1. See AssetHierarchyInfoTypeDef
2. See AssetRelationshipTypeType

AssetPropertySummaryTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetPropertySummaryTypeDef

def get_value() -> AssetPropertySummaryTypeDef:
    return {
        "id": ...,
    }

Definition

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

1. See PropertyNotificationTypeDef

AssetPropertyTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetPropertyTypeDef

def get_value() -> AssetPropertyTypeDef:
    return {
        "id": ...,
        "name": ...,
        "dataType": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchPutAssetPropertyErrorTypeDef

def get_value() -> BatchPutAssetPropertyErrorTypeDef:
    return {
        "errorCode": ...,
        "errorMessage": ...,
        "timestamps": ...,
    }

Definition

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

1. See BatchPutAssetPropertyValueErrorCodeType
2. See TimeInNanosTypeDef

AssetPropertyValueTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetPropertyValueTypeDef

def get_value() -> AssetPropertyValueTypeDef:
    return {
        "value": ...,
        "timestamp": ...,
    }

Definition

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

1. See VariantTypeDef
2. See TimeInNanosTypeDef
3. See QualityType

InterpolatedAssetPropertyValueTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import InterpolatedAssetPropertyValueTypeDef

def get_value() -> InterpolatedAssetPropertyValueTypeDef:
    return {
        "timestamp": ...,
        "value": ...,
    }

Definition

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

1. See TimeInNanosTypeDef
2. See VariantTypeDef

BatchAssociateProjectAssetsResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchAssociateProjectAssetsResponseTypeDef

def get_value() -> BatchAssociateProjectAssetsResponseTypeDef:
    return {
        "errors": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetErrorDetailsTypeDef
2. See ResponseMetadataTypeDef

BatchDisassociateProjectAssetsResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchDisassociateProjectAssetsResponseTypeDef

def get_value() -> BatchDisassociateProjectAssetsResponseTypeDef:
    return {
        "errors": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetErrorDetailsTypeDef
2. See ResponseMetadataTypeDef

CreateAccessPolicyResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreateAccessPolicyResponseTypeDef

def get_value() -> CreateAccessPolicyResponseTypeDef:
    return {
        "accessPolicyId": ...,
        "accessPolicyArn": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CreateBulkImportJobResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreateBulkImportJobResponseTypeDef

def get_value() -> CreateBulkImportJobResponseTypeDef:
    return {
        "jobId": ...,
        "jobName": ...,
        "jobStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See JobStatusType
2. See ResponseMetadataTypeDef

CreateDashboardResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreateDashboardResponseTypeDef

def get_value() -> CreateDashboardResponseTypeDef:
    return {
        "dashboardId": ...,
        "dashboardArn": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CreateGatewayResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreateGatewayResponseTypeDef

def get_value() -> CreateGatewayResponseTypeDef:
    return {
        "gatewayId": ...,
        "gatewayArn": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

CreateProjectResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreateProjectResponseTypeDef

def get_value() -> CreateProjectResponseTypeDef:
    return {
        "projectId": ...,
        "projectArn": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

DescribeDashboardResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeDashboardResponseTypeDef

def get_value() -> DescribeDashboardResponseTypeDef:
    return {
        "dashboardId": ...,
        "dashboardArn": ...,
        "dashboardName": ...,
        "projectId": ...,
        "dashboardDescription": ...,
        "dashboardDefinition": ...,
        "dashboardCreationDate": ...,
        "dashboardLastUpdateDate": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeGatewayCapabilityConfigurationResponseTypeDef

def get_value() -> DescribeGatewayCapabilityConfigurationResponseTypeDef:
    return {
        "gatewayId": ...,
        "capabilityNamespace": ...,
        "capabilityConfiguration": ...,
        "capabilitySyncStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See CapabilitySyncStatusType
2. See ResponseMetadataTypeDef

DescribeProjectResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeProjectResponseTypeDef

def get_value() -> DescribeProjectResponseTypeDef:
    return {
        "projectId": ...,
        "projectArn": ...,
        "projectName": ...,
        "portalId": ...,
        "projectDescription": ...,
        "projectCreationDate": ...,
        "projectLastUpdateDate": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeTimeSeriesResponseTypeDef

def get_value() -> DescribeTimeSeriesResponseTypeDef:
    return {
        "assetId": ...,
        "propertyId": ...,
        "alias": ...,
        "timeSeriesId": ...,
        "dataType": ...,
        "dataTypeSpec": ...,
        "timeSeriesCreationDate": ...,
        "timeSeriesLastUpdateDate": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeTimeSeriesResponseTypeDef(TypedDict):
    assetId: str,
    propertyId: str,
    alias: str,
    timeSeriesId: str,
    dataType: PropertyDataTypeType,  # (1)
    dataTypeSpec: str,
    timeSeriesCreationDate: datetime,
    timeSeriesLastUpdateDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See PropertyDataTypeType
2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

ListProjectAssetsResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListProjectAssetsResponseTypeDef

def get_value() -> ListProjectAssetsResponseTypeDef:
    return {
        "assetIds": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

UpdateGatewayCapabilityConfigurationResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdateGatewayCapabilityConfigurationResponseTypeDef

def get_value() -> UpdateGatewayCapabilityConfigurationResponseTypeDef:
    return {
        "capabilityNamespace": ...,
        "capabilitySyncStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See CapabilitySyncStatusType
2. See ResponseMetadataTypeDef

BatchGetAssetPropertyAggregatesRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyAggregatesRequestRequestTypeDef

def get_value() -> BatchGetAssetPropertyAggregatesRequestRequestTypeDef:
    return {
        "entries": ...,
    }

Definition

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

1. See BatchGetAssetPropertyAggregatesEntryTypeDef

BatchGetAssetPropertyAggregatesSkippedEntryTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyAggregatesSkippedEntryTypeDef

def get_value() -> BatchGetAssetPropertyAggregatesSkippedEntryTypeDef:
    return {
        "entryId": ...,
        "completionStatus": ...,
    }

Definition

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

1. See BatchEntryCompletionStatusType
2. See BatchGetAssetPropertyAggregatesErrorInfoTypeDef

BatchGetAssetPropertyValueRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueRequestRequestTypeDef

def get_value() -> BatchGetAssetPropertyValueRequestRequestTypeDef:
    return {
        "entries": ...,
    }

Definition

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

1. See BatchGetAssetPropertyValueEntryTypeDef

BatchGetAssetPropertyValueSkippedEntryTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueSkippedEntryTypeDef

def get_value() -> BatchGetAssetPropertyValueSkippedEntryTypeDef:
    return {
        "entryId": ...,
        "completionStatus": ...,
    }

Definition

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

1. See BatchEntryCompletionStatusType
2. See BatchGetAssetPropertyValueErrorInfoTypeDef

BatchGetAssetPropertyValueHistoryRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueHistoryRequestRequestTypeDef

def get_value() -> BatchGetAssetPropertyValueHistoryRequestRequestTypeDef:
    return {
        "entries": ...,
    }

Definition

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

1. See BatchGetAssetPropertyValueHistoryEntryTypeDef

BatchGetAssetPropertyValueHistorySkippedEntryTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueHistorySkippedEntryTypeDef

def get_value() -> BatchGetAssetPropertyValueHistorySkippedEntryTypeDef:
    return {
        "entryId": ...,
        "completionStatus": ...,
    }

Definition

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

1. See BatchEntryCompletionStatusType
2. See BatchGetAssetPropertyValueHistoryErrorInfoTypeDef

ConfigurationStatusTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ConfigurationStatusTypeDef

def get_value() -> ConfigurationStatusTypeDef:
    return {
        "state": ...,
    }

Definition

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

1. See ConfigurationStateType
2. See ConfigurationErrorDetailsTypeDef

CreatePortalRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreatePortalRequestRequestTypeDef

def get_value() -> CreatePortalRequestRequestTypeDef:
    return {
        "portalName": ...,
        "portalContactEmail": ...,
        "roleArn": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import ImageTypeDef

def get_value() -> ImageTypeDef:
    return {
        "id": ...,
    }

Definition

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

1. See ImageFileTypeDef

FileFormatTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import FileFormatTypeDef

def get_value() -> FileFormatTypeDef:
    return {
        "csv": ...,
    }

Definition

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

1. See CsvTypeDef

MultiLayerStorageTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import MultiLayerStorageTypeDef

def get_value() -> MultiLayerStorageTypeDef:
    return {
        "customerManagedS3Storage": ...,
    }

Definition

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

1. See CustomerManagedS3StorageTypeDef

ListDashboardsResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListDashboardsResponseTypeDef

def get_value() -> ListDashboardsResponseTypeDef:
    return {
        "dashboardSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See DashboardSummaryTypeDef
2. See ResponseMetadataTypeDef

DescribeAssetModelRequestAssetModelActiveWaitTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeAssetModelRequestAssetModelActiveWaitTypeDef

def get_value() -> DescribeAssetModelRequestAssetModelActiveWaitTypeDef:
    return {
        "assetModelId": ...,
    }

Definition

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

1. See WaiterConfigTypeDef

DescribeAssetModelRequestAssetModelNotExistsWaitTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeAssetModelRequestAssetModelNotExistsWaitTypeDef

def get_value() -> DescribeAssetModelRequestAssetModelNotExistsWaitTypeDef:
    return {
        "assetModelId": ...,
    }

Definition

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

1. See WaiterConfigTypeDef

DescribeAssetRequestAssetActiveWaitTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeAssetRequestAssetActiveWaitTypeDef

def get_value() -> DescribeAssetRequestAssetActiveWaitTypeDef:
    return {
        "assetId": ...,
    }

Definition

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

1. See WaiterConfigTypeDef

DescribeAssetRequestAssetNotExistsWaitTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeAssetRequestAssetNotExistsWaitTypeDef

def get_value() -> DescribeAssetRequestAssetNotExistsWaitTypeDef:
    return {
        "assetId": ...,
    }

Definition

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

1. See WaiterConfigTypeDef

DescribePortalRequestPortalActiveWaitTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribePortalRequestPortalActiveWaitTypeDef

def get_value() -> DescribePortalRequestPortalActiveWaitTypeDef:
    return {
        "portalId": ...,
    }

Definition

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

1. See WaiterConfigTypeDef

DescribePortalRequestPortalNotExistsWaitTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribePortalRequestPortalNotExistsWaitTypeDef

def get_value() -> DescribePortalRequestPortalNotExistsWaitTypeDef:
    return {
        "portalId": ...,
    }

Definition

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

1. See WaiterConfigTypeDef

DescribeLoggingOptionsResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeLoggingOptionsResponseTypeDef

def get_value() -> DescribeLoggingOptionsResponseTypeDef:
    return {
        "loggingOptions": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See LoggingOptionsTypeDef
2. See ResponseMetadataTypeDef

PutLoggingOptionsRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import PutLoggingOptionsRequestRequestTypeDef

def get_value() -> PutLoggingOptionsRequestRequestTypeDef:
    return {
        "loggingOptions": ...,
    }

Definition

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

1. See LoggingOptionsTypeDef

ErrorDetailsTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ErrorDetailsTypeDef

def get_value() -> ErrorDetailsTypeDef:
    return {
        "code": ...,
        "message": ...,
    }

Definition

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

1. See ErrorCodeType
2. See DetailedErrorTypeDef

ExpressionVariableTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ExpressionVariableTypeDef

def get_value() -> ExpressionVariableTypeDef:
    return {
        "name": ...,
        "value": ...,
    }

Definition

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

1. See VariableValueTypeDef

MeasurementProcessingConfigTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import MeasurementProcessingConfigTypeDef

def get_value() -> MeasurementProcessingConfigTypeDef:
    return {
        "forwardingConfig": ...,
    }

Definition

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

1. See ForwardingConfigTypeDef

TransformProcessingConfigTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import TransformProcessingConfigTypeDef

def get_value() -> TransformProcessingConfigTypeDef:
    return {
        "computeLocation": ...,
    }

Definition

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

1. See ComputeLocationType
2. See ForwardingConfigTypeDef

GatewayPlatformTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import GatewayPlatformTypeDef

def get_value() -> GatewayPlatformTypeDef:
    return {
        "greengrass": ...,
    }

Definition

class GatewayPlatformTypeDef(TypedDict):
    greengrass: NotRequired[GreengrassTypeDef],  # (1)
    greengrassV2: NotRequired[GreengrassV2TypeDef],  # (2)

1. See GreengrassTypeDef
2. See GreengrassV2TypeDef

GetAssetPropertyAggregatesRequestGetAssetPropertyAggregatesPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import GetAssetPropertyAggregatesRequestGetAssetPropertyAggregatesPaginateTypeDef

def get_value() -> GetAssetPropertyAggregatesRequestGetAssetPropertyAggregatesPaginateTypeDef:
    return {
        "aggregateTypes": ...,
        "resolution": ...,
        "startDate": ...,
        "endDate": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import GetAssetPropertyValueHistoryRequestGetAssetPropertyValueHistoryPaginateTypeDef

def get_value() -> GetAssetPropertyValueHistoryRequestGetAssetPropertyValueHistoryPaginateTypeDef:
    return {
        "assetId": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import GetInterpolatedAssetPropertyValuesRequestGetInterpolatedAssetPropertyValuesPaginateTypeDef

def get_value() -> GetInterpolatedAssetPropertyValuesRequestGetInterpolatedAssetPropertyValuesPaginateTypeDef:
    return {
        "startTimeInSeconds": ...,
        "endTimeInSeconds": ...,
        "quality": ...,
        "intervalInSeconds": ...,
        "type": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAccessPoliciesRequestListAccessPoliciesPaginateTypeDef

def get_value() -> ListAccessPoliciesRequestListAccessPoliciesPaginateTypeDef:
    return {
        "identityType": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef

def get_value() -> ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef:
    return {
        "assetModelId": ...,
    }

Definition

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

1. See ListAssetModelPropertiesFilterType
2. See PaginatorConfigTypeDef

ListAssetModelsRequestListAssetModelsPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAssetModelsRequestListAssetModelsPaginateTypeDef

def get_value() -> ListAssetModelsRequestListAssetModelsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef

def get_value() -> ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef:
    return {
        "assetId": ...,
    }

Definition

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

1. See ListAssetPropertiesFilterType
2. See PaginatorConfigTypeDef

ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef

def get_value() -> ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef:
    return {
        "assetId": ...,
        "traversalType": ...,
    }

Definition

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

1. See TraversalTypeType
2. See PaginatorConfigTypeDef

ListAssetsRequestListAssetsPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAssetsRequestListAssetsPaginateTypeDef

def get_value() -> ListAssetsRequestListAssetsPaginateTypeDef:
    return {
        "assetModelId": ...,
    }

Definition

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

1. See ListAssetsFilterType
2. See PaginatorConfigTypeDef

ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef

def get_value() -> ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef:
    return {
        "assetId": ...,
    }

Definition

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

1. See TraversalDirectionType
2. See PaginatorConfigTypeDef

ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef

def get_value() -> ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef:
    return {
        "filter": ...,
    }

Definition

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

1. See ListBulkImportJobsFilterType
2. See PaginatorConfigTypeDef

ListDashboardsRequestListDashboardsPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListDashboardsRequestListDashboardsPaginateTypeDef

def get_value() -> ListDashboardsRequestListDashboardsPaginateTypeDef:
    return {
        "projectId": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListGatewaysRequestListGatewaysPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListGatewaysRequestListGatewaysPaginateTypeDef

def get_value() -> ListGatewaysRequestListGatewaysPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListPortalsRequestListPortalsPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListPortalsRequestListPortalsPaginateTypeDef

def get_value() -> ListPortalsRequestListPortalsPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListProjectAssetsRequestListProjectAssetsPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListProjectAssetsRequestListProjectAssetsPaginateTypeDef

def get_value() -> ListProjectAssetsRequestListProjectAssetsPaginateTypeDef:
    return {
        "projectId": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListProjectsRequestListProjectsPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListProjectsRequestListProjectsPaginateTypeDef

def get_value() -> ListProjectsRequestListProjectsPaginateTypeDef:
    return {
        "portalId": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

ListTimeSeriesRequestListTimeSeriesPaginateTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListTimeSeriesRequestListTimeSeriesPaginateTypeDef

def get_value() -> ListTimeSeriesRequestListTimeSeriesPaginateTypeDef:
    return {
        "assetId": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import IdentityTypeDef

def get_value() -> IdentityTypeDef:
    return {
        "user": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListBulkImportJobsResponseTypeDef

def get_value() -> ListBulkImportJobsResponseTypeDef:
    return {
        "jobSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See JobSummaryTypeDef
2. See ResponseMetadataTypeDef

ListProjectsResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListProjectsResponseTypeDef

def get_value() -> ListProjectsResponseTypeDef:
    return {
        "projectSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ProjectSummaryTypeDef
2. See ResponseMetadataTypeDef

ListTimeSeriesResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListTimeSeriesResponseTypeDef

def get_value() -> ListTimeSeriesResponseTypeDef:
    return {
        "TimeSeriesSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See TimeSeriesSummaryTypeDef
2. See ResponseMetadataTypeDef

MetricWindowTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import MetricWindowTypeDef

def get_value() -> MetricWindowTypeDef:
    return {
        "tumbling": ...,
    }

Definition

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

1. See TumblingWindowTypeDef

PortalStatusTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import PortalStatusTypeDef

def get_value() -> PortalStatusTypeDef:
    return {
        "state": ...,
    }

Definition

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

1. See PortalStateType
2. See MonitorErrorDetailsTypeDef

ResourceTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ResourceTypeDef

def get_value() -> ResourceTypeDef:
    return {
        "portal": ...,
    }

Definition

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

1. See PortalResourceTypeDef
2. See ProjectResourceTypeDef

BatchGetAssetPropertyAggregatesSuccessEntryTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyAggregatesSuccessEntryTypeDef

def get_value() -> BatchGetAssetPropertyAggregatesSuccessEntryTypeDef:
    return {
        "entryId": ...,
        "aggregatedValues": ...,
    }

Definition

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

1. See AggregatedValueTypeDef

GetAssetPropertyAggregatesResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import GetAssetPropertyAggregatesResponseTypeDef

def get_value() -> GetAssetPropertyAggregatesResponseTypeDef:
    return {
        "aggregatedValues": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AggregatedValueTypeDef
2. See ResponseMetadataTypeDef

ListAssetRelationshipsResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAssetRelationshipsResponseTypeDef

def get_value() -> ListAssetRelationshipsResponseTypeDef:
    return {
        "assetRelationshipSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetRelationshipSummaryTypeDef
2. See ResponseMetadataTypeDef

ListAssetPropertiesResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAssetPropertiesResponseTypeDef

def get_value() -> ListAssetPropertiesResponseTypeDef:
    return {
        "assetPropertySummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetPropertySummaryTypeDef
2. See ResponseMetadataTypeDef

AssetCompositeModelTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetCompositeModelTypeDef

def get_value() -> AssetCompositeModelTypeDef:
    return {
        "name": ...,
        "type": ...,
        "properties": ...,
    }

Definition

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

1. See AssetPropertyTypeDef

BatchPutAssetPropertyErrorEntryTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchPutAssetPropertyErrorEntryTypeDef

def get_value() -> BatchPutAssetPropertyErrorEntryTypeDef:
    return {
        "entryId": ...,
        "errors": ...,
    }

Definition

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

1. See BatchPutAssetPropertyErrorTypeDef

BatchGetAssetPropertyValueHistorySuccessEntryTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueHistorySuccessEntryTypeDef

def get_value() -> BatchGetAssetPropertyValueHistorySuccessEntryTypeDef:
    return {
        "entryId": ...,
        "assetPropertyValueHistory": ...,
    }

Definition

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

1. See AssetPropertyValueTypeDef

BatchGetAssetPropertyValueSuccessEntryTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueSuccessEntryTypeDef

def get_value() -> BatchGetAssetPropertyValueSuccessEntryTypeDef:
    return {
        "entryId": ...,
    }

Definition

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

1. See AssetPropertyValueTypeDef

GetAssetPropertyValueHistoryResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import GetAssetPropertyValueHistoryResponseTypeDef

def get_value() -> GetAssetPropertyValueHistoryResponseTypeDef:
    return {
        "assetPropertyValueHistory": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetPropertyValueTypeDef
2. See ResponseMetadataTypeDef

GetAssetPropertyValueResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import GetAssetPropertyValueResponseTypeDef

def get_value() -> GetAssetPropertyValueResponseTypeDef:
    return {
        "propertyValue": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetPropertyValueTypeDef
2. See ResponseMetadataTypeDef

PutAssetPropertyValueEntryTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import PutAssetPropertyValueEntryTypeDef

def get_value() -> PutAssetPropertyValueEntryTypeDef:
    return {
        "entryId": ...,
        "propertyValues": ...,
    }

Definition

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

1. See AssetPropertyValueTypeDef

GetInterpolatedAssetPropertyValuesResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import GetInterpolatedAssetPropertyValuesResponseTypeDef

def get_value() -> GetInterpolatedAssetPropertyValuesResponseTypeDef:
    return {
        "interpolatedAssetPropertyValues": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See InterpolatedAssetPropertyValueTypeDef
2. See ResponseMetadataTypeDef

DescribeDefaultEncryptionConfigurationResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeDefaultEncryptionConfigurationResponseTypeDef

def get_value() -> DescribeDefaultEncryptionConfigurationResponseTypeDef:
    return {
        "encryptionType": ...,
        "kmsKeyArn": ...,
        "configurationStatus": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import PutDefaultEncryptionConfigurationResponseTypeDef

def get_value() -> PutDefaultEncryptionConfigurationResponseTypeDef:
    return {
        "encryptionType": ...,
        "kmsKeyArn": ...,
        "configurationStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See EncryptionTypeType
2. See ConfigurationStatusTypeDef
3. See ResponseMetadataTypeDef

UpdatePortalRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdatePortalRequestRequestTypeDef

def get_value() -> UpdatePortalRequestRequestTypeDef:
    return {
        "portalId": ...,
        "portalName": ...,
        "portalContactEmail": ...,
        "roleArn": ...,
    }

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

JobConfigurationTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import JobConfigurationTypeDef

def get_value() -> JobConfigurationTypeDef:
    return {
        "fileFormat": ...,
    }

Definition

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

1. See FileFormatTypeDef

DescribeStorageConfigurationResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeStorageConfigurationResponseTypeDef

def get_value() -> DescribeStorageConfigurationResponseTypeDef:
    return {
        "storageType": ...,
        "multiLayerStorage": ...,
        "disassociatedDataStorage": ...,
        "retentionPeriod": ...,
        "configurationStatus": ...,
        "lastUpdateDate": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import PutStorageConfigurationRequestRequestTypeDef

def get_value() -> PutStorageConfigurationRequestRequestTypeDef:
    return {
        "storageType": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import PutStorageConfigurationResponseTypeDef

def get_value() -> PutStorageConfigurationResponseTypeDef:
    return {
        "storageType": ...,
        "multiLayerStorage": ...,
        "disassociatedDataStorage": ...,
        "retentionPeriod": ...,
        "configurationStatus": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetModelStatusTypeDef

def get_value() -> AssetModelStatusTypeDef:
    return {
        "state": ...,
    }

Definition

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

1. See AssetModelStateType
2. See ErrorDetailsTypeDef

AssetStatusTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetStatusTypeDef

def get_value() -> AssetStatusTypeDef:
    return {
        "state": ...,
    }

Definition

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

1. See AssetStateType
2. See ErrorDetailsTypeDef

MeasurementTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import MeasurementTypeDef

def get_value() -> MeasurementTypeDef:
    return {
        "processingConfig": ...,
    }

Definition

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

1. See MeasurementProcessingConfigTypeDef

TransformTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import TransformTypeDef

def get_value() -> TransformTypeDef:
    return {
        "expression": ...,
        "variables": ...,
    }

Definition

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

1. See ExpressionVariableTypeDef
2. See TransformProcessingConfigTypeDef

CreateGatewayRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreateGatewayRequestRequestTypeDef

def get_value() -> CreateGatewayRequestRequestTypeDef:
    return {
        "gatewayName": ...,
        "gatewayPlatform": ...,
    }

Definition

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

1. See GatewayPlatformTypeDef

DescribeGatewayResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeGatewayResponseTypeDef

def get_value() -> DescribeGatewayResponseTypeDef:
    return {
        "gatewayId": ...,
        "gatewayName": ...,
        "gatewayArn": ...,
        "gatewayPlatform": ...,
        "gatewayCapabilitySummaries": ...,
        "creationDate": ...,
        "lastUpdateDate": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import GatewaySummaryTypeDef

def get_value() -> GatewaySummaryTypeDef:
    return {
        "gatewayId": ...,
        "gatewayName": ...,
        "creationDate": ...,
        "lastUpdateDate": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import MetricTypeDef

def get_value() -> MetricTypeDef:
    return {
        "expression": ...,
        "variables": ...,
        "window": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreatePortalResponseTypeDef

def get_value() -> CreatePortalResponseTypeDef:
    return {
        "portalId": ...,
        "portalArn": ...,
        "portalStartUrl": ...,
        "portalStatus": ...,
        "ssoApplicationId": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import DeletePortalResponseTypeDef

def get_value() -> DeletePortalResponseTypeDef:
    return {
        "portalStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See PortalStatusTypeDef
2. See ResponseMetadataTypeDef

DescribePortalResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribePortalResponseTypeDef

def get_value() -> DescribePortalResponseTypeDef:
    return {
        "portalId": ...,
        "portalArn": ...,
        "portalName": ...,
        "portalDescription": ...,
        "portalClientId": ...,
        "portalStartUrl": ...,
        "portalContactEmail": ...,
        "portalStatus": ...,
        "portalCreationDate": ...,
        "portalLastUpdateDate": ...,
        "portalLogoImageLocation": ...,
        "roleArn": ...,
        "portalAuthMode": ...,
        "notificationSenderEmail": ...,
        "alarms": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import PortalSummaryTypeDef

def get_value() -> PortalSummaryTypeDef:
    return {
        "id": ...,
        "name": ...,
        "startUrl": ...,
        "status": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdatePortalResponseTypeDef

def get_value() -> UpdatePortalResponseTypeDef:
    return {
        "portalStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See PortalStatusTypeDef
2. See ResponseMetadataTypeDef

AccessPolicySummaryTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import AccessPolicySummaryTypeDef

def get_value() -> AccessPolicySummaryTypeDef:
    return {
        "id": ...,
        "identity": ...,
        "resource": ...,
        "permission": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreateAccessPolicyRequestRequestTypeDef

def get_value() -> CreateAccessPolicyRequestRequestTypeDef:
    return {
        "accessPolicyIdentity": ...,
        "accessPolicyResource": ...,
        "accessPolicyPermission": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeAccessPolicyResponseTypeDef

def get_value() -> DescribeAccessPolicyResponseTypeDef:
    return {
        "accessPolicyId": ...,
        "accessPolicyArn": ...,
        "accessPolicyIdentity": ...,
        "accessPolicyResource": ...,
        "accessPolicyPermission": ...,
        "accessPolicyCreationDate": ...,
        "accessPolicyLastUpdateDate": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdateAccessPolicyRequestRequestTypeDef

def get_value() -> UpdateAccessPolicyRequestRequestTypeDef:
    return {
        "accessPolicyId": ...,
        "accessPolicyIdentity": ...,
        "accessPolicyResource": ...,
        "accessPolicyPermission": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyAggregatesResponseTypeDef

def get_value() -> BatchGetAssetPropertyAggregatesResponseTypeDef:
    return {
        "errorEntries": ...,
        "successEntries": ...,
        "skippedEntries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchPutAssetPropertyValueResponseTypeDef

def get_value() -> BatchPutAssetPropertyValueResponseTypeDef:
    return {
        "errorEntries": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See BatchPutAssetPropertyErrorEntryTypeDef
2. See ResponseMetadataTypeDef

BatchGetAssetPropertyValueHistoryResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueHistoryResponseTypeDef

def get_value() -> BatchGetAssetPropertyValueHistoryResponseTypeDef:
    return {
        "errorEntries": ...,
        "successEntries": ...,
        "skippedEntries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchGetAssetPropertyValueResponseTypeDef

def get_value() -> BatchGetAssetPropertyValueResponseTypeDef:
    return {
        "errorEntries": ...,
        "successEntries": ...,
        "skippedEntries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import BatchPutAssetPropertyValueRequestRequestTypeDef

def get_value() -> BatchPutAssetPropertyValueRequestRequestTypeDef:
    return {
        "entries": ...,
    }

Definition

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

1. See PutAssetPropertyValueEntryTypeDef

CreateBulkImportJobRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreateBulkImportJobRequestRequestTypeDef

def get_value() -> CreateBulkImportJobRequestRequestTypeDef:
    return {
        "jobName": ...,
        "jobRoleArn": ...,
        "files": ...,
        "errorReportLocation": ...,
        "jobConfiguration": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeBulkImportJobResponseTypeDef

def get_value() -> DescribeBulkImportJobResponseTypeDef:
    return {
        "jobId": ...,
        "jobName": ...,
        "jobStatus": ...,
        "jobRoleArn": ...,
        "files": ...,
        "errorReportLocation": ...,
        "jobConfiguration": ...,
        "jobCreationDate": ...,
        "jobLastUpdateDate": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetModelSummaryTypeDef

def get_value() -> AssetModelSummaryTypeDef:
    return {
        "id": ...,
        "arn": ...,
        "name": ...,
        "description": ...,
        "creationDate": ...,
        "lastUpdateDate": ...,
        "status": ...,
    }

Definition

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

1. See AssetModelStatusTypeDef

CreateAssetModelResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreateAssetModelResponseTypeDef

def get_value() -> CreateAssetModelResponseTypeDef:
    return {
        "assetModelId": ...,
        "assetModelArn": ...,
        "assetModelStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetModelStatusTypeDef
2. See ResponseMetadataTypeDef

DeleteAssetModelResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DeleteAssetModelResponseTypeDef

def get_value() -> DeleteAssetModelResponseTypeDef:
    return {
        "assetModelStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetModelStatusTypeDef
2. See ResponseMetadataTypeDef

UpdateAssetModelResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdateAssetModelResponseTypeDef

def get_value() -> UpdateAssetModelResponseTypeDef:
    return {
        "assetModelStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetModelStatusTypeDef
2. See ResponseMetadataTypeDef

AssetSummaryTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetSummaryTypeDef

def get_value() -> AssetSummaryTypeDef:
    return {
        "id": ...,
        "arn": ...,
        "name": ...,
        "assetModelId": ...,
        "creationDate": ...,
        "lastUpdateDate": ...,
        "status": ...,
        "hierarchies": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssociatedAssetsSummaryTypeDef

def get_value() -> AssociatedAssetsSummaryTypeDef:
    return {
        "id": ...,
        "arn": ...,
        "name": ...,
        "assetModelId": ...,
        "creationDate": ...,
        "lastUpdateDate": ...,
        "status": ...,
        "hierarchies": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreateAssetResponseTypeDef

def get_value() -> CreateAssetResponseTypeDef:
    return {
        "assetId": ...,
        "assetArn": ...,
        "assetStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetStatusTypeDef
2. See ResponseMetadataTypeDef

DeleteAssetResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DeleteAssetResponseTypeDef

def get_value() -> DeleteAssetResponseTypeDef:
    return {
        "assetStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetStatusTypeDef
2. See ResponseMetadataTypeDef

DescribeAssetResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeAssetResponseTypeDef

def get_value() -> DescribeAssetResponseTypeDef:
    return {
        "assetId": ...,
        "assetArn": ...,
        "assetName": ...,
        "assetModelId": ...,
        "assetProperties": ...,
        "assetHierarchies": ...,
        "assetCompositeModels": ...,
        "assetCreationDate": ...,
        "assetLastUpdateDate": ...,
        "assetStatus": ...,
        "assetDescription": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdateAssetResponseTypeDef

def get_value() -> UpdateAssetResponseTypeDef:
    return {
        "assetStatus": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetStatusTypeDef
2. See ResponseMetadataTypeDef

ListGatewaysResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListGatewaysResponseTypeDef

def get_value() -> ListGatewaysResponseTypeDef:
    return {
        "gatewaySummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See GatewaySummaryTypeDef
2. See ResponseMetadataTypeDef

PropertyTypeTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import PropertyTypeTypeDef

def get_value() -> PropertyTypeTypeDef:
    return {
        "attribute": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListPortalsResponseTypeDef

def get_value() -> ListPortalsResponseTypeDef:
    return {
        "portalSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See PortalSummaryTypeDef
2. See ResponseMetadataTypeDef

ListAccessPoliciesResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAccessPoliciesResponseTypeDef

def get_value() -> ListAccessPoliciesResponseTypeDef:
    return {
        "accessPolicySummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AccessPolicySummaryTypeDef
2. See ResponseMetadataTypeDef

ListAssetModelsResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAssetModelsResponseTypeDef

def get_value() -> ListAssetModelsResponseTypeDef:
    return {
        "assetModelSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetModelSummaryTypeDef
2. See ResponseMetadataTypeDef

ListAssetsResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAssetsResponseTypeDef

def get_value() -> ListAssetsResponseTypeDef:
    return {
        "assetSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetSummaryTypeDef
2. See ResponseMetadataTypeDef

ListAssociatedAssetsResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAssociatedAssetsResponseTypeDef

def get_value() -> ListAssociatedAssetsResponseTypeDef:
    return {
        "assetSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssociatedAssetsSummaryTypeDef
2. See ResponseMetadataTypeDef

AssetModelPropertyDefinitionTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetModelPropertyDefinitionTypeDef

def get_value() -> AssetModelPropertyDefinitionTypeDef:
    return {
        "name": ...,
        "dataType": ...,
        "type": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetModelPropertySummaryTypeDef

def get_value() -> AssetModelPropertySummaryTypeDef:
    return {
        "name": ...,
        "dataType": ...,
        "type": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetModelPropertyTypeDef

def get_value() -> AssetModelPropertyTypeDef:
    return {
        "name": ...,
        "dataType": ...,
        "type": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import PropertyTypeDef

def get_value() -> PropertyTypeDef:
    return {
        "id": ...,
        "name": ...,
        "dataType": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetModelCompositeModelDefinitionTypeDef

def get_value() -> AssetModelCompositeModelDefinitionTypeDef:
    return {
        "name": ...,
        "type": ...,
    }

Definition

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

1. See AssetModelPropertyDefinitionTypeDef

ListAssetModelPropertiesResponseTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import ListAssetModelPropertiesResponseTypeDef

def get_value() -> ListAssetModelPropertiesResponseTypeDef:
    return {
        "assetModelPropertySummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AssetModelPropertySummaryTypeDef
2. See ResponseMetadataTypeDef

AssetModelCompositeModelTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import AssetModelCompositeModelTypeDef

def get_value() -> AssetModelCompositeModelTypeDef:
    return {
        "name": ...,
        "type": ...,
    }

Definition

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

1. See AssetModelPropertyTypeDef

CompositeModelPropertyTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import CompositeModelPropertyTypeDef

def get_value() -> CompositeModelPropertyTypeDef:
    return {
        "name": ...,
        "type": ...,
        "assetProperty": ...,
    }

Definition

class CompositeModelPropertyTypeDef(TypedDict):
    name: str,
    type: str,
    assetProperty: PropertyTypeDef,  # (1)
    id: NotRequired[str],

1. See PropertyTypeDef

CreateAssetModelRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsitewise.type_defs import CreateAssetModelRequestRequestTypeDef

def get_value() -> CreateAssetModelRequestRequestTypeDef:
    return {
        "assetModelName": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeAssetModelResponseTypeDef

def get_value() -> DescribeAssetModelResponseTypeDef:
    return {
        "assetModelId": ...,
        "assetModelArn": ...,
        "assetModelName": ...,
        "assetModelDescription": ...,
        "assetModelProperties": ...,
        "assetModelHierarchies": ...,
        "assetModelCompositeModels": ...,
        "assetModelCreationDate": ...,
        "assetModelLastUpdateDate": ...,
        "assetModelStatus": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import UpdateAssetModelRequestRequestTypeDef

def get_value() -> UpdateAssetModelRequestRequestTypeDef:
    return {
        "assetModelId": ...,
        "assetModelName": ...,
    }

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

Usage Example

from mypy_boto3_iotsitewise.type_defs import DescribeAssetPropertyResponseTypeDef

def get_value() -> DescribeAssetPropertyResponseTypeDef:
    return {
        "assetId": ...,
        "assetName": ...,
        "assetModelId": ...,
        "assetProperty": ...,
        "compositeModel": ...,
        "ResponseMetadata": ...,
    }

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