Documentation

Overview

Package iotsitewise provides the client and types for making API requests to AWS IoT SiteWise.

Welcome to the AWS IoT SiteWise API Reference. AWS IoT SiteWise is an AWS service that connects Industrial Internet of Things (IIoT) (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) devices to the power of the AWS Cloud. For more information, see the AWS IoT SiteWise User Guide (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/). For information about AWS IoT SiteWise quotas, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the AWS IoT SiteWise User Guide.

See https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02 for more information on this service.

See iotsitewise package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/iotsitewise/

Using the Client

To contact AWS IoT SiteWise with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS IoT SiteWise client IoTSiteWise for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/iotsitewise/#New

Index

Constants

View Source
const (
	// AggregateTypeAverage is a AggregateType enum value
	AggregateTypeAverage = "AVERAGE"

	// AggregateTypeCount is a AggregateType enum value
	AggregateTypeCount = "COUNT"

	// AggregateTypeMaximum is a AggregateType enum value
	AggregateTypeMaximum = "MAXIMUM"

	// AggregateTypeMinimum is a AggregateType enum value
	AggregateTypeMinimum = "MINIMUM"

	// AggregateTypeSum is a AggregateType enum value
	AggregateTypeSum = "SUM"

	// AggregateTypeStandardDeviation is a AggregateType enum value
	AggregateTypeStandardDeviation = "STANDARD_DEVIATION"
)
View Source
const (
	// AssetModelStateCreating is a AssetModelState enum value
	AssetModelStateCreating = "CREATING"

	// AssetModelStateActive is a AssetModelState enum value
	AssetModelStateActive = "ACTIVE"

	// AssetModelStateUpdating is a AssetModelState enum value
	AssetModelStateUpdating = "UPDATING"

	// AssetModelStatePropagating is a AssetModelState enum value
	AssetModelStatePropagating = "PROPAGATING"

	// AssetModelStateDeleting is a AssetModelState enum value
	AssetModelStateDeleting = "DELETING"

	// AssetModelStateFailed is a AssetModelState enum value
	AssetModelStateFailed = "FAILED"
)
View Source
const (
	// AssetStateCreating is a AssetState enum value
	AssetStateCreating = "CREATING"

	// AssetStateActive is a AssetState enum value
	AssetStateActive = "ACTIVE"

	// AssetStateUpdating is a AssetState enum value
	AssetStateUpdating = "UPDATING"

	// AssetStateDeleting is a AssetState enum value
	AssetStateDeleting = "DELETING"

	// AssetStateFailed is a AssetState enum value
	AssetStateFailed = "FAILED"
)
View Source
const (
	// AuthModeIam is a AuthMode enum value
	AuthModeIam = "IAM"

	// AuthModeSso is a AuthMode enum value
	AuthModeSso = "SSO"
)
View Source
const (
	// BatchPutAssetPropertyValueErrorCodeResourceNotFoundException is a BatchPutAssetPropertyValueErrorCode enum value
	BatchPutAssetPropertyValueErrorCodeResourceNotFoundException = "ResourceNotFoundException"

	// BatchPutAssetPropertyValueErrorCodeInvalidRequestException is a BatchPutAssetPropertyValueErrorCode enum value
	BatchPutAssetPropertyValueErrorCodeInvalidRequestException = "InvalidRequestException"

	// BatchPutAssetPropertyValueErrorCodeInternalFailureException is a BatchPutAssetPropertyValueErrorCode enum value
	BatchPutAssetPropertyValueErrorCodeInternalFailureException = "InternalFailureException"

	// BatchPutAssetPropertyValueErrorCodeServiceUnavailableException is a BatchPutAssetPropertyValueErrorCode enum value
	BatchPutAssetPropertyValueErrorCodeServiceUnavailableException = "ServiceUnavailableException"

	// BatchPutAssetPropertyValueErrorCodeThrottlingException is a BatchPutAssetPropertyValueErrorCode enum value
	BatchPutAssetPropertyValueErrorCodeThrottlingException = "ThrottlingException"

	// BatchPutAssetPropertyValueErrorCodeLimitExceededException is a BatchPutAssetPropertyValueErrorCode enum value
	BatchPutAssetPropertyValueErrorCodeLimitExceededException = "LimitExceededException"

	// BatchPutAssetPropertyValueErrorCodeConflictingOperationException is a BatchPutAssetPropertyValueErrorCode enum value
	BatchPutAssetPropertyValueErrorCodeConflictingOperationException = "ConflictingOperationException"

	// BatchPutAssetPropertyValueErrorCodeTimestampOutOfRangeException is a BatchPutAssetPropertyValueErrorCode enum value
	BatchPutAssetPropertyValueErrorCodeTimestampOutOfRangeException = "TimestampOutOfRangeException"

	// BatchPutAssetPropertyValueErrorCodeAccessDeniedException is a BatchPutAssetPropertyValueErrorCode enum value
	BatchPutAssetPropertyValueErrorCodeAccessDeniedException = "AccessDeniedException"
)
View Source
const (
	// CapabilitySyncStatusInSync is a CapabilitySyncStatus enum value
	CapabilitySyncStatusInSync = "IN_SYNC"

	// CapabilitySyncStatusOutOfSync is a CapabilitySyncStatus enum value
	CapabilitySyncStatusOutOfSync = "OUT_OF_SYNC"

	// CapabilitySyncStatusSyncFailed is a CapabilitySyncStatus enum value
	CapabilitySyncStatusSyncFailed = "SYNC_FAILED"
)
View Source
const (
	// ConfigurationStateActive is a ConfigurationState enum value
	ConfigurationStateActive = "ACTIVE"

	// ConfigurationStateUpdateInProgress is a ConfigurationState enum value
	ConfigurationStateUpdateInProgress = "UPDATE_IN_PROGRESS"

	// ConfigurationStateUpdateFailed is a ConfigurationState enum value
	ConfigurationStateUpdateFailed = "UPDATE_FAILED"
)
View Source
const (
	// EncryptionTypeSitewiseDefaultEncryption is a EncryptionType enum value
	EncryptionTypeSitewiseDefaultEncryption = "SITEWISE_DEFAULT_ENCRYPTION"

	// EncryptionTypeKmsBasedEncryption is a EncryptionType enum value
	EncryptionTypeKmsBasedEncryption = "KMS_BASED_ENCRYPTION"
)
View Source
const (
	// ErrorCodeValidationError is a ErrorCode enum value
	ErrorCodeValidationError = "VALIDATION_ERROR"

	// ErrorCodeInternalFailure is a ErrorCode enum value
	ErrorCodeInternalFailure = "INTERNAL_FAILURE"
)
View Source
const (
	// IdentityTypeUser is a IdentityType enum value
	IdentityTypeUser = "USER"

	// IdentityTypeGroup is a IdentityType enum value
	IdentityTypeGroup = "GROUP"

	// IdentityTypeIam is a IdentityType enum value
	IdentityTypeIam = "IAM"
)
View Source
const (
	// ListAssetsFilterAll is a ListAssetsFilter enum value
	ListAssetsFilterAll = "ALL"

	// ListAssetsFilterTopLevel is a ListAssetsFilter enum value
	ListAssetsFilterTopLevel = "TOP_LEVEL"
)
View Source
const (
	// LoggingLevelError is a LoggingLevel enum value
	LoggingLevelError = "ERROR"

	// LoggingLevelInfo is a LoggingLevel enum value
	LoggingLevelInfo = "INFO"

	// LoggingLevelOff is a LoggingLevel enum value
	LoggingLevelOff = "OFF"
)
View Source
const (
	// MonitorErrorCodeInternalFailure is a MonitorErrorCode enum value
	MonitorErrorCodeInternalFailure = "INTERNAL_FAILURE"

	// MonitorErrorCodeValidationError is a MonitorErrorCode enum value
	MonitorErrorCodeValidationError = "VALIDATION_ERROR"

	// MonitorErrorCodeLimitExceeded is a MonitorErrorCode enum value
	MonitorErrorCodeLimitExceeded = "LIMIT_EXCEEDED"
)
View Source
const (
	// PermissionAdministrator is a Permission enum value
	PermissionAdministrator = "ADMINISTRATOR"

	// PermissionViewer is a Permission enum value
	PermissionViewer = "VIEWER"
)
View Source
const (
	// PortalStateCreating is a PortalState enum value
	PortalStateCreating = "CREATING"

	// PortalStateUpdating is a PortalState enum value
	PortalStateUpdating = "UPDATING"

	// PortalStateDeleting is a PortalState enum value
	PortalStateDeleting = "DELETING"

	// PortalStateActive is a PortalState enum value
	PortalStateActive = "ACTIVE"

	// PortalStateFailed is a PortalState enum value
	PortalStateFailed = "FAILED"
)
View Source
const (
	// PropertyDataTypeString is a PropertyDataType enum value
	PropertyDataTypeString = "STRING"

	// PropertyDataTypeInteger is a PropertyDataType enum value
	PropertyDataTypeInteger = "INTEGER"

	// PropertyDataTypeDouble is a PropertyDataType enum value
	PropertyDataTypeDouble = "DOUBLE"

	// PropertyDataTypeBoolean is a PropertyDataType enum value
	PropertyDataTypeBoolean = "BOOLEAN"

	// PropertyDataTypeStruct is a PropertyDataType enum value
	PropertyDataTypeStruct = "STRUCT"
)
View Source
const (
	// PropertyNotificationStateEnabled is a PropertyNotificationState enum value
	PropertyNotificationStateEnabled = "ENABLED"

	// PropertyNotificationStateDisabled is a PropertyNotificationState enum value
	PropertyNotificationStateDisabled = "DISABLED"
)
View Source
const (
	// QualityGood is a Quality enum value
	QualityGood = "GOOD"

	// QualityBad is a Quality enum value
	QualityBad = "BAD"

	// QualityUncertain is a Quality enum value
	QualityUncertain = "UNCERTAIN"
)
View Source
const (
	// ResourceTypePortal is a ResourceType enum value
	ResourceTypePortal = "PORTAL"

	// ResourceTypeProject is a ResourceType enum value
	ResourceTypeProject = "PROJECT"
)
View Source
const (
	// TimeOrderingAscending is a TimeOrdering enum value
	TimeOrderingAscending = "ASCENDING"

	// TimeOrderingDescending is a TimeOrdering enum value
	TimeOrderingDescending = "DESCENDING"
)
View Source
const (
	// TraversalDirectionParent is a TraversalDirection enum value
	TraversalDirectionParent = "PARENT"

	// TraversalDirectionChild is a TraversalDirection enum value
	TraversalDirectionChild = "CHILD"
)
View Source
const (

	// ErrCodeConflictingOperationException for service response error code
	// "ConflictingOperationException".
	//
	// Your request has conflicting operations. This can occur if you're trying
	// to perform more than one operation on the same resource at the same time.
	ErrCodeConflictingOperationException = "ConflictingOperationException"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// AWS IoT SiteWise can't process your request right now. Try again later.
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request isn't valid. This can occur if your request contains malformed
	// JSON or unsupported characters. Check your request and try again.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// You've reached the limit for a resource. For example, this can occur if you're
	// trying to associate more than the allowed number of child assets or attempting
	// to create more than the allowed number of properties for an asset model.
	//
	// For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
	// in the AWS IoT SiteWise User Guide.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeResourceAlreadyExistsException for service response error code
	// "ResourceAlreadyExistsException".
	//
	// The resource already exists.
	ErrCodeResourceAlreadyExistsException = "ResourceAlreadyExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested resource can't be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The requested service is unavailable.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Your request exceeded a rate limit. For example, you might have exceeded
	// the number of AWS IoT SiteWise assets that can be created per second, the
	// allowed number of messages per second, and so on.
	//
	// For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
	// in the AWS IoT SiteWise User Guide.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// You've reached the limit for the number of tags allowed for a resource. For
	// more information, see Tag naming limits and requirements (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions)
	// in the AWS General Reference.
	ErrCodeTooManyTagsException = "TooManyTagsException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// You are not authorized.
	ErrCodeUnauthorizedException = "UnauthorizedException"
)
View Source
const (
	ServiceName = "IoTSiteWise" // Name of service.
	EndpointsID = "iotsitewise" // ID to lookup a service endpoint with.
	ServiceID   = "IoTSiteWise" // ServiceID is a unique identifier of a specific service.
)

    Service information constants

    View Source
    const (
    	// AssetErrorCodeInternalFailure is a AssetErrorCode enum value
    	AssetErrorCodeInternalFailure = "INTERNAL_FAILURE"
    )
    View Source
    const (
    	// AssetRelationshipTypeHierarchy is a AssetRelationshipType enum value
    	AssetRelationshipTypeHierarchy = "HIERARCHY"
    )
    View Source
    const (
    	// ImageFileTypePng is a ImageFileType enum value
    	ImageFileTypePng = "PNG"
    )
    View Source
    const (
    	// TraversalTypePathToRoot is a TraversalType enum value
    	TraversalTypePathToRoot = "PATH_TO_ROOT"
    )

    Variables

    This section is empty.

    Functions

    func AggregateType_Values

    func AggregateType_Values() []string

      AggregateType_Values returns all elements of the AggregateType enum

      func AssetErrorCode_Values

      func AssetErrorCode_Values() []string

        AssetErrorCode_Values returns all elements of the AssetErrorCode enum

        func AssetModelState_Values

        func AssetModelState_Values() []string

          AssetModelState_Values returns all elements of the AssetModelState enum

          func AssetRelationshipType_Values

          func AssetRelationshipType_Values() []string

            AssetRelationshipType_Values returns all elements of the AssetRelationshipType enum

            func AssetState_Values

            func AssetState_Values() []string

              AssetState_Values returns all elements of the AssetState enum

              func AuthMode_Values

              func AuthMode_Values() []string

                AuthMode_Values returns all elements of the AuthMode enum

                func BatchPutAssetPropertyValueErrorCode_Values

                func BatchPutAssetPropertyValueErrorCode_Values() []string

                  BatchPutAssetPropertyValueErrorCode_Values returns all elements of the BatchPutAssetPropertyValueErrorCode enum

                  func CapabilitySyncStatus_Values

                  func CapabilitySyncStatus_Values() []string

                    CapabilitySyncStatus_Values returns all elements of the CapabilitySyncStatus enum

                    func ConfigurationState_Values

                    func ConfigurationState_Values() []string

                      ConfigurationState_Values returns all elements of the ConfigurationState enum

                      func EncryptionType_Values

                      func EncryptionType_Values() []string

                        EncryptionType_Values returns all elements of the EncryptionType enum

                        func ErrorCode_Values

                        func ErrorCode_Values() []string

                          ErrorCode_Values returns all elements of the ErrorCode enum

                          func IdentityType_Values

                          func IdentityType_Values() []string

                            IdentityType_Values returns all elements of the IdentityType enum

                            func ImageFileType_Values

                            func ImageFileType_Values() []string

                              ImageFileType_Values returns all elements of the ImageFileType enum

                              func ListAssetsFilter_Values

                              func ListAssetsFilter_Values() []string

                                ListAssetsFilter_Values returns all elements of the ListAssetsFilter enum

                                func LoggingLevel_Values

                                func LoggingLevel_Values() []string

                                  LoggingLevel_Values returns all elements of the LoggingLevel enum

                                  func MonitorErrorCode_Values

                                  func MonitorErrorCode_Values() []string

                                    MonitorErrorCode_Values returns all elements of the MonitorErrorCode enum

                                    func Permission_Values

                                    func Permission_Values() []string

                                      Permission_Values returns all elements of the Permission enum

                                      func PortalState_Values

                                      func PortalState_Values() []string

                                        PortalState_Values returns all elements of the PortalState enum

                                        func PropertyDataType_Values

                                        func PropertyDataType_Values() []string

                                          PropertyDataType_Values returns all elements of the PropertyDataType enum

                                          func PropertyNotificationState_Values

                                          func PropertyNotificationState_Values() []string

                                            PropertyNotificationState_Values returns all elements of the PropertyNotificationState enum

                                            func Quality_Values

                                            func Quality_Values() []string

                                              Quality_Values returns all elements of the Quality enum

                                              func ResourceType_Values

                                              func ResourceType_Values() []string

                                                ResourceType_Values returns all elements of the ResourceType enum

                                                func TimeOrdering_Values

                                                func TimeOrdering_Values() []string

                                                  TimeOrdering_Values returns all elements of the TimeOrdering enum

                                                  func TraversalDirection_Values

                                                  func TraversalDirection_Values() []string

                                                    TraversalDirection_Values returns all elements of the TraversalDirection enum

                                                    func TraversalType_Values

                                                    func TraversalType_Values() []string

                                                      TraversalType_Values returns all elements of the TraversalType enum

                                                      Types

                                                      type AccessPolicySummary

                                                      type AccessPolicySummary struct {
                                                      
                                                      	// The date the access policy was created, in Unix epoch time.
                                                      	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`
                                                      
                                                      	// The ID of the access policy.
                                                      	//
                                                      	// Id is a required field
                                                      	Id *string `locationName:"id" min:"36" type:"string" required:"true"`
                                                      
                                                      	// The identity (an AWS SSO user, an AWS SSO group, or an IAM user).
                                                      	//
                                                      	// Identity is a required field
                                                      	Identity *Identity `locationName:"identity" type:"structure" required:"true"`
                                                      
                                                      	// The date the access policy was last updated, in Unix epoch time.
                                                      	LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp"`
                                                      
                                                      	// The permissions for the access policy. Note that a project ADMINISTRATOR
                                                      	// is also known as a project owner.
                                                      	//
                                                      	// Permission is a required field
                                                      	Permission *string `locationName:"permission" type:"string" required:"true" enum:"Permission"`
                                                      
                                                      	// The AWS IoT SiteWise Monitor resource (a portal or project).
                                                      	//
                                                      	// Resource is a required field
                                                      	Resource *Resource `locationName:"resource" type:"structure" required:"true"`
                                                      	// contains filtered or unexported fields
                                                      }

                                                        Contains an access policy that defines an identity's access to an AWS IoT SiteWise Monitor resource.

                                                        func (AccessPolicySummary) GoString

                                                        func (s AccessPolicySummary) GoString() string

                                                          GoString returns the string representation

                                                          func (*AccessPolicySummary) SetCreationDate

                                                          func (s *AccessPolicySummary) SetCreationDate(v time.Time) *AccessPolicySummary

                                                            SetCreationDate sets the CreationDate field's value.

                                                            func (*AccessPolicySummary) SetId

                                                              SetId sets the Id field's value.

                                                              func (*AccessPolicySummary) SetIdentity

                                                              func (s *AccessPolicySummary) SetIdentity(v *Identity) *AccessPolicySummary

                                                                SetIdentity sets the Identity field's value.

                                                                func (*AccessPolicySummary) SetLastUpdateDate

                                                                func (s *AccessPolicySummary) SetLastUpdateDate(v time.Time) *AccessPolicySummary

                                                                  SetLastUpdateDate sets the LastUpdateDate field's value.

                                                                  func (*AccessPolicySummary) SetPermission

                                                                  func (s *AccessPolicySummary) SetPermission(v string) *AccessPolicySummary

                                                                    SetPermission sets the Permission field's value.

                                                                    func (*AccessPolicySummary) SetResource

                                                                    func (s *AccessPolicySummary) SetResource(v *Resource) *AccessPolicySummary

                                                                      SetResource sets the Resource field's value.

                                                                      func (AccessPolicySummary) String

                                                                      func (s AccessPolicySummary) String() string

                                                                        String returns the string representation

                                                                        type AggregatedValue

                                                                        type AggregatedValue struct {
                                                                        
                                                                        	// The quality of the aggregated data.
                                                                        	Quality *string `locationName:"quality" type:"string" enum:"Quality"`
                                                                        
                                                                        	// The date the aggregating computations occurred, in Unix epoch time.
                                                                        	//
                                                                        	// Timestamp is a required field
                                                                        	Timestamp *time.Time `locationName:"timestamp" type:"timestamp" required:"true"`
                                                                        
                                                                        	// The value of the aggregates.
                                                                        	//
                                                                        	// Value is a required field
                                                                        	Value *Aggregates `locationName:"value" type:"structure" required:"true"`
                                                                        	// contains filtered or unexported fields
                                                                        }

                                                                          Contains aggregated asset property values (for example, average, minimum, and maximum).

                                                                          func (AggregatedValue) GoString

                                                                          func (s AggregatedValue) GoString() string

                                                                            GoString returns the string representation

                                                                            func (*AggregatedValue) SetQuality

                                                                            func (s *AggregatedValue) SetQuality(v string) *AggregatedValue

                                                                              SetQuality sets the Quality field's value.

                                                                              func (*AggregatedValue) SetTimestamp

                                                                              func (s *AggregatedValue) SetTimestamp(v time.Time) *AggregatedValue

                                                                                SetTimestamp sets the Timestamp field's value.

                                                                                func (*AggregatedValue) SetValue

                                                                                func (s *AggregatedValue) SetValue(v *Aggregates) *AggregatedValue

                                                                                  SetValue sets the Value field's value.

                                                                                  func (AggregatedValue) String

                                                                                  func (s AggregatedValue) String() string

                                                                                    String returns the string representation

                                                                                    type Aggregates

                                                                                    type Aggregates struct {
                                                                                    
                                                                                    	// The average (mean) value of the time series over a time interval window.
                                                                                    	Average *float64 `locationName:"average" type:"double"`
                                                                                    
                                                                                    	// The count of data points in the time series over a time interval window.
                                                                                    	Count *float64 `locationName:"count" type:"double"`
                                                                                    
                                                                                    	// The maximum value of the time series over a time interval window.
                                                                                    	Maximum *float64 `locationName:"maximum" type:"double"`
                                                                                    
                                                                                    	// The minimum value of the time series over a time interval window.
                                                                                    	Minimum *float64 `locationName:"minimum" type:"double"`
                                                                                    
                                                                                    	// The standard deviation of the time series over a time interval window.
                                                                                    	StandardDeviation *float64 `locationName:"standardDeviation" type:"double"`
                                                                                    
                                                                                    	// The sum of the time series over a time interval window.
                                                                                    	Sum *float64 `locationName:"sum" type:"double"`
                                                                                    	// contains filtered or unexported fields
                                                                                    }

                                                                                      Contains the (pre-calculated) aggregate values for an asset property.

                                                                                      func (Aggregates) GoString

                                                                                      func (s Aggregates) GoString() string

                                                                                        GoString returns the string representation

                                                                                        func (*Aggregates) SetAverage

                                                                                        func (s *Aggregates) SetAverage(v float64) *Aggregates

                                                                                          SetAverage sets the Average field's value.

                                                                                          func (*Aggregates) SetCount

                                                                                          func (s *Aggregates) SetCount(v float64) *Aggregates

                                                                                            SetCount sets the Count field's value.

                                                                                            func (*Aggregates) SetMaximum

                                                                                            func (s *Aggregates) SetMaximum(v float64) *Aggregates

                                                                                              SetMaximum sets the Maximum field's value.

                                                                                              func (*Aggregates) SetMinimum

                                                                                              func (s *Aggregates) SetMinimum(v float64) *Aggregates

                                                                                                SetMinimum sets the Minimum field's value.

                                                                                                func (*Aggregates) SetStandardDeviation

                                                                                                func (s *Aggregates) SetStandardDeviation(v float64) *Aggregates

                                                                                                  SetStandardDeviation sets the StandardDeviation field's value.

                                                                                                  func (*Aggregates) SetSum

                                                                                                  func (s *Aggregates) SetSum(v float64) *Aggregates

                                                                                                    SetSum sets the Sum field's value.

                                                                                                    func (Aggregates) String

                                                                                                    func (s Aggregates) String() string

                                                                                                      String returns the string representation

                                                                                                      type AssetCompositeModel

                                                                                                      type AssetCompositeModel struct {
                                                                                                      
                                                                                                      	// The description of the composite model.
                                                                                                      	Description *string `locationName:"description" min:"1" type:"string"`
                                                                                                      
                                                                                                      	// The name of the composite model.
                                                                                                      	//
                                                                                                      	// Name is a required field
                                                                                                      	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
                                                                                                      
                                                                                                      	// The asset properties that this composite model defines.
                                                                                                      	//
                                                                                                      	// Properties is a required field
                                                                                                      	Properties []*AssetProperty `locationName:"properties" type:"list" required:"true"`
                                                                                                      
                                                                                                      	// The type of the composite model. For alarm composite models, this type is
                                                                                                      	// AWS/ALARM.
                                                                                                      	//
                                                                                                      	// Type is a required field
                                                                                                      	Type *string `locationName:"type" min:"1" type:"string" required:"true"`
                                                                                                      	// contains filtered or unexported fields
                                                                                                      }

                                                                                                        Contains information about a composite model in an asset. This object contains the asset's properties that you define in the composite model.

                                                                                                        func (AssetCompositeModel) GoString

                                                                                                        func (s AssetCompositeModel) GoString() string

                                                                                                          GoString returns the string representation

                                                                                                          func (*AssetCompositeModel) SetDescription

                                                                                                          func (s *AssetCompositeModel) SetDescription(v string) *AssetCompositeModel

                                                                                                            SetDescription sets the Description field's value.

                                                                                                            func (*AssetCompositeModel) SetName

                                                                                                              SetName sets the Name field's value.

                                                                                                              func (*AssetCompositeModel) SetProperties

                                                                                                              func (s *AssetCompositeModel) SetProperties(v []*AssetProperty) *AssetCompositeModel

                                                                                                                SetProperties sets the Properties field's value.

                                                                                                                func (*AssetCompositeModel) SetType

                                                                                                                  SetType sets the Type field's value.

                                                                                                                  func (AssetCompositeModel) String

                                                                                                                  func (s AssetCompositeModel) String() string

                                                                                                                    String returns the string representation

                                                                                                                    type AssetErrorDetails

                                                                                                                    type AssetErrorDetails struct {
                                                                                                                    
                                                                                                                    	// The ID of the asset.
                                                                                                                    	//
                                                                                                                    	// AssetId is a required field
                                                                                                                    	AssetId *string `locationName:"assetId" min:"36" type:"string" required:"true"`
                                                                                                                    
                                                                                                                    	// The error code.
                                                                                                                    	//
                                                                                                                    	// Code is a required field
                                                                                                                    	Code *string `locationName:"code" type:"string" required:"true" enum:"AssetErrorCode"`
                                                                                                                    
                                                                                                                    	// The error message.
                                                                                                                    	//
                                                                                                                    	// Message is a required field
                                                                                                                    	Message *string `locationName:"message" type:"string" required:"true"`
                                                                                                                    	// contains filtered or unexported fields
                                                                                                                    }

                                                                                                                      Contains error details for the requested associate project asset action.

                                                                                                                      func (AssetErrorDetails) GoString

                                                                                                                      func (s AssetErrorDetails) GoString() string

                                                                                                                        GoString returns the string representation

                                                                                                                        func (*AssetErrorDetails) SetAssetId

                                                                                                                        func (s *AssetErrorDetails) SetAssetId(v string) *AssetErrorDetails

                                                                                                                          SetAssetId sets the AssetId field's value.

                                                                                                                          func (*AssetErrorDetails) SetCode

                                                                                                                            SetCode sets the Code field's value.

                                                                                                                            func (*AssetErrorDetails) SetMessage

                                                                                                                            func (s *AssetErrorDetails) SetMessage(v string) *AssetErrorDetails

                                                                                                                              SetMessage sets the Message field's value.

                                                                                                                              func (AssetErrorDetails) String

                                                                                                                              func (s AssetErrorDetails) String() string

                                                                                                                                String returns the string representation

                                                                                                                                type AssetHierarchy

                                                                                                                                type AssetHierarchy struct {
                                                                                                                                
                                                                                                                                	// The ID of the hierarchy. This ID is a hierarchyId.
                                                                                                                                	Id *string `locationName:"id" min:"36" type:"string"`
                                                                                                                                
                                                                                                                                	// The hierarchy name provided in the CreateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html)
                                                                                                                                	// or UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
                                                                                                                                	// API operation.
                                                                                                                                	//
                                                                                                                                	// Name is a required field
                                                                                                                                	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
                                                                                                                                	// contains filtered or unexported fields
                                                                                                                                }

                                                                                                                                  Describes an asset hierarchy that contains a hierarchy's name and ID.

                                                                                                                                  func (AssetHierarchy) GoString

                                                                                                                                  func (s AssetHierarchy) GoString() string

                                                                                                                                    GoString returns the string representation

                                                                                                                                    func (*AssetHierarchy) SetId

                                                                                                                                    func (s *AssetHierarchy) SetId(v string) *AssetHierarchy

                                                                                                                                      SetId sets the Id field's value.

                                                                                                                                      func (*AssetHierarchy) SetName

                                                                                                                                      func (s *AssetHierarchy) SetName(v string) *AssetHierarchy

                                                                                                                                        SetName sets the Name field's value.

                                                                                                                                        func (AssetHierarchy) String

                                                                                                                                        func (s AssetHierarchy) String() string

                                                                                                                                          String returns the string representation

                                                                                                                                          type AssetHierarchyInfo

                                                                                                                                          type AssetHierarchyInfo struct {
                                                                                                                                          
                                                                                                                                          	// The ID of the child asset in this asset relationship.
                                                                                                                                          	ChildAssetId *string `locationName:"childAssetId" min:"36" type:"string"`
                                                                                                                                          
                                                                                                                                          	// The ID of the parent asset in this asset relationship.
                                                                                                                                          	ParentAssetId *string `locationName:"parentAssetId" min:"36" type:"string"`
                                                                                                                                          	// contains filtered or unexported fields
                                                                                                                                          }

                                                                                                                                            Contains information about a parent asset and a child asset that are related through an asset hierarchy.

                                                                                                                                            func (AssetHierarchyInfo) GoString

                                                                                                                                            func (s AssetHierarchyInfo) GoString() string

                                                                                                                                              GoString returns the string representation

                                                                                                                                              func (*AssetHierarchyInfo) SetChildAssetId

                                                                                                                                              func (s *AssetHierarchyInfo) SetChildAssetId(v string) *AssetHierarchyInfo

                                                                                                                                                SetChildAssetId sets the ChildAssetId field's value.

                                                                                                                                                func (*AssetHierarchyInfo) SetParentAssetId

                                                                                                                                                func (s *AssetHierarchyInfo) SetParentAssetId(v string) *AssetHierarchyInfo

                                                                                                                                                  SetParentAssetId sets the ParentAssetId field's value.

                                                                                                                                                  func (AssetHierarchyInfo) String

                                                                                                                                                  func (s AssetHierarchyInfo) String() string

                                                                                                                                                    String returns the string representation

                                                                                                                                                    type AssetModelCompositeModel

                                                                                                                                                    type AssetModelCompositeModel struct {
                                                                                                                                                    
                                                                                                                                                    	// The description of the composite model.
                                                                                                                                                    	Description *string `locationName:"description" min:"1" type:"string"`
                                                                                                                                                    
                                                                                                                                                    	// The name of the composite model.
                                                                                                                                                    	//
                                                                                                                                                    	// Name is a required field
                                                                                                                                                    	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
                                                                                                                                                    
                                                                                                                                                    	// The asset property definitions for this composite model.
                                                                                                                                                    	Properties []*AssetModelProperty `locationName:"properties" type:"list"`
                                                                                                                                                    
                                                                                                                                                    	// The type of the composite model. For alarm composite models, this type is
                                                                                                                                                    	// AWS/ALARM.
                                                                                                                                                    	//
                                                                                                                                                    	// Type is a required field
                                                                                                                                                    	Type *string `locationName:"type" min:"1" type:"string" required:"true"`
                                                                                                                                                    	// contains filtered or unexported fields
                                                                                                                                                    }

                                                                                                                                                      Contains information about a composite model in an asset model. This object contains the asset property definitions that you define in the composite model.

                                                                                                                                                      func (AssetModelCompositeModel) GoString

                                                                                                                                                      func (s AssetModelCompositeModel) GoString() string

                                                                                                                                                        GoString returns the string representation

                                                                                                                                                        func (*AssetModelCompositeModel) SetDescription

                                                                                                                                                          SetDescription sets the Description field's value.

                                                                                                                                                          func (*AssetModelCompositeModel) SetName

                                                                                                                                                            SetName sets the Name field's value.

                                                                                                                                                            func (*AssetModelCompositeModel) SetProperties

                                                                                                                                                              SetProperties sets the Properties field's value.

                                                                                                                                                              func (*AssetModelCompositeModel) SetType

                                                                                                                                                                SetType sets the Type field's value.

                                                                                                                                                                func (AssetModelCompositeModel) String

                                                                                                                                                                func (s AssetModelCompositeModel) String() string

                                                                                                                                                                  String returns the string representation

                                                                                                                                                                  func (*AssetModelCompositeModel) Validate

                                                                                                                                                                  func (s *AssetModelCompositeModel) Validate() error

                                                                                                                                                                    Validate inspects the fields of the type to determine if they are valid.

                                                                                                                                                                    type AssetModelCompositeModelDefinition

                                                                                                                                                                    type AssetModelCompositeModelDefinition struct {
                                                                                                                                                                    
                                                                                                                                                                    	// The description of the composite model.
                                                                                                                                                                    	Description *string `locationName:"description" min:"1" type:"string"`
                                                                                                                                                                    
                                                                                                                                                                    	// The name of the composite model.
                                                                                                                                                                    	//
                                                                                                                                                                    	// Name is a required field
                                                                                                                                                                    	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
                                                                                                                                                                    
                                                                                                                                                                    	// The asset property definitions for this composite model.
                                                                                                                                                                    	Properties []*AssetModelPropertyDefinition `locationName:"properties" type:"list"`
                                                                                                                                                                    
                                                                                                                                                                    	// The type of the composite model. For alarm composite models, this type is
                                                                                                                                                                    	// AWS/ALARM.
                                                                                                                                                                    	//
                                                                                                                                                                    	// Type is a required field
                                                                                                                                                                    	Type *string `locationName:"type" min:"1" type:"string" required:"true"`
                                                                                                                                                                    	// contains filtered or unexported fields
                                                                                                                                                                    }

                                                                                                                                                                      Contains a composite model definition in an asset model. This composite model definition is applied to all assets created from the asset model.

                                                                                                                                                                      func (AssetModelCompositeModelDefinition) GoString

                                                                                                                                                                        GoString returns the string representation

                                                                                                                                                                        func (*AssetModelCompositeModelDefinition) SetDescription

                                                                                                                                                                          SetDescription sets the Description field's value.

                                                                                                                                                                          func (*AssetModelCompositeModelDefinition) SetName

                                                                                                                                                                            SetName sets the Name field's value.

                                                                                                                                                                            func (*AssetModelCompositeModelDefinition) SetProperties

                                                                                                                                                                              SetProperties sets the Properties field's value.

                                                                                                                                                                              func (*AssetModelCompositeModelDefinition) SetType

                                                                                                                                                                                SetType sets the Type field's value.

                                                                                                                                                                                func (AssetModelCompositeModelDefinition) String

                                                                                                                                                                                  String returns the string representation

                                                                                                                                                                                  func (*AssetModelCompositeModelDefinition) Validate

                                                                                                                                                                                    Validate inspects the fields of the type to determine if they are valid.

                                                                                                                                                                                    type AssetModelHierarchy

                                                                                                                                                                                    type AssetModelHierarchy struct {
                                                                                                                                                                                    
                                                                                                                                                                                    	// The ID of the asset model. All assets in this hierarchy must be instances
                                                                                                                                                                                    	// of the childAssetModelId asset model.
                                                                                                                                                                                    	//
                                                                                                                                                                                    	// ChildAssetModelId is a required field
                                                                                                                                                                                    	ChildAssetModelId *string `locationName:"childAssetModelId" min:"36" type:"string" required:"true"`
                                                                                                                                                                                    
                                                                                                                                                                                    	// The ID of the asset model hierarchy. This ID is a hierarchyId.
                                                                                                                                                                                    	Id *string `locationName:"id" min:"36" type:"string"`
                                                                                                                                                                                    
                                                                                                                                                                                    	// The name of the asset model hierarchy that you specify by using the CreateAssetModel
                                                                                                                                                                                    	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html)
                                                                                                                                                                                    	// or UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
                                                                                                                                                                                    	// API operation.
                                                                                                                                                                                    	//
                                                                                                                                                                                    	// Name is a required field
                                                                                                                                                                                    	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
                                                                                                                                                                                    	// contains filtered or unexported fields
                                                                                                                                                                                    }

                                                                                                                                                                                      Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.

                                                                                                                                                                                      func (AssetModelHierarchy) GoString

                                                                                                                                                                                      func (s AssetModelHierarchy) GoString() string

                                                                                                                                                                                        GoString returns the string representation

                                                                                                                                                                                        func (*AssetModelHierarchy) SetChildAssetModelId

                                                                                                                                                                                        func (s *AssetModelHierarchy) SetChildAssetModelId(v string) *AssetModelHierarchy

                                                                                                                                                                                          SetChildAssetModelId sets the ChildAssetModelId field's value.

                                                                                                                                                                                          func (*AssetModelHierarchy) SetId

                                                                                                                                                                                            SetId sets the Id field's value.

                                                                                                                                                                                            func (*AssetModelHierarchy) SetName

                                                                                                                                                                                              SetName sets the Name field's value.

                                                                                                                                                                                              func (AssetModelHierarchy) String

                                                                                                                                                                                              func (s AssetModelHierarchy) String() string

                                                                                                                                                                                                String returns the string representation

                                                                                                                                                                                                func (*AssetModelHierarchy) Validate

                                                                                                                                                                                                func (s *AssetModelHierarchy) Validate() error

                                                                                                                                                                                                  Validate inspects the fields of the type to determine if they are valid.

                                                                                                                                                                                                  type AssetModelHierarchyDefinition

                                                                                                                                                                                                  type AssetModelHierarchyDefinition struct {
                                                                                                                                                                                                  
                                                                                                                                                                                                  	// The ID of an asset model for this hierarchy.
                                                                                                                                                                                                  	//
                                                                                                                                                                                                  	// ChildAssetModelId is a required field
                                                                                                                                                                                                  	ChildAssetModelId *string `locationName:"childAssetModelId" min:"36" type:"string" required:"true"`
                                                                                                                                                                                                  
                                                                                                                                                                                                  	// The name of the asset model hierarchy definition (as specified in the CreateAssetModel
                                                                                                                                                                                                  	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html)
                                                                                                                                                                                                  	// or UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
                                                                                                                                                                                                  	// API operation).
                                                                                                                                                                                                  	//
                                                                                                                                                                                                  	// Name is a required field
                                                                                                                                                                                                  	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
                                                                                                                                                                                                  	// contains filtered or unexported fields
                                                                                                                                                                                                  }

                                                                                                                                                                                                    Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.

                                                                                                                                                                                                    func (AssetModelHierarchyDefinition) GoString

                                                                                                                                                                                                      GoString returns the string representation

                                                                                                                                                                                                      func (*AssetModelHierarchyDefinition) SetChildAssetModelId

                                                                                                                                                                                                        SetChildAssetModelId sets the ChildAssetModelId field's value.

                                                                                                                                                                                                        func (*AssetModelHierarchyDefinition) SetName

                                                                                                                                                                                                          SetName sets the Name field's value.

                                                                                                                                                                                                          func (AssetModelHierarchyDefinition) String

                                                                                                                                                                                                            String returns the string representation

                                                                                                                                                                                                            func (*AssetModelHierarchyDefinition) Validate

                                                                                                                                                                                                            func (s *AssetModelHierarchyDefinition) Validate() error

                                                                                                                                                                                                              Validate inspects the fields of the type to determine if they are valid.

                                                                                                                                                                                                              type AssetModelProperty

                                                                                                                                                                                                              type AssetModelProperty struct {
                                                                                                                                                                                                              
                                                                                                                                                                                                              	// The data type of the asset model property.
                                                                                                                                                                                                              	//
                                                                                                                                                                                                              	// DataType is a required field
                                                                                                                                                                                                              	DataType *string `locationName:"dataType" type:"string" required:"true" enum:"PropertyDataType"`
                                                                                                                                                                                                              
                                                                                                                                                                                                              	// The data type of the structure for this property. This parameter exists on
                                                                                                                                                                                                              	// properties that have the STRUCT data type.
                                                                                                                                                                                                              	DataTypeSpec *string `locationName:"dataTypeSpec" min:"1" type:"string"`
                                                                                                                                                                                                              
                                                                                                                                                                                                              	// The ID of the asset model property.
                                                                                                                                                                                                              	Id *string `locationName:"id" min:"36" type:"string"`
                                                                                                                                                                                                              
                                                                                                                                                                                                              	// The name of the asset model property.
                                                                                                                                                                                                              	//
                                                                                                                                                                                                              	// Name is a required field
                                                                                                                                                                                                              	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
                                                                                                                                                                                                              
                                                                                                                                                                                                              	// The property type (see PropertyType).
                                                                                                                                                                                                              	//
                                                                                                                                                                                                              	// Type is a required field
                                                                                                                                                                                                              	Type *PropertyType `locationName:"type" type:"structure" required:"true"`
                                                                                                                                                                                                              
                                                                                                                                                                                                              	// The unit of the asset model property, such as Newtons or RPM.
                                                                                                                                                                                                              	Unit *string `locationName:"unit" min:"1" type:"string"`
                                                                                                                                                                                                              	// contains filtered or unexported fields
                                                                                                                                                                                                              }

                                                                                                                                                                                                                Contains information about an asset model property.

                                                                                                                                                                                                                func (AssetModelProperty) GoString

                                                                                                                                                                                                                func (s AssetModelProperty) GoString() string

                                                                                                                                                                                                                  GoString returns the string representation

                                                                                                                                                                                                                  func (*AssetModelProperty) SetDataType

                                                                                                                                                                                                                  func (s *AssetModelProperty) SetDataType(v string) *AssetModelProperty

                                                                                                                                                                                                                    SetDataType sets the DataType field's value.

                                                                                                                                                                                                                    func (*AssetModelProperty) SetDataTypeSpec

                                                                                                                                                                                                                    func (s *AssetModelProperty) SetDataTypeSpec(v string) *AssetModelProperty

                                                                                                                                                                                                                      SetDataTypeSpec sets the DataTypeSpec field's value.

                                                                                                                                                                                                                      func (*AssetModelProperty) SetId

                                                                                                                                                                                                                        SetId sets the Id field's value.

                                                                                                                                                                                                                        func (*AssetModelProperty) SetName

                                                                                                                                                                                                                          SetName sets the Name field's value.

                                                                                                                                                                                                                          func (*AssetModelProperty) SetType

                                                                                                                                                                                                                            SetType sets the Type field's value.

                                                                                                                                                                                                                            func (*AssetModelProperty) SetUnit

                                                                                                                                                                                                                              SetUnit sets the Unit field's value.

                                                                                                                                                                                                                              func (AssetModelProperty) String

                                                                                                                                                                                                                              func (s AssetModelProperty) String() string

                                                                                                                                                                                                                                String returns the string representation

                                                                                                                                                                                                                                func (*AssetModelProperty) Validate

                                                                                                                                                                                                                                func (s *AssetModelProperty) Validate() error

                                                                                                                                                                                                                                  Validate inspects the fields of the type to determine if they are valid.

                                                                                                                                                                                                                                  type AssetModelPropertyDefinition

                                                                                                                                                                                                                                  type AssetModelPropertyDefinition struct {
                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                  	// The data type of the property definition.
                                                                                                                                                                                                                                  	//
                                                                                                                                                                                                                                  	// If you specify STRUCT, you must also specify dataTypeSpec to identify the
                                                                                                                                                                                                                                  	// type of the structure for this property.
                                                                                                                                                                                                                                  	//
                                                                                                                                                                                                                                  	// DataType is a required field
                                                                                                                                                                                                                                  	DataType *string `locationName:"dataType" type:"string" required:"true" enum:"PropertyDataType"`
                                                                                                                                                                                                                                  
                                                                                                                                                                                                                                  	// The data type of the structure for this property. This parameter is required
                                                                                                                                                                                                                                  	// on properties that have the STRUCT data type.
                                                                                                                                                                                                                                  	//
                                                                                                                                                                                                                                  	// The options for this parameter depend on the type of the composite model
                                                                                                                                                                                                                                  	// in which you define