Type definitions#

Index > IoTSiteWise > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

CsvUnionTypeDef#

# CsvUnionTypeDef definition

CsvUnionTypeDef = Union[
    CsvTypeDef,  # (1)
    CsvOutputTypeDef,  # (2)
]

See CsvTypeDef
See CsvOutputTypeDef

PortalTypeEntryUnionTypeDef#

# PortalTypeEntryUnionTypeDef definition

PortalTypeEntryUnionTypeDef = Union[
    PortalTypeEntryTypeDef,  # (1)
    PortalTypeEntryOutputTypeDef,  # (2)
]

See PortalTypeEntryTypeDef
See PortalTypeEntryOutputTypeDef

VariableValueUnionTypeDef#

# VariableValueUnionTypeDef definition

VariableValueUnionTypeDef = Union[
    VariableValueTypeDef,  # (1)
    VariableValueOutputTypeDef,  # (2)
]

See VariableValueTypeDef
See VariableValueOutputTypeDef

FileFormatUnionTypeDef#

# FileFormatUnionTypeDef definition

FileFormatUnionTypeDef = Union[
    FileFormatTypeDef,  # (1)
    FileFormatOutputTypeDef,  # (2)
]

See FileFormatTypeDef
See FileFormatOutputTypeDef

ExpressionVariableUnionTypeDef#

# ExpressionVariableUnionTypeDef definition

ExpressionVariableUnionTypeDef = Union[
    ExpressionVariableTypeDef,  # (1)
    ExpressionVariableOutputTypeDef,  # (2)
]

See ExpressionVariableTypeDef
See ExpressionVariableOutputTypeDef

MetricUnionTypeDef#

# MetricUnionTypeDef definition

MetricUnionTypeDef = Union[
    MetricTypeDef,  # (1)
    MetricOutputTypeDef,  # (2)
]

See MetricTypeDef
See MetricOutputTypeDef

TransformUnionTypeDef#

# TransformUnionTypeDef definition

TransformUnionTypeDef = Union[
    TransformTypeDef,  # (1)
    TransformOutputTypeDef,  # (2)
]

See TransformTypeDef
See TransformOutputTypeDef

PropertyTypeUnionTypeDef#

# PropertyTypeUnionTypeDef definition

PropertyTypeUnionTypeDef = Union[
    PropertyTypeTypeDef,  # (1)
    PropertyTypeOutputTypeDef,  # (2)
]

See PropertyTypeTypeDef
See PropertyTypeOutputTypeDef

AssetModelPropertyUnionTypeDef#

# AssetModelPropertyUnionTypeDef definition

AssetModelPropertyUnionTypeDef = Union[
    AssetModelPropertyTypeDef,  # (1)
    AssetModelPropertyOutputTypeDef,  # (2)
]

See AssetModelPropertyTypeDef
See AssetModelPropertyOutputTypeDef

AssetModelCompositeModelUnionTypeDef#

# AssetModelCompositeModelUnionTypeDef definition

AssetModelCompositeModelUnionTypeDef = Union[
    AssetModelCompositeModelTypeDef,  # (1)
    AssetModelCompositeModelOutputTypeDef,  # (2)
]

AccessDeniedExceptionTypeDef#

# AccessDeniedExceptionTypeDef definition

class AccessDeniedExceptionTypeDef(TypedDict):
    message: NotRequired[str],

ActionDefinitionTypeDef#

# ActionDefinitionTypeDef definition

class ActionDefinitionTypeDef(TypedDict):
    actionDefinitionId: str,
    actionName: str,
    actionType: str,

ActionPayloadTypeDef#

# ActionPayloadTypeDef definition

class ActionPayloadTypeDef(TypedDict):
    stringValue: str,

TargetResourceTypeDef#

# TargetResourceTypeDef definition

class TargetResourceTypeDef(TypedDict):
    assetId: str,

AggregatesTypeDef#

# AggregatesTypeDef definition

class AggregatesTypeDef(TypedDict):
    average: NotRequired[float],
    count: NotRequired[float],
    maximum: NotRequired[float],
    minimum: NotRequired[float],
    sum: NotRequired[float],
    standardDeviation: NotRequired[float],

AlarmsTypeDef#

# AlarmsTypeDef definition

class AlarmsTypeDef(TypedDict):
    alarmRoleArn: str,
    notificationLambdaArn: NotRequired[str],

AssetCompositeModelPathSegmentTypeDef#

# AssetCompositeModelPathSegmentTypeDef definition

class AssetCompositeModelPathSegmentTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],

AssetErrorDetailsTypeDef#

# AssetErrorDetailsTypeDef definition

class AssetErrorDetailsTypeDef(TypedDict):
    assetId: str,
    code: AssetErrorCodeType,  # (1)
    message: str,

See AssetErrorCodeType

AssetHierarchyInfoTypeDef#

# AssetHierarchyInfoTypeDef definition

class AssetHierarchyInfoTypeDef(TypedDict):
    parentAssetId: NotRequired[str],
    childAssetId: NotRequired[str],

AssetHierarchyTypeDef#

# AssetHierarchyTypeDef definition

class AssetHierarchyTypeDef(TypedDict):
    name: str,
    id: NotRequired[str],
    externalId: NotRequired[str],

AssetModelCompositeModelPathSegmentTypeDef#

# AssetModelCompositeModelPathSegmentTypeDef definition

class AssetModelCompositeModelPathSegmentTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],

AssetModelHierarchyDefinitionTypeDef#

# AssetModelHierarchyDefinitionTypeDef definition

class AssetModelHierarchyDefinitionTypeDef(TypedDict):
    name: str,
    childAssetModelId: str,
    id: NotRequired[str],
    externalId: NotRequired[str],

AssetModelHierarchyTypeDef#

# AssetModelHierarchyTypeDef definition

class AssetModelHierarchyTypeDef(TypedDict):
    name: str,
    childAssetModelId: str,
    id: NotRequired[str],
    externalId: NotRequired[str],

AssetModelPropertyPathSegmentTypeDef#

# AssetModelPropertyPathSegmentTypeDef definition

class AssetModelPropertyPathSegmentTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],

AssetPropertyPathSegmentTypeDef#

# AssetPropertyPathSegmentTypeDef definition

class AssetPropertyPathSegmentTypeDef(TypedDict):
    id: NotRequired[str],
    name: NotRequired[str],

PropertyNotificationTypeDef#

# PropertyNotificationTypeDef definition

class PropertyNotificationTypeDef(TypedDict):
    topic: str,
    state: PropertyNotificationStateType,  # (1)

See PropertyNotificationStateType

TimeInNanosTypeDef#

# TimeInNanosTypeDef definition

class TimeInNanosTypeDef(TypedDict):
    timeInSeconds: int,
    offsetInNanos: NotRequired[int],

VariantTypeDef#

# VariantTypeDef definition

class VariantTypeDef(TypedDict):
    stringValue: NotRequired[str],
    integerValue: NotRequired[int],
    doubleValue: NotRequired[float],
    booleanValue: NotRequired[bool],

AssociateAssetsRequestRequestTypeDef#

# AssociateAssetsRequestRequestTypeDef definition

class AssociateAssetsRequestRequestTypeDef(TypedDict):
    assetId: str,
    hierarchyId: str,
    childAssetId: str,
    clientToken: NotRequired[str],

AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef#

# AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef definition

class AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef(TypedDict):
    alias: str,
    assetId: str,
    propertyId: str,
    clientToken: NotRequired[str],

AttributeTypeDef#

# AttributeTypeDef definition

class AttributeTypeDef(TypedDict):
    defaultValue: NotRequired[str],

BatchAssociateProjectAssetsRequestRequestTypeDef#

# BatchAssociateProjectAssetsRequestRequestTypeDef definition

class BatchAssociateProjectAssetsRequestRequestTypeDef(TypedDict):
    projectId: str,
    assetIds: Sequence[str],
    clientToken: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

BatchDisassociateProjectAssetsRequestRequestTypeDef#

# BatchDisassociateProjectAssetsRequestRequestTypeDef definition

class BatchDisassociateProjectAssetsRequestRequestTypeDef(TypedDict):
    projectId: str,
    assetIds: Sequence[str],
    clientToken: NotRequired[str],

BatchGetAssetPropertyAggregatesErrorEntryTypeDef#

# BatchGetAssetPropertyAggregatesErrorEntryTypeDef definition

class BatchGetAssetPropertyAggregatesErrorEntryTypeDef(TypedDict):
    errorCode: BatchGetAssetPropertyAggregatesErrorCodeType,  # (1)
    errorMessage: str,
    entryId: str,

See BatchGetAssetPropertyAggregatesErrorCodeType

BatchGetAssetPropertyAggregatesErrorInfoTypeDef#

# BatchGetAssetPropertyAggregatesErrorInfoTypeDef definition

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

See BatchGetAssetPropertyAggregatesErrorCodeType

BatchGetAssetPropertyValueEntryTypeDef#

# BatchGetAssetPropertyValueEntryTypeDef definition

class BatchGetAssetPropertyValueEntryTypeDef(TypedDict):
    entryId: str,
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],

BatchGetAssetPropertyValueErrorEntryTypeDef#

# BatchGetAssetPropertyValueErrorEntryTypeDef definition

class BatchGetAssetPropertyValueErrorEntryTypeDef(TypedDict):
    errorCode: BatchGetAssetPropertyValueErrorCodeType,  # (1)
    errorMessage: str,
    entryId: str,

See BatchGetAssetPropertyValueErrorCodeType

BatchGetAssetPropertyValueErrorInfoTypeDef#

# BatchGetAssetPropertyValueErrorInfoTypeDef definition

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

See BatchGetAssetPropertyValueErrorCodeType

BatchGetAssetPropertyValueHistoryErrorEntryTypeDef#

# BatchGetAssetPropertyValueHistoryErrorEntryTypeDef definition

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

See BatchGetAssetPropertyValueHistoryErrorCodeType

BatchGetAssetPropertyValueHistoryErrorInfoTypeDef#

# BatchGetAssetPropertyValueHistoryErrorInfoTypeDef definition

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

See BatchGetAssetPropertyValueHistoryErrorCodeType

ContentTypeDef#

# ContentTypeDef definition

class ContentTypeDef(TypedDict):
    text: NotRequired[str],

ColumnTypeTypeDef#

# ColumnTypeTypeDef definition

class ColumnTypeTypeDef(TypedDict):
    scalarType: NotRequired[ScalarTypeType],  # (1)

See ScalarTypeType

CompositionRelationshipItemTypeDef#

# CompositionRelationshipItemTypeDef definition

class CompositionRelationshipItemTypeDef(TypedDict):
    id: NotRequired[str],

CompositionRelationshipSummaryTypeDef#

# CompositionRelationshipSummaryTypeDef definition

class CompositionRelationshipSummaryTypeDef(TypedDict):
    assetModelId: str,
    assetModelCompositeModelId: str,
    assetModelCompositeModelType: str,

ConfigurationErrorDetailsTypeDef#

# ConfigurationErrorDetailsTypeDef definition

class ConfigurationErrorDetailsTypeDef(TypedDict):
    code: ErrorCodeType,  # (1)
    message: str,

See ErrorCodeType

ConflictingOperationExceptionTypeDef#

# ConflictingOperationExceptionTypeDef definition

class ConflictingOperationExceptionTypeDef(TypedDict):
    message: str,
    resourceId: str,
    resourceArn: str,

CreateAssetRequestRequestTypeDef#

# CreateAssetRequestRequestTypeDef definition

class CreateAssetRequestRequestTypeDef(TypedDict):
    assetName: str,
    assetModelId: str,
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    assetDescription: NotRequired[str],
    assetId: NotRequired[str],
    assetExternalId: NotRequired[str],

ErrorReportLocationTypeDef#

# ErrorReportLocationTypeDef definition

class ErrorReportLocationTypeDef(TypedDict):
    bucket: str,
    prefix: str,

FileTypeDef#

# FileTypeDef definition

