Skip to content

Iotsitewise Classes

AccessDeniedException

message

  • Type: typing.Optional[str]

AccessPolicySummary

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]

ActionDefinition

actionDefinitionId

  • Type:
  • Required: Yes

actionName

  • Type:
  • Required: Yes

actionType

  • Type:
  • Required: Yes

ActionPayload

stringValue

  • Type:
  • Required: Yes

ActionSummary

actionId

  • Type: typing.Optional[str]

actionDefinitionId

  • Type: typing.Optional[str]

targetResource

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.TargetResource]

AggregatedValue

timestamp

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

quality

  • Type: typing.Optional[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]

Aggregates

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]

Alarms

alarmRoleArn

  • Type:
  • Required: Yes

notificationLambdaArn

  • Type: typing.Optional[str]

AssetCompositeModel

name

  • Type:
  • Required: Yes

type

  • Type:
  • Required: Yes

properties

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetProperty]
  • Required: Yes

description

  • Type: typing.Optional[str]

id

  • Type: typing.Optional[str]

externalId

  • Type: typing.Optional[str]

AssetCompositeModelPathSegment

id

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

AssetCompositeModelSummary

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.iotsitewise_classes.AssetCompositeModelPathSegment]
  • Required: Yes

externalId

  • Type: typing.Optional[str]

AssetErrorDetails

assetId

  • Type:
  • Required: Yes

code

  • Type: typing.Literal['INTERNAL_FAILURE']
  • Required: Yes

message

  • Type:
  • Required: Yes

AssetHierarchy

name

  • Type:
  • Required: Yes

id

  • Type: typing.Optional[str]

externalId

  • Type: typing.Optional[str]

AssetHierarchyInfo

parentAssetId

  • Type: typing.Optional[str]

childAssetId

  • Type: typing.Optional[str]

AssetModelCompositeModel

name

  • Type:
  • Required: Yes

type

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

properties

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelProperty, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelPropertyOutput]]]

id

  • Type: typing.Optional[str]

externalId

  • Type: typing.Optional[str]

AssetModelCompositeModelDefinition

name

  • Type:
  • Required: Yes

type

  • Type:
  • Required: Yes

id

  • Type: typing.Optional[str]

externalId

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

properties

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelPropertyDefinition]]

AssetModelCompositeModelOutput

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.iotsitewise_classes.AssetModelPropertyOutput]]

id

  • Type: typing.Optional[str]

externalId

  • Type: typing.Optional[str]

AssetModelCompositeModelPathSegment

id

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

AssetModelCompositeModelSummary

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.iotsitewise_classes.AssetModelCompositeModelPathSegment]]

AssetModelHierarchy

name

  • Type:
  • Required: Yes

childAssetModelId

  • Type:
  • Required: Yes

id

  • Type: typing.Optional[str]

externalId

  • Type: typing.Optional[str]

AssetModelHierarchyDefinition

name

  • Type:
  • Required: Yes

childAssetModelId

  • Type:
  • Required: Yes

id

  • Type: typing.Optional[str]

externalId

  • Type: typing.Optional[str]

AssetModelProperty

name

  • Type:
  • Required: Yes

dataType

  • Type: typing.Literal['BOOLEAN', 'DOUBLE', 'INTEGER', 'STRING', 'STRUCT']
  • Required: Yes

type

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PropertyType, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PropertyTypeOutput]
  • Required: Yes

id

  • Type: typing.Optional[str]

externalId

  • 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.iotsitewise_classes.AssetModelPropertyPathSegment]]

AssetModelPropertyDefinition

name

  • Type:
  • Required: Yes

dataType

  • Type: typing.Literal['BOOLEAN', 'DOUBLE', 'INTEGER', 'STRING', 'STRUCT']
  • Required: Yes

type

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PropertyType, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PropertyTypeOutput]
  • Required: Yes

id

  • Type: typing.Optional[str]

externalId

  • Type: typing.Optional[str]

dataTypeSpec

  • Type: typing.Optional[str]

unit

  • Type: typing.Optional[str]

AssetModelPropertyOutput

name

  • Type:
  • Required: Yes

dataType

  • Type: typing.Literal['BOOLEAN', 'DOUBLE', 'INTEGER', 'STRING', 'STRUCT']
  • Required: Yes

type

  • Type:
  • Required: Yes

id

  • Type: typing.Optional[str]

externalId

  • 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.iotsitewise_classes.AssetModelPropertyPathSegment]]

AssetModelPropertyPathSegment

id

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

AssetModelPropertySummary

name

  • Type:
  • Required: Yes

dataType

  • Type: typing.Literal['BOOLEAN', 'DOUBLE', 'INTEGER', 'STRING', 'STRUCT']
  • Required: Yes

type

  • Type:
  • Required: Yes

id

  • Type: typing.Optional[str]

externalId

  • 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.iotsitewise_classes.AssetModelPropertyPathSegment]]

AssetModelStatus

state

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'PROPAGATING', 'UPDATING']
  • Required: Yes

error

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ErrorDetails]

AssetModelSummary

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

externalId

  • Type: typing.Optional[str]

assetModelType

  • Type: typing.Optional[typing.Literal['ASSET_MODEL', 'COMPONENT_MODEL']]

version

  • Type: typing.Optional[str]

AssetProperty

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.iotsitewise_classes.PropertyNotification]

dataTypeSpec

  • Type: typing.Optional[str]

unit

  • Type: typing.Optional[str]

path

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetPropertyPathSegment]]

externalId

  • Type: typing.Optional[str]

AssetPropertyPathSegment

id

  • Type: typing.Optional[str]

name

  • Type: typing.Optional[str]

AssetPropertySummary

id

  • Type:
  • Required: Yes

alias

  • Type: typing.Optional[str]

unit

  • Type: typing.Optional[str]

notification

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PropertyNotification]

assetCompositeModelId

  • Type: typing.Optional[str]

path

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetPropertyPathSegment]]

externalId

  • Type: typing.Optional[str]

AssetPropertyValue

value

  • Type:
  • Required: Yes

timestamp

  • Type:
  • Required: Yes

quality

  • Type: typing.Optional[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]

AssetRelationshipSummary

relationshipType

  • Type: typing.Literal['HIERARCHY']
  • Required: Yes

hierarchyInfo

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetHierarchyInfo]

AssetStatus

state

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
  • Required: Yes

error

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ErrorDetails]

AssetSummary

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.iotsitewise_classes.AssetHierarchy]
  • Required: Yes

description

  • Type: typing.Optional[str]

