Iotsitewise Classes
AccessPolicySummaryTypeDef
id
- Type:
- Required: Yes
identity
- Type:
- Required: Yes
resource
- Type:
- Required: Yes
permission
- Type: typing.Literal['ADMINISTRATOR', 'VIEWER']
- Required: Yes
creationDate
- Type: typing.Optional[datetime.datetime]
lastUpdateDate
- Type: typing.Optional[datetime.datetime]
ActionDefinitionTypeDef
actionDefinitionId
- Type:
- Required: Yes
actionName
- Type:
- Required: Yes
actionType
- Type:
- Required: Yes
ActionPayloadTypeDef
stringValue
- Type:
- Required: Yes
ActionSummaryTypeDef
actionId
- Type: typing.Optional[str]
actionDefinitionId
- Type: typing.Optional[str]
targetResource
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.TargetResourceTypeDef]
AggregatedValueTypeDef
timestamp
- Type:
- Required: Yes
value
- Type:
- Required: Yes
quality
- Type: typing.Optional[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]
AggregatesTypeDef
average
- Type: typing.Optional[float]
count
- Type: typing.Optional[float]
maximum
- Type: typing.Optional[float]
minimum
- Type: typing.Optional[float]
sum
- Type: typing.Optional[float]
standardDeviation
- Type: typing.Optional[float]
AlarmsTypeDef
alarmRoleArn
- Type:
- Required: Yes
notificationLambdaArn
- Type: typing.Optional[str]
AssetCompositeModelPathSegmentTypeDef
id
- Type: typing.Optional[str]
name
- Type: typing.Optional[str]
AssetCompositeModelSummaryTypeDef
id
- Type:
- Required: Yes
name
- Type:
- Required: Yes
type
- Type:
- Required: Yes
description
- Type:
- Required: Yes
path
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetCompositeModelPathSegmentTypeDef]
- Required: Yes
externalId
- Type: typing.Optional[str]
AssetCompositeModelTypeDef
name
- Type:
- Required: Yes
type
- Type:
- Required: Yes
properties
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetPropertyTypeDef]
- Required: Yes
description
- Type: typing.Optional[str]
id
- Type: typing.Optional[str]
externalId
- Type: typing.Optional[str]
AssetErrorDetailsTypeDef
assetId
- Type:
- Required: Yes
code
- Type: typing.Literal['INTERNAL_FAILURE']
- Required: Yes
message
- Type:
- Required: Yes
AssetHierarchyInfoTypeDef
parentAssetId
- Type: typing.Optional[str]
childAssetId
- Type: typing.Optional[str]
AssetHierarchyTypeDef
name
- Type:
- Required: Yes
id
- Type: typing.Optional[str]
externalId
- Type: typing.Optional[str]
AssetModelCompositeModelDefinitionTypeDef
name
- Type:
- Required: Yes
type
- Type:
- Required: Yes
description
- Type: typing.Optional[str]
properties
- Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyDefinitionTypeDef]]
id
- Type: typing.Optional[str]
externalId
- Type: typing.Optional[str]
AssetModelCompositeModelPathSegmentTypeDef
id
- Type: typing.Optional[str]
name
- Type: typing.Optional[str]
AssetModelCompositeModelSummaryTypeDef
id
- Type:
- Required: Yes
name
- Type:
- Required: Yes
type
- Type:
- Required: Yes
externalId
- Type: typing.Optional[str]
description
- Type: typing.Optional[str]
path
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelCompositeModelPathSegmentTypeDef]]
AssetModelCompositeModelTypeDef
name
- Type:
- Required: Yes
type
- Type:
- Required: Yes
description
- Type: typing.Optional[str]
properties
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyTypeDef]]
id
- Type: typing.Optional[str]
externalId
- Type: typing.Optional[str]
AssetModelHierarchyDefinitionTypeDef
name
- Type:
- Required: Yes
childAssetModelId
- Type:
- Required: Yes
id
- Type: typing.Optional[str]
externalId
- Type: typing.Optional[str]
AssetModelHierarchyTypeDef
name
- Type:
- Required: Yes
childAssetModelId
- Type:
- Required: Yes
id
- Type: typing.Optional[str]
externalId
- Type: typing.Optional[str]
AssetModelPropertyDefinitionTypeDef
name
- Type:
- Required: Yes
dataType
- Type: typing.Literal['BOOLEAN', 'DOUBLE', 'INTEGER', 'STRING', 'STRUCT']
- Required: Yes
type
- Type:
- Required: Yes
dataTypeSpec
- Type: typing.Optional[str]
unit
- Type: typing.Optional[str]
id
- Type: typing.Optional[str]
externalId
- Type: typing.Optional[str]
AssetModelPropertyPathSegmentTypeDef
id
- Type: typing.Optional[str]
name
- Type: typing.Optional[str]
AssetModelPropertySummaryPaginatorTypeDef
name
- Type:
- Required: Yes
dataType
- Type: typing.Literal['BOOLEAN', 'DOUBLE', 'INTEGER', 'STRING', 'STRUCT']
- Required: Yes
type
- Type:
- Required: Yes
id
- Type: typing.Optional[str]
dataTypeSpec
- Type: typing.Optional[str]
unit
- Type: typing.Optional[str]
assetModelCompositeModelId
- Type: typing.Optional[str]
path
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyPathSegmentTypeDef]]
externalId
- Type: typing.Optional[str]
AssetModelPropertySummaryTypeDef
name
- Type:
- Required: Yes
dataType
- Type: typing.Literal['BOOLEAN', 'DOUBLE', 'INTEGER', 'STRING', 'STRUCT']
- Required: Yes
type
- Type:
- Required: Yes
id
- Type: typing.Optional[str]
dataTypeSpec
- Type: typing.Optional[str]
unit
- Type: typing.Optional[str]
assetModelCompositeModelId
- Type: typing.Optional[str]
path
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyPathSegmentTypeDef]]
externalId
- Type: typing.Optional[str]
AssetModelPropertyTypeDef
name
- Type:
- Required: Yes
dataType
- Type: typing.Literal['BOOLEAN', 'DOUBLE', 'INTEGER', 'STRING', 'STRUCT']
- Required: Yes
type
- Type:
- Required: Yes
id
- Type: typing.Optional[str]
dataTypeSpec
- Type: typing.Optional[str]
unit
- Type: typing.Optional[str]
path
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyPathSegmentTypeDef]]
externalId
- Type: typing.Optional[str]
AssetModelStatusTypeDef
state
- Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'PROPAGATING', 'UPDATING']
- Required: Yes
error
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.ErrorDetailsTypeDef]
AssetModelSummaryTypeDef
id
- Type:
- Required: Yes
arn
- Type:
- Required: Yes
name
- Type:
- Required: Yes
description
- Type:
- Required: Yes
creationDate
- Type:
- Required: Yes
lastUpdateDate
- Type:
- Required: Yes
status
- Type:
- Required: Yes
assetModelType
- Type: typing.Optional[typing.Literal['ASSET_MODEL', 'COMPONENT_MODEL']]
externalId
- Type: typing.Optional[str]
AssetPropertyPathSegmentTypeDef
id
- Type: typing.Optional[str]
name
- Type: typing.Optional[str]
AssetPropertySummaryTypeDef
id
- Type:
- Required: Yes
alias
- Type: typing.Optional[str]
unit
- Type: typing.Optional[str]
notification
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PropertyNotificationTypeDef]
assetCompositeModelId
- Type: typing.Optional[str]
path
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetPropertyPathSegmentTypeDef]]
externalId
- Type: typing.Optional[str]
AssetPropertyTypeDef
id
- Type:
- Required: Yes
name
- Type:
- Required: Yes
dataType
- Type: typing.Literal['BOOLEAN', 'DOUBLE', 'INTEGER', 'STRING', 'STRUCT']
- Required: Yes
alias
- Type: typing.Optional[str]
notification
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PropertyNotificationTypeDef]
dataTypeSpec
- Type: typing.Optional[str]
unit
- Type: typing.Optional[str]
path
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetPropertyPathSegmentTypeDef]]
externalId
- Type: typing.Optional[str]
AssetPropertyValueTypeDef
value
- Type:
- Required: Yes
timestamp
- Type:
- Required: Yes
quality
- Type: typing.Optional[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]
AssetRelationshipSummaryTypeDef
relationshipType
- Type: typing.Literal['HIERARCHY']
- Required: Yes
hierarchyInfo
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetHierarchyInfoTypeDef]
AssetStatusTypeDef
state
- Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
- Required: Yes
error
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.ErrorDetailsTypeDef]
AssetSummaryTypeDef
id
- Type:
- Required: Yes
arn
- Type:
- Required: Yes
name
- Type:
- Required: Yes
assetModelId
- Type:
- Required: Yes
creationDate
- Type:
- Required: Yes
lastUpdateDate
- Type:
- Required: Yes
status
- Type:
- Required: Yes
hierarchies
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetHierarchyTypeDef]
- Required: Yes
description
- Type: typing.Optional[str]
externalId
- Type: typing.Optional[str]
AssociateAssetsRequestRequestTypeDef
assetId
- Type:
- Required: Yes
hierarchyId
- Type:
- Required: Yes
childAssetId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef
alias
- Type:
- Required: Yes
assetId
- Type:
- Required: Yes
propertyId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
AssociatedAssetsSummaryTypeDef
id
- Type:
- Required: Yes
arn
- Type:
- Required: Yes
name
- Type:
- Required: Yes
assetModelId
- Type:
- Required: Yes
creationDate
- Type:
- Required: Yes
lastUpdateDate
- Type:
- Required: Yes
status
- Type:
- Required: Yes
hierarchies
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetHierarchyTypeDef]
- Required: Yes
description
- Type: typing.Optional[str]
externalId
- Type: typing.Optional[str]
AttributeTypeDef
defaultValue
- Type: typing.Optional[str]
BaseValidatorModel
Oops! This Pydantic model is currently empty. Stay tuned!
BatchAssociateProjectAssetsRequestRequestTypeDef
projectId
- Type:
- Required: Yes
assetIds
- Type: typing.Sequence[str]
- Required: Yes
clientToken
- Type: typing.Optional[str]
BatchAssociateProjectAssetsResponseTypeDef
errors
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetErrorDetailsTypeDef]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
BatchDisassociateProjectAssetsRequestRequestTypeDef
projectId
- Type:
- Required: Yes
assetIds
- Type: typing.Sequence[str]
- Required: Yes
clientToken
- Type: typing.Optional[str]
BatchDisassociateProjectAssetsResponseTypeDef
errors
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetErrorDetailsTypeDef]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
BatchGetAssetPropertyAggregatesEntryTypeDef
entryId
- Type:
- Required: Yes
aggregateTypes
- Type: typing.Sequence[typing.Literal['AVERAGE', 'COUNT', 'MAXIMUM', 'MINIMUM', 'STANDARD_DEVIATION', 'SUM']]
- Required: Yes
resolution
- Type:
- Required: Yes
startDate
- Type: typing.Union[datetime.datetime, str]
- Required: Yes
endDate
- Type: typing.Union[datetime.datetime, str]
- Required: Yes
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
propertyAlias
- Type: typing.Optional[str]
qualities
- Type: typing.Optional[typing.Sequence[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]]
timeOrdering
- Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]
BatchGetAssetPropertyAggregatesErrorEntryTypeDef
errorCode
- Type: typing.Literal['AccessDeniedException', 'InvalidRequestException', 'ResourceNotFoundException']
- Required: Yes
errorMessage
- Type:
- Required: Yes
entryId
- Type:
- Required: Yes
BatchGetAssetPropertyAggregatesErrorInfoTypeDef
errorCode
- Type: typing.Literal['AccessDeniedException', 'InvalidRequestException', 'ResourceNotFoundException']
- Required: Yes
errorTimestamp
- Type:
- Required: Yes
BatchGetAssetPropertyAggregatesRequestRequestTypeDef
entries
- Type: typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyAggregatesEntryTypeDef]
- Required: Yes
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
BatchGetAssetPropertyAggregatesResponseTypeDef
errorEntries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyAggregatesErrorEntryTypeDef]
- Required: Yes
successEntries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyAggregatesSuccessEntryTypeDef]
- Required: Yes
skippedEntries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyAggregatesSkippedEntryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
BatchGetAssetPropertyAggregatesSkippedEntryTypeDef
entryId
- Type:
- Required: Yes
completionStatus
- Type: typing.Literal['ERROR', 'SUCCESS']
- Required: Yes
errorInfo
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyAggregatesErrorInfoTypeDef]
BatchGetAssetPropertyAggregatesSuccessEntryTypeDef
entryId
- Type:
- Required: Yes
aggregatedValues
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AggregatedValueTypeDef]
- Required: Yes
BatchGetAssetPropertyValueEntryTypeDef
entryId
- Type:
- Required: Yes
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
propertyAlias
- Type: typing.Optional[str]
BatchGetAssetPropertyValueErrorEntryTypeDef
errorCode
- Type: typing.Literal['AccessDeniedException', 'InvalidRequestException', 'ResourceNotFoundException']
- Required: Yes
errorMessage
- Type:
- Required: Yes
entryId
- Type:
- Required: Yes
BatchGetAssetPropertyValueErrorInfoTypeDef
errorCode
- Type: typing.Literal['AccessDeniedException', 'InvalidRequestException', 'ResourceNotFoundException']
- Required: Yes
errorTimestamp
- Type:
- Required: Yes
BatchGetAssetPropertyValueHistoryEntryTypeDef
entryId
- Type:
- Required: Yes
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
propertyAlias
- Type: typing.Optional[str]
startDate
- Type: typing.Union[datetime.datetime, str, NoneType]
endDate
- Type: typing.Union[datetime.datetime, str, NoneType]
qualities
- Type: typing.Optional[typing.Sequence[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]]
timeOrdering
- Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]
BatchGetAssetPropertyValueHistoryErrorEntryTypeDef
errorCode
- Type: typing.Literal['AccessDeniedException', 'InvalidRequestException', 'ResourceNotFoundException']
- Required: Yes
errorMessage
- Type:
- Required: Yes
entryId
- Type:
- Required: Yes
BatchGetAssetPropertyValueHistoryErrorInfoTypeDef
errorCode
- Type: typing.Literal['AccessDeniedException', 'InvalidRequestException', 'ResourceNotFoundException']
- Required: Yes
errorTimestamp
- Type:
- Required: Yes
BatchGetAssetPropertyValueHistoryRequestRequestTypeDef
entries
- Type: typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyValueHistoryEntryTypeDef]
- Required: Yes
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
BatchGetAssetPropertyValueHistoryResponseTypeDef
errorEntries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyValueHistoryErrorEntryTypeDef]
- Required: Yes
successEntries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyValueHistorySuccessEntryTypeDef]
- Required: Yes
skippedEntries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyValueHistorySkippedEntryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
BatchGetAssetPropertyValueHistorySkippedEntryTypeDef
entryId
- Type:
- Required: Yes
completionStatus
- Type: typing.Literal['ERROR', 'SUCCESS']
- Required: Yes
errorInfo
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyValueHistoryErrorInfoTypeDef]
BatchGetAssetPropertyValueHistorySuccessEntryTypeDef
entryId
- Type:
- Required: Yes
assetPropertyValueHistory
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetPropertyValueTypeDef]
- Required: Yes
BatchGetAssetPropertyValueRequestRequestTypeDef
entries
- Type: typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyValueEntryTypeDef]
- Required: Yes
nextToken
- Type: typing.Optional[str]
BatchGetAssetPropertyValueResponseTypeDef
errorEntries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyValueErrorEntryTypeDef]
- Required: Yes
successEntries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyValueSuccessEntryTypeDef]
- Required: Yes
skippedEntries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyValueSkippedEntryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
BatchGetAssetPropertyValueSkippedEntryTypeDef
entryId
- Type:
- Required: Yes
completionStatus
- Type: typing.Literal['ERROR', 'SUCCESS']
- Required: Yes
errorInfo
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchGetAssetPropertyValueErrorInfoTypeDef]
BatchGetAssetPropertyValueSuccessEntryTypeDef
entryId
- Type:
- Required: Yes
assetPropertyValue
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetPropertyValueTypeDef]
BatchPutAssetPropertyErrorEntryTypeDef
entryId
- Type:
- Required: Yes
errors
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchPutAssetPropertyErrorTypeDef]
- Required: Yes
BatchPutAssetPropertyErrorTypeDef
errorCode
- Type: typing.Literal['AccessDeniedException', 'ConflictingOperationException', 'InternalFailureException', 'InvalidRequestException', 'LimitExceededException', 'ResourceNotFoundException', 'ServiceUnavailableException', 'ThrottlingException', 'TimestampOutOfRangeException']
- Required: Yes
errorMessage
- Type:
- Required: Yes
timestamps
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.TimeInNanosTypeDef]
- Required: Yes
BatchPutAssetPropertyValueRequestRequestTypeDef
entries
- Type: typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.PutAssetPropertyValueEntryTypeDef]
- Required: Yes
BatchPutAssetPropertyValueResponseTypeDef
errorEntries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.BatchPutAssetPropertyErrorEntryTypeDef]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ColumnInfoTypeDef
name
- Type: typing.Optional[str]
type
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.ColumnTypeTypeDef]
ColumnTypeTypeDef
scalarType
- Type: typing.Optional[typing.Literal['BOOLEAN', 'DOUBLE', 'INT', 'STRING', 'TIMESTAMP']]
CompositeModelPropertyTypeDef
name
- Type:
- Required: Yes
type
- Type:
- Required: Yes
assetProperty
- Type:
- Required: Yes
id
- Type: typing.Optional[str]
externalId
- Type: typing.Optional[str]
CompositionDetailsTypeDef
compositionRelationship
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.CompositionRelationshipItemTypeDef]]
CompositionRelationshipItemTypeDef
id
- Type: typing.Optional[str]
CompositionRelationshipSummaryTypeDef
assetModelId
- Type:
- Required: Yes
assetModelCompositeModelId
- Type:
- Required: Yes
assetModelCompositeModelType
- Type:
- Required: Yes
ConfigurationErrorDetailsTypeDef
code
- Type: typing.Literal['INTERNAL_FAILURE', 'VALIDATION_ERROR']
- Required: Yes
message
- Type:
- Required: Yes
ConfigurationStatusTypeDef
state
- Type: typing.Literal['ACTIVE', 'UPDATE_FAILED', 'UPDATE_IN_PROGRESS']
- Required: Yes
error
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.ConfigurationErrorDetailsTypeDef]
CreateAccessPolicyRequestRequestTypeDef
accessPolicyIdentity
- Type:
- Required: Yes
accessPolicyResource
- Type:
- Required: Yes
accessPolicyPermission
- Type: typing.Literal['ADMINISTRATOR', 'VIEWER']
- Required: Yes
clientToken
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Mapping[str, str]]
CreateAccessPolicyResponseTypeDef
accessPolicyId
- Type:
- Required: Yes
accessPolicyArn
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateAssetModelCompositeModelRequestRequestTypeDef
assetModelId
- Type:
- Required: Yes
assetModelCompositeModelName
- Type:
- Required: Yes
assetModelCompositeModelType
- Type:
- Required: Yes
parentAssetModelCompositeModelId
- Type: typing.Optional[str]
assetModelCompositeModelExternalId
- Type: typing.Optional[str]
assetModelCompositeModelId
- Type: typing.Optional[str]
assetModelCompositeModelDescription
- Type: typing.Optional[str]
clientToken
- Type: typing.Optional[str]
composedAssetModelId
- Type: typing.Optional[str]
assetModelCompositeModelProperties
- Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyDefinitionTypeDef]]
CreateAssetModelCompositeModelResponseTypeDef
assetModelCompositeModelId
- Type:
- Required: Yes
assetModelCompositeModelPath
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelCompositeModelPathSegmentTypeDef]
- Required: Yes
assetModelStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateAssetModelRequestRequestTypeDef
assetModelName
- Type:
- Required: Yes
assetModelDescription
- Type: typing.Optional[str]
assetModelProperties
- Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyDefinitionTypeDef]]
assetModelHierarchies
- Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelHierarchyDefinitionTypeDef]]
assetModelCompositeModels
- Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelCompositeModelDefinitionTypeDef]]
clientToken
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Mapping[str, str]]
assetModelId
- Type: typing.Optional[str]
assetModelExternalId
- Type: typing.Optional[str]
assetModelType
- Type: typing.Optional[typing.Literal['ASSET_MODEL', 'COMPONENT_MODEL']]
CreateAssetModelResponseTypeDef
assetModelId
- Type:
- Required: Yes
assetModelArn
- Type:
- Required: Yes
assetModelStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateAssetRequestRequestTypeDef
assetName
- Type:
- Required: Yes
assetModelId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Mapping[str, str]]
assetDescription
- Type: typing.Optional[str]
assetId
- Type: typing.Optional[str]
assetExternalId
- Type: typing.Optional[str]
CreateAssetResponseTypeDef
assetId
- Type:
- Required: Yes
assetArn
- Type:
- Required: Yes
assetStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateBulkImportJobRequestRequestTypeDef
jobName
- Type:
- Required: Yes
jobRoleArn
- Type:
- Required: Yes
files
- Type: typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.FileTypeDef]
- Required: Yes
errorReportLocation
- Type:
- Required: Yes
jobConfiguration
- Type:
- Required: Yes
adaptiveIngestion
- Type: typing.Optional[bool]
deleteFilesAfterImport
- Type: typing.Optional[bool]
CreateBulkImportJobResponseTypeDef
jobId
- Type:
- Required: Yes
jobName
- Type:
- Required: Yes
jobStatus
- Type: typing.Literal['CANCELLED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', 'FAILED', 'PENDING', 'RUNNING']
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateDashboardRequestRequestTypeDef
projectId
- Type:
- Required: Yes
dashboardName
- Type:
- Required: Yes
dashboardDefinition
- Type:
- Required: Yes
dashboardDescription
- Type: typing.Optional[str]
clientToken
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Mapping[str, str]]
CreateDashboardResponseTypeDef
dashboardId
- Type:
- Required: Yes
dashboardArn
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateGatewayRequestRequestTypeDef
gatewayName
- Type:
- Required: Yes
gatewayPlatform
- Type:
- Required: Yes
tags
- Type: typing.Optional[typing.Mapping[str, str]]
CreateGatewayResponseTypeDef
gatewayId
- Type:
- Required: Yes
gatewayArn
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreatePortalRequestRequestTypeDef
portalName
- Type:
- Required: Yes
portalContactEmail
- Type:
- Required: Yes
roleArn
- Type:
- Required: Yes
portalDescription
- Type: typing.Optional[str]
clientToken
- Type: typing.Optional[str]
portalLogoImageFile
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.ImageFileTypeDef]
tags
- Type: typing.Optional[typing.Mapping[str, str]]
portalAuthMode
- Type: typing.Optional[typing.Literal['IAM', 'SSO']]
notificationSenderEmail
- Type: typing.Optional[str]
alarms
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.AlarmsTypeDef]
CreatePortalResponseTypeDef
portalId
- Type:
- Required: Yes
portalArn
- Type:
- Required: Yes
portalStartUrl
- Type:
- Required: Yes
portalStatus
- Type:
- Required: Yes
ssoApplicationId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateProjectRequestRequestTypeDef
portalId
- Type:
- Required: Yes
projectName
- Type:
- Required: Yes
projectDescription
- Type: typing.Optional[str]
clientToken
- Type: typing.Optional[str]
tags
- Type: typing.Optional[typing.Mapping[str, str]]
CreateProjectResponseTypeDef
projectId
- Type:
- Required: Yes
projectArn
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CsvTypeDef
columnNames
- Type: typing.Sequence[typing.Literal['ALIAS', 'ASSET_ID', 'DATA_TYPE', 'PROPERTY_ID', 'QUALITY', 'TIMESTAMP_NANO_OFFSET', 'TIMESTAMP_SECONDS', 'VALUE']]
- Required: Yes
CustomerManagedS3StorageTypeDef
s3ResourceArn
- Type:
- Required: Yes
roleArn
- Type:
- Required: Yes
DashboardSummaryTypeDef
id
- Type:
- Required: Yes
name
- Type:
- Required: Yes
description
- Type: typing.Optional[str]
creationDate
- Type: typing.Optional[datetime.datetime]
lastUpdateDate
- Type: typing.Optional[datetime.datetime]
DatumTypeDef
scalarValue
- Type: typing.Optional[str]
arrayValue
- Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]
rowValue
- Type: typing.Optional[typing.Dict[str, typing.Any]]
nullValue
- Type: typing.Optional[bool]
DeleteAccessPolicyRequestRequestTypeDef
accessPolicyId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
DeleteAssetModelCompositeModelRequestRequestTypeDef
assetModelId
- Type:
- Required: Yes
assetModelCompositeModelId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
DeleteAssetModelCompositeModelResponseTypeDef
assetModelStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DeleteAssetModelRequestRequestTypeDef
assetModelId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
DeleteAssetModelResponseTypeDef
assetModelStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DeleteAssetRequestRequestTypeDef
assetId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
DeleteAssetResponseTypeDef
assetStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DeleteDashboardRequestRequestTypeDef
dashboardId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
DeleteGatewayRequestRequestTypeDef
gatewayId
- Type:
- Required: Yes
DeletePortalRequestRequestTypeDef
portalId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
DeletePortalResponseTypeDef
portalStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DeleteProjectRequestRequestTypeDef
projectId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
DeleteTimeSeriesRequestRequestTypeDef
alias
- Type: typing.Optional[str]
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
clientToken
- Type: typing.Optional[str]
DescribeAccessPolicyRequestRequestTypeDef
accessPolicyId
- Type:
- Required: Yes
DescribeAccessPolicyResponseTypeDef
accessPolicyId
- Type:
- Required: Yes
accessPolicyArn
- Type:
- Required: Yes
accessPolicyIdentity
- Type:
- Required: Yes
accessPolicyResource
- Type:
- Required: Yes
accessPolicyPermission
- Type: typing.Literal['ADMINISTRATOR', 'VIEWER']
- Required: Yes
accessPolicyCreationDate
- Type:
- Required: Yes
accessPolicyLastUpdateDate
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeActionRequestRequestTypeDef
actionId
- Type:
- Required: Yes
DescribeActionResponseTypeDef
actionId
- Type:
- Required: Yes
targetResource
- Type:
- Required: Yes
actionDefinitionId
- Type:
- Required: Yes
actionPayload
- Type:
- Required: Yes
executionTime
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeAssetCompositeModelRequestRequestTypeDef
assetId
- Type:
- Required: Yes
assetCompositeModelId
- Type:
- Required: Yes
DescribeAssetCompositeModelResponseTypeDef
assetId
- Type:
- Required: Yes
assetCompositeModelId
- Type:
- Required: Yes
assetCompositeModelExternalId
- Type:
- Required: Yes
assetCompositeModelPath
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetCompositeModelPathSegmentTypeDef]
- Required: Yes
assetCompositeModelName
- Type:
- Required: Yes
assetCompositeModelDescription
- Type:
- Required: Yes
assetCompositeModelType
- Type:
- Required: Yes
assetCompositeModelProperties
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetPropertyTypeDef]
- Required: Yes
assetCompositeModelSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetCompositeModelSummaryTypeDef]
- Required: Yes
actionDefinitions
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.ActionDefinitionTypeDef]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeAssetModelCompositeModelRequestRequestTypeDef
assetModelId
- Type:
- Required: Yes
assetModelCompositeModelId
- Type:
- Required: Yes
DescribeAssetModelCompositeModelResponseTypeDef
assetModelId
- Type:
- Required: Yes
assetModelCompositeModelId
- Type:
- Required: Yes
assetModelCompositeModelExternalId
- Type:
- Required: Yes
assetModelCompositeModelPath
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelCompositeModelPathSegmentTypeDef]
- Required: Yes
assetModelCompositeModelName
- Type:
- Required: Yes
assetModelCompositeModelDescription
- Type:
- Required: Yes
assetModelCompositeModelType
- Type:
- Required: Yes
assetModelCompositeModelProperties
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyTypeDef]
- Required: Yes
compositionDetails
- Type:
- Required: Yes
assetModelCompositeModelSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelCompositeModelSummaryTypeDef]
- Required: Yes
actionDefinitions
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.ActionDefinitionTypeDef]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeAssetModelRequestAssetModelActiveWaitTypeDef
assetModelId
- Type:
- Required: Yes
excludeProperties
- Type: typing.Optional[bool]
WaiterConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.WaiterConfigTypeDef]
DescribeAssetModelRequestAssetModelNotExistsWaitTypeDef
assetModelId
- Type:
- Required: Yes
excludeProperties
- Type: typing.Optional[bool]
WaiterConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.WaiterConfigTypeDef]
DescribeAssetModelRequestRequestTypeDef
assetModelId
- Type:
- Required: Yes
excludeProperties
- Type: typing.Optional[bool]
DescribeAssetModelResponseTypeDef
assetModelId
- Type:
- Required: Yes
assetModelArn
- Type:
- Required: Yes
assetModelName
- Type:
- Required: Yes
assetModelDescription
- Type:
- Required: Yes
assetModelProperties
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyTypeDef]
- Required: Yes
assetModelHierarchies
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelHierarchyTypeDef]
- Required: Yes
assetModelCompositeModels
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelCompositeModelTypeDef]
- Required: Yes
assetModelCreationDate
- Type:
- Required: Yes
assetModelLastUpdateDate
- Type:
- Required: Yes
assetModelStatus
- Type:
- Required: Yes
assetModelType
- Type: typing.Literal['ASSET_MODEL', 'COMPONENT_MODEL']
- Required: Yes
assetModelCompositeModelSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelCompositeModelSummaryTypeDef]
- Required: Yes
assetModelExternalId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeAssetPropertyRequestRequestTypeDef
assetId
- Type:
- Required: Yes
propertyId
- Type:
- Required: Yes
DescribeAssetPropertyResponseTypeDef
assetId
- Type:
- Required: Yes
assetName
- Type:
- Required: Yes
assetModelId
- Type:
- Required: Yes
assetProperty
- Type:
- Required: Yes
compositeModel
- Type:
- Required: Yes
assetExternalId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeAssetRequestAssetActiveWaitTypeDef
assetId
- Type:
- Required: Yes
excludeProperties
- Type: typing.Optional[bool]
WaiterConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.WaiterConfigTypeDef]
DescribeAssetRequestAssetNotExistsWaitTypeDef
assetId
- Type:
- Required: Yes
excludeProperties
- Type: typing.Optional[bool]
WaiterConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.WaiterConfigTypeDef]
DescribeAssetRequestRequestTypeDef
assetId
- Type:
- Required: Yes
excludeProperties
- Type: typing.Optional[bool]
DescribeAssetResponseTypeDef
assetId
- Type:
- Required: Yes
assetArn
- Type:
- Required: Yes
assetName
- Type:
- Required: Yes
assetModelId
- Type:
- Required: Yes
assetProperties
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetPropertyTypeDef]
- Required: Yes
assetHierarchies
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetHierarchyTypeDef]
- Required: Yes
assetCompositeModels
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetCompositeModelTypeDef]
- Required: Yes
assetCreationDate
- Type:
- Required: Yes
assetLastUpdateDate
- Type:
- Required: Yes
assetStatus
- Type:
- Required: Yes
assetDescription
- Type:
- Required: Yes
assetCompositeModelSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetCompositeModelSummaryTypeDef]
- Required: Yes
assetExternalId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeBulkImportJobRequestRequestTypeDef
jobId
- Type:
- Required: Yes
DescribeBulkImportJobResponseTypeDef
jobId
- Type:
- Required: Yes
jobName
- Type:
- Required: Yes
jobStatus
- Type: typing.Literal['CANCELLED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', 'FAILED', 'PENDING', 'RUNNING']
- Required: Yes
jobRoleArn
- Type:
- Required: Yes
files
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.FileTypeDef]
- Required: Yes
errorReportLocation
- Type:
- Required: Yes
jobConfiguration
- Type:
- Required: Yes
jobCreationDate
- Type:
- Required: Yes
jobLastUpdateDate
- Type:
- Required: Yes
adaptiveIngestion
- Type:
- Required: Yes
deleteFilesAfterImport
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeDashboardRequestRequestTypeDef
dashboardId
- Type:
- Required: Yes
DescribeDashboardResponseTypeDef
dashboardId
- Type:
- Required: Yes
dashboardArn
- Type:
- Required: Yes
dashboardName
- Type:
- Required: Yes
projectId
- Type:
- Required: Yes
dashboardDescription
- Type:
- Required: Yes
dashboardDefinition
- Type:
- Required: Yes
dashboardCreationDate
- Type:
- Required: Yes
dashboardLastUpdateDate
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeDefaultEncryptionConfigurationResponseTypeDef
encryptionType
- Type: typing.Literal['KMS_BASED_ENCRYPTION', 'SITEWISE_DEFAULT_ENCRYPTION']
- Required: Yes
kmsKeyArn
- Type:
- Required: Yes
configurationStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeGatewayCapabilityConfigurationRequestRequestTypeDef
gatewayId
- Type:
- Required: Yes
capabilityNamespace
- Type:
- Required: Yes
DescribeGatewayCapabilityConfigurationResponseTypeDef
gatewayId
- Type:
- Required: Yes
capabilityNamespace
- Type:
- Required: Yes
capabilityConfiguration
- Type:
- Required: Yes
capabilitySyncStatus
- Type: typing.Literal['IN_SYNC', 'OUT_OF_SYNC', 'SYNC_FAILED', 'UNKNOWN']
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeGatewayRequestRequestTypeDef
gatewayId
- Type:
- Required: Yes
DescribeGatewayResponseTypeDef
gatewayId
- Type:
- Required: Yes
gatewayName
- Type:
- Required: Yes
gatewayArn
- Type:
- Required: Yes
gatewayPlatform
- Type:
- Required: Yes
gatewayCapabilitySummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.GatewayCapabilitySummaryTypeDef]
- Required: Yes
creationDate
- Type:
- Required: Yes
lastUpdateDate
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeLoggingOptionsResponseTypeDef
loggingOptions
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribePortalRequestPortalActiveWaitTypeDef
portalId
- Type:
- Required: Yes
WaiterConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.WaiterConfigTypeDef]
DescribePortalRequestPortalNotExistsWaitTypeDef
portalId
- Type:
- Required: Yes
WaiterConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.WaiterConfigTypeDef]
DescribePortalRequestRequestTypeDef
portalId
- Type:
- Required: Yes
DescribePortalResponseTypeDef
portalId
- Type:
- Required: Yes
portalArn
- Type:
- Required: Yes
portalName
- Type:
- Required: Yes
portalDescription
- Type:
- Required: Yes
portalClientId
- Type:
- Required: Yes
portalStartUrl
- Type:
- Required: Yes
portalContactEmail
- Type:
- Required: Yes
portalStatus
- Type:
- Required: Yes
portalCreationDate
- Type:
- Required: Yes
portalLastUpdateDate
- Type:
- Required: Yes
portalLogoImageLocation
- Type:
- Required: Yes
roleArn
- Type:
- Required: Yes
portalAuthMode
- Type: typing.Literal['IAM', 'SSO']
- Required: Yes
notificationSenderEmail
- Type:
- Required: Yes
alarms
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeProjectRequestRequestTypeDef
projectId
- Type:
- Required: Yes
DescribeProjectResponseTypeDef
projectId
- Type:
- Required: Yes
projectArn
- Type:
- Required: Yes
projectName
- Type:
- Required: Yes
portalId
- Type:
- Required: Yes
projectDescription
- Type:
- Required: Yes
projectCreationDate
- Type:
- Required: Yes
projectLastUpdateDate
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeStorageConfigurationResponseTypeDef
storageType
- Type: typing.Literal['MULTI_LAYER_STORAGE', 'SITEWISE_DEFAULT_STORAGE']
- Required: Yes
multiLayerStorage
- Type:
- Required: Yes
disassociatedDataStorage
- Type: typing.Literal['DISABLED', 'ENABLED']
- Required: Yes
retentionPeriod
- Type:
- Required: Yes
configurationStatus
- Type:
- Required: Yes
lastUpdateDate
- Type:
- Required: Yes
warmTier
- Type: typing.Literal['DISABLED', 'ENABLED']
- Required: Yes
warmTierRetentionPeriod
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DescribeTimeSeriesRequestRequestTypeDef
alias
- Type: typing.Optional[str]
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
DescribeTimeSeriesResponseTypeDef
assetId
- Type:
- Required: Yes
propertyId
- Type:
- Required: Yes
alias
- Type:
- Required: Yes
timeSeriesId
- Type:
- Required: Yes
dataType
- Type: typing.Literal['BOOLEAN', 'DOUBLE', 'INTEGER', 'STRING', 'STRUCT']
- Required: Yes
dataTypeSpec
- Type:
- Required: Yes
timeSeriesCreationDate
- Type:
- Required: Yes
timeSeriesLastUpdateDate
- Type:
- Required: Yes
timeSeriesArn
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
DetailedErrorTypeDef
code
- Type: typing.Literal['INCOMPATIBLE_COMPUTE_LOCATION', 'INCOMPATIBLE_FORWARDING_CONFIGURATION']
- Required: Yes
message
- Type:
- Required: Yes
DisassociateAssetsRequestRequestTypeDef
assetId
- Type:
- Required: Yes
hierarchyId
- Type:
- Required: Yes
childAssetId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef
alias
- Type:
- Required: Yes
assetId
- Type:
- Required: Yes
propertyId
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
EmptyResponseMetadataTypeDef
ResponseMetadata
- Type:
- Required: Yes
ErrorDetailsTypeDef
code
- Type: typing.Literal['INTERNAL_FAILURE', 'VALIDATION_ERROR']
- Required: Yes
message
- Type:
- Required: Yes
details
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.DetailedErrorTypeDef]]
ErrorReportLocationTypeDef
bucket
- Type:
- Required: Yes
prefix
- Type:
- Required: Yes
ExecuteActionRequestRequestTypeDef
targetResource
- Type:
- Required: Yes
actionDefinitionId
- Type:
- Required: Yes
actionPayload
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
ExecuteActionResponseTypeDef
actionId
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ExecuteQueryRequestExecuteQueryPaginateTypeDef
queryStatement
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ExecuteQueryRequestRequestTypeDef
queryStatement
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
ExecuteQueryResponseTypeDef
columns
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.ColumnInfoTypeDef]
- Required: Yes
rows
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.RowTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ExpressionVariablePaginatorTypeDef
name
- Type:
- Required: Yes
value
- Type:
- Required: Yes
ExpressionVariableTypeDef
name
- Type:
- Required: Yes
value
- Type:
- Required: Yes
FileFormatTypeDef
csv
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.CsvTypeDef]
parquet
- Type: typing.Optional[typing.Mapping[str, typing.Any]]
FileTypeDef
bucket
- Type:
- Required: Yes
key
- Type:
- Required: Yes
versionId
- Type: typing.Optional[str]
ForwardingConfigTypeDef
state
- Type: typing.Literal['DISABLED', 'ENABLED']
- Required: Yes
GatewayCapabilitySummaryTypeDef
capabilityNamespace
- Type:
- Required: Yes
capabilitySyncStatus
- Type: typing.Literal['IN_SYNC', 'OUT_OF_SYNC', 'SYNC_FAILED', 'UNKNOWN']
- Required: Yes
GatewayPlatformTypeDef
greengrass
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.GreengrassTypeDef]
greengrassV2
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.GreengrassV2TypeDef]
GatewaySummaryTypeDef
gatewayId
- Type:
- Required: Yes
gatewayName
- Type:
- Required: Yes
creationDate
- Type:
- Required: Yes
lastUpdateDate
- Type:
- Required: Yes
gatewayPlatform
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.GatewayPlatformTypeDef]
gatewayCapabilitySummaries
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.GatewayCapabilitySummaryTypeDef]]
GetAssetPropertyAggregatesRequestGetAssetPropertyAggregatesPaginateTypeDef
aggregateTypes
- Type: typing.Sequence[typing.Literal['AVERAGE', 'COUNT', 'MAXIMUM', 'MINIMUM', 'STANDARD_DEVIATION', 'SUM']]
- Required: Yes
resolution
- Type:
- Required: Yes
startDate
- Type: typing.Union[datetime.datetime, str]
- Required: Yes
endDate
- Type: typing.Union[datetime.datetime, str]
- Required: Yes
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
propertyAlias
- Type: typing.Optional[str]
qualities
- Type: typing.Optional[typing.Sequence[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]]
timeOrdering
- Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
GetAssetPropertyAggregatesRequestRequestTypeDef
aggregateTypes
- Type: typing.Sequence[typing.Literal['AVERAGE', 'COUNT', 'MAXIMUM', 'MINIMUM', 'STANDARD_DEVIATION', 'SUM']]
- Required: Yes
resolution
- Type:
- Required: Yes
startDate
- Type: typing.Union[datetime.datetime, str]
- Required: Yes
endDate
- Type: typing.Union[datetime.datetime, str]
- Required: Yes
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
propertyAlias
- Type: typing.Optional[str]
qualities
- Type: typing.Optional[typing.Sequence[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]]
timeOrdering
- Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
GetAssetPropertyAggregatesResponseTypeDef
aggregatedValues
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AggregatedValueTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetAssetPropertyValueHistoryRequestGetAssetPropertyValueHistoryPaginateTypeDef
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
propertyAlias
- Type: typing.Optional[str]
startDate
- Type: typing.Union[datetime.datetime, str, NoneType]
endDate
- Type: typing.Union[datetime.datetime, str, NoneType]
qualities
- Type: typing.Optional[typing.Sequence[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]]
timeOrdering
- Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
GetAssetPropertyValueHistoryRequestRequestTypeDef
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
propertyAlias
- Type: typing.Optional[str]
startDate
- Type: typing.Union[datetime.datetime, str, NoneType]
endDate
- Type: typing.Union[datetime.datetime, str, NoneType]
qualities
- Type: typing.Optional[typing.Sequence[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]]
timeOrdering
- Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
GetAssetPropertyValueHistoryResponseTypeDef
assetPropertyValueHistory
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetPropertyValueTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetAssetPropertyValueRequestRequestTypeDef
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
propertyAlias
- Type: typing.Optional[str]
GetAssetPropertyValueResponseTypeDef
propertyValue
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetInterpolatedAssetPropertyValuesRequestGetInterpolatedAssetPropertyValuesPaginateTypeDef
startTimeInSeconds
- Type:
- Required: Yes
endTimeInSeconds
- Type:
- Required: Yes
quality
- Type: typing.Literal['BAD', 'GOOD', 'UNCERTAIN']
- Required: Yes
intervalInSeconds
- Type:
- Required: Yes
type
- Type:
- Required: Yes
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
propertyAlias
- Type: typing.Optional[str]
startTimeOffsetInNanos
- Type: typing.Optional[int]
endTimeOffsetInNanos
- Type: typing.Optional[int]
intervalWindowInSeconds
- Type: typing.Optional[int]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
GetInterpolatedAssetPropertyValuesRequestRequestTypeDef
startTimeInSeconds
- Type:
- Required: Yes
endTimeInSeconds
- Type:
- Required: Yes
quality
- Type: typing.Literal['BAD', 'GOOD', 'UNCERTAIN']
- Required: Yes
intervalInSeconds
- Type:
- Required: Yes
type
- Type:
- Required: Yes
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
propertyAlias
- Type: typing.Optional[str]
startTimeOffsetInNanos
- Type: typing.Optional[int]
endTimeOffsetInNanos
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
intervalWindowInSeconds
- Type: typing.Optional[int]
GetInterpolatedAssetPropertyValuesResponseTypeDef
interpolatedAssetPropertyValues
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.InterpolatedAssetPropertyValueTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GreengrassTypeDef
groupArn
- Type:
- Required: Yes
GreengrassV2TypeDef
coreDeviceThingName
- Type:
- Required: Yes
GroupIdentityTypeDef
id
- Type:
- Required: Yes
IAMRoleIdentityTypeDef
arn
- Type:
- Required: Yes
IAMUserIdentityTypeDef
arn
- Type:
- Required: Yes
IdentityTypeDef
user
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.UserIdentityTypeDef]
group
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.GroupIdentityTypeDef]
iamUser
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.IAMUserIdentityTypeDef]
iamRole
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.IAMRoleIdentityTypeDef]
ImageFileTypeDef
data
- Type: typing.Union[str, bytes, typing.IO[typing.Any]]
- Required: Yes
type
- Type: typing.Literal['PNG']
- Required: Yes
ImageLocationTypeDef
id
- Type:
- Required: Yes
url
- Type:
- Required: Yes
ImageTypeDef
id
- Type: typing.Optional[str]
file
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.ImageFileTypeDef]
InterpolatedAssetPropertyValueTypeDef
timestamp
- Type:
- Required: Yes
value
- Type:
- Required: Yes
JobConfigurationTypeDef
fileFormat
- Type:
- Required: Yes
JobSummaryTypeDef
id
- Type:
- Required: Yes
name
- Type:
- Required: Yes
status
- Type: typing.Literal['CANCELLED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', 'FAILED', 'PENDING', 'RUNNING']
- Required: Yes
ListAccessPoliciesRequestListAccessPoliciesPaginateTypeDef
identityType
- Type: typing.Optional[typing.Literal['GROUP', 'IAM', 'USER']]
identityId
- Type: typing.Optional[str]
resourceType
- Type: typing.Optional[typing.Literal['PORTAL', 'PROJECT']]
resourceId
- Type: typing.Optional[str]
iamArn
- Type: typing.Optional[str]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListAccessPoliciesRequestRequestTypeDef
identityType
- Type: typing.Optional[typing.Literal['GROUP', 'IAM', 'USER']]
identityId
- Type: typing.Optional[str]
resourceType
- Type: typing.Optional[typing.Literal['PORTAL', 'PROJECT']]
resourceId
- Type: typing.Optional[str]
iamArn
- Type: typing.Optional[str]
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
ListAccessPoliciesResponseTypeDef
accessPolicySummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AccessPolicySummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListActionsRequestListActionsPaginateTypeDef
targetResourceType
- Type: typing.Literal['ASSET']
- Required: Yes
targetResourceId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListActionsRequestRequestTypeDef
targetResourceType
- Type: typing.Literal['ASSET']
- Required: Yes
targetResourceId
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
ListActionsResponseTypeDef
actionSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.ActionSummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListAssetModelCompositeModelsRequestListAssetModelCompositeModelsPaginateTypeDef
assetModelId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListAssetModelCompositeModelsRequestRequestTypeDef
assetModelId
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
ListAssetModelCompositeModelsResponseTypeDef
assetModelCompositeModelSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelCompositeModelSummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef
assetModelId
- Type:
- Required: Yes
filter
- Type: typing.Optional[typing.Literal['ALL', 'BASE']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListAssetModelPropertiesRequestRequestTypeDef
assetModelId
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
filter
- Type: typing.Optional[typing.Literal['ALL', 'BASE']]
ListAssetModelPropertiesResponsePaginatorTypeDef
assetModelPropertySummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertySummaryPaginatorTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListAssetModelPropertiesResponseTypeDef
assetModelPropertySummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertySummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListAssetModelsRequestListAssetModelsPaginateTypeDef
assetModelTypes
- Type: typing.Optional[typing.Sequence[typing.Literal['ASSET_MODEL', 'COMPONENT_MODEL']]]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListAssetModelsRequestRequestTypeDef
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
assetModelTypes
- Type: typing.Optional[typing.Sequence[typing.Literal['ASSET_MODEL', 'COMPONENT_MODEL']]]
ListAssetModelsResponseTypeDef
assetModelSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelSummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef
assetId
- Type:
- Required: Yes
filter
- Type: typing.Optional[typing.Literal['ALL', 'BASE']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListAssetPropertiesRequestRequestTypeDef
assetId
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
filter
- Type: typing.Optional[typing.Literal['ALL', 'BASE']]
ListAssetPropertiesResponseTypeDef
assetPropertySummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetPropertySummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef
assetId
- Type:
- Required: Yes
traversalType
- Type: typing.Literal['PATH_TO_ROOT']
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListAssetRelationshipsRequestRequestTypeDef
assetId
- Type:
- Required: Yes
traversalType
- Type: typing.Literal['PATH_TO_ROOT']
- Required: Yes
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
ListAssetRelationshipsResponseTypeDef
assetRelationshipSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetRelationshipSummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListAssetsRequestListAssetsPaginateTypeDef
assetModelId
- Type: typing.Optional[str]
filter
- Type: typing.Optional[typing.Literal['ALL', 'TOP_LEVEL']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListAssetsRequestRequestTypeDef
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
assetModelId
- Type: typing.Optional[str]
filter
- Type: typing.Optional[typing.Literal['ALL', 'TOP_LEVEL']]
ListAssetsResponseTypeDef
assetSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetSummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef
assetId
- Type:
- Required: Yes
hierarchyId
- Type: typing.Optional[str]
traversalDirection
- Type: typing.Optional[typing.Literal['CHILD', 'PARENT']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListAssociatedAssetsRequestRequestTypeDef
assetId
- Type:
- Required: Yes
hierarchyId
- Type: typing.Optional[str]
traversalDirection
- Type: typing.Optional[typing.Literal['CHILD', 'PARENT']]
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
ListAssociatedAssetsResponseTypeDef
assetSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssociatedAssetsSummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef
filter
- Type: typing.Optional[typing.Literal['ALL', 'CANCELLED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', 'FAILED', 'PENDING', 'RUNNING']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListBulkImportJobsRequestRequestTypeDef
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
filter
- Type: typing.Optional[typing.Literal['ALL', 'CANCELLED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', 'FAILED', 'PENDING', 'RUNNING']]
ListBulkImportJobsResponseTypeDef
jobSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.JobSummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListCompositionRelationshipsRequestListCompositionRelationshipsPaginateTypeDef
assetModelId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListCompositionRelationshipsRequestRequestTypeDef
assetModelId
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
ListCompositionRelationshipsResponseTypeDef
compositionRelationshipSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.CompositionRelationshipSummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListDashboardsRequestListDashboardsPaginateTypeDef
projectId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListDashboardsRequestRequestTypeDef
projectId
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
ListDashboardsResponseTypeDef
dashboardSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.DashboardSummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListGatewaysRequestListGatewaysPaginateTypeDef
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListGatewaysRequestRequestTypeDef
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
ListGatewaysResponseTypeDef
gatewaySummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.GatewaySummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListPortalsRequestListPortalsPaginateTypeDef
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListPortalsRequestRequestTypeDef
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
ListPortalsResponseTypeDef
portalSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.PortalSummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListProjectAssetsRequestListProjectAssetsPaginateTypeDef
projectId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListProjectAssetsRequestRequestTypeDef
projectId
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
ListProjectAssetsResponseTypeDef
assetIds
- Type: typing.List[str]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListProjectsRequestListProjectsPaginateTypeDef
portalId
- Type:
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListProjectsRequestRequestTypeDef
portalId
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
ListProjectsResponseTypeDef
projectSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.ProjectSummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListTagsForResourceRequestRequestTypeDef
resourceArn
- Type:
- Required: Yes
ListTagsForResourceResponseTypeDef
tags
- Type: typing.Dict[str, str]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListTimeSeriesRequestListTimeSeriesPaginateTypeDef
assetId
- Type: typing.Optional[str]
aliasPrefix
- Type: typing.Optional[str]
timeSeriesType
- Type: typing.Optional[typing.Literal['ASSOCIATED', 'DISASSOCIATED']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PaginatorConfigTypeDef]
ListTimeSeriesRequestRequestTypeDef
nextToken
- Type: typing.Optional[str]
maxResults
- Type: typing.Optional[int]
assetId
- Type: typing.Optional[str]
aliasPrefix
- Type: typing.Optional[str]
timeSeriesType
- Type: typing.Optional[typing.Literal['ASSOCIATED', 'DISASSOCIATED']]
ListTimeSeriesResponseTypeDef
TimeSeriesSummaries
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.TimeSeriesSummaryTypeDef]
- Required: Yes
nextToken
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
LoggingOptionsTypeDef
level
- Type: typing.Literal['ERROR', 'INFO', 'OFF']
- Required: Yes
MeasurementProcessingConfigTypeDef
forwardingConfig
- Type:
- Required: Yes
MeasurementTypeDef
processingConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.MeasurementProcessingConfigTypeDef]
MetricPaginatorTypeDef
expression
- Type:
- Required: Yes
variables
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.ExpressionVariablePaginatorTypeDef]
- Required: Yes
window
- Type:
- Required: Yes
processingConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.MetricProcessingConfigTypeDef]
MetricProcessingConfigTypeDef
computeLocation
- Type: typing.Literal['CLOUD', 'EDGE']
- Required: Yes
MetricTypeDef
expression
- Type:
- Required: Yes
variables
- Type: typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.ExpressionVariableTypeDef]
- Required: Yes
window
- Type:
- Required: Yes
processingConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.MetricProcessingConfigTypeDef]
MetricWindowTypeDef
tumbling
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.TumblingWindowTypeDef]
MonitorErrorDetailsTypeDef
code
- Type: typing.Optional[typing.Literal['INTERNAL_FAILURE', 'LIMIT_EXCEEDED', 'VALIDATION_ERROR']]
message
- Type: typing.Optional[str]
MultiLayerStorageTypeDef
customerManagedS3Storage
- Type:
- Required: Yes
PaginatorConfigTypeDef
MaxItems
- Type: typing.Optional[int]
PageSize
- Type: typing.Optional[int]
StartingToken
- Type: typing.Optional[str]
PortalResourceTypeDef
id
- Type:
- Required: Yes
PortalStatusTypeDef
state
- Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
- Required: Yes
error
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.MonitorErrorDetailsTypeDef]
PortalSummaryTypeDef
id
- Type:
- Required: Yes
name
- Type:
- Required: Yes
startUrl
- Type:
- Required: Yes
status
- Type:
- Required: Yes
description
- Type: typing.Optional[str]
creationDate
- Type: typing.Optional[datetime.datetime]
lastUpdateDate
- Type: typing.Optional[datetime.datetime]
roleArn
- Type: typing.Optional[str]
ProjectResourceTypeDef
id
- Type:
- Required: Yes
ProjectSummaryTypeDef
id
- Type:
- Required: Yes
name
- Type:
- Required: Yes
description
- Type: typing.Optional[str]
creationDate
- Type: typing.Optional[datetime.datetime]
lastUpdateDate
- Type: typing.Optional[datetime.datetime]
PropertyNotificationTypeDef
topic
- Type:
- Required: Yes
state
- Type: typing.Literal['DISABLED', 'ENABLED']
- Required: Yes
PropertyTypeDef
id
- Type:
- Required: Yes
name
- Type:
- Required: Yes
dataType
- Type: typing.Literal['BOOLEAN', 'DOUBLE', 'INTEGER', 'STRING', 'STRUCT']
- Required: Yes
alias
- Type: typing.Optional[str]
notification
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PropertyNotificationTypeDef]
unit
- Type: typing.Optional[str]
type
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PropertyTypeTypeDef]
path
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetPropertyPathSegmentTypeDef]]
externalId
- Type: typing.Optional[str]
PropertyTypePaginatorTypeDef
attribute
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.AttributeTypeDef]
measurement
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.MeasurementTypeDef]
transform
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.TransformPaginatorTypeDef]
metric
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.MetricPaginatorTypeDef]
PropertyTypeTypeDef
attribute
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.AttributeTypeDef]
measurement
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.MeasurementTypeDef]
transform
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.TransformTypeDef]
metric
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.MetricTypeDef]
PutAssetPropertyValueEntryTypeDef
entryId
- Type:
- Required: Yes
propertyValues
- Type: typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetPropertyValueTypeDef]
- Required: Yes
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
propertyAlias
- Type: typing.Optional[str]
PutDefaultEncryptionConfigurationRequestRequestTypeDef
encryptionType
- Type: typing.Literal['KMS_BASED_ENCRYPTION', 'SITEWISE_DEFAULT_ENCRYPTION']
- Required: Yes
kmsKeyId
- Type: typing.Optional[str]
PutDefaultEncryptionConfigurationResponseTypeDef
encryptionType
- Type: typing.Literal['KMS_BASED_ENCRYPTION', 'SITEWISE_DEFAULT_ENCRYPTION']
- Required: Yes
kmsKeyArn
- Type:
- Required: Yes
configurationStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
PutLoggingOptionsRequestRequestTypeDef
loggingOptions
- Type:
- Required: Yes
PutStorageConfigurationRequestRequestTypeDef
storageType
- Type: typing.Literal['MULTI_LAYER_STORAGE', 'SITEWISE_DEFAULT_STORAGE']
- Required: Yes
multiLayerStorage
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.MultiLayerStorageTypeDef]
disassociatedDataStorage
- Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]
retentionPeriod
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.RetentionPeriodTypeDef]
warmTier
- Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]
warmTierRetentionPeriod
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.WarmTierRetentionPeriodTypeDef]
PutStorageConfigurationResponseTypeDef
storageType
- Type: typing.Literal['MULTI_LAYER_STORAGE', 'SITEWISE_DEFAULT_STORAGE']
- Required: Yes
multiLayerStorage
- Type:
- Required: Yes
disassociatedDataStorage
- Type: typing.Literal['DISABLED', 'ENABLED']
- Required: Yes
retentionPeriod
- Type:
- Required: Yes
configurationStatus
- Type:
- Required: Yes
warmTier
- Type: typing.Literal['DISABLED', 'ENABLED']
- Required: Yes
warmTierRetentionPeriod
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ResourceTypeDef
portal
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.PortalResourceTypeDef]
project
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.ProjectResourceTypeDef]
ResponseMetadataTypeDef
RequestId
- Type:
- Required: Yes
HostId
- Type:
- Required: Yes
HTTPStatusCode
- Type:
- Required: Yes
HTTPHeaders
- Type: typing.Dict[str, str]
- Required: Yes
RetryAttempts
- Type:
- Required: Yes
RetentionPeriodTypeDef
numberOfDays
- Type: typing.Optional[int]
unlimited
- Type: typing.Optional[bool]
RowTypeDef
data
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.DatumTypeDef]
- Required: Yes
TagResourceRequestRequestTypeDef
resourceArn
- Type:
- Required: Yes
tags
- Type: typing.Mapping[str, str]
- Required: Yes
TargetResourceTypeDef
assetId
- Type:
- Required: Yes
TimeInNanosTypeDef
timeInSeconds
- Type:
- Required: Yes
offsetInNanos
- Type: typing.Optional[int]
TimeSeriesSummaryTypeDef
timeSeriesId
- Type:
- Required: Yes
dataType
- Type: typing.Literal['BOOLEAN', 'DOUBLE', 'INTEGER', 'STRING', 'STRUCT']
- Required: Yes
timeSeriesCreationDate
- Type:
- Required: Yes
timeSeriesLastUpdateDate
- Type:
- Required: Yes
timeSeriesArn
- Type:
- Required: Yes
assetId
- Type: typing.Optional[str]
propertyId
- Type: typing.Optional[str]
alias
- Type: typing.Optional[str]
dataTypeSpec
- Type: typing.Optional[str]
TransformPaginatorTypeDef
expression
- Type:
- Required: Yes
variables
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.ExpressionVariablePaginatorTypeDef]
- Required: Yes
processingConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.TransformProcessingConfigTypeDef]
TransformProcessingConfigTypeDef
computeLocation
- Type: typing.Literal['CLOUD', 'EDGE']
- Required: Yes
forwardingConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.ForwardingConfigTypeDef]
TransformTypeDef
expression
- Type:
- Required: Yes
variables
- Type: typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.ExpressionVariableTypeDef]
- Required: Yes
processingConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.TransformProcessingConfigTypeDef]
TumblingWindowTypeDef
interval
- Type:
- Required: Yes
offset
- Type: typing.Optional[str]
UntagResourceRequestRequestTypeDef
resourceArn
- Type:
- Required: Yes
tagKeys
- Type: typing.Sequence[str]
- Required: Yes
UpdateAccessPolicyRequestRequestTypeDef
accessPolicyId
- Type:
- Required: Yes
accessPolicyIdentity
- Type:
- Required: Yes
accessPolicyResource
- Type:
- Required: Yes
accessPolicyPermission
- Type: typing.Literal['ADMINISTRATOR', 'VIEWER']
- Required: Yes
clientToken
- Type: typing.Optional[str]
UpdateAssetModelCompositeModelRequestRequestTypeDef
assetModelId
- Type:
- Required: Yes
assetModelCompositeModelId
- Type:
- Required: Yes
assetModelCompositeModelName
- Type:
- Required: Yes
assetModelCompositeModelExternalId
- Type: typing.Optional[str]
assetModelCompositeModelDescription
- Type: typing.Optional[str]
clientToken
- Type: typing.Optional[str]
assetModelCompositeModelProperties
- Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyTypeDef]]
UpdateAssetModelCompositeModelResponseTypeDef
assetModelCompositeModelPath
- Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelCompositeModelPathSegmentTypeDef]
- Required: Yes
assetModelStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateAssetModelRequestRequestTypeDef
assetModelId
- Type:
- Required: Yes
assetModelName
- Type:
- Required: Yes
assetModelDescription
- Type: typing.Optional[str]
assetModelProperties
- Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyTypeDef]]
assetModelHierarchies
- Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelHierarchyTypeDef]]
assetModelCompositeModels
- Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelCompositeModelTypeDef]]
clientToken
- Type: typing.Optional[str]
assetModelExternalId
- Type: typing.Optional[str]
UpdateAssetModelResponseTypeDef
assetModelStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateAssetPropertyRequestRequestTypeDef
assetId
- Type:
- Required: Yes
propertyId
- Type:
- Required: Yes
propertyAlias
- Type: typing.Optional[str]
propertyNotificationState
- Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]
clientToken
- Type: typing.Optional[str]
propertyUnit
- Type: typing.Optional[str]
UpdateAssetRequestRequestTypeDef
assetId
- Type:
- Required: Yes
assetName
- Type:
- Required: Yes
clientToken
- Type: typing.Optional[str]
assetDescription
- Type: typing.Optional[str]
assetExternalId
- Type: typing.Optional[str]
UpdateAssetResponseTypeDef
assetStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateDashboardRequestRequestTypeDef
dashboardId
- Type:
- Required: Yes
dashboardName
- Type:
- Required: Yes
dashboardDefinition
- Type:
- Required: Yes
dashboardDescription
- Type: typing.Optional[str]
clientToken
- Type: typing.Optional[str]
UpdateGatewayCapabilityConfigurationRequestRequestTypeDef
gatewayId
- Type:
- Required: Yes
capabilityNamespace
- Type:
- Required: Yes
capabilityConfiguration
- Type:
- Required: Yes
UpdateGatewayCapabilityConfigurationResponseTypeDef
capabilityNamespace
- Type:
- Required: Yes
capabilitySyncStatus
- Type: typing.Literal['IN_SYNC', 'OUT_OF_SYNC', 'SYNC_FAILED', 'UNKNOWN']
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateGatewayRequestRequestTypeDef
gatewayId
- Type:
- Required: Yes
gatewayName
- Type:
- Required: Yes
UpdatePortalRequestRequestTypeDef
portalId
- Type:
- Required: Yes
portalName
- Type:
- Required: Yes
portalContactEmail
- Type:
- Required: Yes
roleArn
- Type:
- Required: Yes
portalDescription
- Type: typing.Optional[str]
portalLogoImage
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.ImageTypeDef]
clientToken
- Type: typing.Optional[str]
notificationSenderEmail
- Type: typing.Optional[str]
alarms
- Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise_classes.AlarmsTypeDef]
UpdatePortalResponseTypeDef
portalStatus
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
UpdateProjectRequestRequestTypeDef
projectId
- Type:
- Required: Yes
projectName
- Type:
- Required: Yes
projectDescription
- Type: typing.Optional[str]
clientToken
- Type: typing.Optional[str]
UserIdentityTypeDef
id
- Type:
- Required: Yes
VariableValuePaginatorTypeDef
propertyId
- Type: typing.Optional[str]
hierarchyId
- Type: typing.Optional[str]
propertyPath
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyPathSegmentTypeDef]]
VariableValueTypeDef
propertyId
- Type: typing.Optional[str]
hierarchyId
- Type: typing.Optional[str]
propertyPath
- Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.iotsitewise_classes.AssetModelPropertyPathSegmentTypeDef]]
VariantTypeDef
stringValue
- Type: typing.Optional[str]
integerValue
- Type: typing.Optional[int]
doubleValue
- Type: typing.Optional[float]
booleanValue
- Type: typing.Optional[bool]
WaiterConfigTypeDef
Delay
- Type: typing.Optional[int]
MaxAttempts
- Type: typing.Optional[int]
WarmTierRetentionPeriodTypeDef
numberOfDays
- Type: typing.Optional[int]
unlimited
- Type: typing.Optional[bool]