class FileTypeDef(TypedDict):
    bucket: str,
    key: str,
    versionId: NotRequired[str],

CreateDashboardRequestRequestTypeDef#

# CreateDashboardRequestRequestTypeDef definition

class CreateDashboardRequestRequestTypeDef(TypedDict):
    projectId: str,
    dashboardName: str,
    dashboardDefinition: str,
    dashboardDescription: NotRequired[str],
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

CreateProjectRequestRequestTypeDef#

# CreateProjectRequestRequestTypeDef definition

class CreateProjectRequestRequestTypeDef(TypedDict):
    portalId: str,
    projectName: str,
    projectDescription: NotRequired[str],
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

CsvOutputTypeDef#

# CsvOutputTypeDef definition

class CsvOutputTypeDef(TypedDict):
    columnNames: list[ColumnNameType],  # (1)

See ColumnNameType

CsvTypeDef#

# CsvTypeDef definition

class CsvTypeDef(TypedDict):
    columnNames: Sequence[ColumnNameType],  # (1)

See ColumnNameType

CustomerManagedS3StorageTypeDef#

# CustomerManagedS3StorageTypeDef definition

class CustomerManagedS3StorageTypeDef(TypedDict):
    s3ResourceArn: str,
    roleArn: str,

DashboardSummaryTypeDef#

# DashboardSummaryTypeDef definition

class DashboardSummaryTypeDef(TypedDict):
    id: str,
    name: str,
    description: NotRequired[str],
    creationDate: NotRequired[datetime],
    lastUpdateDate: NotRequired[datetime],

DatumPaginatorTypeDef#

# DatumPaginatorTypeDef definition

class DatumPaginatorTypeDef(TypedDict):
    scalarValue: NotRequired[str],
    arrayValue: NotRequired[list[dict[str, Any]]],
    rowValue: NotRequired[dict[str, Any]],
    nullValue: NotRequired[bool],

DatumTypeDef#

# DatumTypeDef definition

class DatumTypeDef(TypedDict):
    scalarValue: NotRequired[str],
    arrayValue: NotRequired[list[dict[str, Any]]],
    rowValue: NotRequired[dict[str, Any]],
    nullValue: NotRequired[bool],

DatumWaiterTypeDef#

# DatumWaiterTypeDef definition

class DatumWaiterTypeDef(TypedDict):
    scalarValue: NotRequired[str],
    arrayValue: NotRequired[list[dict[str, Any]]],
    rowValue: NotRequired[dict[str, Any]],
    nullValue: NotRequired[bool],

DeleteAccessPolicyRequestRequestTypeDef#

# DeleteAccessPolicyRequestRequestTypeDef definition

class DeleteAccessPolicyRequestRequestTypeDef(TypedDict):
    accessPolicyId: str,
    clientToken: NotRequired[str],

DeleteAssetModelCompositeModelRequestRequestTypeDef#

# DeleteAssetModelCompositeModelRequestRequestTypeDef definition

class DeleteAssetModelCompositeModelRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    assetModelCompositeModelId: str,
    clientToken: NotRequired[str],
    ifMatch: NotRequired[str],
    ifNoneMatch: NotRequired[str],
    matchForVersionType: NotRequired[AssetModelVersionTypeType],  # (1)

See AssetModelVersionTypeType

DeleteAssetModelRequestRequestTypeDef#

# DeleteAssetModelRequestRequestTypeDef definition

class DeleteAssetModelRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    clientToken: NotRequired[str],
    ifMatch: NotRequired[str],
    ifNoneMatch: NotRequired[str],
    matchForVersionType: NotRequired[AssetModelVersionTypeType],  # (1)

See AssetModelVersionTypeType

DeleteAssetRequestRequestTypeDef#

# DeleteAssetRequestRequestTypeDef definition

class DeleteAssetRequestRequestTypeDef(TypedDict):
    assetId: str,
    clientToken: NotRequired[str],

DeleteDashboardRequestRequestTypeDef#

# DeleteDashboardRequestRequestTypeDef definition

class DeleteDashboardRequestRequestTypeDef(TypedDict):
    dashboardId: str,
    clientToken: NotRequired[str],

DeleteDatasetRequestRequestTypeDef#

# DeleteDatasetRequestRequestTypeDef definition

class DeleteDatasetRequestRequestTypeDef(TypedDict):
    datasetId: str,
    clientToken: NotRequired[str],

DeleteGatewayRequestRequestTypeDef#

# DeleteGatewayRequestRequestTypeDef definition

class DeleteGatewayRequestRequestTypeDef(TypedDict):
    gatewayId: str,

DeletePortalRequestRequestTypeDef#

# DeletePortalRequestRequestTypeDef definition

class DeletePortalRequestRequestTypeDef(TypedDict):
    portalId: str,
    clientToken: NotRequired[str],

DeleteProjectRequestRequestTypeDef#

# DeleteProjectRequestRequestTypeDef definition

class DeleteProjectRequestRequestTypeDef(TypedDict):
    projectId: str,
    clientToken: NotRequired[str],

DeleteTimeSeriesRequestRequestTypeDef#

# DeleteTimeSeriesRequestRequestTypeDef definition

class DeleteTimeSeriesRequestRequestTypeDef(TypedDict):
    alias: NotRequired[str],
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    clientToken: NotRequired[str],

DescribeAccessPolicyRequestRequestTypeDef#

# DescribeAccessPolicyRequestRequestTypeDef definition

class DescribeAccessPolicyRequestRequestTypeDef(TypedDict):
    accessPolicyId: str,

DescribeActionRequestRequestTypeDef#

# DescribeActionRequestRequestTypeDef definition

class DescribeActionRequestRequestTypeDef(TypedDict):
    actionId: str,

DescribeAssetCompositeModelRequestRequestTypeDef#

# DescribeAssetCompositeModelRequestRequestTypeDef definition

class DescribeAssetCompositeModelRequestRequestTypeDef(TypedDict):
    assetId: str,
    assetCompositeModelId: str,

DescribeAssetModelCompositeModelRequestRequestTypeDef#

# DescribeAssetModelCompositeModelRequestRequestTypeDef definition

class DescribeAssetModelCompositeModelRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    assetModelCompositeModelId: str,
    assetModelVersion: NotRequired[str],

DescribeAssetModelRequestRequestTypeDef#

# DescribeAssetModelRequestRequestTypeDef definition

class DescribeAssetModelRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    excludeProperties: NotRequired[bool],
    assetModelVersion: NotRequired[str],

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeAssetPropertyRequestRequestTypeDef#

# DescribeAssetPropertyRequestRequestTypeDef definition

class DescribeAssetPropertyRequestRequestTypeDef(TypedDict):
    assetId: str,
    propertyId: str,

DescribeAssetRequestRequestTypeDef#

# DescribeAssetRequestRequestTypeDef definition

class DescribeAssetRequestRequestTypeDef(TypedDict):
    assetId: str,
    excludeProperties: NotRequired[bool],

DescribeBulkImportJobRequestRequestTypeDef#

# DescribeBulkImportJobRequestRequestTypeDef definition

class DescribeBulkImportJobRequestRequestTypeDef(TypedDict):
    jobId: str,

DescribeDashboardRequestRequestTypeDef#

# DescribeDashboardRequestRequestTypeDef definition

class DescribeDashboardRequestRequestTypeDef(TypedDict):
    dashboardId: str,

DescribeDatasetRequestRequestTypeDef#

# DescribeDatasetRequestRequestTypeDef definition

class DescribeDatasetRequestRequestTypeDef(TypedDict):
    datasetId: str,

DescribeGatewayCapabilityConfigurationRequestRequestTypeDef#

# DescribeGatewayCapabilityConfigurationRequestRequestTypeDef definition

class DescribeGatewayCapabilityConfigurationRequestRequestTypeDef(TypedDict):
    gatewayId: str,
    capabilityNamespace: str,

DescribeGatewayRequestRequestTypeDef#

# DescribeGatewayRequestRequestTypeDef definition

class DescribeGatewayRequestRequestTypeDef(TypedDict):
    gatewayId: str,

GatewayCapabilitySummaryTypeDef#

# GatewayCapabilitySummaryTypeDef definition

class GatewayCapabilitySummaryTypeDef(TypedDict):
    capabilityNamespace: str,
    capabilitySyncStatus: CapabilitySyncStatusType,  # (1)

See CapabilitySyncStatusType

LoggingOptionsTypeDef#

# LoggingOptionsTypeDef definition

class LoggingOptionsTypeDef(TypedDict):
    level: LoggingLevelType,  # (1)

See LoggingLevelType

DescribePortalRequestRequestTypeDef#

# DescribePortalRequestRequestTypeDef definition

class DescribePortalRequestRequestTypeDef(TypedDict):
    portalId: str,

ImageLocationTypeDef#

# ImageLocationTypeDef definition

class ImageLocationTypeDef(TypedDict):
    id: str,
    url: str,

PortalTypeEntryOutputTypeDef#

# PortalTypeEntryOutputTypeDef definition

class PortalTypeEntryOutputTypeDef(TypedDict):
    portalTools: NotRequired[list[str]],

DescribeProjectRequestRequestTypeDef#

# DescribeProjectRequestRequestTypeDef definition

class DescribeProjectRequestRequestTypeDef(TypedDict):
    projectId: str,

RetentionPeriodTypeDef#

# RetentionPeriodTypeDef definition

class RetentionPeriodTypeDef(TypedDict):
    numberOfDays: NotRequired[int],
    unlimited: NotRequired[bool],

WarmTierRetentionPeriodTypeDef#

# WarmTierRetentionPeriodTypeDef definition

class WarmTierRetentionPeriodTypeDef(TypedDict):
    numberOfDays: NotRequired[int],
    unlimited: NotRequired[bool],

DescribeTimeSeriesRequestRequestTypeDef#

# DescribeTimeSeriesRequestRequestTypeDef definition

class DescribeTimeSeriesRequestRequestTypeDef(TypedDict):
    alias: NotRequired[str],
    assetId: NotRequired[str],
    propertyId: NotRequired[str],

DetailedErrorTypeDef#

# DetailedErrorTypeDef definition

class DetailedErrorTypeDef(TypedDict):
    code: DetailedErrorCodeType,  # (1)
    message: str,

See DetailedErrorCodeType

DisassociateAssetsRequestRequestTypeDef#

# DisassociateAssetsRequestRequestTypeDef definition

class DisassociateAssetsRequestRequestTypeDef(TypedDict):
    assetId: str,
    hierarchyId: str,
    childAssetId: str,
    clientToken: NotRequired[str],

DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef#

# DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef definition

class DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef(TypedDict):
    alias: str,
    assetId: str,
    propertyId: str,
    clientToken: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ExecuteQueryRequestRequestTypeDef#

# ExecuteQueryRequestRequestTypeDef definition

class ExecuteQueryRequestRequestTypeDef(TypedDict):
    queryStatement: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    clientToken: NotRequired[str],

ForwardingConfigTypeDef#

# ForwardingConfigTypeDef definition

class ForwardingConfigTypeDef(TypedDict):
    state: ForwardingConfigStateType,  # (1)

See ForwardingConfigStateType

GreengrassTypeDef#

# GreengrassTypeDef definition

class GreengrassTypeDef(TypedDict):
    groupArn: str,

GreengrassV2TypeDef#

# GreengrassV2TypeDef definition

class GreengrassV2TypeDef(TypedDict):
    coreDeviceThingName: str,

SiemensIETypeDef#

# SiemensIETypeDef definition

class SiemensIETypeDef(TypedDict):
    iotCoreThingName: str,

GetAssetPropertyValueRequestRequestTypeDef#

# GetAssetPropertyValueRequestRequestTypeDef definition

class GetAssetPropertyValueRequestRequestTypeDef(TypedDict):
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],

GetInterpolatedAssetPropertyValuesRequestRequestTypeDef#

# GetInterpolatedAssetPropertyValuesRequestRequestTypeDef definition