externalId

  • Type: typing.Optional[str]

AssociateAssetsRequest

assetId

  • Type:
  • Required: Yes

hierarchyId

  • Type:
  • Required: Yes

childAssetId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

AssociateTimeSeriesToAssetPropertyRequest

alias

  • Type:
  • Required: Yes

assetId

  • Type:
  • Required: Yes

propertyId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

AssociatedAssetsSummary

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.iotsitewise_classes.AssetHierarchy]
  • Required: Yes

description

  • Type: typing.Optional[str]

externalId

  • Type: typing.Optional[str]

Attribute

defaultValue

  • Type: typing.Optional[str]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BatchAssociateProjectAssetsRequest

projectId

  • Type:
  • Required: Yes

assetIds

  • Type: typing.List[str]
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

BatchAssociateProjectAssetsResponse

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetErrorDetails]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchDisassociateProjectAssetsRequest

projectId

  • Type:
  • Required: Yes

assetIds

  • Type: typing.List[str]
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

BatchDisassociateProjectAssetsResponse

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetErrorDetails]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BatchGetAssetPropertyAggregatesEntry

entryId

  • Type:
  • Required: Yes

aggregateTypes

  • Type: typing.List[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.List[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]]

timeOrdering

  • Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]

BatchGetAssetPropertyAggregatesErrorEntry

errorCode

  • Type: typing.Literal['AccessDeniedException', 'InvalidRequestException', 'ResourceNotFoundException']
  • Required: Yes

errorMessage

  • Type:
  • Required: Yes

entryId

  • Type:
  • Required: Yes

BatchGetAssetPropertyAggregatesErrorInfo

errorCode

  • Type: typing.Literal['AccessDeniedException', 'InvalidRequestException', 'ResourceNotFoundException']
  • Required: Yes

errorTimestamp

  • Type:
  • Required: Yes

BatchGetAssetPropertyAggregatesRequest

entries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyAggregatesEntry]
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

BatchGetAssetPropertyAggregatesResponse

errorEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyAggregatesErrorEntry]
  • Required: Yes

successEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyAggregatesSuccessEntry]
  • Required: Yes

skippedEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyAggregatesSkippedEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

BatchGetAssetPropertyAggregatesSkippedEntry

entryId

  • Type:
  • Required: Yes

completionStatus

  • Type: typing.Literal['ERROR', 'SUCCESS']
  • Required: Yes

errorInfo

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyAggregatesErrorInfo]

BatchGetAssetPropertyAggregatesSuccessEntry

entryId

  • Type:
  • Required: Yes

aggregatedValues

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AggregatedValue]
  • Required: Yes

BatchGetAssetPropertyValueEntry

entryId

  • Type:
  • Required: Yes

assetId

  • Type: typing.Optional[str]

propertyId

  • Type: typing.Optional[str]

propertyAlias

  • Type: typing.Optional[str]

BatchGetAssetPropertyValueErrorEntry

errorCode

  • Type: typing.Literal['AccessDeniedException', 'InvalidRequestException', 'ResourceNotFoundException']
  • Required: Yes

errorMessage

  • Type:
  • Required: Yes

entryId

  • Type:
  • Required: Yes

BatchGetAssetPropertyValueErrorInfo

errorCode

  • Type: typing.Literal['AccessDeniedException', 'InvalidRequestException', 'ResourceNotFoundException']
  • Required: Yes

errorTimestamp

  • Type:
  • Required: Yes

BatchGetAssetPropertyValueHistoryEntry

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.List[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]]

timeOrdering

  • Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]

BatchGetAssetPropertyValueHistoryErrorEntry

errorCode

  • Type: typing.Literal['AccessDeniedException', 'InvalidRequestException', 'ResourceNotFoundException']
  • Required: Yes

errorMessage

  • Type:
  • Required: Yes

entryId

  • Type:
  • Required: Yes

BatchGetAssetPropertyValueHistoryErrorInfo

errorCode

  • Type: typing.Literal['AccessDeniedException', 'InvalidRequestException', 'ResourceNotFoundException']
  • Required: Yes

errorTimestamp

  • Type:
  • Required: Yes

BatchGetAssetPropertyValueHistoryRequest

entries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyValueHistoryEntry]
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

BatchGetAssetPropertyValueHistoryResponse

errorEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyValueHistoryErrorEntry]
  • Required: Yes

successEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyValueHistorySuccessEntry]
  • Required: Yes

skippedEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyValueHistorySkippedEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

BatchGetAssetPropertyValueHistorySkippedEntry

entryId

  • Type:
  • Required: Yes

completionStatus

  • Type: typing.Literal['ERROR', 'SUCCESS']
  • Required: Yes

errorInfo

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyValueHistoryErrorInfo]

BatchGetAssetPropertyValueHistorySuccessEntry

entryId

  • Type:
  • Required: Yes

assetPropertyValueHistory

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetPropertyValue]
  • Required: Yes

BatchGetAssetPropertyValueRequest

entries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyValueEntry]
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

BatchGetAssetPropertyValueResponse

errorEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyValueErrorEntry]
  • Required: Yes

successEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyValueSuccessEntry]
  • Required: Yes

skippedEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyValueSkippedEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

BatchGetAssetPropertyValueSkippedEntry

entryId

  • Type:
  • Required: Yes

completionStatus

  • Type: typing.Literal['ERROR', 'SUCCESS']
  • Required: Yes

errorInfo

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchGetAssetPropertyValueErrorInfo]

BatchGetAssetPropertyValueSuccessEntry

entryId

  • Type:
  • Required: Yes

assetPropertyValue

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetPropertyValue]

BatchPutAssetPropertyError

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.iotsitewise_classes.TimeInNanos]
  • Required: Yes

BatchPutAssetPropertyErrorEntry

entryId

  • Type:
  • Required: Yes

errors

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchPutAssetPropertyError]
  • Required: Yes

BatchPutAssetPropertyValueRequest

entries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PutAssetPropertyValueEntry]
  • Required: Yes

enablePartialEntryProcessing

  • Type: typing.Optional[bool]

BatchPutAssetPropertyValueResponse

errorEntries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.BatchPutAssetPropertyErrorEntry]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Citation

reference

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Reference]

content

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Content]

ColumnInfo

name

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ColumnType]

ColumnType

scalarType

  • Type: typing.Optional[typing.Literal['BOOLEAN', 'DOUBLE', 'INT', 'STRING', 'TIMESTAMP']]

CompositeModelProperty

name

  • Type:
  • Required: Yes

type

  • Type:
  • Required: Yes

