Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AWS IoT TwinMaker can respond with.

Structs

BatchPutPropertyError

An error returned by the BatchPutProperty action.

BatchPutPropertyErrorEntry

An object that contains information about errors returned by the BatchPutProperty action.

BundleInformation

Information about the pricing bundle.

ColumnDescription

A description of the column in the query results.

ComponentPropertyGroupRequest

The component property group request.

ComponentPropertyGroupResponse

The component property group response.

ComponentRequest

An object that sets information about a component type create or update request.

ComponentResponse

An object that returns information about a component type create or update request.

ComponentSummary

An object that returns information about a component summary.

ComponentTypeSummary

An object that contains information about a component type.

ComponentUpdateRequest

The component update request.

CompositeComponentRequest

An object that sets information about the composite component update request.

CompositeComponentTypeRequest

An object that sets information about the composite component types of a component type.

CompositeComponentTypeResponse

An object that returns information about the composite component types of a component type.

CompositeComponentUpdateRequest

An object that sets information about the composite component update request.

DataConnector

The data connector.

DataType

An object that specifies the data type of a property.

DataValue

An object that specifies a value for a property.

DestinationConfiguration

The \[link to action\] metadata transfer job destination configuration.

EntityPropertyReference

An object that uniquely identifies an entity property.

EntitySummary

An object that contains information about an entity.

ErrorDetails

The error details.

FilterByAsset

Filter by asset. \[TwinMaker asset\]

FilterByAssetModel

Filter by asset model.

FilterByComponentType

Filter by component type.

FilterByEntity

Vilter by entity.

FunctionRequest

The function request body.

FunctionResponse

The function response.

InterpolationParameters

An object that specifies how to interpolate data in a list.

IotSiteWiseSourceConfiguration

The metadata transfer job AWS IoT SiteWise source configuration.

IotTwinMakerDestinationConfiguration

The metadata transfer job AWS IoT TwinMaker destination configuration.

IotTwinMakerSourceConfiguration

The metadata transfer job AWS IoT TwinMaker source configuration.

LambdaFunction

The Lambda function.

MetadataTransferJobProgress

The metadata transfer job's progress.

MetadataTransferJobStatus

The metadata transfer job status.

MetadataTransferJobSummary

The metadata transfer job summary.

OrderBy

Filter criteria that orders the return output. It can be sorted in ascending or descending order.

ParentEntityUpdateRequest

The parent entity update request.

PricingPlan

The pricing plan.

PropertyDefinitionRequest

An object that sets information about a property.

PropertyDefinitionResponse

An object that contains response data from a property definition request.

PropertyFilter

An object that filters items returned by a property request.

PropertyGroupRequest

PropertyGroupResponse

The property group response

PropertyLatestValue

The latest value of the property.

PropertyRequest

An object that sets information about a property.

PropertyResponse

An object that contains information about a property response.

PropertySummary

This is an object that contains the information of a property.

PropertyValue

An object that contains information about a value for a time series property.

PropertyValueEntry

An object that specifies information about time series property values. This object is used and consumed by the BatchPutPropertyValues action.

PropertyValueHistory

The history of values for a time series property.

Relationship

An object that specifies a relationship with another component type.

RelationshipValue

A value that associates a component and an entity.

Row

Represents a single row in the query results.

S3DestinationConfiguration

The S3 destination configuration.

S3SourceConfiguration

The S3 destination source configuration.

SceneError

The scene error.

SceneSummary

An object that contains information about a scene.

SourceConfiguration

The source configuration.

Status

An object that represents the status of an entity, component, component type, or workspace.

SyncJobStatus

The SyncJob status.

SyncJobSummary

The SyncJob summary.

SyncResourceStatus

The sync resource status.

SyncResourceSummary

The sync resource summary.

TabularConditions

The tabular conditions.

WorkspaceSummary

An object that contains information about a workspace.

Enums

ColumnType

When writing a match expression against ColumnType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ComponentUpdateType

When writing a match expression against ComponentUpdateType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DestinationType

When writing a match expression against DestinationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ErrorCode

When writing a match expression against ErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GroupType

When writing a match expression against GroupType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

InterpolationType

When writing a match expression against InterpolationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IotSiteWiseSourceConfigurationFilter

The AWS IoT SiteWise soucre configuration filter.\[need held with desc here\]

IotTwinMakerSourceConfigurationFilter

The metadata transfer job AWS IoT TwinMaker source configuration filter.

ListComponentTypesFilter

An object that filters items in a list of component types.

Only one object is accepted as a valid input.

ListEntitiesFilter

An object that filters items in a list of entities.

ListMetadataTransferJobsFilter

The ListMetadataTransferJobs filter.

MetadataTransferJobState

When writing a match expression against MetadataTransferJobState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Order

When writing a match expression against Order, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OrderByTime

When writing a match expression against OrderByTime, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ParentEntityUpdateType

When writing a match expression against ParentEntityUpdateType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PricingMode

When writing a match expression against PricingMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PricingTier

When writing a match expression against PricingTier, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PropertyGroupUpdateType

When writing a match expression against PropertyGroupUpdateType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PropertyUpdateType

When writing a match expression against PropertyUpdateType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SceneErrorCode

When writing a match expression against SceneErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Scope

When writing a match expression against Scope, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SourceType

When writing a match expression against SourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

State

When writing a match expression against State, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SyncJobState

When writing a match expression against SyncJobState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SyncResourceFilter

The sync resource filter.

SyncResourceState

When writing a match expression against SyncResourceState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SyncResourceType

When writing a match expression against SyncResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Type

When writing a match expression against Type, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

UpdateReason

When writing a match expression against UpdateReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.