class GetInterpolatedAssetPropertyValuesRequestRequestTypeDef(TypedDict):
    startTimeInSeconds: int,
    endTimeInSeconds: int,
    quality: QualityType,  # (1)
    intervalInSeconds: int,
    type: str,
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],
    startTimeOffsetInNanos: NotRequired[int],
    endTimeOffsetInNanos: NotRequired[int],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    intervalWindowInSeconds: NotRequired[int],

See QualityType

GroupIdentityTypeDef#

# GroupIdentityTypeDef definition

class GroupIdentityTypeDef(TypedDict):
    id: str,

IAMRoleIdentityTypeDef#

# IAMRoleIdentityTypeDef definition

class IAMRoleIdentityTypeDef(TypedDict):
    arn: str,

IAMUserIdentityTypeDef#

# IAMUserIdentityTypeDef definition

class IAMUserIdentityTypeDef(TypedDict):
    arn: str,

UserIdentityTypeDef#

# UserIdentityTypeDef definition

class UserIdentityTypeDef(TypedDict):
    id: str,

InternalFailureExceptionTypeDef#

# InternalFailureExceptionTypeDef definition

class InternalFailureExceptionTypeDef(TypedDict):
    message: str,

InvalidRequestExceptionTypeDef#

# InvalidRequestExceptionTypeDef definition

class InvalidRequestExceptionTypeDef(TypedDict):
    message: str,

InvokeAssistantRequestRequestTypeDef#

# InvokeAssistantRequestRequestTypeDef definition

class InvokeAssistantRequestRequestTypeDef(TypedDict):
    message: str,
    conversationId: NotRequired[str],
    enableTrace: NotRequired[bool],

JobSummaryTypeDef#

# JobSummaryTypeDef definition

class JobSummaryTypeDef(TypedDict):
    id: str,
    name: str,
    status: JobStatusType,  # (1)

See JobStatusType

KendraSourceDetailTypeDef#

# KendraSourceDetailTypeDef definition

class KendraSourceDetailTypeDef(TypedDict):
    knowledgeBaseArn: str,
    roleArn: str,

LimitExceededExceptionTypeDef#

# LimitExceededExceptionTypeDef definition

class LimitExceededExceptionTypeDef(TypedDict):
    message: str,

ListAccessPoliciesRequestRequestTypeDef#

# ListAccessPoliciesRequestRequestTypeDef definition

class ListAccessPoliciesRequestRequestTypeDef(TypedDict):
    identityType: NotRequired[IdentityTypeType],  # (1)
    identityId: NotRequired[str],
    resourceType: NotRequired[ResourceTypeType],  # (2)
    resourceId: NotRequired[str],
    iamArn: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

See IdentityTypeType
See ResourceTypeType

ListActionsRequestRequestTypeDef#

# ListActionsRequestRequestTypeDef definition

class ListActionsRequestRequestTypeDef(TypedDict):
    targetResourceType: TargetResourceTypeType,  # (1)
    targetResourceId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

See TargetResourceTypeType

ListAssetModelCompositeModelsRequestRequestTypeDef#

# ListAssetModelCompositeModelsRequestRequestTypeDef definition

class ListAssetModelCompositeModelsRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    assetModelVersion: NotRequired[str],

ListAssetModelPropertiesRequestRequestTypeDef#

# ListAssetModelPropertiesRequestRequestTypeDef definition

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

See ListAssetModelPropertiesFilterType

ListAssetModelsRequestRequestTypeDef#

# ListAssetModelsRequestRequestTypeDef definition

class ListAssetModelsRequestRequestTypeDef(TypedDict):
    assetModelTypes: NotRequired[Sequence[AssetModelTypeType]],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    assetModelVersion: NotRequired[str],

See AssetModelTypeType

ListAssetPropertiesRequestRequestTypeDef#

# ListAssetPropertiesRequestRequestTypeDef definition

class ListAssetPropertiesRequestRequestTypeDef(TypedDict):
    assetId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    filter: NotRequired[ListAssetPropertiesFilterType],  # (1)

See ListAssetPropertiesFilterType

ListAssetRelationshipsRequestRequestTypeDef#

# ListAssetRelationshipsRequestRequestTypeDef definition

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

See TraversalTypeType

ListAssetsRequestRequestTypeDef#

# ListAssetsRequestRequestTypeDef definition

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

See ListAssetsFilterType

ListAssociatedAssetsRequestRequestTypeDef#

# ListAssociatedAssetsRequestRequestTypeDef definition

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

See TraversalDirectionType

ListBulkImportJobsRequestRequestTypeDef#

# ListBulkImportJobsRequestRequestTypeDef definition

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

See ListBulkImportJobsFilterType

ListCompositionRelationshipsRequestRequestTypeDef#

# ListCompositionRelationshipsRequestRequestTypeDef definition

class ListCompositionRelationshipsRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDashboardsRequestRequestTypeDef#

# ListDashboardsRequestRequestTypeDef definition

class ListDashboardsRequestRequestTypeDef(TypedDict):
    projectId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDatasetsRequestRequestTypeDef#

# ListDatasetsRequestRequestTypeDef definition

class ListDatasetsRequestRequestTypeDef(TypedDict):
    sourceType: DatasetSourceTypeType,  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

See DatasetSourceTypeType

ListGatewaysRequestRequestTypeDef#

# ListGatewaysRequestRequestTypeDef definition

class ListGatewaysRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListPortalsRequestRequestTypeDef#

# ListPortalsRequestRequestTypeDef definition

class ListPortalsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListProjectAssetsRequestRequestTypeDef#

# ListProjectAssetsRequestRequestTypeDef definition

class ListProjectAssetsRequestRequestTypeDef(TypedDict):
    projectId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListProjectsRequestRequestTypeDef#

# ListProjectsRequestRequestTypeDef definition

class ListProjectsRequestRequestTypeDef(TypedDict):
    portalId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ProjectSummaryTypeDef#

# ProjectSummaryTypeDef definition

class ProjectSummaryTypeDef(TypedDict):
    id: str,
    name: str,
    description: NotRequired[str],
    creationDate: NotRequired[datetime],
    lastUpdateDate: NotRequired[datetime],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTimeSeriesRequestRequestTypeDef#

# ListTimeSeriesRequestRequestTypeDef definition

class ListTimeSeriesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    assetId: NotRequired[str],
    aliasPrefix: NotRequired[str],
    timeSeriesType: NotRequired[ListTimeSeriesTypeType],  # (1)

See ListTimeSeriesTypeType

TimeSeriesSummaryTypeDef#

# TimeSeriesSummaryTypeDef definition

class TimeSeriesSummaryTypeDef(TypedDict):
    timeSeriesId: str,
    dataType: PropertyDataTypeType,  # (1)
    timeSeriesCreationDate: datetime,
    timeSeriesLastUpdateDate: datetime,
    timeSeriesArn: str,
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    alias: NotRequired[str],
    dataTypeSpec: NotRequired[str],

See PropertyDataTypeType

LocationTypeDef#

# LocationTypeDef definition

class LocationTypeDef(TypedDict):
    uri: NotRequired[str],

MetricProcessingConfigTypeDef#

# MetricProcessingConfigTypeDef definition

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

See ComputeLocationType

TumblingWindowTypeDef#

# TumblingWindowTypeDef definition

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

MonitorErrorDetailsTypeDef#

# MonitorErrorDetailsTypeDef definition

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

See MonitorErrorCodeType

PortalResourceTypeDef#

# PortalResourceTypeDef definition

class PortalResourceTypeDef(TypedDict):
    id: str,

PortalTypeEntryTypeDef#

# PortalTypeEntryTypeDef definition

class PortalTypeEntryTypeDef(TypedDict):
    portalTools: NotRequired[Sequence[str]],

ProjectResourceTypeDef#

# ProjectResourceTypeDef definition

class ProjectResourceTypeDef(TypedDict):
    id: str,

PutDefaultEncryptionConfigurationRequestRequestTypeDef#

# PutDefaultEncryptionConfigurationRequestRequestTypeDef definition

class PutDefaultEncryptionConfigurationRequestRequestTypeDef(TypedDict):
    encryptionType: EncryptionTypeType,  # (1)
    kmsKeyId: NotRequired[str],

See EncryptionTypeType

ResourceNotFoundExceptionTypeDef#

# ResourceNotFoundExceptionTypeDef definition

class ResourceNotFoundExceptionTypeDef(TypedDict):
    message: str,

ThrottlingExceptionTypeDef#

# ThrottlingExceptionTypeDef definition

class ThrottlingExceptionTypeDef(TypedDict):
    message: str,

TraceTypeDef#

# TraceTypeDef definition