assetProperty

  • Type:
  • Required: Yes

id

  • Type: typing.Optional[str]

externalId

  • Type: typing.Optional[str]

CompositionDetails

compositionRelationship

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.CompositionRelationshipItem]]

CompositionRelationshipItem

id

  • Type: typing.Optional[str]

CompositionRelationshipSummary

assetModelId

  • Type:
  • Required: Yes

assetModelCompositeModelId

  • Type:
  • Required: Yes

assetModelCompositeModelType

  • Type:
  • Required: Yes

ConfigurationErrorDetails

code

  • Type: typing.Literal['INTERNAL_FAILURE', 'VALIDATION_ERROR']
  • Required: Yes

message

  • Type:
  • Required: Yes

ConfigurationStatus

state

  • Type: typing.Literal['ACTIVE', 'UPDATE_FAILED', 'UPDATE_IN_PROGRESS']
  • Required: Yes

error

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ConfigurationErrorDetails]

ConflictingOperationException

message

  • Type:
  • Required: Yes

resourceId

  • Type:
  • Required: Yes

resourceArn

  • Type:
  • Required: Yes

Content

text

  • Type: typing.Optional[str]

CreateAccessPolicyRequest

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.Dict[str, str]]

CreateAccessPolicyResponse

accessPolicyId

  • Type:
  • Required: Yes

accessPolicyArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateAssetModelCompositeModelRequest

assetModelId

  • Type:
  • Required: Yes

assetModelCompositeModelName

  • Type:
  • Required: Yes

assetModelCompositeModelType

  • Type:
  • Required: Yes

assetModelCompositeModelExternalId

  • Type: typing.Optional[str]

parentAssetModelCompositeModelId

  • 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.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelPropertyDefinition]]

ifMatch

  • Type: typing.Optional[str]

ifNoneMatch

  • Type: typing.Optional[str]

matchForVersionType

  • Type: typing.Optional[typing.Literal['ACTIVE', 'LATEST']]

CreateAssetModelCompositeModelResponse

assetModelCompositeModelId

  • Type:
  • Required: Yes

assetModelCompositeModelPath

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelCompositeModelPathSegment]
  • Required: Yes

assetModelStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateAssetModelRequest

assetModelName

  • Type:
  • Required: Yes

assetModelType

  • Type: typing.Optional[typing.Literal['ASSET_MODEL', 'COMPONENT_MODEL']]

assetModelId

  • Type: typing.Optional[str]

assetModelExternalId

  • Type: typing.Optional[str]

assetModelDescription

  • Type: typing.Optional[str]

assetModelProperties

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelPropertyDefinition]]

assetModelHierarchies

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelHierarchyDefinition]]

assetModelCompositeModels

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelCompositeModelDefinition]]

clientToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateAssetModelResponse

assetModelId

  • Type:
  • Required: Yes

assetModelArn

  • Type:
  • Required: Yes

assetModelStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateAssetRequest

assetName

  • Type:
  • Required: Yes

assetModelId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

assetDescription

  • Type: typing.Optional[str]

assetId

  • Type: typing.Optional[str]

assetExternalId

  • Type: typing.Optional[str]

CreateAssetResponse

assetId

  • Type:
  • Required: Yes

assetArn

  • Type:
  • Required: Yes

assetStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateBulkImportJobRequest

jobName

  • Type:
  • Required: Yes

jobRoleArn

  • Type:
  • Required: Yes

files

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.File]
  • Required: Yes

errorReportLocation

  • Type:
  • Required: Yes

jobConfiguration

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.JobConfiguration, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.JobConfigurationOutput]
  • Required: Yes

adaptiveIngestion

  • Type: typing.Optional[bool]

deleteFilesAfterImport

  • Type: typing.Optional[bool]

CreateBulkImportJobResponse

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

CreateDashboardRequest

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.Dict[str, str]]

CreateDashboardResponse

dashboardId

  • Type:
  • Required: Yes

dashboardArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateDatasetRequest

datasetName

  • Type:
  • Required: Yes

datasetSource

  • Type:
  • Required: Yes

datasetId

  • Type: typing.Optional[str]

datasetDescription

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateDatasetResponse

datasetId

  • Type:
  • Required: Yes

datasetArn

  • Type:
  • Required: Yes

datasetStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateGatewayRequest

gatewayName

  • Type:
  • Required: Yes

gatewayPlatform

  • Type:
  • Required: Yes

gatewayVersion

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateGatewayResponse

gatewayId

  • Type:
  • Required: Yes

gatewayArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreatePortalRequest

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.iotsitewise_classes.ImageFile]

tags

  • Type: typing.Optional[typing.Dict[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.iotsitewise_classes.Alarms]

portalType

  • Type: typing.Optional[typing.Literal['SITEWISE_PORTAL_V1', 'SITEWISE_PORTAL_V2']]

portalTypeConfiguration

  • Type: typing.Optional[typing.Dict[str, typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PortalTypeEntry, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PortalTypeEntryOutput]]]

CreatePortalResponse

portalId

  • Type:
  • Required: Yes

portalArn

  • Type:
  • Required: Yes

portalStartUrl

  • Type:
  • Required: Yes

portalStatus

  • Type:
  • Required: Yes

ssoApplicationId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateProjectRequest

portalId

  • Type:
  • Required: Yes

projectName

  • Type:
  • Required: Yes

projectDescription

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Dict[str, str]]

CreateProjectResponse

projectId

  • Type:
  • Required: Yes

projectArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Csv

columnNames

  • Type: typing.List[typing.Literal['ALIAS', 'ASSET_ID', 'DATA_TYPE', 'PROPERTY_ID', 'QUALITY', 'TIMESTAMP_NANO_OFFSET', 'TIMESTAMP_SECONDS', 'VALUE']]
  • Required: Yes

CsvOutput

columnNames

  • Type: typing.List[typing.Literal['ALIAS', 'ASSET_ID', 'DATA_TYPE', 'PROPERTY_ID', 'QUALITY', 'TIMESTAMP_NANO_OFFSET', 'TIMESTAMP_SECONDS', 'VALUE']]
  • Required: Yes

CustomerManagedS3Storage

s3ResourceArn

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

DashboardSummary

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]

DataSetReference

datasetArn

  • Type: typing.Optional[str]

source

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Source]

DatasetSource

sourceType

  • Type: typing.Literal['KENDRA']
  • Required: Yes

sourceFormat

  • Type: typing.Literal['KNOWLEDGE_BASE']
  • Required: Yes