class TraceTypeDef(TypedDict):
    text: NotRequired[str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateAssetPropertyRequestRequestTypeDef#

# UpdateAssetPropertyRequestRequestTypeDef definition

class UpdateAssetPropertyRequestRequestTypeDef(TypedDict):
    assetId: str,
    propertyId: str,
    propertyAlias: NotRequired[str],
    propertyNotificationState: NotRequired[PropertyNotificationStateType],  # (1)
    clientToken: NotRequired[str],
    propertyUnit: NotRequired[str],

See PropertyNotificationStateType

UpdateAssetRequestRequestTypeDef#

# UpdateAssetRequestRequestTypeDef definition

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

UpdateDashboardRequestRequestTypeDef#

# UpdateDashboardRequestRequestTypeDef definition

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

UpdateGatewayCapabilityConfigurationRequestRequestTypeDef#

# UpdateGatewayCapabilityConfigurationRequestRequestTypeDef definition

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

UpdateGatewayRequestRequestTypeDef#

# UpdateGatewayRequestRequestTypeDef definition

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

UpdateProjectRequestRequestTypeDef#

# UpdateProjectRequestRequestTypeDef definition

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

ActionSummaryTypeDef#

# ActionSummaryTypeDef definition

class ActionSummaryTypeDef(TypedDict):
    actionId: NotRequired[str],
    actionDefinitionId: NotRequired[str],
    targetResource: NotRequired[TargetResourceTypeDef],  # (1)

See TargetResourceTypeDef

ExecuteActionRequestRequestTypeDef#

# ExecuteActionRequestRequestTypeDef definition

class ExecuteActionRequestRequestTypeDef(TypedDict):
    targetResource: TargetResourceTypeDef,  # (1)
    actionDefinitionId: str,
    actionPayload: ActionPayloadTypeDef,  # (2)
    clientToken: NotRequired[str],

See TargetResourceTypeDef
See ActionPayloadTypeDef

AggregatedValueTypeDef#

# AggregatedValueTypeDef definition

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

See QualityType
See AggregatesTypeDef

AssetCompositeModelSummaryTypeDef#

# AssetCompositeModelSummaryTypeDef definition

class AssetCompositeModelSummaryTypeDef(TypedDict):
    id: str,
    name: str,
    type: str,
    description: str,
    path: list[AssetCompositeModelPathSegmentTypeDef],  # (1)
    externalId: NotRequired[str],

See AssetCompositeModelPathSegmentTypeDef

AssetRelationshipSummaryTypeDef#

# AssetRelationshipSummaryTypeDef definition

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

See AssetHierarchyInfoTypeDef
See AssetRelationshipTypeType

AssetModelCompositeModelSummaryTypeDef#

# AssetModelCompositeModelSummaryTypeDef definition

class AssetModelCompositeModelSummaryTypeDef(TypedDict):
    id: str,
    name: str,
    type: str,
    externalId: NotRequired[str],
    description: NotRequired[str],
    path: NotRequired[list[AssetModelCompositeModelPathSegmentTypeDef]],  # (1)

See AssetModelCompositeModelPathSegmentTypeDef

VariableValueOutputTypeDef#

# VariableValueOutputTypeDef definition

class VariableValueOutputTypeDef(TypedDict):
    propertyId: NotRequired[str],
    hierarchyId: NotRequired[str],
    propertyPath: NotRequired[list[AssetModelPropertyPathSegmentTypeDef]],  # (1)

See AssetModelPropertyPathSegmentTypeDef

VariableValueTypeDef#

# VariableValueTypeDef definition

class VariableValueTypeDef(TypedDict):
    propertyId: NotRequired[str],
    hierarchyId: NotRequired[str],
    propertyPath: NotRequired[Sequence[AssetModelPropertyPathSegmentTypeDef]],  # (1)

See AssetModelPropertyPathSegmentTypeDef

AssetPropertySummaryTypeDef#

# AssetPropertySummaryTypeDef definition

class AssetPropertySummaryTypeDef(TypedDict):
    id: str,
    alias: NotRequired[str],
    unit: NotRequired[str],
    notification: NotRequired[PropertyNotificationTypeDef],  # (1)
    assetCompositeModelId: NotRequired[str],
    path: NotRequired[list[AssetPropertyPathSegmentTypeDef]],  # (2)
    externalId: NotRequired[str],

AssetPropertyTypeDef#

# AssetPropertyTypeDef definition

class AssetPropertyTypeDef(TypedDict):
    id: str,
    name: str,
    dataType: PropertyDataTypeType,  # (2)
    alias: NotRequired[str],
    notification: NotRequired[PropertyNotificationTypeDef],  # (1)
    dataTypeSpec: NotRequired[str],
    unit: NotRequired[str],
    path: NotRequired[list[AssetPropertyPathSegmentTypeDef]],  # (3)
    externalId: NotRequired[str],

BatchPutAssetPropertyErrorTypeDef#

# BatchPutAssetPropertyErrorTypeDef definition

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

AssetPropertyValueTypeDef#

# AssetPropertyValueTypeDef definition

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

InterpolatedAssetPropertyValueTypeDef#

# InterpolatedAssetPropertyValueTypeDef definition

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

See TimeInNanosTypeDef
See VariantTypeDef

BatchAssociateProjectAssetsResponseTypeDef#

# BatchAssociateProjectAssetsResponseTypeDef definition

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

See AssetErrorDetailsTypeDef
See ResponseMetadataTypeDef

BatchDisassociateProjectAssetsResponseTypeDef#

# BatchDisassociateProjectAssetsResponseTypeDef definition

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

See AssetErrorDetailsTypeDef
See ResponseMetadataTypeDef

CreateAccessPolicyResponseTypeDef#

# CreateAccessPolicyResponseTypeDef definition

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

See ResponseMetadataTypeDef

CreateBulkImportJobResponseTypeDef#

# CreateBulkImportJobResponseTypeDef definition

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

See JobStatusType
See ResponseMetadataTypeDef

CreateDashboardResponseTypeDef#

# CreateDashboardResponseTypeDef definition

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

See ResponseMetadataTypeDef

CreateGatewayResponseTypeDef#

# CreateGatewayResponseTypeDef definition

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

See ResponseMetadataTypeDef

CreateProjectResponseTypeDef#

# CreateProjectResponseTypeDef definition

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

See ResponseMetadataTypeDef

DescribeActionResponseTypeDef#

# DescribeActionResponseTypeDef definition

class DescribeActionResponseTypeDef(TypedDict):
    actionId: str,
    targetResource: TargetResourceTypeDef,  # (1)
    actionDefinitionId: str,
    actionPayload: ActionPayloadTypeDef,  # (2)
    executionTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

DescribeDashboardResponseTypeDef#

# DescribeDashboardResponseTypeDef definition

class DescribeDashboardResponseTypeDef(TypedDict):
    dashboardId: str,
    dashboardArn: str,
    dashboardName: str,
    projectId: str,
    dashboardDescription: str,
    dashboardDefinition: str,
    dashboardCreationDate: datetime,
    dashboardLastUpdateDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

DescribeGatewayCapabilityConfigurationResponseTypeDef#

# DescribeGatewayCapabilityConfigurationResponseTypeDef definition

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

See CapabilitySyncStatusType
See ResponseMetadataTypeDef

DescribeProjectResponseTypeDef#

# DescribeProjectResponseTypeDef definition

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

See ResponseMetadataTypeDef

DescribeTimeSeriesResponseTypeDef#

# DescribeTimeSeriesResponseTypeDef definition

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

See PropertyDataTypeType
See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

See ResponseMetadataTypeDef

ExecuteActionResponseTypeDef#

# ExecuteActionResponseTypeDef definition

class ExecuteActionResponseTypeDef(TypedDict):
    actionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

See ResponseMetadataTypeDef

ListProjectAssetsResponseTypeDef#

# ListProjectAssetsResponseTypeDef definition

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

See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

See ResponseMetadataTypeDef

UpdateGatewayCapabilityConfigurationResponseTypeDef#

# UpdateGatewayCapabilityConfigurationResponseTypeDef definition

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

See CapabilitySyncStatusType
See ResponseMetadataTypeDef

BatchGetAssetPropertyAggregatesEntryTypeDef#

# BatchGetAssetPropertyAggregatesEntryTypeDef definition

class BatchGetAssetPropertyAggregatesEntryTypeDef(TypedDict):
    entryId: str,
    aggregateTypes: Sequence[AggregateTypeType],  # (1)
    resolution: str,
    startDate: TimestampTypeDef,
    endDate: TimestampTypeDef,
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],
    qualities: NotRequired[Sequence[QualityType]],  # (2)
    timeOrdering: NotRequired[TimeOrderingType],  # (3)

BatchGetAssetPropertyValueHistoryEntryTypeDef#

# BatchGetAssetPropertyValueHistoryEntryTypeDef definition

class BatchGetAssetPropertyValueHistoryEntryTypeDef(TypedDict):
    entryId: str,
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],
    startDate: NotRequired[TimestampTypeDef],
    endDate: NotRequired[TimestampTypeDef],
    qualities: NotRequired[Sequence[QualityType]],  # (1)
    timeOrdering: NotRequired[TimeOrderingType],  # (2)

See QualityType
See TimeOrderingType

GetAssetPropertyAggregatesRequestRequestTypeDef#

# GetAssetPropertyAggregatesRequestRequestTypeDef definition

class GetAssetPropertyAggregatesRequestRequestTypeDef(TypedDict):
    aggregateTypes: Sequence[AggregateTypeType],  # (1)
    resolution: str,
    startDate: TimestampTypeDef,
    endDate: TimestampTypeDef,
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],
    qualities: NotRequired[Sequence[QualityType]],  # (2)
    timeOrdering: NotRequired[TimeOrderingType],  # (3)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

GetAssetPropertyValueHistoryRequestRequestTypeDef#

# GetAssetPropertyValueHistoryRequestRequestTypeDef definition

class GetAssetPropertyValueHistoryRequestRequestTypeDef(TypedDict):
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],
    startDate: NotRequired[TimestampTypeDef],
    endDate: NotRequired[TimestampTypeDef],
    qualities: NotRequired[Sequence[QualityType]],  # (1)
    timeOrdering: NotRequired[TimeOrderingType],  # (2)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

See QualityType
See TimeOrderingType

BatchGetAssetPropertyAggregatesSkippedEntryTypeDef#

# BatchGetAssetPropertyAggregatesSkippedEntryTypeDef definition

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

BatchGetAssetPropertyValueRequestRequestTypeDef#

# BatchGetAssetPropertyValueRequestRequestTypeDef definition

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

See BatchGetAssetPropertyValueEntryTypeDef

BatchGetAssetPropertyValueSkippedEntryTypeDef#

# BatchGetAssetPropertyValueSkippedEntryTypeDef definition

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

BatchGetAssetPropertyValueHistorySkippedEntryTypeDef#

# BatchGetAssetPropertyValueHistorySkippedEntryTypeDef definition

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

ImageFileTypeDef#

# ImageFileTypeDef definition

class ImageFileTypeDef(TypedDict):
    data: BlobTypeDef,
    type: ImageFileTypeType,  # (1)

See ImageFileTypeType

ColumnInfoTypeDef#

# ColumnInfoTypeDef definition

class ColumnInfoTypeDef(TypedDict):
    name: NotRequired[str],
    type: NotRequired[ColumnTypeTypeDef],  # (1)

See ColumnTypeTypeDef

CompositionDetailsTypeDef#

# CompositionDetailsTypeDef definition

class CompositionDetailsTypeDef(TypedDict):
    compositionRelationship: NotRequired[list[CompositionRelationshipItemTypeDef]],  # (1)

See CompositionRelationshipItemTypeDef

ListCompositionRelationshipsResponseTypeDef#

# ListCompositionRelationshipsResponseTypeDef definition

class ListCompositionRelationshipsResponseTypeDef(TypedDict):
    compositionRelationshipSummaries: list[CompositionRelationshipSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

ConfigurationStatusTypeDef#

# ConfigurationStatusTypeDef definition

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

See ConfigurationStateType
See ConfigurationErrorDetailsTypeDef

FileFormatOutputTypeDef#

# FileFormatOutputTypeDef definition

class FileFormatOutputTypeDef(TypedDict):
    csv: NotRequired[CsvOutputTypeDef],  # (1)
    parquet: NotRequired[dict[str, Any]],

See CsvOutputTypeDef

MultiLayerStorageTypeDef#

# MultiLayerStorageTypeDef definition

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

See CustomerManagedS3StorageTypeDef

ListDashboardsResponseTypeDef#

# ListDashboardsResponseTypeDef definition

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

See DashboardSummaryTypeDef
See ResponseMetadataTypeDef

RowPaginatorTypeDef#

# RowPaginatorTypeDef definition

class RowPaginatorTypeDef(TypedDict):
    data: list[DatumPaginatorTypeDef],  # (1)

See DatumPaginatorTypeDef

RowTypeDef#

# RowTypeDef definition

class RowTypeDef(TypedDict):
    data: list[DatumTypeDef],  # (1)

See DatumTypeDef

RowWaiterTypeDef#

# RowWaiterTypeDef definition

class RowWaiterTypeDef(TypedDict):
    data: list[DatumWaiterTypeDef],  # (1)

See DatumWaiterTypeDef

DescribeAssetModelRequestWaitTypeDef#

# DescribeAssetModelRequestWaitTypeDef definition

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

See WaiterConfigTypeDef

DescribeAssetRequestWaitTypeDef#

# DescribeAssetRequestWaitTypeDef definition

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

See WaiterConfigTypeDef

DescribePortalRequestWaitTypeDef#

# DescribePortalRequestWaitTypeDef definition

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

See WaiterConfigTypeDef

DescribeLoggingOptionsResponseTypeDef#

# DescribeLoggingOptionsResponseTypeDef definition

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

See LoggingOptionsTypeDef
See ResponseMetadataTypeDef

PutLoggingOptionsRequestRequestTypeDef#

# PutLoggingOptionsRequestRequestTypeDef definition

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

See LoggingOptionsTypeDef

ErrorDetailsTypeDef#

# ErrorDetailsTypeDef definition

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

See ErrorCodeType
See DetailedErrorTypeDef

ExecuteQueryRequestPaginateTypeDef#

# ExecuteQueryRequestPaginateTypeDef definition

class ExecuteQueryRequestPaginateTypeDef(TypedDict):
    queryStatement: str,
    clientToken: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

GetAssetPropertyAggregatesRequestPaginateTypeDef#

# GetAssetPropertyAggregatesRequestPaginateTypeDef definition

class GetAssetPropertyAggregatesRequestPaginateTypeDef(TypedDict):
    aggregateTypes: Sequence[AggregateTypeType],  # (1)
    resolution: str,
    startDate: TimestampTypeDef,
    endDate: TimestampTypeDef,
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],
    qualities: NotRequired[Sequence[QualityType]],  # (2)
    timeOrdering: NotRequired[TimeOrderingType],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)

GetAssetPropertyValueHistoryRequestPaginateTypeDef#

# GetAssetPropertyValueHistoryRequestPaginateTypeDef definition

class GetAssetPropertyValueHistoryRequestPaginateTypeDef(TypedDict):
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],
    startDate: NotRequired[TimestampTypeDef],
    endDate: NotRequired[TimestampTypeDef],
    qualities: NotRequired[Sequence[QualityType]],  # (1)
    timeOrdering: NotRequired[TimeOrderingType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)

GetInterpolatedAssetPropertyValuesRequestPaginateTypeDef#

# GetInterpolatedAssetPropertyValuesRequestPaginateTypeDef definition

class GetInterpolatedAssetPropertyValuesRequestPaginateTypeDef(TypedDict):
    startTimeInSeconds: int,
    endTimeInSeconds: int,
    quality: QualityType,  # (1)
    intervalInSeconds: int,
    type: str,
    assetId: NotRequired[str],
    propertyId: NotRequired[str],
    propertyAlias: NotRequired[str],
    startTimeOffsetInNanos: NotRequired[int],
    endTimeOffsetInNanos: NotRequired[int],
    intervalWindowInSeconds: NotRequired[int],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

See QualityType
See PaginatorConfigTypeDef

ListAccessPoliciesRequestPaginateTypeDef#

# ListAccessPoliciesRequestPaginateTypeDef definition

class ListAccessPoliciesRequestPaginateTypeDef(TypedDict):
    identityType: NotRequired[IdentityTypeType],  # (1)
    identityId: NotRequired[str],
    resourceType: NotRequired[ResourceTypeType],  # (2)
    resourceId: NotRequired[str],
    iamArn: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)

ListActionsRequestPaginateTypeDef#

# ListActionsRequestPaginateTypeDef definition

class ListActionsRequestPaginateTypeDef(TypedDict):
    targetResourceType: TargetResourceTypeType,  # (1)
    targetResourceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

See TargetResourceTypeType
See PaginatorConfigTypeDef

ListAssetModelCompositeModelsRequestPaginateTypeDef#

# ListAssetModelCompositeModelsRequestPaginateTypeDef definition

class ListAssetModelCompositeModelsRequestPaginateTypeDef(TypedDict):
    assetModelId: str,
    assetModelVersion: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListAssetModelPropertiesRequestPaginateTypeDef#

# ListAssetModelPropertiesRequestPaginateTypeDef definition

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

See ListAssetModelPropertiesFilterType
See PaginatorConfigTypeDef

ListAssetModelsRequestPaginateTypeDef#

# ListAssetModelsRequestPaginateTypeDef definition

class ListAssetModelsRequestPaginateTypeDef(TypedDict):
    assetModelTypes: NotRequired[Sequence[AssetModelTypeType]],  # (1)
    assetModelVersion: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

See AssetModelTypeType
See PaginatorConfigTypeDef

ListAssetPropertiesRequestPaginateTypeDef#

# ListAssetPropertiesRequestPaginateTypeDef definition

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

See ListAssetPropertiesFilterType
See PaginatorConfigTypeDef

ListAssetRelationshipsRequestPaginateTypeDef#

# ListAssetRelationshipsRequestPaginateTypeDef definition

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

See TraversalTypeType
See PaginatorConfigTypeDef

ListAssetsRequestPaginateTypeDef#

# ListAssetsRequestPaginateTypeDef definition

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

See ListAssetsFilterType
See PaginatorConfigTypeDef

ListAssociatedAssetsRequestPaginateTypeDef#

# ListAssociatedAssetsRequestPaginateTypeDef definition

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

See TraversalDirectionType
See PaginatorConfigTypeDef

ListBulkImportJobsRequestPaginateTypeDef#

# ListBulkImportJobsRequestPaginateTypeDef definition

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

See ListBulkImportJobsFilterType
See PaginatorConfigTypeDef

ListCompositionRelationshipsRequestPaginateTypeDef#

# ListCompositionRelationshipsRequestPaginateTypeDef definition

class ListCompositionRelationshipsRequestPaginateTypeDef(TypedDict):
    assetModelId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

See PaginatorConfigTypeDef

ListDashboardsRequestPaginateTypeDef#

# ListDashboardsRequestPaginateTypeDef definition

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

See PaginatorConfigTypeDef

ListDatasetsRequestPaginateTypeDef#

# ListDatasetsRequestPaginateTypeDef definition

class ListDatasetsRequestPaginateTypeDef(TypedDict):
    sourceType: DatasetSourceTypeType,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

See DatasetSourceTypeType
See PaginatorConfigTypeDef

ListGatewaysRequestPaginateTypeDef#

# ListGatewaysRequestPaginateTypeDef definition

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

See PaginatorConfigTypeDef

ListPortalsRequestPaginateTypeDef#

# ListPortalsRequestPaginateTypeDef definition

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

See PaginatorConfigTypeDef

ListProjectAssetsRequestPaginateTypeDef#

# ListProjectAssetsRequestPaginateTypeDef definition

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

See PaginatorConfigTypeDef

ListProjectsRequestPaginateTypeDef#

# ListProjectsRequestPaginateTypeDef definition

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

See PaginatorConfigTypeDef

ListTimeSeriesRequestPaginateTypeDef#

# ListTimeSeriesRequestPaginateTypeDef definition

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

See ListTimeSeriesTypeType
See PaginatorConfigTypeDef

MeasurementProcessingConfigTypeDef#

# MeasurementProcessingConfigTypeDef definition

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

See ForwardingConfigTypeDef

TransformProcessingConfigTypeDef#

# TransformProcessingConfigTypeDef definition

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

See ComputeLocationType
See ForwardingConfigTypeDef

GatewayPlatformTypeDef#

# GatewayPlatformTypeDef definition

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

IdentityTypeDef#

# IdentityTypeDef definition

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

ListBulkImportJobsResponseTypeDef#

# ListBulkImportJobsResponseTypeDef definition

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

See JobSummaryTypeDef
See ResponseMetadataTypeDef

SourceDetailTypeDef#

# SourceDetailTypeDef definition

class SourceDetailTypeDef(TypedDict):
    kendra: NotRequired[KendraSourceDetailTypeDef],  # (1)

See KendraSourceDetailTypeDef

ListProjectsResponseTypeDef#

# ListProjectsResponseTypeDef definition

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

See ProjectSummaryTypeDef
See ResponseMetadataTypeDef

ListTimeSeriesResponseTypeDef#

# ListTimeSeriesResponseTypeDef definition

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

See TimeSeriesSummaryTypeDef
See ResponseMetadataTypeDef

SourceTypeDef#

# SourceTypeDef definition

class SourceTypeDef(TypedDict):
    arn: NotRequired[str],
    location: NotRequired[LocationTypeDef],  # (1)

See LocationTypeDef

MetricWindowTypeDef#

# MetricWindowTypeDef definition

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

See TumblingWindowTypeDef

PortalStatusTypeDef#

# PortalStatusTypeDef definition

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

See PortalStateType
See MonitorErrorDetailsTypeDef

ResourceTypeDef#

# ResourceTypeDef definition

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

See PortalResourceTypeDef
See ProjectResourceTypeDef

ListActionsResponseTypeDef#

# ListActionsResponseTypeDef definition