sourceDetail

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.SourceDetail]

DatasetStatus

state

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
  • Required: Yes

error

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ErrorDetails]

DatasetSummary

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

Datum

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]

DatumPaginator

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]

DatumWaiter

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]

DeleteAccessPolicyRequest

accessPolicyId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeleteAssetModelCompositeModelRequest

assetModelId

  • Type:
  • Required: Yes

assetModelCompositeModelId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

ifMatch

  • Type: typing.Optional[str]

ifNoneMatch

  • Type: typing.Optional[str]

matchForVersionType

  • Type: typing.Optional[typing.Literal['ACTIVE', 'LATEST']]

DeleteAssetModelCompositeModelResponse

assetModelStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteAssetModelRequest

assetModelId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

ifMatch

  • Type: typing.Optional[str]

ifNoneMatch

  • Type: typing.Optional[str]

matchForVersionType

  • Type: typing.Optional[typing.Literal['ACTIVE', 'LATEST']]

DeleteAssetModelResponse

assetModelStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteAssetRequest

assetId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeleteAssetResponse

assetStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteDashboardRequest

dashboardId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeleteDatasetRequest

datasetId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeleteDatasetResponse

datasetStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteGatewayRequest

gatewayId

  • Type:
  • Required: Yes

DeletePortalRequest

portalId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeletePortalResponse

portalStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteProjectRequest

projectId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DeleteTimeSeriesRequest

alias

  • Type: typing.Optional[str]

assetId

  • Type: typing.Optional[str]

propertyId

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

DescribeAccessPolicyRequest

accessPolicyId

  • Type:
  • Required: Yes

DescribeAccessPolicyResponse

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

DescribeActionRequest

actionId

  • Type:
  • Required: Yes

DescribeActionResponse

actionId

  • Type:
  • Required: Yes

targetResource

  • Type:
  • Required: Yes

actionDefinitionId

  • Type:
  • Required: Yes

actionPayload

  • Type:
  • Required: Yes

executionTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeAssetCompositeModelRequest

assetId

  • Type:
  • Required: Yes

assetCompositeModelId

  • Type:
  • Required: Yes

DescribeAssetCompositeModelResponse

assetId

  • Type:
  • Required: Yes

assetCompositeModelId

  • Type:
  • Required: Yes

assetCompositeModelExternalId

  • Type:
  • Required: Yes

assetCompositeModelPath

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetCompositeModelPathSegment]
  • Required: Yes

assetCompositeModelName

  • Type:
  • Required: Yes

assetCompositeModelDescription

  • Type:
  • Required: Yes

assetCompositeModelType

  • Type:
  • Required: Yes

assetCompositeModelProperties

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetProperty]
  • Required: Yes

assetCompositeModelSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetCompositeModelSummary]
  • Required: Yes

actionDefinitions

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ActionDefinition]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeAssetModelCompositeModelRequest

assetModelId

  • Type:
  • Required: Yes

assetModelCompositeModelId

  • Type:
  • Required: Yes

assetModelVersion

  • Type: typing.Optional[str]

DescribeAssetModelCompositeModelResponse

assetModelId

  • Type:
  • Required: Yes

assetModelCompositeModelId

  • Type:
  • Required: Yes

assetModelCompositeModelExternalId

  • Type:
  • Required: Yes

assetModelCompositeModelPath

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelCompositeModelPathSegment]
  • Required: Yes

assetModelCompositeModelName

  • Type:
  • Required: Yes

assetModelCompositeModelDescription

  • Type:
  • Required: Yes

assetModelCompositeModelType

  • Type:
  • Required: Yes

assetModelCompositeModelProperties

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelPropertyOutput]
  • Required: Yes

compositionDetails

  • Type:
  • Required: Yes

assetModelCompositeModelSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelCompositeModelSummary]
  • Required: Yes

actionDefinitions

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ActionDefinition]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeAssetModelRequest

assetModelId

  • Type:
  • Required: Yes

excludeProperties

  • Type: typing.Optional[bool]

assetModelVersion

  • Type: typing.Optional[str]

DescribeAssetModelRequestWait

assetModelId

  • Type:
  • Required: Yes

excludeProperties

  • Type: typing.Optional[bool]

assetModelVersion

  • Type: typing.Optional[str]

WaiterConfig

  • Type:

DescribeAssetModelRequestWaitExtra

assetModelId

  • Type:
  • Required: Yes

excludeProperties

  • Type: typing.Optional[bool]

assetModelVersion

  • Type: typing.Optional[str]

WaiterConfig

  • Type:

DescribeAssetModelResponse

assetModelId

  • Type:
  • Required: Yes

assetModelExternalId

  • Type:
  • Required: Yes

assetModelArn

  • Type:
  • Required: Yes

assetModelName

  • Type:
  • Required: Yes

assetModelType

  • Type: typing.Literal['ASSET_MODEL', 'COMPONENT_MODEL']
  • Required: Yes

assetModelDescription

  • Type:
  • Required: Yes

assetModelProperties

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelPropertyOutput]
  • Required: Yes

assetModelHierarchies

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelHierarchy]
  • Required: Yes

assetModelCompositeModels

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelCompositeModelOutput]
  • Required: Yes

assetModelCompositeModelSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelCompositeModelSummary]
  • Required: Yes

assetModelCreationDate

  • Type:
  • Required: Yes

assetModelLastUpdateDate

  • Type:
  • Required: Yes

assetModelStatus

  • Type:
  • Required: Yes

assetModelVersion

  • Type:
  • Required: Yes

eTag

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeAssetPropertyRequest

assetId

  • Type:
  • Required: Yes

propertyId

  • Type:
  • Required: Yes

DescribeAssetPropertyResponse

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

DescribeAssetRequest

assetId

  • Type:
  • Required: Yes

excludeProperties

  • Type: typing.Optional[bool]

DescribeAssetRequestWait

assetId

  • Type:
  • Required: Yes

excludeProperties

  • Type: typing.Optional[bool]

WaiterConfig

  • Type:

DescribeAssetRequestWaitExtra

assetId

  • Type:
  • Required: Yes

excludeProperties

  • Type: typing.Optional[bool]

WaiterConfig

  • Type:

DescribeAssetResponse

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.iotsitewise_classes.AssetProperty]
  • Required: Yes

assetHierarchies

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetHierarchy]
  • Required: Yes

assetCompositeModels

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetCompositeModel]
  • 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.iotsitewise_classes.AssetCompositeModelSummary]
  • Required: Yes

assetExternalId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeBulkImportJobRequest

jobId

  • Type:
  • Required: Yes

DescribeBulkImportJobResponse

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.iotsitewise_classes.File]
  • 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

DescribeDashboardRequest

dashboardId

  • Type:
  • Required: Yes

DescribeDashboardResponse

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

DescribeDatasetRequest

datasetId

  • Type:
  • Required: Yes

DescribeDatasetResponse

datasetId

  • Type:
  • Required: Yes

datasetArn

  • Type:
  • Required: Yes

datasetName

  • Type:
  • Required: Yes

datasetDescription

  • Type:
  • Required: Yes

datasetSource

  • Type:
  • Required: Yes

datasetStatus

  • Type:
  • Required: Yes

datasetCreationDate

  • Type:
  • Required: Yes

datasetLastUpdateDate

  • Type:
  • Required: Yes

datasetVersion

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeDefaultEncryptionConfigurationResponse

encryptionType

  • Type: typing.Literal['KMS_BASED_ENCRYPTION', 'SITEWISE_DEFAULT_ENCRYPTION']
  • Required: Yes

kmsKeyArn

  • Type:
  • Required: Yes

configurationStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeGatewayCapabilityConfigurationRequest

gatewayId

  • Type:
  • Required: Yes

capabilityNamespace

  • Type:
  • Required: Yes

DescribeGatewayCapabilityConfigurationResponse

gatewayId

  • Type:
  • Required: Yes

capabilityNamespace

  • Type:
  • Required: Yes

capabilityConfiguration

  • Type:
  • Required: Yes

capabilitySyncStatus

  • Type: typing.Literal['IN_SYNC', 'NOT_APPLICABLE', 'OUT_OF_SYNC', 'SYNC_FAILED', 'UNKNOWN']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeGatewayRequest

gatewayId

  • Type:
  • Required: Yes

DescribeGatewayResponse

gatewayId

  • Type:
  • Required: Yes

gatewayName

  • Type:
  • Required: Yes

gatewayArn

  • Type:
  • Required: Yes

gatewayPlatform

  • Type:
  • Required: Yes

gatewayVersion

  • Type:
  • Required: Yes

gatewayCapabilitySummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.GatewayCapabilitySummary]
  • Required: Yes

creationDate

  • Type:
  • Required: Yes

lastUpdateDate

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeLoggingOptionsResponse

loggingOptions

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribePortalRequest

portalId

  • Type:
  • Required: Yes

DescribePortalRequestWait

portalId

  • Type:
  • Required: Yes

WaiterConfig

  • Type:

DescribePortalRequestWaitExtra

portalId

  • Type:
  • Required: Yes

WaiterConfig

  • Type:

DescribePortalResponse

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

portalType

  • Type: typing.Literal['SITEWISE_PORTAL_V1', 'SITEWISE_PORTAL_V2']
  • Required: Yes

portalTypeConfiguration

  • Type: typing.Dict[str, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PortalTypeEntryOutput]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeProjectRequest

projectId

  • Type:
  • Required: Yes

DescribeProjectResponse

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

DescribeStorageConfigurationResponse

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

disallowIngestNullNaN

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DescribeTimeSeriesRequest

alias

  • Type: typing.Optional[str]

assetId

  • Type: typing.Optional[str]

propertyId

  • Type: typing.Optional[str]

DescribeTimeSeriesResponse

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

DetailedError

code

  • Type: typing.Literal['INCOMPATIBLE_COMPUTE_LOCATION', 'INCOMPATIBLE_FORWARDING_CONFIGURATION']
  • Required: Yes

message

  • Type:
  • Required: Yes

DisassociateAssetsRequest

assetId

  • Type:
  • Required: Yes

hierarchyId

  • Type:
  • Required: Yes

childAssetId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

DisassociateTimeSeriesFromAssetPropertyRequest

alias

  • Type:
  • Required: Yes

assetId

  • Type:
  • Required: Yes

propertyId

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

EmptyResponseMetadata

ResponseMetadata

  • Type:
  • Required: Yes

ErrorDetails

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.iotsitewise_classes.DetailedError]]

ErrorReportLocation

bucket

  • Type:
  • Required: Yes

prefix

  • Type:
  • Required: Yes

ExecuteActionRequest

targetResource

  • Type:
  • Required: Yes

actionDefinitionId

  • Type:
  • Required: Yes

actionPayload

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

ExecuteActionResponse

actionId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ExecuteQueryRequest

queryStatement

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

clientToken

  • Type: typing.Optional[str]

ExecuteQueryRequestPaginate

queryStatement

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ExecuteQueryResponse

columns

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ColumnInfo]
  • Required: Yes

rows

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Row]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ExecuteQueryResponsePaginator

columns

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ColumnInfo]
  • Required: Yes

rows

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.RowPaginator]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ExecuteQueryResponseWaiter

columns

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ColumnInfo]
  • Required: Yes

rows

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.RowWaiter]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ExpressionVariable

name

  • Type:
  • Required: Yes

value

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.VariableValue, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.VariableValueOutput]
  • Required: Yes

ExpressionVariableOutput

name

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

File

bucket

  • Type:
  • Required: Yes

key

  • Type:
  • Required: Yes

versionId

  • Type: typing.Optional[str]

FileFormat

csv

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Csv]

parquet

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

FileFormatOutput

csv

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.CsvOutput]

parquet

  • Type: typing.Optional[typing.Dict[str, typing.Any]]

ForwardingConfig

state

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

GatewayCapabilitySummary

capabilityNamespace

  • Type:
  • Required: Yes

capabilitySyncStatus

  • Type: typing.Literal['IN_SYNC', 'NOT_APPLICABLE', 'OUT_OF_SYNC', 'SYNC_FAILED', 'UNKNOWN']
  • Required: Yes

GatewayPlatform

greengrass

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Greengrass]

greengrassV2

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.GreengrassV2]

siemensIE

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.SiemensIE]

GatewaySummary

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.iotsitewise_classes.GatewayPlatform]

gatewayVersion

  • Type: typing.Optional[str]

gatewayCapabilitySummaries

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.GatewayCapabilitySummary]]

GetAssetPropertyAggregatesRequest

aggregateTypes

  • Type: typing.List[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.List[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]]

timeOrdering

  • Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

GetAssetPropertyAggregatesRequestPaginate

aggregateTypes

  • Type: typing.List[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.List[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]]

timeOrdering

  • Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

GetAssetPropertyAggregatesResponse

aggregatedValues

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AggregatedValue]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

GetAssetPropertyValueHistoryRequest

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.List[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]]