class ListActionsResponseTypeDef(TypedDict):
    actionSummaries: list[ActionSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ActionSummaryTypeDef
See ResponseMetadataTypeDef

BatchGetAssetPropertyAggregatesSuccessEntryTypeDef#

# BatchGetAssetPropertyAggregatesSuccessEntryTypeDef definition

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

See AggregatedValueTypeDef

GetAssetPropertyAggregatesResponseTypeDef#

# GetAssetPropertyAggregatesResponseTypeDef definition

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

See AggregatedValueTypeDef
See ResponseMetadataTypeDef

ListAssetRelationshipsResponseTypeDef#

# ListAssetRelationshipsResponseTypeDef definition

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

See AssetRelationshipSummaryTypeDef
See ResponseMetadataTypeDef

ListAssetModelCompositeModelsResponseTypeDef#

# ListAssetModelCompositeModelsResponseTypeDef definition

class ListAssetModelCompositeModelsResponseTypeDef(TypedDict):
    assetModelCompositeModelSummaries: list[AssetModelCompositeModelSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

ExpressionVariableOutputTypeDef#

# ExpressionVariableOutputTypeDef definition

class ExpressionVariableOutputTypeDef(TypedDict):
    name: str,
    value: VariableValueOutputTypeDef,  # (1)

See VariableValueOutputTypeDef

ListAssetPropertiesResponseTypeDef#

# ListAssetPropertiesResponseTypeDef definition

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

See AssetPropertySummaryTypeDef
See ResponseMetadataTypeDef

AssetCompositeModelTypeDef#

# AssetCompositeModelTypeDef definition

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

See AssetPropertyTypeDef

DescribeAssetCompositeModelResponseTypeDef#

# DescribeAssetCompositeModelResponseTypeDef definition

class DescribeAssetCompositeModelResponseTypeDef(TypedDict):
    assetId: str,
    assetCompositeModelId: str,
    assetCompositeModelExternalId: str,
    assetCompositeModelPath: list[AssetCompositeModelPathSegmentTypeDef],  # (1)
    assetCompositeModelName: str,
    assetCompositeModelDescription: str,
    assetCompositeModelType: str,
    assetCompositeModelProperties: list[AssetPropertyTypeDef],  # (2)
    assetCompositeModelSummaries: list[AssetCompositeModelSummaryTypeDef],  # (3)
    actionDefinitions: list[ActionDefinitionTypeDef],  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)

See AssetCompositeModelPathSegmentTypeDef
See AssetPropertyTypeDef
See AssetCompositeModelSummaryTypeDef
See ActionDefinitionTypeDef
See ResponseMetadataTypeDef

BatchPutAssetPropertyErrorEntryTypeDef#

# BatchPutAssetPropertyErrorEntryTypeDef definition

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

See BatchPutAssetPropertyErrorTypeDef

BatchGetAssetPropertyValueHistorySuccessEntryTypeDef#

# BatchGetAssetPropertyValueHistorySuccessEntryTypeDef definition

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

See AssetPropertyValueTypeDef

BatchGetAssetPropertyValueSuccessEntryTypeDef#

# BatchGetAssetPropertyValueSuccessEntryTypeDef definition

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

See AssetPropertyValueTypeDef

GetAssetPropertyValueHistoryResponseTypeDef#

# GetAssetPropertyValueHistoryResponseTypeDef definition

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

See AssetPropertyValueTypeDef
See ResponseMetadataTypeDef

GetAssetPropertyValueResponseTypeDef#

# GetAssetPropertyValueResponseTypeDef definition

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

See AssetPropertyValueTypeDef
See ResponseMetadataTypeDef

PutAssetPropertyValueEntryTypeDef#

# PutAssetPropertyValueEntryTypeDef definition

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

See AssetPropertyValueTypeDef

GetInterpolatedAssetPropertyValuesResponseTypeDef#

# GetInterpolatedAssetPropertyValuesResponseTypeDef definition

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

BatchGetAssetPropertyAggregatesRequestRequestTypeDef#

# BatchGetAssetPropertyAggregatesRequestRequestTypeDef definition

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

See BatchGetAssetPropertyAggregatesEntryTypeDef

BatchGetAssetPropertyValueHistoryRequestRequestTypeDef#

# BatchGetAssetPropertyValueHistoryRequestRequestTypeDef definition

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

See BatchGetAssetPropertyValueHistoryEntryTypeDef

ImageTypeDef#

# ImageTypeDef definition

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

See ImageFileTypeDef

DescribeDefaultEncryptionConfigurationResponseTypeDef#

# DescribeDefaultEncryptionConfigurationResponseTypeDef definition

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

PutDefaultEncryptionConfigurationResponseTypeDef#

# PutDefaultEncryptionConfigurationResponseTypeDef definition

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

JobConfigurationOutputTypeDef#

# JobConfigurationOutputTypeDef definition

class JobConfigurationOutputTypeDef(TypedDict):
    fileFormat: FileFormatOutputTypeDef,  # (1)

See FileFormatOutputTypeDef

FileFormatTypeDef#

# FileFormatTypeDef definition

class FileFormatTypeDef(TypedDict):
    csv: NotRequired[CsvUnionTypeDef],  # (1)
    parquet: NotRequired[Mapping[str, Any]],

See CsvTypeDef CsvOutputTypeDef

DescribeStorageConfigurationResponseTypeDef#

# DescribeStorageConfigurationResponseTypeDef definition

class DescribeStorageConfigurationResponseTypeDef(TypedDict):
    storageType: StorageTypeType,  # (1)
    multiLayerStorage: MultiLayerStorageTypeDef,  # (2)
    disassociatedDataStorage: DisassociatedDataStorageStateType,  # (3)
    retentionPeriod: RetentionPeriodTypeDef,  # (4)
    configurationStatus: ConfigurationStatusTypeDef,  # (5)
    lastUpdateDate: datetime,
    warmTier: WarmTierStateType,  # (6)
    warmTierRetentionPeriod: WarmTierRetentionPeriodTypeDef,  # (7)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)

PutStorageConfigurationRequestRequestTypeDef#

# PutStorageConfigurationRequestRequestTypeDef definition

class PutStorageConfigurationRequestRequestTypeDef(TypedDict):
    storageType: StorageTypeType,  # (1)
    multiLayerStorage: NotRequired[MultiLayerStorageTypeDef],  # (2)
    disassociatedDataStorage: NotRequired[DisassociatedDataStorageStateType],  # (3)
    retentionPeriod: NotRequired[RetentionPeriodTypeDef],  # (4)
    warmTier: NotRequired[WarmTierStateType],  # (5)
    warmTierRetentionPeriod: NotRequired[WarmTierRetentionPeriodTypeDef],  # (6)

PutStorageConfigurationResponseTypeDef#

# PutStorageConfigurationResponseTypeDef definition

class PutStorageConfigurationResponseTypeDef(TypedDict):
    storageType: StorageTypeType,  # (1)
    multiLayerStorage: MultiLayerStorageTypeDef,  # (2)
    disassociatedDataStorage: DisassociatedDataStorageStateType,  # (3)
    retentionPeriod: RetentionPeriodTypeDef,  # (4)
    configurationStatus: ConfigurationStatusTypeDef,  # (5)
    warmTier: WarmTierStateType,  # (6)
    warmTierRetentionPeriod: WarmTierRetentionPeriodTypeDef,  # (7)
    ResponseMetadata: ResponseMetadataTypeDef,  # (8)

ExecuteQueryResponsePaginatorTypeDef#

# ExecuteQueryResponsePaginatorTypeDef definition

class ExecuteQueryResponsePaginatorTypeDef(TypedDict):
    columns: list[ColumnInfoTypeDef],  # (1)
    rows: list[RowPaginatorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    nextToken: NotRequired[str],

ExecuteQueryResponseTypeDef#

# ExecuteQueryResponseTypeDef definition

class ExecuteQueryResponseTypeDef(TypedDict):
    columns: list[ColumnInfoTypeDef],  # (1)
    rows: list[RowTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    nextToken: NotRequired[str],

ExecuteQueryResponseWaiterTypeDef#

# ExecuteQueryResponseWaiterTypeDef definition

class ExecuteQueryResponseWaiterTypeDef(TypedDict):
    columns: list[ColumnInfoTypeDef],  # (1)
    rows: list[RowWaiterTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    nextToken: NotRequired[str],

AssetModelStatusTypeDef#

# AssetModelStatusTypeDef definition

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

See AssetModelStateType
See ErrorDetailsTypeDef

AssetStatusTypeDef#

# AssetStatusTypeDef definition

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

See AssetStateType
See ErrorDetailsTypeDef

DatasetStatusTypeDef#

# DatasetStatusTypeDef definition

class DatasetStatusTypeDef(TypedDict):
    state: DatasetStateType,  # (1)
    error: NotRequired[ErrorDetailsTypeDef],  # (2)

See DatasetStateType
See ErrorDetailsTypeDef

MeasurementTypeDef#

# MeasurementTypeDef definition

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

See MeasurementProcessingConfigTypeDef

CreateGatewayRequestRequestTypeDef#

# CreateGatewayRequestRequestTypeDef definition

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

See GatewayPlatformTypeDef

DescribeGatewayResponseTypeDef#

# DescribeGatewayResponseTypeDef definition

class DescribeGatewayResponseTypeDef(TypedDict):
    gatewayId: str,
    gatewayName: str,
    gatewayArn: str,
    gatewayPlatform: GatewayPlatformTypeDef,  # (1)
    gatewayCapabilitySummaries: list[GatewayCapabilitySummaryTypeDef],  # (2)
    creationDate: datetime,
    lastUpdateDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

GatewaySummaryTypeDef#

# GatewaySummaryTypeDef definition

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

See GatewayPlatformTypeDef
See GatewayCapabilitySummaryTypeDef

DatasetSourceTypeDef#

# DatasetSourceTypeDef definition

class DatasetSourceTypeDef(TypedDict):
    sourceType: DatasetSourceTypeType,  # (1)
    sourceFormat: DatasetSourceFormatType,  # (2)
    sourceDetail: NotRequired[SourceDetailTypeDef],  # (3)

DataSetReferenceTypeDef#

# DataSetReferenceTypeDef definition

class DataSetReferenceTypeDef(TypedDict):
    datasetArn: NotRequired[str],
    source: NotRequired[SourceTypeDef],  # (1)

See SourceTypeDef

CreatePortalResponseTypeDef#

# CreatePortalResponseTypeDef definition

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

See PortalStatusTypeDef
See ResponseMetadataTypeDef

DeletePortalResponseTypeDef#

# DeletePortalResponseTypeDef definition

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

See PortalStatusTypeDef
See ResponseMetadataTypeDef

DescribePortalResponseTypeDef#

# DescribePortalResponseTypeDef definition

class DescribePortalResponseTypeDef(TypedDict):
    portalId: str,
    portalArn: str,
    portalName: str,
    portalDescription: str,
    portalClientId: str,
    portalStartUrl: str,
    portalContactEmail: str,
    portalStatus: PortalStatusTypeDef,  # (1)
    portalCreationDate: datetime,
    portalLastUpdateDate: datetime,
    portalLogoImageLocation: ImageLocationTypeDef,  # (2)
    roleArn: str,
    portalAuthMode: AuthModeType,  # (3)
    notificationSenderEmail: str,
    alarms: AlarmsTypeDef,  # (4)
    portalType: PortalTypeType,  # (5)
    portalTypeConfiguration: dict[str, PortalTypeEntryOutputTypeDef],  # (6)
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)

PortalSummaryTypeDef#

# PortalSummaryTypeDef definition

class PortalSummaryTypeDef(TypedDict):
    id: str,
    name: str,
    startUrl: str,
    status: PortalStatusTypeDef,  # (1)
    description: NotRequired[str],
    creationDate: NotRequired[datetime],
    lastUpdateDate: NotRequired[datetime],
    roleArn: NotRequired[str],
    portalType: NotRequired[PortalTypeType],  # (2)

See PortalStatusTypeDef
See PortalTypeType

UpdatePortalResponseTypeDef#

# UpdatePortalResponseTypeDef definition

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

See PortalStatusTypeDef
See ResponseMetadataTypeDef

CreatePortalRequestRequestTypeDef#

# CreatePortalRequestRequestTypeDef definition

class CreatePortalRequestRequestTypeDef(TypedDict):
    portalName: str,
    portalContactEmail: str,
    roleArn: str,
    portalDescription: NotRequired[str],
    clientToken: NotRequired[str],
    portalLogoImageFile: NotRequired[ImageFileTypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],
    portalAuthMode: NotRequired[AuthModeType],  # (2)
    notificationSenderEmail: NotRequired[str],
    alarms: NotRequired[AlarmsTypeDef],  # (3)
    portalType: NotRequired[PortalTypeType],  # (4)
    portalTypeConfiguration: NotRequired[Mapping[str, PortalTypeEntryUnionTypeDef]],  # (5)

See ImageFileTypeDef
See AuthModeType
See AlarmsTypeDef
See PortalTypeType
See PortalTypeEntryTypeDef PortalTypeEntryOutputTypeDef

AccessPolicySummaryTypeDef#

# AccessPolicySummaryTypeDef definition

class AccessPolicySummaryTypeDef(TypedDict):
    id: str,
    identity: IdentityTypeDef,  # (1)
    resource: ResourceTypeDef,  # (2)
    permission: PermissionType,  # (3)
    creationDate: NotRequired[datetime],
    lastUpdateDate: NotRequired[datetime],

CreateAccessPolicyRequestRequestTypeDef#

# CreateAccessPolicyRequestRequestTypeDef definition

class CreateAccessPolicyRequestRequestTypeDef(TypedDict):
    accessPolicyIdentity: IdentityTypeDef,  # (1)
    accessPolicyResource: ResourceTypeDef,  # (2)
    accessPolicyPermission: PermissionType,  # (3)
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

DescribeAccessPolicyResponseTypeDef#

# DescribeAccessPolicyResponseTypeDef definition

class DescribeAccessPolicyResponseTypeDef(TypedDict):
    accessPolicyId: str,
    accessPolicyArn: str,
    accessPolicyIdentity: IdentityTypeDef,  # (1)
    accessPolicyResource: ResourceTypeDef,  # (2)
    accessPolicyPermission: PermissionType,  # (3)
    accessPolicyCreationDate: datetime,
    accessPolicyLastUpdateDate: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

UpdateAccessPolicyRequestRequestTypeDef#

# UpdateAccessPolicyRequestRequestTypeDef definition

class UpdateAccessPolicyRequestRequestTypeDef(TypedDict):
    accessPolicyId: str,
    accessPolicyIdentity: IdentityTypeDef,  # (1)
    accessPolicyResource: ResourceTypeDef,  # (2)
    accessPolicyPermission: PermissionType,  # (3)
    clientToken: NotRequired[str],

BatchGetAssetPropertyAggregatesResponseTypeDef#

# BatchGetAssetPropertyAggregatesResponseTypeDef definition

class BatchGetAssetPropertyAggregatesResponseTypeDef(TypedDict):
    errorEntries: list[BatchGetAssetPropertyAggregatesErrorEntryTypeDef],  # (1)
    successEntries: list[BatchGetAssetPropertyAggregatesSuccessEntryTypeDef],  # (2)
    skippedEntries: list[BatchGetAssetPropertyAggregatesSkippedEntryTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
    nextToken: NotRequired[str],

MetricOutputTypeDef#

# MetricOutputTypeDef definition

class MetricOutputTypeDef(TypedDict):
    expression: str,
    variables: list[ExpressionVariableOutputTypeDef],  # (1)
    window: MetricWindowTypeDef,  # (2)
    processingConfig: NotRequired[MetricProcessingConfigTypeDef],  # (3)

TransformOutputTypeDef#

# TransformOutputTypeDef definition

class TransformOutputTypeDef(TypedDict):
    expression: str,
    variables: list[ExpressionVariableOutputTypeDef],  # (1)
    processingConfig: NotRequired[TransformProcessingConfigTypeDef],  # (2)

ExpressionVariableTypeDef#

# ExpressionVariableTypeDef definition

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

See VariableValueTypeDef VariableValueOutputTypeDef

BatchPutAssetPropertyValueResponseTypeDef#

# BatchPutAssetPropertyValueResponseTypeDef definition

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

BatchGetAssetPropertyValueHistoryResponseTypeDef#

# BatchGetAssetPropertyValueHistoryResponseTypeDef definition

class BatchGetAssetPropertyValueHistoryResponseTypeDef(TypedDict):
    errorEntries: list[BatchGetAssetPropertyValueHistoryErrorEntryTypeDef],  # (1)
    successEntries: list[BatchGetAssetPropertyValueHistorySuccessEntryTypeDef],  # (2)
    skippedEntries: list[BatchGetAssetPropertyValueHistorySkippedEntryTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
    nextToken: NotRequired[str],

BatchGetAssetPropertyValueResponseTypeDef#

# BatchGetAssetPropertyValueResponseTypeDef definition

class BatchGetAssetPropertyValueResponseTypeDef(TypedDict):
    errorEntries: list[BatchGetAssetPropertyValueErrorEntryTypeDef],  # (1)
    successEntries: list[BatchGetAssetPropertyValueSuccessEntryTypeDef],  # (2)
    skippedEntries: list[BatchGetAssetPropertyValueSkippedEntryTypeDef],  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
    nextToken: NotRequired[str],

BatchPutAssetPropertyValueRequestRequestTypeDef#

# BatchPutAssetPropertyValueRequestRequestTypeDef definition

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

See PutAssetPropertyValueEntryTypeDef

UpdatePortalRequestRequestTypeDef#

# UpdatePortalRequestRequestTypeDef definition

class UpdatePortalRequestRequestTypeDef(TypedDict):
    portalId: str,
    portalName: str,
    portalContactEmail: str,
    roleArn: str,
    portalDescription: NotRequired[str],
    portalLogoImage: NotRequired[ImageTypeDef],  # (1)
    clientToken: NotRequired[str],
    notificationSenderEmail: NotRequired[str],
    alarms: NotRequired[AlarmsTypeDef],  # (2)
    portalType: NotRequired[PortalTypeType],  # (3)
    portalTypeConfiguration: NotRequired[Mapping[str, PortalTypeEntryTypeDef]],  # (4)

DescribeBulkImportJobResponseTypeDef#

# DescribeBulkImportJobResponseTypeDef definition

class DescribeBulkImportJobResponseTypeDef(TypedDict):
    jobId: str,
    jobName: str,
    jobStatus: JobStatusType,  # (1)
    jobRoleArn: str,
    files: list[FileTypeDef],  # (2)
    errorReportLocation: ErrorReportLocationTypeDef,  # (3)
    jobConfiguration: JobConfigurationOutputTypeDef,  # (4)
    jobCreationDate: datetime,
    jobLastUpdateDate: datetime,
    adaptiveIngestion: bool,
    deleteFilesAfterImport: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)

AssetModelSummaryTypeDef#

# AssetModelSummaryTypeDef definition

class AssetModelSummaryTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    description: str,
    creationDate: datetime,
    lastUpdateDate: datetime,
    status: AssetModelStatusTypeDef,  # (2)
    externalId: NotRequired[str],
    assetModelType: NotRequired[AssetModelTypeType],  # (1)
    version: NotRequired[str],

See AssetModelTypeType
See AssetModelStatusTypeDef

CreateAssetModelCompositeModelResponseTypeDef#

# CreateAssetModelCompositeModelResponseTypeDef definition

class CreateAssetModelCompositeModelResponseTypeDef(TypedDict):
    assetModelCompositeModelId: str,
    assetModelCompositeModelPath: list[AssetModelCompositeModelPathSegmentTypeDef],  # (1)
    assetModelStatus: AssetModelStatusTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

See AssetModelCompositeModelPathSegmentTypeDef
See AssetModelStatusTypeDef
See ResponseMetadataTypeDef

CreateAssetModelResponseTypeDef#

# CreateAssetModelResponseTypeDef definition

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

See AssetModelStatusTypeDef
See ResponseMetadataTypeDef

DeleteAssetModelCompositeModelResponseTypeDef#

# DeleteAssetModelCompositeModelResponseTypeDef definition

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

See AssetModelStatusTypeDef
See ResponseMetadataTypeDef

DeleteAssetModelResponseTypeDef#

# DeleteAssetModelResponseTypeDef definition

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

See AssetModelStatusTypeDef
See ResponseMetadataTypeDef

UpdateAssetModelCompositeModelResponseTypeDef#

# UpdateAssetModelCompositeModelResponseTypeDef definition

class UpdateAssetModelCompositeModelResponseTypeDef(TypedDict):
    assetModelCompositeModelPath: list[AssetModelCompositeModelPathSegmentTypeDef],  # (1)
    assetModelStatus: AssetModelStatusTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

See AssetModelCompositeModelPathSegmentTypeDef
See AssetModelStatusTypeDef
See ResponseMetadataTypeDef

UpdateAssetModelResponseTypeDef#

# UpdateAssetModelResponseTypeDef definition

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

See AssetModelStatusTypeDef
See ResponseMetadataTypeDef

AssetSummaryTypeDef#

# AssetSummaryTypeDef definition

class AssetSummaryTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    assetModelId: str,
    creationDate: datetime,
    lastUpdateDate: datetime,
    status: AssetStatusTypeDef,  # (1)
    hierarchies: list[AssetHierarchyTypeDef],  # (2)
    description: NotRequired[str],
    externalId: NotRequired[str],

See AssetStatusTypeDef
See AssetHierarchyTypeDef

AssociatedAssetsSummaryTypeDef#

# AssociatedAssetsSummaryTypeDef definition

class AssociatedAssetsSummaryTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    assetModelId: str,
    creationDate: datetime,
    lastUpdateDate: datetime,
    status: AssetStatusTypeDef,  # (1)
    hierarchies: list[AssetHierarchyTypeDef],  # (2)
    description: NotRequired[str],
    externalId: NotRequired[str],

See AssetStatusTypeDef
See AssetHierarchyTypeDef

CreateAssetResponseTypeDef#

# CreateAssetResponseTypeDef definition

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

See AssetStatusTypeDef
See ResponseMetadataTypeDef

DeleteAssetResponseTypeDef#

# DeleteAssetResponseTypeDef definition

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

See AssetStatusTypeDef
See ResponseMetadataTypeDef

DescribeAssetResponseTypeDef#

# DescribeAssetResponseTypeDef definition

class DescribeAssetResponseTypeDef(TypedDict):
    assetId: str,
    assetArn: str,
    assetName: str,
    assetModelId: str,
    assetProperties: list[AssetPropertyTypeDef],  # (1)
    assetHierarchies: list[AssetHierarchyTypeDef],  # (2)
    assetCompositeModels: list[AssetCompositeModelTypeDef],  # (3)
    assetCreationDate: datetime,
    assetLastUpdateDate: datetime,
    assetStatus: AssetStatusTypeDef,  # (4)
    assetDescription: str,
    assetCompositeModelSummaries: list[AssetCompositeModelSummaryTypeDef],  # (5)
    assetExternalId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

UpdateAssetResponseTypeDef#

# UpdateAssetResponseTypeDef definition

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

See AssetStatusTypeDef
See ResponseMetadataTypeDef

CreateDatasetResponseTypeDef#

# CreateDatasetResponseTypeDef definition

class CreateDatasetResponseTypeDef(TypedDict):
    datasetId: str,
    datasetArn: str,
    datasetStatus: DatasetStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See DatasetStatusTypeDef
See ResponseMetadataTypeDef

DatasetSummaryTypeDef#

# DatasetSummaryTypeDef definition

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

See DatasetStatusTypeDef

DeleteDatasetResponseTypeDef#

# DeleteDatasetResponseTypeDef definition

class DeleteDatasetResponseTypeDef(TypedDict):
    datasetStatus: DatasetStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See DatasetStatusTypeDef
See ResponseMetadataTypeDef

UpdateDatasetResponseTypeDef#

# UpdateDatasetResponseTypeDef definition

class UpdateDatasetResponseTypeDef(TypedDict):
    datasetId: str,
    datasetArn: str,
    datasetStatus: DatasetStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See DatasetStatusTypeDef
See ResponseMetadataTypeDef

ListGatewaysResponseTypeDef#

# ListGatewaysResponseTypeDef definition

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

See GatewaySummaryTypeDef
See ResponseMetadataTypeDef

CreateDatasetRequestRequestTypeDef#

# CreateDatasetRequestRequestTypeDef definition

class CreateDatasetRequestRequestTypeDef(TypedDict):
    datasetName: str,
    datasetSource: DatasetSourceTypeDef,  # (1)
    datasetId: NotRequired[str],
    datasetDescription: NotRequired[str],
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

See DatasetSourceTypeDef

DescribeDatasetResponseTypeDef#

# DescribeDatasetResponseTypeDef definition

class DescribeDatasetResponseTypeDef(TypedDict):
    datasetId: str,
    datasetArn: str,
    datasetName: str,
    datasetDescription: str,
    datasetSource: DatasetSourceTypeDef,  # (1)
    datasetStatus: DatasetStatusTypeDef,  # (2)
    datasetCreationDate: datetime,
    datasetLastUpdateDate: datetime,
    datasetVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

UpdateDatasetRequestRequestTypeDef#

# UpdateDatasetRequestRequestTypeDef definition

class UpdateDatasetRequestRequestTypeDef(TypedDict):
    datasetId: str,
    datasetName: str,
    datasetSource: DatasetSourceTypeDef,  # (1)
    datasetDescription: NotRequired[str],
    clientToken: NotRequired[str],

See DatasetSourceTypeDef

ReferenceTypeDef#

# ReferenceTypeDef definition

class ReferenceTypeDef(TypedDict):
    dataset: NotRequired[DataSetReferenceTypeDef],  # (1)

See DataSetReferenceTypeDef

ListPortalsResponseTypeDef#

# ListPortalsResponseTypeDef definition

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

See PortalSummaryTypeDef
See ResponseMetadataTypeDef

ListAccessPoliciesResponseTypeDef#

# ListAccessPoliciesResponseTypeDef definition

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

See AccessPolicySummaryTypeDef
See ResponseMetadataTypeDef

PropertyTypeOutputTypeDef#

# PropertyTypeOutputTypeDef definition

class PropertyTypeOutputTypeDef(TypedDict):
    attribute: NotRequired[AttributeTypeDef],  # (1)
    measurement: NotRequired[MeasurementTypeDef],  # (2)
    transform: NotRequired[TransformOutputTypeDef],  # (3)
    metric: NotRequired[MetricOutputTypeDef],  # (4)

JobConfigurationTypeDef#

# JobConfigurationTypeDef definition

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

See FileFormatTypeDef FileFormatOutputTypeDef

ListAssetModelsResponseTypeDef#

# ListAssetModelsResponseTypeDef definition

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

See AssetModelSummaryTypeDef
See ResponseMetadataTypeDef

ListAssetsResponseTypeDef#

# ListAssetsResponseTypeDef definition

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

See AssetSummaryTypeDef
See ResponseMetadataTypeDef

ListAssociatedAssetsResponseTypeDef#

# ListAssociatedAssetsResponseTypeDef definition

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

See AssociatedAssetsSummaryTypeDef
See ResponseMetadataTypeDef

ListDatasetsResponseTypeDef#

# ListDatasetsResponseTypeDef definition

class ListDatasetsResponseTypeDef(TypedDict):
    datasetSummaries: list[DatasetSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

See DatasetSummaryTypeDef
See ResponseMetadataTypeDef

CitationTypeDef#

# CitationTypeDef definition

class CitationTypeDef(TypedDict):
    reference: NotRequired[ReferenceTypeDef],  # (1)
    content: NotRequired[ContentTypeDef],  # (2)

See ReferenceTypeDef
See ContentTypeDef

AssetModelPropertyOutputTypeDef#

# AssetModelPropertyOutputTypeDef definition

class AssetModelPropertyOutputTypeDef(TypedDict):
    name: str,
    dataType: PropertyDataTypeType,  # (1)
    type: PropertyTypeOutputTypeDef,  # (2)
    id: NotRequired[str],
    externalId: NotRequired[str],
    dataTypeSpec: NotRequired[str],
    unit: NotRequired[str],
    path: NotRequired[list[AssetModelPropertyPathSegmentTypeDef]],  # (3)

See PropertyDataTypeType
See PropertyTypeOutputTypeDef
See AssetModelPropertyPathSegmentTypeDef

AssetModelPropertySummaryTypeDef#

# AssetModelPropertySummaryTypeDef definition

class AssetModelPropertySummaryTypeDef(TypedDict):
    name: str,
    dataType: PropertyDataTypeType,  # (1)
    type: PropertyTypeOutputTypeDef,  # (2)
    id: NotRequired[str],
    externalId: NotRequired[str],
    dataTypeSpec: NotRequired[str],
    unit: NotRequired[str],
    assetModelCompositeModelId: NotRequired[str],
    path: NotRequired[list[AssetModelPropertyPathSegmentTypeDef]],  # (3)

See PropertyDataTypeType
See PropertyTypeOutputTypeDef
See AssetModelPropertyPathSegmentTypeDef

PropertyTypeDef#

# PropertyTypeDef definition

class PropertyTypeDef(TypedDict):
    id: str,
    name: str,
    dataType: PropertyDataTypeType,  # (2)
    alias: NotRequired[str],
    notification: NotRequired[PropertyNotificationTypeDef],  # (1)
    unit: NotRequired[str],
    type: NotRequired[PropertyTypeOutputTypeDef],  # (3)
    path: NotRequired[list[AssetPropertyPathSegmentTypeDef]],  # (4)
    externalId: NotRequired[str],

MetricTypeDef#

# MetricTypeDef definition

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

TransformTypeDef#

# TransformTypeDef definition

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

CreateBulkImportJobRequestRequestTypeDef#

# CreateBulkImportJobRequestRequestTypeDef definition

class CreateBulkImportJobRequestRequestTypeDef(TypedDict):
    jobName: str,
    jobRoleArn: str,
    files: Sequence[FileTypeDef],  # (1)
    errorReportLocation: ErrorReportLocationTypeDef,  # (2)
    jobConfiguration: JobConfigurationTypeDef,  # (3)
    adaptiveIngestion: NotRequired[bool],
    deleteFilesAfterImport: NotRequired[bool],

InvocationOutputTypeDef#

# InvocationOutputTypeDef definition

class InvocationOutputTypeDef(TypedDict):
    message: NotRequired[str],
    citations: NotRequired[list[CitationTypeDef]],  # (1)

See CitationTypeDef

AssetModelCompositeModelOutputTypeDef#

# AssetModelCompositeModelOutputTypeDef definition

class AssetModelCompositeModelOutputTypeDef(TypedDict):
    name: str,
    type: str,
    description: NotRequired[str],
    properties: NotRequired[list[AssetModelPropertyOutputTypeDef]],  # (1)
    id: NotRequired[str],
    externalId: NotRequired[str],

See AssetModelPropertyOutputTypeDef

DescribeAssetModelCompositeModelResponseTypeDef#

# DescribeAssetModelCompositeModelResponseTypeDef definition

class DescribeAssetModelCompositeModelResponseTypeDef(TypedDict):
    assetModelId: str,
    assetModelCompositeModelId: str,
    assetModelCompositeModelExternalId: str,
    assetModelCompositeModelPath: list[AssetModelCompositeModelPathSegmentTypeDef],  # (1)
    assetModelCompositeModelName: str,
    assetModelCompositeModelDescription: str,
    assetModelCompositeModelType: str,
    assetModelCompositeModelProperties: list[AssetModelPropertyOutputTypeDef],  # (2)
    compositionDetails: CompositionDetailsTypeDef,  # (3)
    assetModelCompositeModelSummaries: list[AssetModelCompositeModelSummaryTypeDef],  # (4)
    actionDefinitions: list[ActionDefinitionTypeDef],  # (5)
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

See AssetModelCompositeModelPathSegmentTypeDef
See AssetModelPropertyOutputTypeDef
See CompositionDetailsTypeDef
See AssetModelCompositeModelSummaryTypeDef
See ActionDefinitionTypeDef
See ResponseMetadataTypeDef

ListAssetModelPropertiesResponseTypeDef#

# ListAssetModelPropertiesResponseTypeDef definition

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

See AssetModelPropertySummaryTypeDef
See ResponseMetadataTypeDef

CompositeModelPropertyTypeDef#

# CompositeModelPropertyTypeDef definition

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

See PropertyTypeDef

ResponseStreamTypeDef#

# ResponseStreamTypeDef definition

class ResponseStreamTypeDef(TypedDict):
    trace: NotRequired[TraceTypeDef],  # (1)
    output: NotRequired[InvocationOutputTypeDef],  # (2)
    accessDeniedException: NotRequired[AccessDeniedExceptionTypeDef],  # (3)
    conflictingOperationException: NotRequired[ConflictingOperationExceptionTypeDef],  # (4)
    internalFailureException: NotRequired[InternalFailureExceptionTypeDef],  # (5)
    invalidRequestException: NotRequired[InvalidRequestExceptionTypeDef],  # (6)
    limitExceededException: NotRequired[LimitExceededExceptionTypeDef],  # (7)
    resourceNotFoundException: NotRequired[ResourceNotFoundExceptionTypeDef],  # (8)
    throttlingException: NotRequired[ThrottlingExceptionTypeDef],  # (9)

See TraceTypeDef
See InvocationOutputTypeDef
See AccessDeniedExceptionTypeDef
See ConflictingOperationExceptionTypeDef
See InternalFailureExceptionTypeDef
See InvalidRequestExceptionTypeDef
See LimitExceededExceptionTypeDef
See ResourceNotFoundExceptionTypeDef
See ThrottlingExceptionTypeDef

DescribeAssetModelResponseTypeDef#

# DescribeAssetModelResponseTypeDef definition

class DescribeAssetModelResponseTypeDef(TypedDict):
    assetModelId: str,
    assetModelExternalId: str,
    assetModelArn: str,
    assetModelName: str,
    assetModelType: AssetModelTypeType,  # (1)
    assetModelDescription: str,
    assetModelProperties: list[AssetModelPropertyOutputTypeDef],  # (2)
    assetModelHierarchies: list[AssetModelHierarchyTypeDef],  # (3)
    assetModelCompositeModels: list[AssetModelCompositeModelOutputTypeDef],  # (4)
    assetModelCompositeModelSummaries: list[AssetModelCompositeModelSummaryTypeDef],  # (5)
    assetModelCreationDate: datetime,
    assetModelLastUpdateDate: datetime,
    assetModelStatus: AssetModelStatusTypeDef,  # (6)
    assetModelVersion: str,
    eTag: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)

See AssetModelTypeType
See AssetModelPropertyOutputTypeDef
See AssetModelHierarchyTypeDef
See AssetModelCompositeModelOutputTypeDef
See AssetModelCompositeModelSummaryTypeDef
See AssetModelStatusTypeDef
See ResponseMetadataTypeDef

DescribeAssetPropertyResponseTypeDef#

# DescribeAssetPropertyResponseTypeDef definition

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

PropertyTypeTypeDef#

# PropertyTypeTypeDef definition

class PropertyTypeTypeDef(TypedDict):
    attribute: NotRequired[AttributeTypeDef],  # (1)
    measurement: NotRequired[MeasurementTypeDef],  # (2)
    transform: NotRequired[TransformUnionTypeDef],  # (3)
    metric: NotRequired[MetricUnionTypeDef],  # (4)

See AttributeTypeDef
See MeasurementTypeDef
See TransformTypeDef TransformOutputTypeDef
See MetricTypeDef MetricOutputTypeDef

InvokeAssistantResponseTypeDef#

# InvokeAssistantResponseTypeDef definition

class InvokeAssistantResponseTypeDef(TypedDict):
    body: EventStream[ResponseStreamTypeDef],  # (1)
    conversationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See ResponseStreamTypeDef
See ResponseMetadataTypeDef

AssetModelPropertyDefinitionTypeDef#

# AssetModelPropertyDefinitionTypeDef definition

class AssetModelPropertyDefinitionTypeDef(TypedDict):
    name: str,
    dataType: PropertyDataTypeType,  # (1)
    type: PropertyTypeUnionTypeDef,  # (2)
    id: NotRequired[str],
    externalId: NotRequired[str],
    dataTypeSpec: NotRequired[str],
    unit: NotRequired[str],

AssetModelPropertyTypeDef#

# AssetModelPropertyTypeDef definition

class AssetModelPropertyTypeDef(TypedDict):
    name: str,
    dataType: PropertyDataTypeType,  # (1)
    type: PropertyTypeUnionTypeDef,  # (2)
    id: NotRequired[str],
    externalId: NotRequired[str],
    dataTypeSpec: NotRequired[str],
    unit: NotRequired[str],
    path: NotRequired[Sequence[AssetModelPropertyPathSegmentTypeDef]],  # (3)

AssetModelCompositeModelDefinitionTypeDef#

# AssetModelCompositeModelDefinitionTypeDef definition

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

See AssetModelPropertyDefinitionTypeDef

CreateAssetModelCompositeModelRequestRequestTypeDef#

# CreateAssetModelCompositeModelRequestRequestTypeDef definition

class CreateAssetModelCompositeModelRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    assetModelCompositeModelName: str,
    assetModelCompositeModelType: str,
    assetModelCompositeModelExternalId: NotRequired[str],
    parentAssetModelCompositeModelId: NotRequired[str],
    assetModelCompositeModelId: NotRequired[str],
    assetModelCompositeModelDescription: NotRequired[str],
    clientToken: NotRequired[str],
    composedAssetModelId: NotRequired[str],
    assetModelCompositeModelProperties: NotRequired[Sequence[AssetModelPropertyDefinitionTypeDef]],  # (1)
    ifMatch: NotRequired[str],
    ifNoneMatch: NotRequired[str],
    matchForVersionType: NotRequired[AssetModelVersionTypeType],  # (2)

UpdateAssetModelCompositeModelRequestRequestTypeDef#

# UpdateAssetModelCompositeModelRequestRequestTypeDef definition

class UpdateAssetModelCompositeModelRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    assetModelCompositeModelId: str,
    assetModelCompositeModelName: str,
    assetModelCompositeModelExternalId: NotRequired[str],
    assetModelCompositeModelDescription: NotRequired[str],
    clientToken: NotRequired[str],
    assetModelCompositeModelProperties: NotRequired[Sequence[AssetModelPropertyTypeDef]],  # (1)
    ifMatch: NotRequired[str],
    ifNoneMatch: NotRequired[str],
    matchForVersionType: NotRequired[AssetModelVersionTypeType],  # (2)

See AssetModelPropertyTypeDef
See AssetModelVersionTypeType

CreateAssetModelRequestRequestTypeDef#

# CreateAssetModelRequestRequestTypeDef definition

class CreateAssetModelRequestRequestTypeDef(TypedDict):
    assetModelName: str,
    assetModelType: NotRequired[AssetModelTypeType],  # (1)
    assetModelId: NotRequired[str],
    assetModelExternalId: NotRequired[str],
    assetModelDescription: NotRequired[str],
    assetModelProperties: NotRequired[Sequence[AssetModelPropertyDefinitionTypeDef]],  # (2)
    assetModelHierarchies: NotRequired[Sequence[AssetModelHierarchyDefinitionTypeDef]],  # (3)
    assetModelCompositeModels: NotRequired[Sequence[AssetModelCompositeModelDefinitionTypeDef]],  # (4)
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

AssetModelCompositeModelTypeDef#

# AssetModelCompositeModelTypeDef definition

class AssetModelCompositeModelTypeDef(TypedDict):
    name: str,
    type: str,
    description: NotRequired[str],
    properties: NotRequired[Sequence[AssetModelPropertyUnionTypeDef]],  # (1)
    id: NotRequired[str],
    externalId: NotRequired[str],

See AssetModelPropertyTypeDef AssetModelPropertyOutputTypeDef

UpdateAssetModelRequestRequestTypeDef#

# UpdateAssetModelRequestRequestTypeDef definition

class UpdateAssetModelRequestRequestTypeDef(TypedDict):
    assetModelId: str,
    assetModelName: str,
    assetModelExternalId: NotRequired[str],
    assetModelDescription: NotRequired[str],
    assetModelProperties: NotRequired[Sequence[AssetModelPropertyUnionTypeDef]],  # (1)
    assetModelHierarchies: NotRequired[Sequence[AssetModelHierarchyTypeDef]],  # (2)
    assetModelCompositeModels: NotRequired[Sequence[AssetModelCompositeModelUnionTypeDef]],  # (3)
    clientToken: NotRequired[str],
    ifMatch: NotRequired[str],
    ifNoneMatch: NotRequired[str],
    matchForVersionType: NotRequired[AssetModelVersionTypeType],  # (4)