timeOrdering

  • Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

GetAssetPropertyValueHistoryRequestPaginate

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.List[typing.Literal['BAD', 'GOOD', 'UNCERTAIN']]]

timeOrdering

  • Type: typing.Optional[typing.Literal['ASCENDING', 'DESCENDING']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

GetAssetPropertyValueHistoryResponse

assetPropertyValueHistory

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetPropertyValue]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

GetAssetPropertyValueRequest

assetId

  • Type: typing.Optional[str]

propertyId

  • Type: typing.Optional[str]

propertyAlias

  • Type: typing.Optional[str]

GetAssetPropertyValueResponse

propertyValue

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetInterpolatedAssetPropertyValuesRequest

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]

GetInterpolatedAssetPropertyValuesRequestPaginate

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.iotsitewise_classes.PaginatorConfig]

GetInterpolatedAssetPropertyValuesResponse

interpolatedAssetPropertyValues

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.InterpolatedAssetPropertyValue]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

Greengrass

groupArn

  • Type:
  • Required: Yes

GreengrassV2

coreDeviceThingName

  • Type:
  • Required: Yes

coreDeviceOperatingSystem

  • Type: typing.Optional[typing.Literal['LINUX_AARCH64', 'LINUX_AMD64', 'WINDOWS_AMD64']]

GroupIdentity

id

  • Type:
  • Required: Yes

IAMRoleIdentity

arn

  • Type:
  • Required: Yes

IAMUserIdentity

arn

  • Type:
  • Required: Yes

Identity

user

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.UserIdentity]

group

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.GroupIdentity]

iamUser

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.IAMUserIdentity]

iamRole

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.IAMRoleIdentity]

Image

id

  • Type: typing.Optional[str]

file

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ImageFile]

ImageFile

data

  • Type: typing.Union[str, bytes, typing.IO[typing.Any], botocore.response.StreamingBody]
  • Required: Yes

type

  • Type: typing.Literal['PNG']
  • Required: Yes

ImageLocation

id

  • Type:
  • Required: Yes

url

  • Type:
  • Required: Yes

InternalFailureException

message

  • Type:
  • Required: Yes

InterpolatedAssetPropertyValue

timestamp

  • Type:
  • Required: Yes

value

  • Type:
  • Required: Yes

InvalidRequestException

message

  • Type:
  • Required: Yes

InvocationOutput

message

  • Type: typing.Optional[str]

citations

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Citation]]

InvokeAssistantRequest

message

  • Type:
  • Required: Yes

conversationId

  • Type: typing.Optional[str]

enableTrace

  • Type: typing.Optional[bool]

InvokeAssistantResponse

body

  • Type: aws_resource_validator.pydantic_models.base_validator_model.EventStream[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ResponseStream]
  • Required: Yes

conversationId

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

JobConfiguration

fileFormat

  • Type:
  • Required: Yes

JobConfigurationOutput

fileFormat

  • Type:
  • Required: Yes

JobSummary

id

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['CANCELLED', 'COMPLETED', 'COMPLETED_WITH_FAILURES', 'FAILED', 'PENDING', 'RUNNING']
  • Required: Yes

KendraSourceDetail

knowledgeBaseArn

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

LimitExceededException

message

  • Type:
  • Required: Yes

ListAccessPoliciesRequest

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]

ListAccessPoliciesRequestPaginate

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.iotsitewise_classes.PaginatorConfig]

ListAccessPoliciesResponse

accessPolicySummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AccessPolicySummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListActionsRequest

targetResourceType

  • Type: typing.Literal['ASSET']
  • Required: Yes

targetResourceId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListActionsRequestPaginate

targetResourceType

  • Type: typing.Literal['ASSET']
  • Required: Yes

targetResourceId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListActionsResponse

actionSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ActionSummary]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListAssetModelCompositeModelsRequest

assetModelId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

assetModelVersion

  • Type: typing.Optional[str]

ListAssetModelCompositeModelsRequestPaginate

assetModelId

  • Type:
  • Required: Yes

assetModelVersion

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListAssetModelCompositeModelsResponse

assetModelCompositeModelSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelCompositeModelSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListAssetModelPropertiesRequest

assetModelId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

filter

  • Type: typing.Optional[typing.Literal['ALL', 'BASE']]

assetModelVersion

  • Type: typing.Optional[str]

ListAssetModelPropertiesRequestPaginate

assetModelId

  • Type:
  • Required: Yes

filter

  • Type: typing.Optional[typing.Literal['ALL', 'BASE']]

assetModelVersion

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListAssetModelPropertiesResponse

assetModelPropertySummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelPropertySummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListAssetModelsRequest

assetModelTypes

  • Type: typing.Optional[typing.List[typing.Literal['ASSET_MODEL', 'COMPONENT_MODEL']]]

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

assetModelVersion

  • Type: typing.Optional[str]

ListAssetModelsRequestPaginate

assetModelTypes

  • Type: typing.Optional[typing.List[typing.Literal['ASSET_MODEL', 'COMPONENT_MODEL']]]

assetModelVersion

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListAssetModelsResponse

assetModelSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListAssetPropertiesRequest

assetId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

filter

  • Type: typing.Optional[typing.Literal['ALL', 'BASE']]

ListAssetPropertiesRequestPaginate

assetId

  • Type:
  • Required: Yes

filter

  • Type: typing.Optional[typing.Literal['ALL', 'BASE']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListAssetPropertiesResponse

assetPropertySummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetPropertySummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListAssetRelationshipsRequest

assetId

  • Type:
  • Required: Yes

traversalType

  • Type: typing.Literal['PATH_TO_ROOT']
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListAssetRelationshipsRequestPaginate

assetId

  • Type:
  • Required: Yes

traversalType

  • Type: typing.Literal['PATH_TO_ROOT']
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListAssetRelationshipsResponse

assetRelationshipSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetRelationshipSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListAssetsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

assetModelId

  • Type: typing.Optional[str]

filter

  • Type: typing.Optional[typing.Literal['ALL', 'TOP_LEVEL']]

ListAssetsRequestPaginate

assetModelId

  • Type: typing.Optional[str]

filter

  • Type: typing.Optional[typing.Literal['ALL', 'TOP_LEVEL']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListAssetsResponse

assetSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListAssociatedAssetsRequest

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]

ListAssociatedAssetsRequestPaginate

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.iotsitewise_classes.PaginatorConfig]

ListAssociatedAssetsResponse

assetSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssociatedAssetsSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListBulkImportJobsRequest

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']]

ListBulkImportJobsRequestPaginate

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.iotsitewise_classes.PaginatorConfig]

ListBulkImportJobsResponse

jobSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.JobSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListCompositionRelationshipsRequest

assetModelId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListCompositionRelationshipsRequestPaginate

assetModelId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListCompositionRelationshipsResponse

compositionRelationshipSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.CompositionRelationshipSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDashboardsRequest

projectId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDashboardsRequestPaginate

projectId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListDashboardsResponse

dashboardSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.DashboardSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListDatasetsRequest

sourceType

  • Type: typing.Literal['KENDRA']
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListDatasetsRequestPaginate

sourceType

  • Type: typing.Literal['KENDRA']
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListDatasetsResponse

datasetSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.DatasetSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListGatewaysRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListGatewaysRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListGatewaysResponse

gatewaySummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.GatewaySummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListPortalsRequest

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListPortalsRequestPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListPortalsResponse

portalSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PortalSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListProjectAssetsRequest

projectId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListProjectAssetsRequestPaginate

projectId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListProjectAssetsResponse

assetIds

  • Type: typing.List[str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListProjectsRequest

portalId

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

ListProjectsRequestPaginate

portalId

  • Type:
  • Required: Yes

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PaginatorConfig]

ListProjectsResponse

projectSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ProjectSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTimeSeriesRequest

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']]

ListTimeSeriesRequestPaginate

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.iotsitewise_classes.PaginatorConfig]

ListTimeSeriesResponse

TimeSeriesSummaries

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.TimeSeriesSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

Location

uri

  • Type: typing.Optional[str]

LoggingOptions

level

  • Type: typing.Literal['ERROR', 'INFO', 'OFF']
  • Required: Yes

Measurement

processingConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.MeasurementProcessingConfig]

MeasurementProcessingConfig

forwardingConfig

  • Type:
  • Required: Yes

Metric

expression

  • Type:
  • Required: Yes

variables

  • Type: typing.List[typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ExpressionVariable, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ExpressionVariableOutput]]
  • Required: Yes

window

  • Type:
  • Required: Yes

processingConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.MetricProcessingConfig]

MetricOutput

expression

  • Type:
  • Required: Yes

variables

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ExpressionVariableOutput]
  • Required: Yes

window

  • Type:
  • Required: Yes

processingConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.MetricProcessingConfig]

MetricProcessingConfig

computeLocation

  • Type: typing.Literal['CLOUD', 'EDGE']
  • Required: Yes

MetricWindow

tumbling

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.TumblingWindow]

MonitorErrorDetails

code

  • Type: typing.Optional[typing.Literal['INTERNAL_FAILURE', 'LIMIT_EXCEEDED', 'VALIDATION_ERROR']]

message

  • Type: typing.Optional[str]

MultiLayerStorage

customerManagedS3Storage

  • Type:
  • Required: Yes

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PortalResource

id

  • Type:
  • Required: Yes

PortalStatus

state

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'PENDING', 'UPDATING']
  • Required: Yes

error

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.MonitorErrorDetails]

PortalSummary

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]

portalType

  • Type: typing.Optional[typing.Literal['SITEWISE_PORTAL_V1', 'SITEWISE_PORTAL_V2']]

PortalTypeEntry

portalTools

  • Type: typing.Optional[typing.List[str]]

PortalTypeEntryOutput

portalTools

  • Type: typing.Optional[typing.List[str]]

ProjectResource

id

  • Type:
  • Required: Yes

ProjectSummary

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]

Property

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.iotsitewise_classes.PropertyNotification]

unit

  • Type: typing.Optional[str]

type

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PropertyTypeOutput]

path

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetPropertyPathSegment]]

externalId

  • Type: typing.Optional[str]

PropertyNotification

topic

  • Type:
  • Required: Yes

state

  • Type: typing.Literal['DISABLED', 'ENABLED']
  • Required: Yes

PropertyType

attribute

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Attribute]

measurement

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Measurement]

transform

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Transform, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.TransformOutput, NoneType]

metric

  • Type: typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Metric, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.MetricOutput, NoneType]

PropertyTypeOutput

attribute

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Attribute]

measurement

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Measurement]

transform

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.TransformOutput]

metric

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.MetricOutput]

PropertyValueNullValue

valueType

  • Type: typing.Literal['B', 'D', 'I', 'S', 'U']
  • Required: Yes

PutAssetPropertyValueEntry

entryId

  • Type:
  • Required: Yes

propertyValues

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetPropertyValue]
  • Required: Yes

assetId

  • Type: typing.Optional[str]

propertyId

  • Type: typing.Optional[str]

propertyAlias

  • Type: typing.Optional[str]

PutDefaultEncryptionConfigurationRequest

encryptionType

  • Type: typing.Literal['KMS_BASED_ENCRYPTION', 'SITEWISE_DEFAULT_ENCRYPTION']
  • Required: Yes

kmsKeyId

  • Type: typing.Optional[str]

PutDefaultEncryptionConfigurationResponse

encryptionType

  • Type: typing.Literal['KMS_BASED_ENCRYPTION', 'SITEWISE_DEFAULT_ENCRYPTION']
  • Required: Yes

kmsKeyArn

  • Type:
  • Required: Yes

configurationStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PutLoggingOptionsRequest

loggingOptions

  • Type:
  • Required: Yes

PutStorageConfigurationRequest

storageType

  • Type: typing.Literal['MULTI_LAYER_STORAGE', 'SITEWISE_DEFAULT_STORAGE']
  • Required: Yes

multiLayerStorage

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.MultiLayerStorage]

disassociatedDataStorage

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

retentionPeriod

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.RetentionPeriod]

warmTier

  • Type: typing.Optional[typing.Literal['DISABLED', 'ENABLED']]

warmTierRetentionPeriod

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.WarmTierRetentionPeriod]

disallowIngestNullNaN

  • Type: typing.Optional[bool]

PutStorageConfigurationResponse

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

disallowIngestNullNaN

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Reference

dataset

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.DataSetReference]

Resource

portal

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PortalResource]

project

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ProjectResource]

ResourceNotFoundException

message

  • Type:
  • Required: Yes

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

ResponseStream

trace

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Trace]

output

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.InvocationOutput]

accessDeniedException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AccessDeniedException]

conflictingOperationException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ConflictingOperationException]

internalFailureException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.InternalFailureException]

invalidRequestException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.InvalidRequestException]

limitExceededException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.LimitExceededException]

resourceNotFoundException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ResourceNotFoundException]

throttlingException

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ThrottlingException]

RetentionPeriod

numberOfDays

  • Type: typing.Optional[int]

unlimited

  • Type: typing.Optional[bool]

Row

data

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Datum]
  • Required: Yes

RowPaginator

data

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.DatumPaginator]
  • Required: Yes

RowWaiter

data

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.DatumWaiter]
  • Required: Yes

SiemensIE

iotCoreThingName

  • Type:
  • Required: Yes

Source

arn

  • Type: typing.Optional[str]

location

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Location]

SourceDetail

kendra

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.KendraSourceDetail]

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

TargetResource

assetId

  • Type:
  • Required: Yes

ThrottlingException

message

  • Type:
  • Required: Yes

TimeInNanos

timeInSeconds

  • Type:
  • Required: Yes

offsetInNanos

  • Type: typing.Optional[int]

TimeSeriesSummary

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]

Trace

text

  • Type: typing.Optional[str]

Transform

expression

  • Type:
  • Required: Yes

variables

  • Type: typing.List[typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ExpressionVariable, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ExpressionVariableOutput]]
  • Required: Yes

processingConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.TransformProcessingConfig]

TransformOutput

expression

  • Type:
  • Required: Yes

variables

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ExpressionVariableOutput]
  • Required: Yes

processingConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.TransformProcessingConfig]

TransformProcessingConfig

computeLocation

  • Type: typing.Literal['CLOUD', 'EDGE']
  • Required: Yes

forwardingConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.ForwardingConfig]

TumblingWindow

interval

  • Type:
  • Required: Yes

offset

  • Type: typing.Optional[str]

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateAccessPolicyRequest

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]

UpdateAssetModelCompositeModelRequest

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.List[typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelProperty, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelPropertyOutput]]]

ifMatch

  • Type: typing.Optional[str]

ifNoneMatch

  • Type: typing.Optional[str]

matchForVersionType

  • Type: typing.Optional[typing.Literal['ACTIVE', 'LATEST']]

UpdateAssetModelCompositeModelResponse

assetModelCompositeModelPath

  • Type: typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelCompositeModelPathSegment]
  • Required: Yes

assetModelStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateAssetModelRequest

assetModelId

  • Type:
  • Required: Yes

assetModelName

  • Type:
  • Required: Yes

assetModelExternalId

  • Type: typing.Optional[str]

assetModelDescription

  • Type: typing.Optional[str]

assetModelProperties

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelProperty, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelPropertyOutput]]]

assetModelHierarchies

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelHierarchy]]

assetModelCompositeModels

  • Type: typing.Optional[typing.List[typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelCompositeModel, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelCompositeModelOutput]]]

clientToken

  • Type: typing.Optional[str]

ifMatch

  • Type: typing.Optional[str]

ifNoneMatch

  • Type: typing.Optional[str]

matchForVersionType

  • Type: typing.Optional[typing.Literal['ACTIVE', 'LATEST']]

UpdateAssetModelResponse

assetModelStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateAssetPropertyRequest

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]

UpdateAssetRequest

assetId

  • Type:
  • Required: Yes

assetName

  • Type:
  • Required: Yes

clientToken

  • Type: typing.Optional[str]

assetDescription

  • Type: typing.Optional[str]

assetExternalId

  • Type: typing.Optional[str]

UpdateAssetResponse

assetStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateDashboardRequest

dashboardId

  • Type:
  • Required: Yes

dashboardName

  • Type:
  • Required: Yes

dashboardDefinition

  • Type:
  • Required: Yes

dashboardDescription

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

UpdateDatasetRequest

datasetId

  • Type:
  • Required: Yes

datasetName

  • Type:
  • Required: Yes

datasetSource

  • Type:
  • Required: Yes

datasetDescription

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

UpdateDatasetResponse

datasetId

  • Type:
  • Required: Yes

datasetArn

  • Type:
  • Required: Yes

datasetStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateGatewayCapabilityConfigurationRequest

gatewayId

  • Type:
  • Required: Yes

capabilityNamespace

  • Type:
  • Required: Yes

capabilityConfiguration

  • Type:
  • Required: Yes

UpdateGatewayCapabilityConfigurationResponse

capabilityNamespace

  • Type:
  • Required: Yes

capabilitySyncStatus

  • Type: typing.Literal['IN_SYNC', 'NOT_APPLICABLE', 'OUT_OF_SYNC', 'SYNC_FAILED', 'UNKNOWN']
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateGatewayRequest

gatewayId

  • Type:
  • Required: Yes

gatewayName

  • Type:
  • Required: Yes

UpdatePortalRequest

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.iotsitewise_classes.Image]

clientToken

  • Type: typing.Optional[str]

notificationSenderEmail

  • Type: typing.Optional[str]

alarms

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.Alarms]

portalType

  • Type: typing.Optional[typing.Literal['SITEWISE_PORTAL_V1', 'SITEWISE_PORTAL_V2']]

portalTypeConfiguration

  • Type: typing.Optional[typing.Dict[str, typing.Union[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PortalTypeEntry, aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PortalTypeEntryOutput]]]

UpdatePortalResponse

portalStatus

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

UpdateProjectRequest

projectId

  • Type:
  • Required: Yes

projectName

  • Type:
  • Required: Yes

projectDescription

  • Type: typing.Optional[str]

clientToken

  • Type: typing.Optional[str]

UserIdentity

id

  • Type:
  • Required: Yes

VariableValue

propertyId

  • Type: typing.Optional[str]

hierarchyId

  • Type: typing.Optional[str]

propertyPath

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelPropertyPathSegment]]

VariableValueOutput

propertyId

  • Type: typing.Optional[str]

hierarchyId

  • Type: typing.Optional[str]

propertyPath

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.AssetModelPropertyPathSegment]]

Variant

stringValue

  • Type: typing.Optional[str]

integerValue

  • Type: typing.Optional[int]

doubleValue

  • Type: typing.Optional[float]

booleanValue

  • Type: typing.Optional[bool]

nullValue

  • Type: typing.Optional[aws_resource_validator.pydantic_models.iotsitewise.iotsitewise_classes.PropertyValueNullValue]

WaiterConfig

Delay

  • Type: typing.Optional[int]

MaxAttempts

  • Type: typing.Optional[int]

WarmTierRetentionPeriod

numberOfDays

  • Type: typing.Optional[int]

unlimited

  • Type: typing.Optional[bool]