iotsitewise

package
v1.50.31 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 4, 2024 License: Apache-2.0 Imports: 10 Imported by: 24

Documentation

Overview

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

Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications) devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/). For information about IoT SiteWise quotas, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html) in the 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 (
	// AssetModelTypeAssetModel is a AssetModelType enum value
	AssetModelTypeAssetModel = "ASSET_MODEL"

	// AssetModelTypeComponentModel is a AssetModelType enum value
	AssetModelTypeComponentModel = "COMPONENT_MODEL"
)
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 (
	// BatchEntryCompletionStatusSuccess is a BatchEntryCompletionStatus enum value
	BatchEntryCompletionStatusSuccess = "SUCCESS"

	// BatchEntryCompletionStatusError is a BatchEntryCompletionStatus enum value
	BatchEntryCompletionStatusError = "ERROR"
)
View Source 
const (
	// BatchGetAssetPropertyAggregatesErrorCodeResourceNotFoundException is a BatchGetAssetPropertyAggregatesErrorCode enum value
	BatchGetAssetPropertyAggregatesErrorCodeResourceNotFoundException = "ResourceNotFoundException"

	// BatchGetAssetPropertyAggregatesErrorCodeInvalidRequestException is a BatchGetAssetPropertyAggregatesErrorCode enum value
	BatchGetAssetPropertyAggregatesErrorCodeInvalidRequestException = "InvalidRequestException"

	// BatchGetAssetPropertyAggregatesErrorCodeAccessDeniedException is a BatchGetAssetPropertyAggregatesErrorCode enum value
	BatchGetAssetPropertyAggregatesErrorCodeAccessDeniedException = "AccessDeniedException"
)
View Source 
const (
	// BatchGetAssetPropertyValueErrorCodeResourceNotFoundException is a BatchGetAssetPropertyValueErrorCode enum value
	BatchGetAssetPropertyValueErrorCodeResourceNotFoundException = "ResourceNotFoundException"

	// BatchGetAssetPropertyValueErrorCodeInvalidRequestException is a BatchGetAssetPropertyValueErrorCode enum value
	BatchGetAssetPropertyValueErrorCodeInvalidRequestException = "InvalidRequestException"

	// BatchGetAssetPropertyValueErrorCodeAccessDeniedException is a BatchGetAssetPropertyValueErrorCode enum value
	BatchGetAssetPropertyValueErrorCodeAccessDeniedException = "AccessDeniedException"
)
View Source 
const (
	// BatchGetAssetPropertyValueHistoryErrorCodeResourceNotFoundException is a BatchGetAssetPropertyValueHistoryErrorCode enum value
	BatchGetAssetPropertyValueHistoryErrorCodeResourceNotFoundException = "ResourceNotFoundException"

	// BatchGetAssetPropertyValueHistoryErrorCodeInvalidRequestException is a BatchGetAssetPropertyValueHistoryErrorCode enum value
	BatchGetAssetPropertyValueHistoryErrorCodeInvalidRequestException = "InvalidRequestException"

	// BatchGetAssetPropertyValueHistoryErrorCodeAccessDeniedException is a BatchGetAssetPropertyValueHistoryErrorCode enum value
	BatchGetAssetPropertyValueHistoryErrorCodeAccessDeniedException = "AccessDeniedException"
)
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"

	// CapabilitySyncStatusUnknown is a CapabilitySyncStatus enum value
	CapabilitySyncStatusUnknown = "UNKNOWN"
)
View Source 
const (
	// ColumnNameAlias is a ColumnName enum value
	ColumnNameAlias = "ALIAS"

	// ColumnNameAssetId is a ColumnName enum value
	ColumnNameAssetId = "ASSET_ID"

	// ColumnNamePropertyId is a ColumnName enum value
	ColumnNamePropertyId = "PROPERTY_ID"

	// ColumnNameDataType is a ColumnName enum value
	ColumnNameDataType = "DATA_TYPE"

	// ColumnNameTimestampSeconds is a ColumnName enum value
	ColumnNameTimestampSeconds = "TIMESTAMP_SECONDS"

	// ColumnNameTimestampNanoOffset is a ColumnName enum value
	ColumnNameTimestampNanoOffset = "TIMESTAMP_NANO_OFFSET"

	// ColumnNameQuality is a ColumnName enum value
	ColumnNameQuality = "QUALITY"

	// ColumnNameValue is a ColumnName enum value
	ColumnNameValue = "VALUE"
)
View Source 
const (
	// ComputeLocationEdge is a ComputeLocation enum value
	ComputeLocationEdge = "EDGE"

	// ComputeLocationCloud is a ComputeLocation enum value
	ComputeLocationCloud = "CLOUD"
)
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 (
	// DetailedErrorCodeIncompatibleComputeLocation is a DetailedErrorCode enum value
	DetailedErrorCodeIncompatibleComputeLocation = "INCOMPATIBLE_COMPUTE_LOCATION"

	// DetailedErrorCodeIncompatibleForwardingConfiguration is a DetailedErrorCode enum value
	DetailedErrorCodeIncompatibleForwardingConfiguration = "INCOMPATIBLE_FORWARDING_CONFIGURATION"
)
View Source 
const (
	// DisassociatedDataStorageStateEnabled is a DisassociatedDataStorageState enum value
	DisassociatedDataStorageStateEnabled = "ENABLED"

	// DisassociatedDataStorageStateDisabled is a DisassociatedDataStorageState enum value
	DisassociatedDataStorageStateDisabled = "DISABLED"
)
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 (
	// ForwardingConfigStateDisabled is a ForwardingConfigState enum value
	ForwardingConfigStateDisabled = "DISABLED"

	// ForwardingConfigStateEnabled is a ForwardingConfigState enum value
	ForwardingConfigStateEnabled = "ENABLED"
)
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 (
	// JobStatusPending is a JobStatus enum value
	JobStatusPending = "PENDING"

	// JobStatusCancelled is a JobStatus enum value
	JobStatusCancelled = "CANCELLED"

	// JobStatusRunning is a JobStatus enum value
	JobStatusRunning = "RUNNING"

	// JobStatusCompleted is a JobStatus enum value
	JobStatusCompleted = "COMPLETED"

	// JobStatusFailed is a JobStatus enum value
	JobStatusFailed = "FAILED"

	// JobStatusCompletedWithFailures is a JobStatus enum value
	JobStatusCompletedWithFailures = "COMPLETED_WITH_FAILURES"
)
View Source 
const (
	// ListAssetModelPropertiesFilterAll is a ListAssetModelPropertiesFilter enum value
	ListAssetModelPropertiesFilterAll = "ALL"

	// ListAssetModelPropertiesFilterBase is a ListAssetModelPropertiesFilter enum value
	ListAssetModelPropertiesFilterBase = "BASE"
)
View Source 
const (
	// ListAssetPropertiesFilterAll is a ListAssetPropertiesFilter enum value
	ListAssetPropertiesFilterAll = "ALL"

	// ListAssetPropertiesFilterBase is a ListAssetPropertiesFilter enum value
	ListAssetPropertiesFilterBase = "BASE"
)
View Source 
const (
	// ListAssetsFilterAll is a ListAssetsFilter enum value
	ListAssetsFilterAll = "ALL"

	// ListAssetsFilterTopLevel is a ListAssetsFilter enum value
	ListAssetsFilterTopLevel = "TOP_LEVEL"
)
View Source 
const (
	// ListBulkImportJobsFilterAll is a ListBulkImportJobsFilter enum value
	ListBulkImportJobsFilterAll = "ALL"

	// ListBulkImportJobsFilterPending is a ListBulkImportJobsFilter enum value
	ListBulkImportJobsFilterPending = "PENDING"

	// ListBulkImportJobsFilterRunning is a ListBulkImportJobsFilter enum value
	ListBulkImportJobsFilterRunning = "RUNNING"

	// ListBulkImportJobsFilterCancelled is a ListBulkImportJobsFilter enum value
	ListBulkImportJobsFilterCancelled = "CANCELLED"

	// ListBulkImportJobsFilterFailed is a ListBulkImportJobsFilter enum value
	ListBulkImportJobsFilterFailed = "FAILED"

	// ListBulkImportJobsFilterCompletedWithFailures is a ListBulkImportJobsFilter enum value
	ListBulkImportJobsFilterCompletedWithFailures = "COMPLETED_WITH_FAILURES"

	// ListBulkImportJobsFilterCompleted is a ListBulkImportJobsFilter enum value
	ListBulkImportJobsFilterCompleted = "COMPLETED"
)
View Source 
const (
	// ListTimeSeriesTypeAssociated is a ListTimeSeriesType enum value
	ListTimeSeriesTypeAssociated = "ASSOCIATED"

	// ListTimeSeriesTypeDisassociated is a ListTimeSeriesType enum value
	ListTimeSeriesTypeDisassociated = "DISASSOCIATED"
)
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 (
	// ScalarTypeBoolean is a ScalarType enum value
	ScalarTypeBoolean = "BOOLEAN"

	// ScalarTypeInt is a ScalarType enum value
	ScalarTypeInt = "INT"

	// ScalarTypeDouble is a ScalarType enum value
	ScalarTypeDouble = "DOUBLE"

	// ScalarTypeTimestamp is a ScalarType enum value
	ScalarTypeTimestamp = "TIMESTAMP"

	// ScalarTypeString is a ScalarType enum value
	ScalarTypeString = "STRING"
)
View Source 
const (
	// StorageTypeSitewiseDefaultStorage is a StorageType enum value
	StorageTypeSitewiseDefaultStorage = "SITEWISE_DEFAULT_STORAGE"

	// StorageTypeMultiLayerStorage is a StorageType enum value
	StorageTypeMultiLayerStorage = "MULTI_LAYER_STORAGE"
)
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 (
	// WarmTierStateEnabled is a WarmTierState enum value
	WarmTierStateEnabled = "ENABLED"

	// WarmTierStateDisabled is a WarmTierState enum value
	WarmTierStateDisabled = "DISABLED"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// Access is denied.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// 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".
	//
	// 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 IoT SiteWise User Guide.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeQueryTimeoutException for service response error code
	// "QueryTimeoutException".
	//
	// The query timed out.
	ErrCodeQueryTimeoutException = "QueryTimeoutException"

	// 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 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 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 Amazon Web Services General Reference.
	ErrCodeTooManyTagsException = "TooManyTagsException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// You are not authorized.
	ErrCodeUnauthorizedException = "UnauthorizedException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The validation failed for this query.
	ErrCodeValidationException = "ValidationException"
)
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 (
	// TargetResourceTypeAsset is a TargetResourceType enum value
	TargetResourceTypeAsset = "ASSET"
)
View Source 
const (
	// TraversalTypePathToRoot is a TraversalType enum value
	TraversalTypePathToRoot = "PATH_TO_ROOT"
)

Variables

This section is empty.

Functions

func AggregateType_Values added in v1.34.3 

func AggregateType_Values() []string

AggregateType_Values returns all elements of the AggregateType enum

func AssetErrorCode_Values added in v1.34.3 

func AssetErrorCode_Values() []string

AssetErrorCode_Values returns all elements of the AssetErrorCode enum

func AssetModelState_Values added in v1.34.3 

func AssetModelState_Values() []string

AssetModelState_Values returns all elements of the AssetModelState enum

func AssetModelType_Values added in v1.48.2 

func AssetModelType_Values() []string

AssetModelType_Values returns all elements of the AssetModelType enum

func AssetRelationshipType_Values added in v1.36.7 

func AssetRelationshipType_Values() []string

AssetRelationshipType_Values returns all elements of the AssetRelationshipType enum

func AssetState_Values added in v1.34.3 

func AssetState_Values() []string

AssetState_Values returns all elements of the AssetState enum

func AuthMode_Values added in v1.34.28 

func AuthMode_Values() []string

AuthMode_Values returns all elements of the AuthMode enum

func BatchEntryCompletionStatus_Values added in v1.43.44 

func BatchEntryCompletionStatus_Values() []string

BatchEntryCompletionStatus_Values returns all elements of the BatchEntryCompletionStatus enum

func BatchGetAssetPropertyAggregatesErrorCode_Values added in v1.43.44 

func BatchGetAssetPropertyAggregatesErrorCode_Values() []string

BatchGetAssetPropertyAggregatesErrorCode_Values returns all elements of the BatchGetAssetPropertyAggregatesErrorCode enum

func BatchGetAssetPropertyValueErrorCode_Values added in v1.43.44 

func BatchGetAssetPropertyValueErrorCode_Values() []string

BatchGetAssetPropertyValueErrorCode_Values returns all elements of the BatchGetAssetPropertyValueErrorCode enum

func BatchGetAssetPropertyValueHistoryErrorCode_Values added in v1.43.44 

func BatchGetAssetPropertyValueHistoryErrorCode_Values() []string

BatchGetAssetPropertyValueHistoryErrorCode_Values returns all elements of the BatchGetAssetPropertyValueHistoryErrorCode enum

func BatchPutAssetPropertyValueErrorCode_Values added in v1.34.3 

func BatchPutAssetPropertyValueErrorCode_Values() []string

BatchPutAssetPropertyValueErrorCode_Values returns all elements of the BatchPutAssetPropertyValueErrorCode enum

func CapabilitySyncStatus_Values added in v1.34.3 

func CapabilitySyncStatus_Values() []string

CapabilitySyncStatus_Values returns all elements of the CapabilitySyncStatus enum

func ColumnName_Values added in v1.44.60 

func ColumnName_Values() []string

ColumnName_Values returns all elements of the ColumnName enum

func ComputeLocation_Values added in v1.40.11 

func ComputeLocation_Values() []string

ComputeLocation_Values returns all elements of the ComputeLocation enum

func ConfigurationState_Values added in v1.35.35 

func ConfigurationState_Values() []string

ConfigurationState_Values returns all elements of the ConfigurationState enum

func DetailedErrorCode_Values added in v1.40.11 

func DetailedErrorCode_Values() []string

DetailedErrorCode_Values returns all elements of the DetailedErrorCode enum

func DisassociatedDataStorageState_Values added in v1.42.12 

func DisassociatedDataStorageState_Values() []string

DisassociatedDataStorageState_Values returns all elements of the DisassociatedDataStorageState enum

func EncryptionType_Values added in v1.35.35 

func EncryptionType_Values() []string

EncryptionType_Values returns all elements of the EncryptionType enum

func ErrorCode_Values added in v1.34.3 

func ErrorCode_Values() []string

ErrorCode_Values returns all elements of the ErrorCode enum

func ForwardingConfigState_Values added in v1.40.11 

func ForwardingConfigState_Values() []string

ForwardingConfigState_Values returns all elements of the ForwardingConfigState enum

func IdentityType_Values added in v1.34.3 

func IdentityType_Values() []string

IdentityType_Values returns all elements of the IdentityType enum

func ImageFileType_Values added in v1.34.3 

func ImageFileType_Values() []string

ImageFileType_Values returns all elements of the ImageFileType enum

func JobStatus_Values added in v1.44.60 

func JobStatus_Values() []string

JobStatus_Values returns all elements of the JobStatus enum

func ListAssetModelPropertiesFilter_Values added in v1.44.129 

func ListAssetModelPropertiesFilter_Values() []string

ListAssetModelPropertiesFilter_Values returns all elements of the ListAssetModelPropertiesFilter enum

func ListAssetPropertiesFilter_Values added in v1.44.129 

func ListAssetPropertiesFilter_Values() []string

ListAssetPropertiesFilter_Values returns all elements of the ListAssetPropertiesFilter enum

func ListAssetsFilter_Values added in v1.34.3 

func ListAssetsFilter_Values() []string

ListAssetsFilter_Values returns all elements of the ListAssetsFilter enum

func ListBulkImportJobsFilter_Values added in v1.44.60 

func ListBulkImportJobsFilter_Values() []string

ListBulkImportJobsFilter_Values returns all elements of the ListBulkImportJobsFilter enum

func ListTimeSeriesType_Values added in v1.42.12 

func ListTimeSeriesType_Values() []string

ListTimeSeriesType_Values returns all elements of the ListTimeSeriesType enum

func LoggingLevel_Values added in v1.34.3 

func LoggingLevel_Values() []string

LoggingLevel_Values returns all elements of the LoggingLevel enum

func MonitorErrorCode_Values added in v1.34.3 

func MonitorErrorCode_Values() []string

MonitorErrorCode_Values returns all elements of the MonitorErrorCode enum

func Permission_Values added in v1.34.3 

func Permission_Values() []string

Permission_Values returns all elements of the Permission enum

func PortalState_Values added in v1.34.3 

func PortalState_Values() []string

PortalState_Values returns all elements of the PortalState enum

func PropertyDataType_Values added in v1.34.3 

func PropertyDataType_Values() []string

PropertyDataType_Values returns all elements of the PropertyDataType enum

func PropertyNotificationState_Values added in v1.34.3 

func PropertyNotificationState_Values() []string

PropertyNotificationState_Values returns all elements of the PropertyNotificationState enum

func Quality_Values added in v1.34.3 

func Quality_Values() []string

Quality_Values returns all elements of the Quality enum

func ResourceType_Values added in v1.34.3 

func ResourceType_Values() []string

ResourceType_Values returns all elements of the ResourceType enum

func ScalarType_Values added in v1.48.2 

func ScalarType_Values() []string

ScalarType_Values returns all elements of the ScalarType enum

func StorageType_Values added in v1.39.2 

func StorageType_Values() []string

StorageType_Values returns all elements of the StorageType enum

func TargetResourceType_Values added in v1.48.2 

func TargetResourceType_Values() []string

TargetResourceType_Values returns all elements of the TargetResourceType enum

func TimeOrdering_Values added in v1.34.3 

func TimeOrdering_Values() []string

TimeOrdering_Values returns all elements of the TimeOrdering enum

func TraversalDirection_Values added in v1.34.10 

func TraversalDirection_Values() []string

TraversalDirection_Values returns all elements of the TraversalDirection enum

func TraversalType_Values added in v1.36.7 

func TraversalType_Values() []string

TraversalType_Values returns all elements of the TraversalType enum

func WarmTierState_Values added in v1.48.2 

func WarmTierState_Values() []string

WarmTierState_Values returns all elements of the WarmTierState enum

Types

type AccessDeniedException added in v1.48.2 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Access is denied.

func (*AccessDeniedException) Code added in v1.48.2 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error added in v1.48.2 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString added in v1.48.2 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message added in v1.48.2 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr added in v1.48.2 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID added in v1.48.2 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode added in v1.48.2 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String added in v1.48.2 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 IAM Identity Center user, an IAM Identity Center 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 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 IoT SiteWise Monitor resource.

func (AccessPolicySummary) GoString 

func (s AccessPolicySummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessPolicySummary) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*AccessPolicySummary) SetId 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionDefinition added in v1.48.2 

type ActionDefinition struct {

	// The ID of the action definition.
	//
	// ActionDefinitionId is a required field
	ActionDefinitionId *string `locationName:"actionDefinitionId" min:"36" type:"string" required:"true"`

	// The name of the action definition.
	//
	// ActionName is a required field
	ActionName *string `locationName:"actionName" min:"1" type:"string" required:"true"`

	// The type of the action definition.
	//
	// ActionType is a required field
	ActionType *string `locationName:"actionType" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains a definition for an action.

func (ActionDefinition) GoString added in v1.48.2 

func (s ActionDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionDefinition) SetActionDefinitionId added in v1.48.2 

func (s *ActionDefinition) SetActionDefinitionId(v string) *ActionDefinition

SetActionDefinitionId sets the ActionDefinitionId field's value.

func (*ActionDefinition) SetActionName added in v1.48.2 

func (s *ActionDefinition) SetActionName(v string) *ActionDefinition

SetActionName sets the ActionName field's value.

func (*ActionDefinition) SetActionType added in v1.48.2 

func (s *ActionDefinition) SetActionType(v string) *ActionDefinition

SetActionType sets the ActionType field's value.

func (ActionDefinition) String added in v1.48.2 

func (s ActionDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ActionPayload added in v1.48.2 

type ActionPayload struct {

	// The payload of the action in a JSON string.
	//
	// StringValue is a required field
	StringValue *string `locationName:"stringValue" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The JSON payload of the action.

func (ActionPayload) GoString added in v1.48.2 

func (s ActionPayload) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionPayload) SetStringValue added in v1.48.2 

func (s *ActionPayload) SetStringValue(v string) *ActionPayload

SetStringValue sets the StringValue field's value.

func (ActionPayload) String added in v1.48.2 

func (s ActionPayload) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionPayload) Validate added in v1.48.2 

func (s *ActionPayload) Validate() error

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

type ActionSummary added in v1.48.2 

type ActionSummary struct {

	// The ID of the action definition.
	ActionDefinitionId *string `locationName:"actionDefinitionId" min:"36" type:"string"`

	// The ID of the action.
	ActionId *string `locationName:"actionId" min:"36" type:"string"`

	// The resource the action will be taken on.
	TargetResource *TargetResource `locationName:"targetResource" type:"structure"`
	// contains filtered or unexported fields
}

Contains the summary of the actions.

func (ActionSummary) GoString added in v1.48.2 

func (s ActionSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionSummary) SetActionDefinitionId added in v1.48.2 

func (s *ActionSummary) SetActionDefinitionId(v string) *ActionSummary

SetActionDefinitionId sets the ActionDefinitionId field's value.

func (*ActionSummary) SetActionId added in v1.48.2 

func (s *ActionSummary) SetActionId(v string) *ActionSummary

SetActionId sets the ActionId field's value.

func (*ActionSummary) SetTargetResource added in v1.48.2 

func (s *ActionSummary) SetTargetResource(v *TargetResource) *ActionSummary

SetTargetResource sets the TargetResource field's value.

func (ActionSummary) String added in v1.48.2 

func (s ActionSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 added in v1.31.4 

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Alarms added in v1.38.50 

type Alarms struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the IAM role that allows the alarm to perform actions and access Amazon
	// Web Services resources and services, such as IoT Events.
	//
	// AlarmRoleArn is a required field
	AlarmRoleArn *string `locationName:"alarmRoleArn" min:"1" type:"string" required:"true"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the Lambda function that manages alarm notifications. For more information,
	// see Managing alarm notifications (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html)
	// in the IoT Events Developer Guide.
	NotificationLambdaArn *string `locationName:"notificationLambdaArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) in the IoT SiteWise Application Guide.

func (Alarms) GoString added in v1.38.50 

func (s Alarms) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Alarms) SetAlarmRoleArn added in v1.38.50 

func (s *Alarms) SetAlarmRoleArn(v string) *Alarms

SetAlarmRoleArn sets the AlarmRoleArn field's value.

func (*Alarms) SetNotificationLambdaArn added in v1.38.50 

func (s *Alarms) SetNotificationLambdaArn(v string) *Alarms

SetNotificationLambdaArn sets the NotificationLambdaArn field's value.

func (Alarms) String added in v1.38.50 

func (s Alarms) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Alarms) Validate added in v1.38.50 

func (s *Alarms) Validate() error

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

type AssetCompositeModel added in v1.36.7 

type AssetCompositeModel struct {

	// The description of the composite model.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The external ID of the asset composite model. For more information, see Using
	// external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID of the asset composite model.
	Id *string `locationName:"id" min:"36" 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 added in v1.36.7 

func (s AssetCompositeModel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetCompositeModel) SetDescription added in v1.36.7 

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

SetDescription sets the Description field's value.

func (*AssetCompositeModel) SetExternalId added in v1.48.2 

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

SetExternalId sets the ExternalId field's value.

func (*AssetCompositeModel) SetId added in v1.44.129 

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

SetId sets the Id field's value.

func (*AssetCompositeModel) SetName added in v1.36.7 

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

SetName sets the Name field's value.

func (*AssetCompositeModel) SetProperties added in v1.36.7 

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

SetProperties sets the Properties field's value.

func (*AssetCompositeModel) SetType added in v1.36.7 

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

SetType sets the Type field's value.

func (AssetCompositeModel) String added in v1.36.7 

func (s AssetCompositeModel) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetCompositeModelPathSegment added in v1.48.2 

type AssetCompositeModelPathSegment struct {

	// The ID of the path segment.
	Id *string `locationName:"id" min:"36" type:"string"`

	// The name of the path segment.
	Name *string `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents one level between a composite model and the root of the asset.

func (AssetCompositeModelPathSegment) GoString added in v1.48.2 

func (s AssetCompositeModelPathSegment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetCompositeModelPathSegment) SetId added in v1.48.2 

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

SetId sets the Id field's value.

func (*AssetCompositeModelPathSegment) SetName added in v1.48.2 

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

SetName sets the Name field's value.

func (AssetCompositeModelPathSegment) String added in v1.48.2 

func (s AssetCompositeModelPathSegment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetCompositeModelSummary added in v1.48.2 

type AssetCompositeModelSummary struct {

	// A description of the composite model that this summary describes.
	//
	// Description is a required field
	Description *string `locationName:"description" min:"1" type:"string" required:"true"`

	// An external ID to assign to the asset model.
	//
	// If the composite model is a derived composite model, or one nested inside
	// a component model, you can only set the external ID using UpdateAssetModelCompositeModel
	// and specifying the derived ID of the model or property from the created model
	// it's a part of.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID of the composite model that this summary describes.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The name of the composite model that this summary describes.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The path that includes all the components of the asset model for the asset.
	//
	// Path is a required field
	Path []*AssetCompositeModelPathSegment `locationName:"path" type:"list" required:"true"`

	// The type of asset model.
	//
	//    * ASSET_MODEL – (default) An asset model that you can use to create
	//    assets. Can't be included as a component in another asset model.
	//
	//    * COMPONENT_MODEL – A reusable component that you can include in the
	//    composite models of other asset models. You can't create assets directly
	//    from this type of asset model.
	//
	// Type is a required field
	Type *string `locationName:"type" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains a summary of the composite model for a specific asset.

func (AssetCompositeModelSummary) GoString added in v1.48.2 

func (s AssetCompositeModelSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetCompositeModelSummary) SetDescription added in v1.48.2 

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

SetDescription sets the Description field's value.

func (*AssetCompositeModelSummary) SetExternalId added in v1.48.2 

func (s *AssetCompositeModelSummary) SetExternalId(v string) *AssetCompositeModelSummary

SetExternalId sets the ExternalId field's value.

func (*AssetCompositeModelSummary) SetId added in v1.48.2 

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

SetId sets the Id field's value.

func (*AssetCompositeModelSummary) SetName added in v1.48.2 

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

SetName sets the Name field's value.

func (*AssetCompositeModelSummary) SetPath added in v1.48.2 

func (s *AssetCompositeModelSummary) SetPath(v []*AssetCompositeModelPathSegment) *AssetCompositeModelSummary

SetPath sets the Path field's value.

func (*AssetCompositeModelSummary) SetType added in v1.48.2 

func (s *AssetCompositeModelSummary) SetType(v string) *AssetCompositeModelSummary

SetType sets the Type field's value.

func (AssetCompositeModelSummary) String added in v1.48.2 

func (s AssetCompositeModelSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetErrorDetails 

type AssetErrorDetails struct {

	// The ID of the asset, in UUID format.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetErrorDetails) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*AssetErrorDetails) SetCode 

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

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetHierarchy 

type AssetHierarchy struct {

	// The external ID of the hierarchy, if it has one. When you update an asset
	// hierarchy, you may assign an external ID if it doesn't already have one.
	// You can't change the external ID of an asset hierarchy that already has one.
	// For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetHierarchy) SetExternalId added in v1.48.2 

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

SetExternalId sets the ExternalId field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetHierarchyInfo added in v1.36.7 

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 added in v1.36.7 

func (s AssetHierarchyInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetHierarchyInfo) SetChildAssetId added in v1.36.7 

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

SetChildAssetId sets the ChildAssetId field's value.

func (*AssetHierarchyInfo) SetParentAssetId added in v1.36.7 

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

SetParentAssetId sets the ParentAssetId field's value.

func (AssetHierarchyInfo) String added in v1.36.7 

func (s AssetHierarchyInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetModelCompositeModel added in v1.36.7 

type AssetModelCompositeModel struct {

	// The description of the composite model.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The external ID of the asset model composite model. For more information,
	// see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID of the asset model composite model.
	Id *string `locationName:"id" min:"13" 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 added in v1.36.7 

func (s AssetModelCompositeModel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelCompositeModel) SetDescription added in v1.36.7 

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

SetDescription sets the Description field's value.

func (*AssetModelCompositeModel) SetExternalId added in v1.48.2 

func (s *AssetModelCompositeModel) SetExternalId(v string) *AssetModelCompositeModel

SetExternalId sets the ExternalId field's value.

func (*AssetModelCompositeModel) SetId added in v1.44.129 

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

SetId sets the Id field's value.

func (*AssetModelCompositeModel) SetName added in v1.36.7 

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

SetName sets the Name field's value.

func (*AssetModelCompositeModel) SetProperties added in v1.36.7 

func (s *AssetModelCompositeModel) SetProperties(v []*AssetModelProperty) *AssetModelCompositeModel

SetProperties sets the Properties field's value.

func (*AssetModelCompositeModel) SetType added in v1.36.7 

func (s *AssetModelCompositeModel) SetType(v string) *AssetModelCompositeModel

SetType sets the Type field's value.

func (AssetModelCompositeModel) String added in v1.36.7 

func (s AssetModelCompositeModel) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelCompositeModel) Validate added in v1.36.7 

func (s *AssetModelCompositeModel) Validate() error

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

type AssetModelCompositeModelDefinition added in v1.36.7 

type AssetModelCompositeModelDefinition struct {

	// The description of the composite model.
	Description *string `locationName:"description" min:"1" type:"string"`

	// An external ID to assign to the composite model. The external ID must be
	// unique among composite models within this asset model. For more information,
	// see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID to assign to the composite model, if desired. IoT SiteWise automatically
	// generates a unique ID for you, so this parameter is never required. However,
	// if you prefer to supply your own ID instead, you can specify it here in UUID
	// format. If you specify your own ID, it must be globally unique.
	Id *string `locationName:"id" min:"36" 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 added in v1.36.7 

func (s AssetModelCompositeModelDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelCompositeModelDefinition) SetDescription added in v1.36.7 

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

SetDescription sets the Description field's value.

func (*AssetModelCompositeModelDefinition) SetExternalId added in v1.48.2 

func (s *AssetModelCompositeModelDefinition) SetExternalId(v string) *AssetModelCompositeModelDefinition

SetExternalId sets the ExternalId field's value.

func (*AssetModelCompositeModelDefinition) SetId added in v1.48.2 

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

SetId sets the Id field's value.

func (*AssetModelCompositeModelDefinition) SetName added in v1.36.7 

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

SetName sets the Name field's value.

func (*AssetModelCompositeModelDefinition) SetProperties added in v1.36.7 

func (s *AssetModelCompositeModelDefinition) SetProperties(v []*AssetModelPropertyDefinition) *AssetModelCompositeModelDefinition

SetProperties sets the Properties field's value.

func (*AssetModelCompositeModelDefinition) SetType added in v1.36.7 

func (s *AssetModelCompositeModelDefinition) SetType(v string) *AssetModelCompositeModelDefinition

SetType sets the Type field's value.

func (AssetModelCompositeModelDefinition) String added in v1.36.7 

func (s AssetModelCompositeModelDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelCompositeModelDefinition) Validate added in v1.36.7 

func (s *AssetModelCompositeModelDefinition) Validate() error

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

type AssetModelCompositeModelPathSegment added in v1.48.2 

type AssetModelCompositeModelPathSegment struct {

	// The ID of the path segment.
	Id *string `locationName:"id" min:"36" type:"string"`

	// The name of the path segment.
	Name *string `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents one level between a composite model and the root of the asset model.

func (AssetModelCompositeModelPathSegment) GoString added in v1.48.2 

func (s AssetModelCompositeModelPathSegment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelCompositeModelPathSegment) SetId added in v1.48.2 

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

SetId sets the Id field's value.

func (*AssetModelCompositeModelPathSegment) SetName added in v1.48.2 

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

SetName sets the Name field's value.

func (AssetModelCompositeModelPathSegment) String added in v1.48.2 

func (s AssetModelCompositeModelPathSegment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetModelCompositeModelSummary added in v1.48.2 

type AssetModelCompositeModelSummary struct {

	// The description of the the composite model that this summary describes..
	Description *string `locationName:"description" min:"1" type:"string"`

	// The external ID of a composite model on this asset model. For more information,
	// see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID of the the composite model that this summary describes..
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The name of the the composite model that this summary describes..
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The path that includes all the pieces that make up the composite model.
	Path []*AssetModelCompositeModelPathSegment `locationName:"path" type:"list"`

	// The type of asset model.
	//
	//    * ASSET_MODEL – (default) An asset model that you can use to create
	//    assets. Can't be included as a component in another asset model.
	//
	//    * COMPONENT_MODEL – A reusable component that you can include in the
	//    composite models of other asset models. You can't create assets directly
	//    from this type of asset model.
	//
	// Type is a required field
	Type *string `locationName:"type" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains a summary of the composite model.

func (AssetModelCompositeModelSummary) GoString added in v1.48.2 

func (s AssetModelCompositeModelSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelCompositeModelSummary) SetDescription added in v1.48.2 

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

SetDescription sets the Description field's value.

func (*AssetModelCompositeModelSummary) SetExternalId added in v1.48.2 

func (s *AssetModelCompositeModelSummary) SetExternalId(v string) *AssetModelCompositeModelSummary

SetExternalId sets the ExternalId field's value.

func (*AssetModelCompositeModelSummary) SetId added in v1.48.2 

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

SetId sets the Id field's value.

func (*AssetModelCompositeModelSummary) SetName added in v1.48.2 

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

SetName sets the Name field's value.

func (*AssetModelCompositeModelSummary) SetPath added in v1.48.2 

func (s *AssetModelCompositeModelSummary) SetPath(v []*AssetModelCompositeModelPathSegment) *AssetModelCompositeModelSummary

SetPath sets the Path field's value.

func (*AssetModelCompositeModelSummary) SetType added in v1.48.2 

func (s *AssetModelCompositeModelSummary) SetType(v string) *AssetModelCompositeModelSummary

SetType sets the Type field's value.

func (AssetModelCompositeModelSummary) String added in v1.48.2 

func (s AssetModelCompositeModelSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetModelHierarchy 

type AssetModelHierarchy struct {

	// The ID of the asset model, in UUID format. All assets in this hierarchy must
	// be instances of the childAssetModelId asset model. IoT SiteWise will always
	// return the actual asset model ID for this value. However, when you are specifying
	// this value as part of a call to UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html),
	// you may provide either the asset model ID or else externalId: followed by
	// the asset model's external ID. For more information, see Using external IDs
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	//
	// ChildAssetModelId is a required field
	ChildAssetModelId *string `locationName:"childAssetModelId" min:"13" type:"string" required:"true"`

	// The external ID (if any) 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)
	// operation. You can assign an external ID by specifying this value as part
	// of a call to UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html).
	// However, you can't change the external ID if one is already assigned. For
	// more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID of the asset model hierarchy. This ID is a hierarchyId.
	//
	//    * If you are callling UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
	//    to create a new hierarchy: You can specify its ID here, if desired. IoT
	//    SiteWise automatically generates a unique ID for you, so this parameter
	//    is never required. However, if you prefer to supply your own ID instead,
	//    you can specify it here in UUID format. If you specify your own ID, it
	//    must be globally unique.
	//
	//    * If you are calling UpdateAssetModel to modify an existing hierarchy:
	//    This can be either the actual ID in UUID format, or else externalId: followed
	//    by the external ID, if it has one. For more information, see Referencing
	//    objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	//    in the IoT SiteWise User Guide.
	Id *string `locationName:"id" min:"13" 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelHierarchy) SetChildAssetModelId 

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

SetChildAssetModelId sets the ChildAssetModelId field's value.

func (*AssetModelHierarchy) SetExternalId added in v1.48.2 

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

SetExternalId sets the ExternalId field's value.

func (*AssetModelHierarchy) SetId 

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

SetId sets the Id field's value.

func (*AssetModelHierarchy) SetName 

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

SetName sets the Name field's value.

func (AssetModelHierarchy) String 

func (s AssetModelHierarchy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. This can be either the actual
	// ID in UUID format, or else externalId: followed by the external ID, if it
	// has one. For more information, see Referencing objects with external IDs
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// ChildAssetModelId is a required field
	ChildAssetModelId *string `locationName:"childAssetModelId" min:"13" type:"string" required:"true"`

	// An external ID to assign to the asset model hierarchy. The external ID must
	// be unique among asset model hierarchies within this asset model. For more
	// information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID to assign to the asset model hierarchy, if desired. IoT SiteWise automatically
	// generates a unique ID for you, so this parameter is never required. However,
	// if you prefer to supply your own ID instead, you can specify it here in UUID
	// format. If you specify your own ID, it must be globally unique.
	Id *string `locationName:"id" min:"36" type:"string"`

	// 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 

func (s AssetModelHierarchyDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelHierarchyDefinition) SetChildAssetModelId 

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

SetChildAssetModelId sets the ChildAssetModelId field's value.

func (*AssetModelHierarchyDefinition) SetExternalId added in v1.48.2 

func (s *AssetModelHierarchyDefinition) SetExternalId(v string) *AssetModelHierarchyDefinition

SetExternalId sets the ExternalId field's value.

func (*AssetModelHierarchyDefinition) SetId added in v1.48.2 

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

SetId sets the Id field's value.

func (*AssetModelHierarchyDefinition) SetName 

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

SetName sets the Name field's value.

func (AssetModelHierarchyDefinition) String 

func (s AssetModelHierarchyDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 external ID (if any) 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)
	// operation. You can assign an external ID by specifying this value as part
	// of a call to UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html).
	// However, you can't change the external ID if one is already assigned. For
	// more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID of the asset model property.
	//
	//    * If you are callling UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
	//    to create a new property: You can specify its ID here, if desired. IoT
	//    SiteWise automatically generates a unique ID for you, so this parameter
	//    is never required. However, if you prefer to supply your own ID instead,
	//    you can specify it here in UUID format. If you specify your own ID, it
	//    must be globally unique.
	//
	//    * If you are calling UpdateAssetModel to modify an existing property:
	//    This can be either the actual ID in UUID format, or else externalId: followed
	//    by the external ID, if it has one. For more information, see Referencing
	//    objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	//    in the IoT SiteWise User Guide.
	Id *string `locationName:"id" min:"13" 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 structured path to the property from the root of the asset model.
	Path []*AssetModelPropertyPathSegment `locationName:"path" type:"list"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelProperty) SetDataType 

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

SetDataType sets the DataType field's value.

func (*AssetModelProperty) SetDataTypeSpec added in v1.36.7 

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

SetDataTypeSpec sets the DataTypeSpec field's value.

func (*AssetModelProperty) SetExternalId added in v1.48.2 

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

SetExternalId sets the ExternalId field's value.

func (*AssetModelProperty) SetId 

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

SetId sets the Id field's value.

func (*AssetModelProperty) SetName 

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

SetName sets the Name field's value.

func (*AssetModelProperty) SetPath added in v1.48.2 

func (s *AssetModelProperty) SetPath(v []*AssetModelPropertyPathSegment) *AssetModelProperty

SetPath sets the Path field's value.

func (*AssetModelProperty) SetType 

func (s *AssetModelProperty) SetType(v *PropertyType) *AssetModelProperty

SetType sets the Type field's value.

func (*AssetModelProperty) SetUnit 

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

SetUnit sets the Unit field's value.

func (AssetModelProperty) String 

func (s AssetModelProperty) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 this property. Use AWS/ALARM_STATE for alarm state in
	// alarm composite models.
	DataTypeSpec *string `locationName:"dataTypeSpec" min:"1" type:"string"`

	// An external ID to assign to the property definition. The external ID must
	// be unique among property definitions within this asset model. For more information,
	// see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID to assign to the asset model property, if desired. IoT SiteWise automatically
	// generates a unique ID for you, so this parameter is never required. However,
	// if you prefer to supply your own ID instead, you can specify it here in UUID
	// format. If you specify your own ID, it must be globally unique.
	Id *string `locationName:"id" min:"36" type:"string"`

	// The name of the property definition.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The property definition type (see PropertyType). You can only specify one
	// type in a property definition.
	//
	// Type is a required field
	Type *PropertyType `locationName:"type" type:"structure" required:"true"`

	// The unit of the property definition, such as Newtons or RPM.
	Unit *string `locationName:"unit" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains an asset model property definition. This property definition is applied to all assets created from the asset model.

func (AssetModelPropertyDefinition) GoString 

func (s AssetModelPropertyDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelPropertyDefinition) SetDataType 

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

SetDataType sets the DataType field's value.

func (*AssetModelPropertyDefinition) SetDataTypeSpec added in v1.36.7 

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

SetDataTypeSpec sets the DataTypeSpec field's value.

func (*AssetModelPropertyDefinition) SetExternalId added in v1.48.2 

func (s *AssetModelPropertyDefinition) SetExternalId(v string) *AssetModelPropertyDefinition

SetExternalId sets the ExternalId field's value.

func (*AssetModelPropertyDefinition) SetId added in v1.48.2 

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

SetId sets the Id field's value.

func (*AssetModelPropertyDefinition) SetName 

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

SetName sets the Name field's value.

func (*AssetModelPropertyDefinition) SetType 

func (s *AssetModelPropertyDefinition) SetType(v *PropertyType) *AssetModelPropertyDefinition

SetType sets the Type field's value.

func (*AssetModelPropertyDefinition) SetUnit 

func (s *AssetModelPropertyDefinition) SetUnit(v string) *AssetModelPropertyDefinition

SetUnit sets the Unit field's value.

func (AssetModelPropertyDefinition) String 

func (s AssetModelPropertyDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelPropertyDefinition) Validate 

func (s *AssetModelPropertyDefinition) Validate() error

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

type AssetModelPropertyPathSegment added in v1.48.2 

type AssetModelPropertyPathSegment struct {

	// The ID of the path segment.
	Id *string `locationName:"id" min:"36" type:"string"`

	// The name of the path segment.
	Name *string `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents one level between a property and the root of the asset model.

func (AssetModelPropertyPathSegment) GoString added in v1.48.2 

func (s AssetModelPropertyPathSegment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelPropertyPathSegment) SetId added in v1.48.2 

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

SetId sets the Id field's value.

func (*AssetModelPropertyPathSegment) SetName added in v1.48.2 

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

SetName sets the Name field's value.

func (AssetModelPropertyPathSegment) String added in v1.48.2 

func (s AssetModelPropertyPathSegment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelPropertyPathSegment) Validate added in v1.48.2 

func (s *AssetModelPropertyPathSegment) Validate() error

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

type AssetModelPropertySummary added in v1.44.129 

type AssetModelPropertySummary struct {

	// The ID of the composite model that contains the asset model property.
	AssetModelCompositeModelId *string `locationName:"assetModelCompositeModelId" min:"36" type:"string"`

	// The data type of the 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 external ID of the property. For more information, see Using external
	// IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID of the property.
	Id *string `locationName:"id" min:"36" type:"string"`

	// The name of the property.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The structured path to the property from the root of the asset model.
	Path []*AssetModelPropertyPathSegment `locationName:"path" type:"list"`

	// Contains a property type, which can be one of attribute, measurement, metric,
	// or transform.
	//
	// Type is a required field
	Type *PropertyType `locationName:"type" type:"structure" required:"true"`

	// The unit (such as Newtons or RPM) of the property.
	Unit *string `locationName:"unit" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains a summary of a property associated with a model.

func (AssetModelPropertySummary) GoString added in v1.44.129 

func (s AssetModelPropertySummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelPropertySummary) SetAssetModelCompositeModelId added in v1.44.129 

func (s *AssetModelPropertySummary) SetAssetModelCompositeModelId(v string) *AssetModelPropertySummary

SetAssetModelCompositeModelId sets the AssetModelCompositeModelId field's value.

func (*AssetModelPropertySummary) SetDataType added in v1.44.129 

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

SetDataType sets the DataType field's value.

func (*AssetModelPropertySummary) SetDataTypeSpec added in v1.44.129 

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

SetDataTypeSpec sets the DataTypeSpec field's value.

func (*AssetModelPropertySummary) SetExternalId added in v1.48.2 

func (s *AssetModelPropertySummary) SetExternalId(v string) *AssetModelPropertySummary

SetExternalId sets the ExternalId field's value.

func (*AssetModelPropertySummary) SetId added in v1.44.129 

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

SetId sets the Id field's value.

func (*AssetModelPropertySummary) SetName added in v1.44.129 

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

SetName sets the Name field's value.

func (*AssetModelPropertySummary) SetPath added in v1.48.2 

func (s *AssetModelPropertySummary) SetPath(v []*AssetModelPropertyPathSegment) *AssetModelPropertySummary

SetPath sets the Path field's value.

func (*AssetModelPropertySummary) SetType added in v1.44.129 

func (s *AssetModelPropertySummary) SetType(v *PropertyType) *AssetModelPropertySummary

SetType sets the Type field's value.

func (*AssetModelPropertySummary) SetUnit added in v1.44.129 

func (s *AssetModelPropertySummary) SetUnit(v string) *AssetModelPropertySummary

SetUnit sets the Unit field's value.

func (AssetModelPropertySummary) String added in v1.44.129 

func (s AssetModelPropertySummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetModelStatus 

type AssetModelStatus struct {

	// Contains associated error information, if any.
	Error *ErrorDetails `locationName:"error" type:"structure"`

	// The current state of the asset model.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"AssetModelState"`
	// contains filtered or unexported fields
}

Contains current status information for an asset model. For more information, see Asset and model states (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) in the IoT SiteWise User Guide.

func (AssetModelStatus) GoString 

func (s AssetModelStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelStatus) SetError 

func (s *AssetModelStatus) SetError(v *ErrorDetails) *AssetModelStatus

SetError sets the Error field's value.

func (*AssetModelStatus) SetState 

func (s *AssetModelStatus) SetState(v string) *AssetModelStatus

SetState sets the State field's value.

func (AssetModelStatus) String 

func (s AssetModelStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetModelSummary 

type AssetModelSummary struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the asset model, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

	// The type of asset model.
	//
	//    * ASSET_MODEL – (default) An asset model that you can use to create
	//    assets. Can't be included as a component in another asset model.
	//
	//    * COMPONENT_MODEL – A reusable component that you can include in the
	//    composite models of other asset models. You can't create assets directly
	//    from this type of asset model.
	AssetModelType *string `locationName:"assetModelType" type:"string" enum:"AssetModelType"`

	// The date the asset model was created, in Unix epoch time.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"`

	// The asset model description.
	//
	// Description is a required field
	Description *string `locationName:"description" min:"1" type:"string" required:"true"`

	// The external ID of the asset model. For more information, see Using external
	// IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID of the asset model (used with IoT SiteWise API operations).
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The date the asset model was last updated, in Unix epoch time.
	//
	// LastUpdateDate is a required field
	LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp" required:"true"`

	// The name of the asset model.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The current status of the asset model.
	//
	// Status is a required field
	Status *AssetModelStatus `locationName:"status" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains a summary of an asset model.

func (AssetModelSummary) GoString 

func (s AssetModelSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetModelSummary) SetArn 

func (s *AssetModelSummary) SetArn(v string) *AssetModelSummary

SetArn sets the Arn field's value.

func (*AssetModelSummary) SetAssetModelType added in v1.48.2 

func (s *AssetModelSummary) SetAssetModelType(v string) *AssetModelSummary

SetAssetModelType sets the AssetModelType field's value.

func (*AssetModelSummary) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*AssetModelSummary) SetDescription 

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

SetDescription sets the Description field's value.

func (*AssetModelSummary) SetExternalId added in v1.48.2 

func (s *AssetModelSummary) SetExternalId(v string) *AssetModelSummary

SetExternalId sets the ExternalId field's value.

func (*AssetModelSummary) SetId 

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

SetId sets the Id field's value.

func (*AssetModelSummary) SetLastUpdateDate 

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

SetLastUpdateDate sets the LastUpdateDate field's value.

func (*AssetModelSummary) SetName 

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

SetName sets the Name field's value.

func (*AssetModelSummary) SetStatus 

func (s *AssetModelSummary) SetStatus(v *AssetModelStatus) *AssetModelSummary

SetStatus sets the Status field's value.

func (AssetModelSummary) String 

func (s AssetModelSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetProperty 

type AssetProperty struct {

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
	// see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the IoT SiteWise User Guide.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// The data type of the asset 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 external ID of the asset property. For more information, see Using external
	// IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID of the asset property.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The name of the property.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The asset property's notification topic and state. For more information,
	// see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).
	Notification *PropertyNotification `locationName:"notification" type:"structure"`

	// The structured path to the property from the root of the asset.
	Path []*AssetPropertyPathSegment `locationName:"path" type:"list"`

	// The unit (such as Newtons or RPM) of the asset property.
	Unit *string `locationName:"unit" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains asset property information.

func (AssetProperty) GoString 

func (s AssetProperty) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetProperty) SetAlias 

func (s *AssetProperty) SetAlias(v string) *AssetProperty

SetAlias sets the Alias field's value.

func (*AssetProperty) SetDataType 

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

SetDataType sets the DataType field's value.

func (*AssetProperty) SetDataTypeSpec added in v1.36.7 

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

SetDataTypeSpec sets the DataTypeSpec field's value.

func (*AssetProperty) SetExternalId added in v1.48.2 

func (s *AssetProperty) SetExternalId(v string) *AssetProperty

SetExternalId sets the ExternalId field's value.

func (*AssetProperty) SetId 

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

SetId sets the Id field's value.

func (*AssetProperty) SetName 

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

SetName sets the Name field's value.

func (*AssetProperty) SetNotification 

func (s *AssetProperty) SetNotification(v *PropertyNotification) *AssetProperty

SetNotification sets the Notification field's value.

func (*AssetProperty) SetPath added in v1.48.2 

func (s *AssetProperty) SetPath(v []*AssetPropertyPathSegment) *AssetProperty

SetPath sets the Path field's value.

func (*AssetProperty) SetUnit 

func (s *AssetProperty) SetUnit(v string) *AssetProperty

SetUnit sets the Unit field's value.

func (AssetProperty) String 

func (s AssetProperty) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetPropertyPathSegment added in v1.48.2 

type AssetPropertyPathSegment struct {

	// The ID of the path segment.
	Id *string `locationName:"id" min:"36" type:"string"`

	// The name of the path segment.
	Name *string `locationName:"name" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents one level between a property and the root of the asset.

func (AssetPropertyPathSegment) GoString added in v1.48.2 

func (s AssetPropertyPathSegment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyPathSegment) SetId added in v1.48.2 

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

SetId sets the Id field's value.

func (*AssetPropertyPathSegment) SetName added in v1.48.2 

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

SetName sets the Name field's value.

func (AssetPropertyPathSegment) String added in v1.48.2 

func (s AssetPropertyPathSegment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetPropertySummary added in v1.44.129 

type AssetPropertySummary struct {

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
	// see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the IoT SiteWise User Guide.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// The ID of the composite model that contains the asset property.
	AssetCompositeModelId *string `locationName:"assetCompositeModelId" min:"36" type:"string"`

	// The external ID of the property. For more information, see Using external
	// IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID of the property.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// Contains asset property value notification information. When the notification
	// state is enabled, IoT SiteWise publishes property value updates to a unique
	// MQTT topic. For more information, see Interacting with other services (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html)
	// in the IoT SiteWise User Guide.
	Notification *PropertyNotification `locationName:"notification" type:"structure"`

	// The structured path to the property from the root of the asset.
	Path []*AssetPropertyPathSegment `locationName:"path" type:"list"`

	// The unit of measure (such as Newtons or RPM) of the asset property.
	Unit *string `locationName:"unit" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains a summary of a property associated with an asset.

func (AssetPropertySummary) GoString added in v1.44.129 

func (s AssetPropertySummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertySummary) SetAlias added in v1.44.129 

func (s *AssetPropertySummary) SetAlias(v string) *AssetPropertySummary

SetAlias sets the Alias field's value.

func (*AssetPropertySummary) SetAssetCompositeModelId added in v1.44.129 

func (s *AssetPropertySummary) SetAssetCompositeModelId(v string) *AssetPropertySummary

SetAssetCompositeModelId sets the AssetCompositeModelId field's value.

func (*AssetPropertySummary) SetExternalId added in v1.48.2 

func (s *AssetPropertySummary) SetExternalId(v string) *AssetPropertySummary

SetExternalId sets the ExternalId field's value.

func (*AssetPropertySummary) SetId added in v1.44.129 

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

SetId sets the Id field's value.

func (*AssetPropertySummary) SetNotification added in v1.44.129 

func (s *AssetPropertySummary) SetNotification(v *PropertyNotification) *AssetPropertySummary

SetNotification sets the Notification field's value.

func (*AssetPropertySummary) SetPath added in v1.48.2 

func (s *AssetPropertySummary) SetPath(v []*AssetPropertyPathSegment) *AssetPropertySummary

SetPath sets the Path field's value.

func (*AssetPropertySummary) SetUnit added in v1.44.129 

func (s *AssetPropertySummary) SetUnit(v string) *AssetPropertySummary

SetUnit sets the Unit field's value.

func (AssetPropertySummary) String added in v1.44.129 

func (s AssetPropertySummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetPropertyValue 

type AssetPropertyValue struct {

	// The quality of the asset property value.
	Quality *string `locationName:"quality" type:"string" enum:"Quality"`

	// The timestamp of the asset property value.
	//
	// Timestamp is a required field
	Timestamp *TimeInNanos `locationName:"timestamp" type:"structure" required:"true"`

	// The value of the asset property (see Variant).
	//
	// Value is a required field
	Value *Variant `locationName:"value" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains asset property value information.

func (AssetPropertyValue) GoString 

func (s AssetPropertyValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyValue) SetQuality 

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

SetQuality sets the Quality field's value.

func (*AssetPropertyValue) SetTimestamp 

func (s *AssetPropertyValue) SetTimestamp(v *TimeInNanos) *AssetPropertyValue

SetTimestamp sets the Timestamp field's value.

func (*AssetPropertyValue) SetValue 

func (s *AssetPropertyValue) SetValue(v *Variant) *AssetPropertyValue

SetValue sets the Value field's value.

func (AssetPropertyValue) String 

func (s AssetPropertyValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetPropertyValue) Validate 

func (s *AssetPropertyValue) Validate() error

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

type AssetRelationshipSummary added in v1.36.7 

type AssetRelationshipSummary struct {

	// The assets that are related through an asset hierarchy.
	//
	// This object is present if the relationshipType is HIERARCHY.
	HierarchyInfo *AssetHierarchyInfo `locationName:"hierarchyInfo" type:"structure"`

	// The relationship type of the assets in this relationship. This value is one
	// of the following:
	//
	//    * HIERARCHY – The assets are related through an asset hierarchy. If
	//    you specify this relationship type, this asset relationship includes the
	//    hierarchyInfo object.
	//
	// RelationshipType is a required field
	RelationshipType *string `locationName:"relationshipType" type:"string" required:"true" enum:"AssetRelationshipType"`
	// contains filtered or unexported fields
}

Contains information about assets that are related to one another.

func (AssetRelationshipSummary) GoString added in v1.36.7 

func (s AssetRelationshipSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetRelationshipSummary) SetHierarchyInfo added in v1.36.7 

func (s *AssetRelationshipSummary) SetHierarchyInfo(v *AssetHierarchyInfo) *AssetRelationshipSummary

SetHierarchyInfo sets the HierarchyInfo field's value.

func (*AssetRelationshipSummary) SetRelationshipType added in v1.36.7 

func (s *AssetRelationshipSummary) SetRelationshipType(v string) *AssetRelationshipSummary

SetRelationshipType sets the RelationshipType field's value.

func (AssetRelationshipSummary) String added in v1.36.7 

func (s AssetRelationshipSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetStatus 

type AssetStatus struct {

	// Contains associated error information, if any.
	Error *ErrorDetails `locationName:"error" type:"structure"`

	// The current status of the asset.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"AssetState"`
	// contains filtered or unexported fields
}

Contains information about the current status of an asset. For more information, see Asset and model states (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html) in the IoT SiteWise User Guide.

func (AssetStatus) GoString 

func (s AssetStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetStatus) SetError 

func (s *AssetStatus) SetError(v *ErrorDetails) *AssetStatus

SetError sets the Error field's value.

func (*AssetStatus) SetState 

func (s *AssetStatus) SetState(v string) *AssetStatus

SetState sets the State field's value.

func (AssetStatus) String 

func (s AssetStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssetSummary 

type AssetSummary struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the asset, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

	// The ID of the asset model used to create this asset.
	//
	// AssetModelId is a required field
	AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"`

	// The date the asset was created, in Unix epoch time.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"`

	// A description for the asset.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The external ID of the asset. For more information, see Using external IDs
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// A list of asset hierarchies that each contain a hierarchyId. A hierarchy
	// specifies allowed parent/child asset relationships.
	//
	// Hierarchies is a required field
	Hierarchies []*AssetHierarchy `locationName:"hierarchies" type:"list" required:"true"`

	// The ID of the asset, in UUID format.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The date the asset was last updated, in Unix epoch time.
	//
	// LastUpdateDate is a required field
	LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp" required:"true"`

	// The name of the asset.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The current status of the asset.
	//
	// Status is a required field
	Status *AssetStatus `locationName:"status" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains a summary of an asset.

func (AssetSummary) GoString 

func (s AssetSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssetSummary) SetArn 

func (s *AssetSummary) SetArn(v string) *AssetSummary

SetArn sets the Arn field's value.

func (*AssetSummary) SetAssetModelId 

func (s *AssetSummary) SetAssetModelId(v string) *AssetSummary

SetAssetModelId sets the AssetModelId field's value.

func (*AssetSummary) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*AssetSummary) SetDescription added in v1.44.25 

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

SetDescription sets the Description field's value.

func (*AssetSummary) SetExternalId added in v1.48.2 

func (s *AssetSummary) SetExternalId(v string) *AssetSummary

SetExternalId sets the ExternalId field's value.

func (*AssetSummary) SetHierarchies 

func (s *AssetSummary) SetHierarchies(v []*AssetHierarchy) *AssetSummary

SetHierarchies sets the Hierarchies field's value.

func (*AssetSummary) SetId 

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

SetId sets the Id field's value.

func (*AssetSummary) SetLastUpdateDate 

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

SetLastUpdateDate sets the LastUpdateDate field's value.

func (*AssetSummary) SetName 

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

SetName sets the Name field's value.

func (*AssetSummary) SetStatus 

func (s *AssetSummary) SetStatus(v *AssetStatus) *AssetSummary

SetStatus sets the Status field's value.

func (AssetSummary) String 

func (s AssetSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateAssetsInput 

type AssociateAssetsInput struct {

	// The ID of the parent asset. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"uri" locationName:"assetId" min:"13" type:"string" required:"true"`

	// The ID of the child asset to be associated. This can be either the actual
	// ID in UUID format, or else externalId: followed by the external ID, if it
	// has one. For more information, see Referencing objects with external IDs
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// ChildAssetId is a required field
	ChildAssetId *string `locationName:"childAssetId" min:"13" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The ID of a hierarchy in the parent asset's model. (This can be either the
	// actual ID in UUID format, or else externalId: followed by the external ID,
	// if it has one. For more information, see Referencing objects with external
	// IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.) Hierarchies allow different groupings of
	// assets to be formed that all come from the same asset model. For more information,
	// see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html)
	// in the IoT SiteWise User Guide.
	//
	// HierarchyId is a required field
	HierarchyId *string `locationName:"hierarchyId" min:"13" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateAssetsInput) GoString 

func (s AssociateAssetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateAssetsInput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*AssociateAssetsInput) SetChildAssetId 

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

SetChildAssetId sets the ChildAssetId field's value.

func (*AssociateAssetsInput) SetClientToken 

func (s *AssociateAssetsInput) SetClientToken(v string) *AssociateAssetsInput

SetClientToken sets the ClientToken field's value.

func (*AssociateAssetsInput) SetHierarchyId 

func (s *AssociateAssetsInput) SetHierarchyId(v string) *AssociateAssetsInput

SetHierarchyId sets the HierarchyId field's value.

func (AssociateAssetsInput) String 

func (s AssociateAssetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateAssetsInput) Validate 

func (s *AssociateAssetsInput) Validate() error

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

type AssociateAssetsOutput 

type AssociateAssetsOutput struct {
	// contains filtered or unexported fields
}

func (AssociateAssetsOutput) GoString 

func (s AssociateAssetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AssociateAssetsOutput) String 

func (s AssociateAssetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateTimeSeriesToAssetPropertyInput added in v1.42.12 

type AssociateTimeSeriesToAssetPropertyInput struct {

	// The alias that identifies the time series.
	//
	// Alias is a required field
	Alias *string `location:"querystring" locationName:"alias" min:"1" type:"string" required:"true"`

	// The ID of the asset in which the asset property was created. This can be
	// either the actual ID in UUID format, or else externalId: followed by the
	// external ID, if it has one. For more information, see Referencing objects
	// with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"querystring" locationName:"assetId" min:"13" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The ID of the asset property. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// PropertyId is a required field
	PropertyId *string `location:"querystring" locationName:"propertyId" min:"13" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateTimeSeriesToAssetPropertyInput) GoString added in v1.42.12 

func (s AssociateTimeSeriesToAssetPropertyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateTimeSeriesToAssetPropertyInput) SetAlias added in v1.42.12 

func (s *AssociateTimeSeriesToAssetPropertyInput) SetAlias(v string) *AssociateTimeSeriesToAssetPropertyInput

SetAlias sets the Alias field's value.

func (*AssociateTimeSeriesToAssetPropertyInput) SetAssetId added in v1.42.12 

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

SetAssetId sets the AssetId field's value.

func (*AssociateTimeSeriesToAssetPropertyInput) SetClientToken added in v1.42.12 

func (s *AssociateTimeSeriesToAssetPropertyInput) SetClientToken(v string) *AssociateTimeSeriesToAssetPropertyInput

SetClientToken sets the ClientToken field's value.

func (*AssociateTimeSeriesToAssetPropertyInput) SetPropertyId added in v1.42.12 

func (s *AssociateTimeSeriesToAssetPropertyInput) SetPropertyId(v string) *AssociateTimeSeriesToAssetPropertyInput

SetPropertyId sets the PropertyId field's value.

func (AssociateTimeSeriesToAssetPropertyInput) String added in v1.42.12 

func (s AssociateTimeSeriesToAssetPropertyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateTimeSeriesToAssetPropertyInput) Validate added in v1.42.12 

func (s *AssociateTimeSeriesToAssetPropertyInput) Validate() error

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

type AssociateTimeSeriesToAssetPropertyOutput added in v1.42.12 

type AssociateTimeSeriesToAssetPropertyOutput struct {
	// contains filtered or unexported fields
}

func (AssociateTimeSeriesToAssetPropertyOutput) GoString added in v1.42.12 

func (s AssociateTimeSeriesToAssetPropertyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AssociateTimeSeriesToAssetPropertyOutput) String added in v1.42.12 

func (s AssociateTimeSeriesToAssetPropertyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociatedAssetsSummary 

type AssociatedAssetsSummary struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the asset, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`

	// The ID of the asset model used to create the asset.
	//
	// AssetModelId is a required field
	AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"`

	// The date the asset was created, in Unix epoch time.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"`

	// A description for the asset.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The external ID of the asset. For more information, see Using external IDs
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// A list of asset hierarchies that each contain a hierarchyId. A hierarchy
	// specifies allowed parent/child asset relationships.
	//
	// Hierarchies is a required field
	Hierarchies []*AssetHierarchy `locationName:"hierarchies" type:"list" required:"true"`

	// The ID of the asset, in UUID format.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The date the asset was last updated, in Unix epoch time.
	//
	// LastUpdateDate is a required field
	LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp" required:"true"`

	// The name of the asset.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The current status of the asset.
	//
	// Status is a required field
	Status *AssetStatus `locationName:"status" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains a summary of an associated asset.

func (AssociatedAssetsSummary) GoString 

func (s AssociatedAssetsSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociatedAssetsSummary) SetArn 

func (s *AssociatedAssetsSummary) SetArn(v string) *AssociatedAssetsSummary

SetArn sets the Arn field's value.

func (*AssociatedAssetsSummary) SetAssetModelId 

func (s *AssociatedAssetsSummary) SetAssetModelId(v string) *AssociatedAssetsSummary

SetAssetModelId sets the AssetModelId field's value.

func (*AssociatedAssetsSummary) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*AssociatedAssetsSummary) SetDescription added in v1.44.25 

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

SetDescription sets the Description field's value.

func (*AssociatedAssetsSummary) SetExternalId added in v1.48.2 

func (s *AssociatedAssetsSummary) SetExternalId(v string) *AssociatedAssetsSummary

SetExternalId sets the ExternalId field's value.

func (*AssociatedAssetsSummary) SetHierarchies 

func (s *AssociatedAssetsSummary) SetHierarchies(v []*AssetHierarchy) *AssociatedAssetsSummary

SetHierarchies sets the Hierarchies field's value.

func (*AssociatedAssetsSummary) SetId 

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

SetId sets the Id field's value.

func (*AssociatedAssetsSummary) SetLastUpdateDate 

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

SetLastUpdateDate sets the LastUpdateDate field's value.

func (*AssociatedAssetsSummary) SetName 

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

SetName sets the Name field's value.

func (*AssociatedAssetsSummary) SetStatus 

func (s *AssociatedAssetsSummary) SetStatus(v *AssetStatus) *AssociatedAssetsSummary

SetStatus sets the Status field's value.

func (AssociatedAssetsSummary) String 

func (s AssociatedAssetsSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Attribute 

type Attribute struct {

	// The default value of the asset model property attribute. All assets that
	// you create from the asset model contain this attribute value. You can update
	// an attribute's value after you create an asset. For more information, see
	// Updating attribute values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html)
	// in the IoT SiteWise User Guide.
	DefaultValue *string `locationName:"defaultValue" type:"string"`
	// contains filtered or unexported fields
}

Contains an asset attribute property. For more information, see Attributes (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes) in the IoT SiteWise User Guide.

func (Attribute) GoString 

func (s Attribute) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Attribute) SetDefaultValue 

func (s *Attribute) SetDefaultValue(v string) *Attribute

SetDefaultValue sets the DefaultValue field's value.

func (Attribute) String 

func (s Attribute) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchAssociateProjectAssetsInput 

type BatchAssociateProjectAssetsInput struct {

	// The IDs of the assets to be associated to the project.
	//
	// AssetIds is a required field
	AssetIds []*string `locationName:"assetIds" min:"1" type:"list" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The ID of the project to which to associate the assets.
	//
	// ProjectId is a required field
	ProjectId *string `location:"uri" locationName:"projectId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (BatchAssociateProjectAssetsInput) GoString 

func (s BatchAssociateProjectAssetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchAssociateProjectAssetsInput) SetAssetIds 

func (s *BatchAssociateProjectAssetsInput) SetAssetIds(v []*string) *BatchAssociateProjectAssetsInput

SetAssetIds sets the AssetIds field's value.

func (*BatchAssociateProjectAssetsInput) SetClientToken 

func (s *BatchAssociateProjectAssetsInput) SetClientToken(v string) *BatchAssociateProjectAssetsInput

SetClientToken sets the ClientToken field's value.

func (*BatchAssociateProjectAssetsInput) SetProjectId 

func (s *BatchAssociateProjectAssetsInput) SetProjectId(v string) *BatchAssociateProjectAssetsInput

SetProjectId sets the ProjectId field's value.

func (BatchAssociateProjectAssetsInput) String 

func (s BatchAssociateProjectAssetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchAssociateProjectAssetsInput) Validate 

func (s *BatchAssociateProjectAssetsInput) Validate() error

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

type BatchAssociateProjectAssetsOutput 

type BatchAssociateProjectAssetsOutput struct {

	// A list of associated error information, if any.
	Errors []*AssetErrorDetails `locationName:"errors" type:"list"`
	// contains filtered or unexported fields
}

func (BatchAssociateProjectAssetsOutput) GoString 

func (s BatchAssociateProjectAssetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchAssociateProjectAssetsOutput) SetErrors 

func (s *BatchAssociateProjectAssetsOutput) SetErrors(v []*AssetErrorDetails) *BatchAssociateProjectAssetsOutput

SetErrors sets the Errors field's value.

func (BatchAssociateProjectAssetsOutput) String 

func (s BatchAssociateProjectAssetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchDisassociateProjectAssetsInput 

type BatchDisassociateProjectAssetsInput struct {

	// The IDs of the assets to be disassociated from the project.
	//
	// AssetIds is a required field
	AssetIds []*string `locationName:"assetIds" min:"1" type:"list" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The ID of the project from which to disassociate the assets.
	//
	// ProjectId is a required field
	ProjectId *string `location:"uri" locationName:"projectId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (BatchDisassociateProjectAssetsInput) GoString 

func (s BatchDisassociateProjectAssetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDisassociateProjectAssetsInput) SetAssetIds 

func (s *BatchDisassociateProjectAssetsInput) SetAssetIds(v []*string) *BatchDisassociateProjectAssetsInput

SetAssetIds sets the AssetIds field's value.

func (*BatchDisassociateProjectAssetsInput) SetClientToken 

func (s *BatchDisassociateProjectAssetsInput) SetClientToken(v string) *BatchDisassociateProjectAssetsInput

SetClientToken sets the ClientToken field's value.

func (*BatchDisassociateProjectAssetsInput) SetProjectId 

func (s *BatchDisassociateProjectAssetsInput) SetProjectId(v string) *BatchDisassociateProjectAssetsInput

SetProjectId sets the ProjectId field's value.

func (BatchDisassociateProjectAssetsInput) String 

func (s BatchDisassociateProjectAssetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDisassociateProjectAssetsInput) Validate 

func (s *BatchDisassociateProjectAssetsInput) Validate() error

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

type BatchDisassociateProjectAssetsOutput 

type BatchDisassociateProjectAssetsOutput struct {

	// A list of associated error information, if any.
	Errors []*AssetErrorDetails `locationName:"errors" type:"list"`
	// contains filtered or unexported fields
}

func (BatchDisassociateProjectAssetsOutput) GoString 

func (s BatchDisassociateProjectAssetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchDisassociateProjectAssetsOutput) SetErrors 

func (s *BatchDisassociateProjectAssetsOutput) SetErrors(v []*AssetErrorDetails) *BatchDisassociateProjectAssetsOutput

SetErrors sets the Errors field's value.

func (BatchDisassociateProjectAssetsOutput) String 

func (s BatchDisassociateProjectAssetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyAggregatesEntry added in v1.43.44 

type BatchGetAssetPropertyAggregatesEntry struct {

	// The data aggregating function.
	//
	// AggregateTypes is a required field
	AggregateTypes []*string `locationName:"aggregateTypes" min:"1" type:"list" required:"true" enum:"AggregateType"`

	// The ID of the asset in which the asset property was created.
	AssetId *string `locationName:"assetId" min:"36" type:"string"`

	// The inclusive end of the range from which to query historical data, expressed
	// in seconds in Unix epoch time.
	//
	// EndDate is a required field
	EndDate *time.Time `locationName:"endDate" type:"timestamp" required:"true"`

	// The ID of the entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
	// see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the IoT SiteWise User Guide.
	PropertyAlias *string `locationName:"propertyAlias" min:"1" type:"string"`

	// The ID of the asset property, in UUID format.
	PropertyId *string `locationName:"propertyId" min:"36" type:"string"`

	// The quality by which to filter asset data.
	Qualities []*string `locationName:"qualities" min:"1" type:"list" enum:"Quality"`

	// The time interval over which to aggregate data.
	//
	// Resolution is a required field
	Resolution *string `locationName:"resolution" min:"2" type:"string" required:"true"`

	// The exclusive start of the range from which to query historical data, expressed
	// in seconds in Unix epoch time.
	//
	// StartDate is a required field
	StartDate *time.Time `locationName:"startDate" type:"timestamp" required:"true"`

	// The chronological sorting order of the requested information.
	//
	// Default: ASCENDING
	TimeOrdering *string `locationName:"timeOrdering" type:"string" enum:"TimeOrdering"`
	// contains filtered or unexported fields
}

Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API.

To identify an asset property, you must specify one of the following:

func (BatchGetAssetPropertyAggregatesEntry) GoString added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyAggregatesEntry) SetAggregateTypes added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesEntry) SetAggregateTypes(v []*string) *BatchGetAssetPropertyAggregatesEntry

SetAggregateTypes sets the AggregateTypes field's value.

func (*BatchGetAssetPropertyAggregatesEntry) SetAssetId added in v1.43.44 

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

SetAssetId sets the AssetId field's value.

func (*BatchGetAssetPropertyAggregatesEntry) SetEndDate added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesEntry) SetEndDate(v time.Time) *BatchGetAssetPropertyAggregatesEntry

SetEndDate sets the EndDate field's value.

func (*BatchGetAssetPropertyAggregatesEntry) SetEntryId added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesEntry) SetEntryId(v string) *BatchGetAssetPropertyAggregatesEntry

SetEntryId sets the EntryId field's value.

func (*BatchGetAssetPropertyAggregatesEntry) SetPropertyAlias added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesEntry) SetPropertyAlias(v string) *BatchGetAssetPropertyAggregatesEntry

SetPropertyAlias sets the PropertyAlias field's value.

func (*BatchGetAssetPropertyAggregatesEntry) SetPropertyId added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesEntry) SetPropertyId(v string) *BatchGetAssetPropertyAggregatesEntry

SetPropertyId sets the PropertyId field's value.

func (*BatchGetAssetPropertyAggregatesEntry) SetQualities added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesEntry) SetQualities(v []*string) *BatchGetAssetPropertyAggregatesEntry

SetQualities sets the Qualities field's value.

func (*BatchGetAssetPropertyAggregatesEntry) SetResolution added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesEntry) SetResolution(v string) *BatchGetAssetPropertyAggregatesEntry

SetResolution sets the Resolution field's value.

func (*BatchGetAssetPropertyAggregatesEntry) SetStartDate added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesEntry) SetStartDate(v time.Time) *BatchGetAssetPropertyAggregatesEntry

SetStartDate sets the StartDate field's value.

func (*BatchGetAssetPropertyAggregatesEntry) SetTimeOrdering added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesEntry) SetTimeOrdering(v string) *BatchGetAssetPropertyAggregatesEntry

SetTimeOrdering sets the TimeOrdering field's value.

func (BatchGetAssetPropertyAggregatesEntry) String added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyAggregatesEntry) Validate added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesEntry) Validate() error

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

type BatchGetAssetPropertyAggregatesErrorEntry added in v1.43.44 

type BatchGetAssetPropertyAggregatesErrorEntry struct {

	// The ID of the entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`

	// The error code.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchGetAssetPropertyAggregatesErrorCode"`

	// The associated error message.
	//
	// ErrorMessage is a required field
	ErrorMessage *string `locationName:"errorMessage" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API.

func (BatchGetAssetPropertyAggregatesErrorEntry) GoString added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesErrorEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyAggregatesErrorEntry) SetEntryId added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesErrorEntry) SetEntryId(v string) *BatchGetAssetPropertyAggregatesErrorEntry

SetEntryId sets the EntryId field's value.

func (*BatchGetAssetPropertyAggregatesErrorEntry) SetErrorCode added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesErrorEntry) SetErrorCode(v string) *BatchGetAssetPropertyAggregatesErrorEntry

SetErrorCode sets the ErrorCode field's value.

func (*BatchGetAssetPropertyAggregatesErrorEntry) SetErrorMessage added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesErrorEntry) SetErrorMessage(v string) *BatchGetAssetPropertyAggregatesErrorEntry

SetErrorMessage sets the ErrorMessage field's value.

func (BatchGetAssetPropertyAggregatesErrorEntry) String added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesErrorEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyAggregatesErrorInfo added in v1.43.44 

type BatchGetAssetPropertyAggregatesErrorInfo struct {

	// The error code.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchGetAssetPropertyAggregatesErrorCode"`

	// The date the error occurred, in Unix epoch time.
	//
	// ErrorTimestamp is a required field
	ErrorTimestamp *time.Time `locationName:"errorTimestamp" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

Contains the error code and the timestamp for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API.

func (BatchGetAssetPropertyAggregatesErrorInfo) GoString added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesErrorInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyAggregatesErrorInfo) SetErrorCode added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesErrorInfo) SetErrorCode(v string) *BatchGetAssetPropertyAggregatesErrorInfo

SetErrorCode sets the ErrorCode field's value.

func (*BatchGetAssetPropertyAggregatesErrorInfo) SetErrorTimestamp added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesErrorInfo) SetErrorTimestamp(v time.Time) *BatchGetAssetPropertyAggregatesErrorInfo

SetErrorTimestamp sets the ErrorTimestamp field's value.

func (BatchGetAssetPropertyAggregatesErrorInfo) String added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesErrorInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyAggregatesInput added in v1.43.44 

type BatchGetAssetPropertyAggregatesInput struct {

	// The list of asset property aggregate entries for the batch get request. You
	// can specify up to 16 entries per request.
	//
	// Entries is a required field
	Entries []*BatchGetAssetPropertyAggregatesEntry `locationName:"entries" type:"list" required:"true"`

	// The maximum number of results to return for each paginated request. A result
	// set is returned in the two cases, whichever occurs first.
	//
	//    * The size of the result set is equal to 1 MB.
	//
	//    * The number of data points in the result set is equal to the value of
	//    maxResults. The maximum value of maxResults is 4000.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (BatchGetAssetPropertyAggregatesInput) GoString added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyAggregatesInput) SetEntries added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesInput) SetEntries(v []*BatchGetAssetPropertyAggregatesEntry) *BatchGetAssetPropertyAggregatesInput

SetEntries sets the Entries field's value.

func (*BatchGetAssetPropertyAggregatesInput) SetMaxResults added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesInput) SetMaxResults(v int64) *BatchGetAssetPropertyAggregatesInput

SetMaxResults sets the MaxResults field's value.

func (*BatchGetAssetPropertyAggregatesInput) SetNextToken added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesInput) SetNextToken(v string) *BatchGetAssetPropertyAggregatesInput

SetNextToken sets the NextToken field's value.

func (BatchGetAssetPropertyAggregatesInput) String added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyAggregatesInput) Validate added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesInput) Validate() error

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

type BatchGetAssetPropertyAggregatesOutput added in v1.43.44 

type BatchGetAssetPropertyAggregatesOutput struct {

	// A list of the errors (if any) associated with the batch request. Each error
	// entry contains the entryId of the entry that failed.
	//
	// ErrorEntries is a required field
	ErrorEntries []*BatchGetAssetPropertyAggregatesErrorEntry `locationName:"errorEntries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A list of entries that were not processed by this batch request. because
	// these entries had been completely processed by previous paginated requests.
	// Each skipped entry contains the entryId of the entry that skipped.
	//
	// SkippedEntries is a required field
	SkippedEntries []*BatchGetAssetPropertyAggregatesSkippedEntry `locationName:"skippedEntries" type:"list" required:"true"`

	// A list of entries that were processed successfully by this batch request.
	// Each success entry contains the entryId of the entry that succeeded and the
	// latest query result.
	//
	// SuccessEntries is a required field
	SuccessEntries []*BatchGetAssetPropertyAggregatesSuccessEntry `locationName:"successEntries" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetAssetPropertyAggregatesOutput) GoString added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyAggregatesOutput) SetErrorEntries added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesOutput) SetErrorEntries(v []*BatchGetAssetPropertyAggregatesErrorEntry) *BatchGetAssetPropertyAggregatesOutput

SetErrorEntries sets the ErrorEntries field's value.

func (*BatchGetAssetPropertyAggregatesOutput) SetNextToken added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesOutput) SetNextToken(v string) *BatchGetAssetPropertyAggregatesOutput

SetNextToken sets the NextToken field's value.

func (*BatchGetAssetPropertyAggregatesOutput) SetSkippedEntries added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesOutput) SetSkippedEntries(v []*BatchGetAssetPropertyAggregatesSkippedEntry) *BatchGetAssetPropertyAggregatesOutput

SetSkippedEntries sets the SkippedEntries field's value.

func (*BatchGetAssetPropertyAggregatesOutput) SetSuccessEntries added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesOutput) SetSuccessEntries(v []*BatchGetAssetPropertyAggregatesSuccessEntry) *BatchGetAssetPropertyAggregatesOutput

SetSuccessEntries sets the SuccessEntries field's value.

func (BatchGetAssetPropertyAggregatesOutput) String added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyAggregatesSkippedEntry added in v1.43.44 

type BatchGetAssetPropertyAggregatesSkippedEntry struct {

	// The completion status of each entry that is associated with the BatchGetAssetPropertyAggregates
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html)
	// API.
	//
	// CompletionStatus is a required field
	CompletionStatus *string `locationName:"completionStatus" type:"string" required:"true" enum:"BatchEntryCompletionStatus"`

	// The ID of the entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`

	// The error information, such as the error code and the timestamp.
	ErrorInfo *BatchGetAssetPropertyAggregatesErrorInfo `locationName:"errorInfo" type:"structure"`
	// contains filtered or unexported fields
}

Contains information for an entry that has been processed by the previous BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) request.

func (BatchGetAssetPropertyAggregatesSkippedEntry) GoString added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesSkippedEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyAggregatesSkippedEntry) SetCompletionStatus added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesSkippedEntry) SetCompletionStatus(v string) *BatchGetAssetPropertyAggregatesSkippedEntry

SetCompletionStatus sets the CompletionStatus field's value.

func (*BatchGetAssetPropertyAggregatesSkippedEntry) SetEntryId added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesSkippedEntry) SetEntryId(v string) *BatchGetAssetPropertyAggregatesSkippedEntry

SetEntryId sets the EntryId field's value.

func (*BatchGetAssetPropertyAggregatesSkippedEntry) SetErrorInfo added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesSkippedEntry) SetErrorInfo(v *BatchGetAssetPropertyAggregatesErrorInfo) *BatchGetAssetPropertyAggregatesSkippedEntry

SetErrorInfo sets the ErrorInfo field's value.

func (BatchGetAssetPropertyAggregatesSkippedEntry) String added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesSkippedEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyAggregatesSuccessEntry added in v1.43.44 

type BatchGetAssetPropertyAggregatesSuccessEntry struct {

	// The requested aggregated asset property values (for example, average, minimum,
	// and maximum).
	//
	// AggregatedValues is a required field
	AggregatedValues []*AggregatedValue `locationName:"aggregatedValues" type:"list" required:"true"`

	// The ID of the entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains success information for an entry that is associated with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html) API.

func (BatchGetAssetPropertyAggregatesSuccessEntry) GoString added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesSuccessEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyAggregatesSuccessEntry) SetAggregatedValues added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesSuccessEntry) SetAggregatedValues(v []*AggregatedValue) *BatchGetAssetPropertyAggregatesSuccessEntry

SetAggregatedValues sets the AggregatedValues field's value.

func (*BatchGetAssetPropertyAggregatesSuccessEntry) SetEntryId added in v1.43.44 

func (s *BatchGetAssetPropertyAggregatesSuccessEntry) SetEntryId(v string) *BatchGetAssetPropertyAggregatesSuccessEntry

SetEntryId sets the EntryId field's value.

func (BatchGetAssetPropertyAggregatesSuccessEntry) String added in v1.43.44 

func (s BatchGetAssetPropertyAggregatesSuccessEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyValueEntry added in v1.43.44 

type BatchGetAssetPropertyValueEntry struct {

	// The ID of the asset in which the asset property was created.
	AssetId *string `locationName:"assetId" min:"36" type:"string"`

	// The ID of the entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
	// see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the IoT SiteWise User Guide.
	PropertyAlias *string `locationName:"propertyAlias" min:"1" type:"string"`

	// The ID of the asset property, in UUID format.
	PropertyId *string `locationName:"propertyId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API.

To identify an asset property, you must specify one of the following:

func (BatchGetAssetPropertyValueEntry) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueEntry) SetAssetId added in v1.43.44 

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

SetAssetId sets the AssetId field's value.

func (*BatchGetAssetPropertyValueEntry) SetEntryId added in v1.43.44 

func (s *BatchGetAssetPropertyValueEntry) SetEntryId(v string) *BatchGetAssetPropertyValueEntry

SetEntryId sets the EntryId field's value.

func (*BatchGetAssetPropertyValueEntry) SetPropertyAlias added in v1.43.44 

func (s *BatchGetAssetPropertyValueEntry) SetPropertyAlias(v string) *BatchGetAssetPropertyValueEntry

SetPropertyAlias sets the PropertyAlias field's value.

func (*BatchGetAssetPropertyValueEntry) SetPropertyId added in v1.43.44 

func (s *BatchGetAssetPropertyValueEntry) SetPropertyId(v string) *BatchGetAssetPropertyValueEntry

SetPropertyId sets the PropertyId field's value.

func (BatchGetAssetPropertyValueEntry) String added in v1.43.44 

func (s BatchGetAssetPropertyValueEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueEntry) Validate added in v1.43.44 

func (s *BatchGetAssetPropertyValueEntry) Validate() error

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

type BatchGetAssetPropertyValueErrorEntry added in v1.43.44 

type BatchGetAssetPropertyValueErrorEntry struct {

	// The ID of the entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`

	// The error code.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchGetAssetPropertyValueErrorCode"`

	// The associated error message.
	//
	// ErrorMessage is a required field
	ErrorMessage *string `locationName:"errorMessage" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains error information for an asset property value entry that is associated with the BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API.

func (BatchGetAssetPropertyValueErrorEntry) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueErrorEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueErrorEntry) SetEntryId added in v1.43.44 

func (s *BatchGetAssetPropertyValueErrorEntry) SetEntryId(v string) *BatchGetAssetPropertyValueErrorEntry

SetEntryId sets the EntryId field's value.

func (*BatchGetAssetPropertyValueErrorEntry) SetErrorCode added in v1.43.44 

func (s *BatchGetAssetPropertyValueErrorEntry) SetErrorCode(v string) *BatchGetAssetPropertyValueErrorEntry

SetErrorCode sets the ErrorCode field's value.

func (*BatchGetAssetPropertyValueErrorEntry) SetErrorMessage added in v1.43.44 

func (s *BatchGetAssetPropertyValueErrorEntry) SetErrorMessage(v string) *BatchGetAssetPropertyValueErrorEntry

SetErrorMessage sets the ErrorMessage field's value.

func (BatchGetAssetPropertyValueErrorEntry) String added in v1.43.44 

func (s BatchGetAssetPropertyValueErrorEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyValueErrorInfo added in v1.43.44 

type BatchGetAssetPropertyValueErrorInfo struct {

	// The error code.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchGetAssetPropertyValueErrorCode"`

	// The date the error occurred, in Unix epoch time.
	//
	// ErrorTimestamp is a required field
	ErrorTimestamp *time.Time `locationName:"errorTimestamp" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

The error information, such as the error code and the timestamp.

func (BatchGetAssetPropertyValueErrorInfo) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueErrorInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueErrorInfo) SetErrorCode added in v1.43.44 

func (s *BatchGetAssetPropertyValueErrorInfo) SetErrorCode(v string) *BatchGetAssetPropertyValueErrorInfo

SetErrorCode sets the ErrorCode field's value.

func (*BatchGetAssetPropertyValueErrorInfo) SetErrorTimestamp added in v1.43.44 

func (s *BatchGetAssetPropertyValueErrorInfo) SetErrorTimestamp(v time.Time) *BatchGetAssetPropertyValueErrorInfo

SetErrorTimestamp sets the ErrorTimestamp field's value.

func (BatchGetAssetPropertyValueErrorInfo) String added in v1.43.44 

func (s BatchGetAssetPropertyValueErrorInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyValueHistoryEntry added in v1.43.44 

type BatchGetAssetPropertyValueHistoryEntry struct {

	// The ID of the asset in which the asset property was created.
	AssetId *string `locationName:"assetId" min:"36" type:"string"`

	// The inclusive end of the range from which to query historical data, expressed
	// in seconds in Unix epoch time.
	EndDate *time.Time `locationName:"endDate" type:"timestamp"`

	// The ID of the entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
	// see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the IoT SiteWise User Guide.
	PropertyAlias *string `locationName:"propertyAlias" min:"1" type:"string"`

	// The ID of the asset property, in UUID format.
	PropertyId *string `locationName:"propertyId" min:"36" type:"string"`

	// The quality by which to filter asset data.
	Qualities []*string `locationName:"qualities" min:"1" type:"list" enum:"Quality"`

	// The exclusive start of the range from which to query historical data, expressed
	// in seconds in Unix epoch time.
	StartDate *time.Time `locationName:"startDate" type:"timestamp"`

	// The chronological sorting order of the requested information.
	//
	// Default: ASCENDING
	TimeOrdering *string `locationName:"timeOrdering" type:"string" enum:"TimeOrdering"`
	// contains filtered or unexported fields
}

Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API.

To identify an asset property, you must specify one of the following:

func (BatchGetAssetPropertyValueHistoryEntry) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueHistoryEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueHistoryEntry) SetAssetId added in v1.43.44 

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

SetAssetId sets the AssetId field's value.

func (*BatchGetAssetPropertyValueHistoryEntry) SetEndDate added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryEntry) SetEndDate(v time.Time) *BatchGetAssetPropertyValueHistoryEntry

SetEndDate sets the EndDate field's value.

func (*BatchGetAssetPropertyValueHistoryEntry) SetEntryId added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryEntry) SetEntryId(v string) *BatchGetAssetPropertyValueHistoryEntry

SetEntryId sets the EntryId field's value.

func (*BatchGetAssetPropertyValueHistoryEntry) SetPropertyAlias added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryEntry) SetPropertyAlias(v string) *BatchGetAssetPropertyValueHistoryEntry

SetPropertyAlias sets the PropertyAlias field's value.

func (*BatchGetAssetPropertyValueHistoryEntry) SetPropertyId added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryEntry) SetPropertyId(v string) *BatchGetAssetPropertyValueHistoryEntry

SetPropertyId sets the PropertyId field's value.

func (*BatchGetAssetPropertyValueHistoryEntry) SetQualities added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryEntry) SetQualities(v []*string) *BatchGetAssetPropertyValueHistoryEntry

SetQualities sets the Qualities field's value.

func (*BatchGetAssetPropertyValueHistoryEntry) SetStartDate added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryEntry) SetStartDate(v time.Time) *BatchGetAssetPropertyValueHistoryEntry

SetStartDate sets the StartDate field's value.

func (*BatchGetAssetPropertyValueHistoryEntry) SetTimeOrdering added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryEntry) SetTimeOrdering(v string) *BatchGetAssetPropertyValueHistoryEntry

SetTimeOrdering sets the TimeOrdering field's value.

func (BatchGetAssetPropertyValueHistoryEntry) String added in v1.43.44 

func (s BatchGetAssetPropertyValueHistoryEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueHistoryEntry) Validate added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryEntry) Validate() error

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

type BatchGetAssetPropertyValueHistoryErrorEntry added in v1.43.44 

type BatchGetAssetPropertyValueHistoryErrorEntry struct {

	// The ID of the entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`

	// The error code.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchGetAssetPropertyValueHistoryErrorCode"`

	// The associated error message.
	//
	// ErrorMessage is a required field
	ErrorMessage *string `locationName:"errorMessage" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.

func (BatchGetAssetPropertyValueHistoryErrorEntry) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueHistoryErrorEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueHistoryErrorEntry) SetEntryId added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryErrorEntry) SetEntryId(v string) *BatchGetAssetPropertyValueHistoryErrorEntry

SetEntryId sets the EntryId field's value.

func (*BatchGetAssetPropertyValueHistoryErrorEntry) SetErrorCode added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryErrorEntry) SetErrorCode(v string) *BatchGetAssetPropertyValueHistoryErrorEntry

SetErrorCode sets the ErrorCode field's value.

func (*BatchGetAssetPropertyValueHistoryErrorEntry) SetErrorMessage added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryErrorEntry) SetErrorMessage(v string) *BatchGetAssetPropertyValueHistoryErrorEntry

SetErrorMessage sets the ErrorMessage field's value.

func (BatchGetAssetPropertyValueHistoryErrorEntry) String added in v1.43.44 

func (s BatchGetAssetPropertyValueHistoryErrorEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyValueHistoryErrorInfo added in v1.43.44 

type BatchGetAssetPropertyValueHistoryErrorInfo struct {

	// The error code.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchGetAssetPropertyValueHistoryErrorCode"`

	// The date the error occurred, in Unix epoch time.
	//
	// ErrorTimestamp is a required field
	ErrorTimestamp *time.Time `locationName:"errorTimestamp" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

The error information, such as the error code and the timestamp.

func (BatchGetAssetPropertyValueHistoryErrorInfo) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueHistoryErrorInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueHistoryErrorInfo) SetErrorCode added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryErrorInfo) SetErrorCode(v string) *BatchGetAssetPropertyValueHistoryErrorInfo

SetErrorCode sets the ErrorCode field's value.

func (*BatchGetAssetPropertyValueHistoryErrorInfo) SetErrorTimestamp added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryErrorInfo) SetErrorTimestamp(v time.Time) *BatchGetAssetPropertyValueHistoryErrorInfo

SetErrorTimestamp sets the ErrorTimestamp field's value.

func (BatchGetAssetPropertyValueHistoryErrorInfo) String added in v1.43.44 

func (s BatchGetAssetPropertyValueHistoryErrorInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyValueHistoryInput added in v1.43.44 

type BatchGetAssetPropertyValueHistoryInput struct {

	// The list of asset property historical value entries for the batch get request.
	// You can specify up to 16 entries per request.
	//
	// Entries is a required field
	Entries []*BatchGetAssetPropertyValueHistoryEntry `locationName:"entries" type:"list" required:"true"`

	// The maximum number of results to return for each paginated request. A result
	// set is returned in the two cases, whichever occurs first.
	//
	//    * The size of the result set is equal to 4 MB.
	//
	//    * The number of data points in the result set is equal to the value of
	//    maxResults. The maximum value of maxResults is 20000.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (BatchGetAssetPropertyValueHistoryInput) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueHistoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueHistoryInput) SetEntries added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryInput) SetEntries(v []*BatchGetAssetPropertyValueHistoryEntry) *BatchGetAssetPropertyValueHistoryInput

SetEntries sets the Entries field's value.

func (*BatchGetAssetPropertyValueHistoryInput) SetMaxResults added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryInput) SetMaxResults(v int64) *BatchGetAssetPropertyValueHistoryInput

SetMaxResults sets the MaxResults field's value.

func (*BatchGetAssetPropertyValueHistoryInput) SetNextToken added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryInput) SetNextToken(v string) *BatchGetAssetPropertyValueHistoryInput

SetNextToken sets the NextToken field's value.

func (BatchGetAssetPropertyValueHistoryInput) String added in v1.43.44 

func (s BatchGetAssetPropertyValueHistoryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueHistoryInput) Validate added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryInput) Validate() error

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

type BatchGetAssetPropertyValueHistoryOutput added in v1.43.44 

type BatchGetAssetPropertyValueHistoryOutput struct {

	// A list of the errors (if any) associated with the batch request. Each error
	// entry contains the entryId of the entry that failed.
	//
	// ErrorEntries is a required field
	ErrorEntries []*BatchGetAssetPropertyValueHistoryErrorEntry `locationName:"errorEntries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A list of entries that were not processed by this batch request. because
	// these entries had been completely processed by previous paginated requests.
	// Each skipped entry contains the entryId of the entry that skipped.
	//
	// SkippedEntries is a required field
	SkippedEntries []*BatchGetAssetPropertyValueHistorySkippedEntry `locationName:"skippedEntries" type:"list" required:"true"`

	// A list of entries that were processed successfully by this batch request.
	// Each success entry contains the entryId of the entry that succeeded and the
	// latest query result.
	//
	// SuccessEntries is a required field
	SuccessEntries []*BatchGetAssetPropertyValueHistorySuccessEntry `locationName:"successEntries" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetAssetPropertyValueHistoryOutput) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueHistoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueHistoryOutput) SetErrorEntries added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryOutput) SetErrorEntries(v []*BatchGetAssetPropertyValueHistoryErrorEntry) *BatchGetAssetPropertyValueHistoryOutput

SetErrorEntries sets the ErrorEntries field's value.

func (*BatchGetAssetPropertyValueHistoryOutput) SetNextToken added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryOutput) SetNextToken(v string) *BatchGetAssetPropertyValueHistoryOutput

SetNextToken sets the NextToken field's value.

func (*BatchGetAssetPropertyValueHistoryOutput) SetSkippedEntries added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryOutput) SetSkippedEntries(v []*BatchGetAssetPropertyValueHistorySkippedEntry) *BatchGetAssetPropertyValueHistoryOutput

SetSkippedEntries sets the SkippedEntries field's value.

func (*BatchGetAssetPropertyValueHistoryOutput) SetSuccessEntries added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistoryOutput) SetSuccessEntries(v []*BatchGetAssetPropertyValueHistorySuccessEntry) *BatchGetAssetPropertyValueHistoryOutput

SetSuccessEntries sets the SuccessEntries field's value.

func (BatchGetAssetPropertyValueHistoryOutput) String added in v1.43.44 

func (s BatchGetAssetPropertyValueHistoryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyValueHistorySkippedEntry added in v1.43.44 

type BatchGetAssetPropertyValueHistorySkippedEntry struct {

	// The completion status of each entry that is associated with the BatchGetAssetPropertyValueHistory
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html)
	// API.
	//
	// CompletionStatus is a required field
	CompletionStatus *string `locationName:"completionStatus" type:"string" required:"true" enum:"BatchEntryCompletionStatus"`

	// The ID of the entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`

	// The error information, such as the error code and the timestamp.
	ErrorInfo *BatchGetAssetPropertyValueHistoryErrorInfo `locationName:"errorInfo" type:"structure"`
	// contains filtered or unexported fields
}

Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) request.

func (BatchGetAssetPropertyValueHistorySkippedEntry) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueHistorySkippedEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueHistorySkippedEntry) SetCompletionStatus added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistorySkippedEntry) SetCompletionStatus(v string) *BatchGetAssetPropertyValueHistorySkippedEntry

SetCompletionStatus sets the CompletionStatus field's value.

func (*BatchGetAssetPropertyValueHistorySkippedEntry) SetEntryId added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistorySkippedEntry) SetEntryId(v string) *BatchGetAssetPropertyValueHistorySkippedEntry

SetEntryId sets the EntryId field's value.

func (*BatchGetAssetPropertyValueHistorySkippedEntry) SetErrorInfo added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistorySkippedEntry) SetErrorInfo(v *BatchGetAssetPropertyValueHistoryErrorInfo) *BatchGetAssetPropertyValueHistorySkippedEntry

SetErrorInfo sets the ErrorInfo field's value.

func (BatchGetAssetPropertyValueHistorySkippedEntry) String added in v1.43.44 

func (s BatchGetAssetPropertyValueHistorySkippedEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyValueHistorySuccessEntry added in v1.43.44 

type BatchGetAssetPropertyValueHistorySuccessEntry struct {

	// The requested historical values for the specified asset property.
	//
	// AssetPropertyValueHistory is a required field
	AssetPropertyValueHistory []*AssetPropertyValue `locationName:"assetPropertyValueHistory" type:"list" required:"true"`

	// The ID of the entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains success information for an entry that is associated with the BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API.

func (BatchGetAssetPropertyValueHistorySuccessEntry) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueHistorySuccessEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueHistorySuccessEntry) SetAssetPropertyValueHistory added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistorySuccessEntry) SetAssetPropertyValueHistory(v []*AssetPropertyValue) *BatchGetAssetPropertyValueHistorySuccessEntry

SetAssetPropertyValueHistory sets the AssetPropertyValueHistory field's value.

func (*BatchGetAssetPropertyValueHistorySuccessEntry) SetEntryId added in v1.43.44 

func (s *BatchGetAssetPropertyValueHistorySuccessEntry) SetEntryId(v string) *BatchGetAssetPropertyValueHistorySuccessEntry

SetEntryId sets the EntryId field's value.

func (BatchGetAssetPropertyValueHistorySuccessEntry) String added in v1.43.44 

func (s BatchGetAssetPropertyValueHistorySuccessEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyValueInput added in v1.43.44 

type BatchGetAssetPropertyValueInput struct {

	// The list of asset property value entries for the batch get request. You can
	// specify up to 128 entries per request.
	//
	// Entries is a required field
	Entries []*BatchGetAssetPropertyValueEntry `locationName:"entries" type:"list" required:"true"`

	// The token to be used for the next set of paginated results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (BatchGetAssetPropertyValueInput) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueInput) SetEntries added in v1.43.44 

func (s *BatchGetAssetPropertyValueInput) SetEntries(v []*BatchGetAssetPropertyValueEntry) *BatchGetAssetPropertyValueInput

SetEntries sets the Entries field's value.

func (*BatchGetAssetPropertyValueInput) SetNextToken added in v1.43.44 

func (s *BatchGetAssetPropertyValueInput) SetNextToken(v string) *BatchGetAssetPropertyValueInput

SetNextToken sets the NextToken field's value.

func (BatchGetAssetPropertyValueInput) String added in v1.43.44 

func (s BatchGetAssetPropertyValueInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueInput) Validate added in v1.43.44 

func (s *BatchGetAssetPropertyValueInput) Validate() error

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

type BatchGetAssetPropertyValueOutput added in v1.43.44 

type BatchGetAssetPropertyValueOutput struct {

	// A list of the errors (if any) associated with the batch request. Each error
	// entry contains the entryId of the entry that failed.
	//
	// ErrorEntries is a required field
	ErrorEntries []*BatchGetAssetPropertyValueErrorEntry `locationName:"errorEntries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A list of entries that were not processed by this batch request. because
	// these entries had been completely processed by previous paginated requests.
	// Each skipped entry contains the entryId of the entry that skipped.
	//
	// SkippedEntries is a required field
	SkippedEntries []*BatchGetAssetPropertyValueSkippedEntry `locationName:"skippedEntries" type:"list" required:"true"`

	// A list of entries that were processed successfully by this batch request.
	// Each success entry contains the entryId of the entry that succeeded and the
	// latest query result.
	//
	// SuccessEntries is a required field
	SuccessEntries []*BatchGetAssetPropertyValueSuccessEntry `locationName:"successEntries" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchGetAssetPropertyValueOutput) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueOutput) SetErrorEntries added in v1.43.44 

func (s *BatchGetAssetPropertyValueOutput) SetErrorEntries(v []*BatchGetAssetPropertyValueErrorEntry) *BatchGetAssetPropertyValueOutput

SetErrorEntries sets the ErrorEntries field's value.

func (*BatchGetAssetPropertyValueOutput) SetNextToken added in v1.43.44 

func (s *BatchGetAssetPropertyValueOutput) SetNextToken(v string) *BatchGetAssetPropertyValueOutput

SetNextToken sets the NextToken field's value.

func (*BatchGetAssetPropertyValueOutput) SetSkippedEntries added in v1.43.44 

func (s *BatchGetAssetPropertyValueOutput) SetSkippedEntries(v []*BatchGetAssetPropertyValueSkippedEntry) *BatchGetAssetPropertyValueOutput

SetSkippedEntries sets the SkippedEntries field's value.

func (*BatchGetAssetPropertyValueOutput) SetSuccessEntries added in v1.43.44 

func (s *BatchGetAssetPropertyValueOutput) SetSuccessEntries(v []*BatchGetAssetPropertyValueSuccessEntry) *BatchGetAssetPropertyValueOutput

SetSuccessEntries sets the SuccessEntries field's value.

func (BatchGetAssetPropertyValueOutput) String added in v1.43.44 

func (s BatchGetAssetPropertyValueOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyValueSkippedEntry added in v1.43.44 

type BatchGetAssetPropertyValueSkippedEntry struct {

	// The completion status of each entry that is associated with the BatchGetAssetPropertyValue
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html)
	// request.
	//
	// CompletionStatus is a required field
	CompletionStatus *string `locationName:"completionStatus" type:"string" required:"true" enum:"BatchEntryCompletionStatus"`

	// The ID of the entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`

	// The error information, such as the error code and the timestamp.
	ErrorInfo *BatchGetAssetPropertyValueErrorInfo `locationName:"errorInfo" type:"structure"`
	// contains filtered or unexported fields
}

Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) request.

func (BatchGetAssetPropertyValueSkippedEntry) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueSkippedEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueSkippedEntry) SetCompletionStatus added in v1.43.44 

func (s *BatchGetAssetPropertyValueSkippedEntry) SetCompletionStatus(v string) *BatchGetAssetPropertyValueSkippedEntry

SetCompletionStatus sets the CompletionStatus field's value.

func (*BatchGetAssetPropertyValueSkippedEntry) SetEntryId added in v1.43.44 

func (s *BatchGetAssetPropertyValueSkippedEntry) SetEntryId(v string) *BatchGetAssetPropertyValueSkippedEntry

SetEntryId sets the EntryId field's value.

func (*BatchGetAssetPropertyValueSkippedEntry) SetErrorInfo added in v1.43.44 

func (s *BatchGetAssetPropertyValueSkippedEntry) SetErrorInfo(v *BatchGetAssetPropertyValueErrorInfo) *BatchGetAssetPropertyValueSkippedEntry

SetErrorInfo sets the ErrorInfo field's value.

func (BatchGetAssetPropertyValueSkippedEntry) String added in v1.43.44 

func (s BatchGetAssetPropertyValueSkippedEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchGetAssetPropertyValueSuccessEntry added in v1.43.44 

type BatchGetAssetPropertyValueSuccessEntry struct {

	// Contains asset property value information.
	AssetPropertyValue *AssetPropertyValue `locationName:"assetPropertyValue" type:"structure"`

	// The ID of the entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains success information for an entry that is associated with the BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html) API.

func (BatchGetAssetPropertyValueSuccessEntry) GoString added in v1.43.44 

func (s BatchGetAssetPropertyValueSuccessEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchGetAssetPropertyValueSuccessEntry) SetAssetPropertyValue added in v1.43.44 

func (s *BatchGetAssetPropertyValueSuccessEntry) SetAssetPropertyValue(v *AssetPropertyValue) *BatchGetAssetPropertyValueSuccessEntry

SetAssetPropertyValue sets the AssetPropertyValue field's value.

func (*BatchGetAssetPropertyValueSuccessEntry) SetEntryId added in v1.43.44 

func (s *BatchGetAssetPropertyValueSuccessEntry) SetEntryId(v string) *BatchGetAssetPropertyValueSuccessEntry

SetEntryId sets the EntryId field's value.

func (BatchGetAssetPropertyValueSuccessEntry) String added in v1.43.44 

func (s BatchGetAssetPropertyValueSuccessEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchPutAssetPropertyError 

type BatchPutAssetPropertyError struct {

	// The error code.
	//
	// ErrorCode is a required field
	ErrorCode *string `locationName:"errorCode" type:"string" required:"true" enum:"BatchPutAssetPropertyValueErrorCode"`

	// The associated error message.
	//
	// ErrorMessage is a required field
	ErrorMessage *string `locationName:"errorMessage" type:"string" required:"true"`

	// A list of timestamps for each error, if any.
	//
	// Timestamps is a required field
	Timestamps []*TimeInNanos `locationName:"timestamps" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains error information from updating a batch of asset property values.

func (BatchPutAssetPropertyError) GoString 

func (s BatchPutAssetPropertyError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutAssetPropertyError) SetErrorCode 

func (s *BatchPutAssetPropertyError) SetErrorCode(v string) *BatchPutAssetPropertyError

SetErrorCode sets the ErrorCode field's value.

func (*BatchPutAssetPropertyError) SetErrorMessage 

func (s *BatchPutAssetPropertyError) SetErrorMessage(v string) *BatchPutAssetPropertyError

SetErrorMessage sets the ErrorMessage field's value.

func (*BatchPutAssetPropertyError) SetTimestamps 

func (s *BatchPutAssetPropertyError) SetTimestamps(v []*TimeInNanos) *BatchPutAssetPropertyError

SetTimestamps sets the Timestamps field's value.

func (BatchPutAssetPropertyError) String 

func (s BatchPutAssetPropertyError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchPutAssetPropertyErrorEntry 

type BatchPutAssetPropertyErrorEntry struct {

	// The ID of the failed entry.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`

	// The list of update property value errors.
	//
	// Errors is a required field
	Errors []*BatchPutAssetPropertyError `locationName:"errors" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains error information for asset property value entries that are associated with the BatchPutAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) API.

func (BatchPutAssetPropertyErrorEntry) GoString 

func (s BatchPutAssetPropertyErrorEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutAssetPropertyErrorEntry) SetEntryId 

func (s *BatchPutAssetPropertyErrorEntry) SetEntryId(v string) *BatchPutAssetPropertyErrorEntry

SetEntryId sets the EntryId field's value.

func (*BatchPutAssetPropertyErrorEntry) SetErrors 

func (s *BatchPutAssetPropertyErrorEntry) SetErrors(v []*BatchPutAssetPropertyError) *BatchPutAssetPropertyErrorEntry

SetErrors sets the Errors field's value.

func (BatchPutAssetPropertyErrorEntry) String 

func (s BatchPutAssetPropertyErrorEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BatchPutAssetPropertyValueInput 

type BatchPutAssetPropertyValueInput struct {

	// The list of asset property value entries for the batch put request. You can
	// specify up to 10 entries per request.
	//
	// Entries is a required field
	Entries []*PutAssetPropertyValueEntry `locationName:"entries" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchPutAssetPropertyValueInput) GoString 

func (s BatchPutAssetPropertyValueInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutAssetPropertyValueInput) SetEntries 

func (s *BatchPutAssetPropertyValueInput) SetEntries(v []*PutAssetPropertyValueEntry) *BatchPutAssetPropertyValueInput

SetEntries sets the Entries field's value.

func (BatchPutAssetPropertyValueInput) String 

func (s BatchPutAssetPropertyValueInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutAssetPropertyValueInput) Validate 

func (s *BatchPutAssetPropertyValueInput) Validate() error

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

type BatchPutAssetPropertyValueOutput 

type BatchPutAssetPropertyValueOutput struct {

	// A list of the errors (if any) associated with the batch put request. Each
	// error entry contains the entryId of the entry that failed.
	//
	// ErrorEntries is a required field
	ErrorEntries []*BatchPutAssetPropertyErrorEntry `locationName:"errorEntries" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchPutAssetPropertyValueOutput) GoString 

func (s BatchPutAssetPropertyValueOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BatchPutAssetPropertyValueOutput) SetErrorEntries 

func (s *BatchPutAssetPropertyValueOutput) SetErrorEntries(v []*BatchPutAssetPropertyErrorEntry) *BatchPutAssetPropertyValueOutput

SetErrorEntries sets the ErrorEntries field's value.

func (BatchPutAssetPropertyValueOutput) String 

func (s BatchPutAssetPropertyValueOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ColumnInfo added in v1.48.2 

type ColumnInfo struct {

	// The name of the column description.
	Name *string `locationName:"name" type:"string"`

	// The type of the column description.
	Type *ColumnType `locationName:"type" type:"structure"`
	// contains filtered or unexported fields
}

A description of the column in the query results.

func (ColumnInfo) GoString added in v1.48.2 

func (s ColumnInfo) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColumnInfo) SetName added in v1.48.2 

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

SetName sets the Name field's value.

func (*ColumnInfo) SetType added in v1.48.2 

func (s *ColumnInfo) SetType(v *ColumnType) *ColumnInfo

SetType sets the Type field's value.

func (ColumnInfo) String added in v1.48.2 

func (s ColumnInfo) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ColumnType added in v1.48.2 

type ColumnType struct {

	// The allowed data types that the column has as it's value.
	ScalarType *string `locationName:"scalarType" type:"string" enum:"ScalarType"`
	// contains filtered or unexported fields
}

The data type of the column.

func (ColumnType) GoString added in v1.48.2 

func (s ColumnType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColumnType) SetScalarType added in v1.48.2 

func (s *ColumnType) SetScalarType(v string) *ColumnType

SetScalarType sets the ScalarType field's value.

func (ColumnType) String added in v1.48.2 

func (s ColumnType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CompositeModelProperty added in v1.36.7 

type CompositeModelProperty struct {

	// Contains asset property information.
	//
	// AssetProperty is a required field
	AssetProperty *Property `locationName:"assetProperty" type:"structure" required:"true"`

	// The external ID of the composite model that contains the property. For more
	// information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID of the composite model that contains the property.
	Id *string `locationName:"id" min:"36" type:"string"`

	// The name of the property.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The type of the composite model that defines this property.
	//
	// 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 property on an asset.

func (CompositeModelProperty) GoString added in v1.36.7 

func (s CompositeModelProperty) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompositeModelProperty) SetAssetProperty added in v1.36.7 

func (s *CompositeModelProperty) SetAssetProperty(v *Property) *CompositeModelProperty

SetAssetProperty sets the AssetProperty field's value.

func (*CompositeModelProperty) SetExternalId added in v1.48.2 

func (s *CompositeModelProperty) SetExternalId(v string) *CompositeModelProperty

SetExternalId sets the ExternalId field's value.

func (*CompositeModelProperty) SetId added in v1.44.129 

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

SetId sets the Id field's value.

func (*CompositeModelProperty) SetName added in v1.36.7 

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

SetName sets the Name field's value.

func (*CompositeModelProperty) SetType added in v1.36.7 

func (s *CompositeModelProperty) SetType(v string) *CompositeModelProperty

SetType sets the Type field's value.

func (CompositeModelProperty) String added in v1.36.7 

func (s CompositeModelProperty) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CompositionDetails added in v1.48.2 

type CompositionDetails struct {

	// An array detailing the composition relationship for this composite model.
	CompositionRelationship []*CompositionRelationshipItem `locationName:"compositionRelationship" type:"list"`
	// contains filtered or unexported fields
}

Metadata for the composition relationship established by using composedAssetModelId in CreateAssetModelCompositeModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html).

func (CompositionDetails) GoString added in v1.48.2 

func (s CompositionDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompositionDetails) SetCompositionRelationship added in v1.48.2 

func (s *CompositionDetails) SetCompositionRelationship(v []*CompositionRelationshipItem) *CompositionDetails

SetCompositionRelationship sets the CompositionRelationship field's value.

func (CompositionDetails) String added in v1.48.2 

func (s CompositionDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CompositionRelationshipItem added in v1.48.2 

type CompositionRelationshipItem struct {

	// The ID of the component.
	Id *string `locationName:"id" min:"36" type:"string"`
	// contains filtered or unexported fields
}

Represents a composite model that composed an asset model of type COMPONENT_MODEL.

func (CompositionRelationshipItem) GoString added in v1.48.2 

func (s CompositionRelationshipItem) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompositionRelationshipItem) SetId added in v1.48.2 

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

SetId sets the Id field's value.

func (CompositionRelationshipItem) String added in v1.48.2 

func (s CompositionRelationshipItem) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CompositionRelationshipSummary added in v1.48.2 

type CompositionRelationshipSummary struct {

	// The ID of a composite model on this asset model.
	//
	// AssetModelCompositeModelId is a required field
	AssetModelCompositeModelId *string `locationName:"assetModelCompositeModelId" min:"36" type:"string" required:"true"`

	// The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
	//
	// AssetModelCompositeModelType is a required field
	AssetModelCompositeModelType *string `locationName:"assetModelCompositeModelType" min:"1" type:"string" required:"true"`

	// The ID of the asset model, in UUID format.
	//
	// AssetModelId is a required field
	AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains a summary of the components of the composite model.

func (CompositionRelationshipSummary) GoString added in v1.48.2 

func (s CompositionRelationshipSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CompositionRelationshipSummary) SetAssetModelCompositeModelId added in v1.48.2 

func (s *CompositionRelationshipSummary) SetAssetModelCompositeModelId(v string) *CompositionRelationshipSummary

SetAssetModelCompositeModelId sets the AssetModelCompositeModelId field's value.

func (*CompositionRelationshipSummary) SetAssetModelCompositeModelType added in v1.48.2 

func (s *CompositionRelationshipSummary) SetAssetModelCompositeModelType(v string) *CompositionRelationshipSummary

SetAssetModelCompositeModelType sets the AssetModelCompositeModelType field's value.

func (*CompositionRelationshipSummary) SetAssetModelId added in v1.48.2 

func (s *CompositionRelationshipSummary) SetAssetModelId(v string) *CompositionRelationshipSummary

SetAssetModelId sets the AssetModelId field's value.

func (CompositionRelationshipSummary) String added in v1.48.2 

func (s CompositionRelationshipSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConfigurationErrorDetails added in v1.35.35 

type ConfigurationErrorDetails struct {

	// The error code.
	//
	// Code is a required field
	Code *string `locationName:"code" type:"string" required:"true" enum:"ErrorCode"`

	// The error message.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the details of an IoT SiteWise configuration error.

func (ConfigurationErrorDetails) GoString added in v1.35.35 

func (s ConfigurationErrorDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfigurationErrorDetails) SetCode added in v1.35.35 

func (s *ConfigurationErrorDetails) SetCode(v string) *ConfigurationErrorDetails

SetCode sets the Code field's value.

func (*ConfigurationErrorDetails) SetMessage added in v1.35.35 

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

SetMessage sets the Message field's value.

func (ConfigurationErrorDetails) String added in v1.35.35 

func (s ConfigurationErrorDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConfigurationStatus added in v1.35.35 

type ConfigurationStatus struct {

	// Contains associated error information, if any.
	Error *ConfigurationErrorDetails `locationName:"error" type:"structure"`

	// The current state of the configuration.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"ConfigurationState"`
	// contains filtered or unexported fields
}

Contains current status information for the configuration.

func (ConfigurationStatus) GoString added in v1.35.35 

func (s ConfigurationStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConfigurationStatus) SetError added in v1.35.35 

func (s *ConfigurationStatus) SetError(v *ConfigurationErrorDetails) *ConfigurationStatus

SetError sets the Error field's value.

func (*ConfigurationStatus) SetState added in v1.35.35 

func (s *ConfigurationStatus) SetState(v string) *ConfigurationStatus

SetState sets the State field's value.

func (ConfigurationStatus) String added in v1.35.35 

func (s ConfigurationStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictingOperationException 

type ConflictingOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The ARN of the resource that conflicts with this operation.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"`

	// The ID of the resource that conflicts with this operation.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (*ConflictingOperationException) Code 

func (s *ConflictingOperationException) Code() string

Code returns the exception type name.

func (*ConflictingOperationException) Error 

func (s *ConflictingOperationException) Error() string

func (ConflictingOperationException) GoString 

func (s ConflictingOperationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictingOperationException) Message 

func (s *ConflictingOperationException) Message() string

Message returns the exception's message.

func (*ConflictingOperationException) OrigErr 

func (s *ConflictingOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictingOperationException) RequestID 

func (s *ConflictingOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictingOperationException) StatusCode 

func (s *ConflictingOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictingOperationException) String 

func (s ConflictingOperationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAccessPolicyInput 

type CreateAccessPolicyInput struct {

	// The identity for this access policy. Choose an IAM Identity Center user,
	// an IAM Identity Center group, or an IAM user.
	//
	// AccessPolicyIdentity is a required field
	AccessPolicyIdentity *Identity `locationName:"accessPolicyIdentity" type:"structure" required:"true"`

	// The permission level for this access policy. Note that a project ADMINISTRATOR
	// is also known as a project owner.
	//
	// AccessPolicyPermission is a required field
	AccessPolicyPermission *string `locationName:"accessPolicyPermission" type:"string" required:"true" enum:"Permission"`

	// The IoT SiteWise Monitor resource for this access policy. Choose either a
	// portal or a project.
	//
	// AccessPolicyResource is a required field
	AccessPolicyResource *Resource `locationName:"accessPolicyResource" type:"structure" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// A list of key-value pairs that contain metadata for the access policy. For
	// more information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the IoT SiteWise User Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateAccessPolicyInput) GoString 

func (s CreateAccessPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessPolicyInput) SetAccessPolicyIdentity 

func (s *CreateAccessPolicyInput) SetAccessPolicyIdentity(v *Identity) *CreateAccessPolicyInput

SetAccessPolicyIdentity sets the AccessPolicyIdentity field's value.

func (*CreateAccessPolicyInput) SetAccessPolicyPermission 

func (s *CreateAccessPolicyInput) SetAccessPolicyPermission(v string) *CreateAccessPolicyInput

SetAccessPolicyPermission sets the AccessPolicyPermission field's value.

func (*CreateAccessPolicyInput) SetAccessPolicyResource 

func (s *CreateAccessPolicyInput) SetAccessPolicyResource(v *Resource) *CreateAccessPolicyInput

SetAccessPolicyResource sets the AccessPolicyResource field's value.

func (*CreateAccessPolicyInput) SetClientToken 

func (s *CreateAccessPolicyInput) SetClientToken(v string) *CreateAccessPolicyInput

SetClientToken sets the ClientToken field's value.

func (*CreateAccessPolicyInput) SetTags 

func (s *CreateAccessPolicyInput) SetTags(v map[string]*string) *CreateAccessPolicyInput

SetTags sets the Tags field's value.

func (CreateAccessPolicyInput) String 

func (s CreateAccessPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessPolicyInput) Validate 

func (s *CreateAccessPolicyInput) Validate() error

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

type CreateAccessPolicyOutput 

type CreateAccessPolicyOutput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the access policy, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
	//
	// AccessPolicyArn is a required field
	AccessPolicyArn *string `locationName:"accessPolicyArn" min:"1" type:"string" required:"true"`

	// The ID of the access policy.
	//
	// AccessPolicyId is a required field
	AccessPolicyId *string `locationName:"accessPolicyId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAccessPolicyOutput) GoString 

func (s CreateAccessPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAccessPolicyOutput) SetAccessPolicyArn 

func (s *CreateAccessPolicyOutput) SetAccessPolicyArn(v string) *CreateAccessPolicyOutput

SetAccessPolicyArn sets the AccessPolicyArn field's value.

func (*CreateAccessPolicyOutput) SetAccessPolicyId 

func (s *CreateAccessPolicyOutput) SetAccessPolicyId(v string) *CreateAccessPolicyOutput

SetAccessPolicyId sets the AccessPolicyId field's value.

func (CreateAccessPolicyOutput) String 

func (s CreateAccessPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAssetInput 

type CreateAssetInput struct {

	// A description for the asset.
	AssetDescription *string `locationName:"assetDescription" min:"1" type:"string"`

	// An external ID to assign to the asset. The external ID must be unique within
	// your Amazon Web Services account. For more information, see Using external
	// IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	AssetExternalId *string `locationName:"assetExternalId" min:"2" type:"string"`

	// The ID to assign to the asset, if desired. IoT SiteWise automatically generates
	// a unique ID for you, so this parameter is never required. However, if you
	// prefer to supply your own ID instead, you can specify it here in UUID format.
	// If you specify your own ID, it must be globally unique.
	AssetId *string `locationName:"assetId" min:"36" type:"string"`

	// The ID of the asset model from which to create the asset. This can be either
	// the actual ID in UUID format, or else externalId: followed by the external
	// ID, if it has one. For more information, see Referencing objects with external
	// IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetModelId is a required field
	AssetModelId *string `locationName:"assetModelId" min:"13" type:"string" required:"true"`

	// A friendly name for the asset.
	//
	// AssetName is a required field
	AssetName *string `locationName:"assetName" min:"1" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// A list of key-value pairs that contain metadata for the asset. For more information,
	// see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the IoT SiteWise User Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateAssetInput) GoString 

func (s CreateAssetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssetInput) SetAssetDescription added in v1.44.25 

func (s *CreateAssetInput) SetAssetDescription(v string) *CreateAssetInput

SetAssetDescription sets the AssetDescription field's value.

func (*CreateAssetInput) SetAssetExternalId added in v1.48.2 

func (s *CreateAssetInput) SetAssetExternalId(v string) *CreateAssetInput

SetAssetExternalId sets the AssetExternalId field's value.

func (*CreateAssetInput) SetAssetId added in v1.48.2 

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

SetAssetId sets the AssetId field's value.

func (*CreateAssetInput) SetAssetModelId 

func (s *CreateAssetInput) SetAssetModelId(v string) *CreateAssetInput

SetAssetModelId sets the AssetModelId field's value.

func (*CreateAssetInput) SetAssetName 

func (s *CreateAssetInput) SetAssetName(v string) *CreateAssetInput

SetAssetName sets the AssetName field's value.

func (*CreateAssetInput) SetClientToken 

func (s *CreateAssetInput) SetClientToken(v string) *CreateAssetInput

SetClientToken sets the ClientToken field's value.

func (*CreateAssetInput) SetTags 

func (s *CreateAssetInput) SetTags(v map[string]*string) *CreateAssetInput

SetTags sets the Tags field's value.

func (CreateAssetInput) String 

func (s CreateAssetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssetInput) Validate 

func (s *CreateAssetInput) Validate() error

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

type CreateAssetModelCompositeModelInput added in v1.48.2 

type CreateAssetModelCompositeModelInput struct {

	// A description for the composite model.
	AssetModelCompositeModelDescription *string `locationName:"assetModelCompositeModelDescription" min:"1" type:"string"`

	// An external ID to assign to the composite model.
	//
	// If the composite model is a derived composite model, or one nested inside
	// a component model, you can only set the external ID using UpdateAssetModelCompositeModel
	// and specifying the derived ID of the model or property from the created model
	// it's a part of.
	AssetModelCompositeModelExternalId *string `locationName:"assetModelCompositeModelExternalId" min:"2" type:"string"`

	// The ID of the composite model. IoT SiteWise automatically generates a unique
	// ID for you, so this parameter is never required. However, if you prefer to
	// supply your own ID instead, you can specify it here in UUID format. If you
	// specify your own ID, it must be globally unique.
	AssetModelCompositeModelId *string `locationName:"assetModelCompositeModelId" min:"36" type:"string"`

	// A unique, friendly name for the composite model.
	//
	// AssetModelCompositeModelName is a required field
	AssetModelCompositeModelName *string `locationName:"assetModelCompositeModelName" min:"1" type:"string" required:"true"`

	// The property definitions of the composite model. For more information, see
	// <LINK>.
	//
	// You can specify up to 200 properties per composite model. For more information,
	// see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
	// in the IoT SiteWise User Guide.
	AssetModelCompositeModelProperties []*AssetModelPropertyDefinition `locationName:"assetModelCompositeModelProperties" type:"list"`

	// The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
	//
	// AssetModelCompositeModelType is a required field
	AssetModelCompositeModelType *string `locationName:"assetModelCompositeModelType" min:"1" type:"string" required:"true"`

	// The ID of the asset model this composite model is a part of.
	//
	// AssetModelId is a required field
	AssetModelId *string `location:"uri" locationName:"assetModelId" min:"13" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The ID of a composite model on this asset.
	ComposedAssetModelId *string `locationName:"composedAssetModelId" min:"13" type:"string"`

	// The ID of the parent composite model in this asset model relationship.
	ParentAssetModelCompositeModelId *string `locationName:"parentAssetModelCompositeModelId" min:"13" type:"string"`
	// contains filtered or unexported fields
}

func (CreateAssetModelCompositeModelInput) GoString added in v1.48.2 

func (s CreateAssetModelCompositeModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssetModelCompositeModelInput) SetAssetModelCompositeModelDescription added in v1.48.2 

func (s *CreateAssetModelCompositeModelInput) SetAssetModelCompositeModelDescription(v string) *CreateAssetModelCompositeModelInput

SetAssetModelCompositeModelDescription sets the AssetModelCompositeModelDescription field's value.

func (*CreateAssetModelCompositeModelInput) SetAssetModelCompositeModelExternalId added in v1.48.2 

func (s *CreateAssetModelCompositeModelInput) SetAssetModelCompositeModelExternalId(v string) *CreateAssetModelCompositeModelInput

SetAssetModelCompositeModelExternalId sets the AssetModelCompositeModelExternalId field's value.

func (*CreateAssetModelCompositeModelInput) SetAssetModelCompositeModelId added in v1.48.2 

func (s *CreateAssetModelCompositeModelInput) SetAssetModelCompositeModelId(v string) *CreateAssetModelCompositeModelInput

SetAssetModelCompositeModelId sets the AssetModelCompositeModelId field's value.

func (*CreateAssetModelCompositeModelInput) SetAssetModelCompositeModelName added in v1.48.2 

func (s *CreateAssetModelCompositeModelInput) SetAssetModelCompositeModelName(v string) *CreateAssetModelCompositeModelInput

SetAssetModelCompositeModelName sets the AssetModelCompositeModelName field's value.

func (*CreateAssetModelCompositeModelInput) SetAssetModelCompositeModelProperties added in v1.48.2 

func (s *CreateAssetModelCompositeModelInput) SetAssetModelCompositeModelProperties(v []*AssetModelPropertyDefinition) *CreateAssetModelCompositeModelInput

SetAssetModelCompositeModelProperties sets the AssetModelCompositeModelProperties field's value.

func (*CreateAssetModelCompositeModelInput) SetAssetModelCompositeModelType added in v1.48.2 

func (s *CreateAssetModelCompositeModelInput) SetAssetModelCompositeModelType(v string) *CreateAssetModelCompositeModelInput

SetAssetModelCompositeModelType sets the AssetModelCompositeModelType field's value.

func (*CreateAssetModelCompositeModelInput) SetAssetModelId added in v1.48.2 

func (s *CreateAssetModelCompositeModelInput) SetAssetModelId(v string) *CreateAssetModelCompositeModelInput

SetAssetModelId sets the AssetModelId field's value.

func (*CreateAssetModelCompositeModelInput) SetClientToken added in v1.48.2 

func (s *CreateAssetModelCompositeModelInput) SetClientToken(v string) *CreateAssetModelCompositeModelInput

SetClientToken sets the ClientToken field's value.

func (*CreateAssetModelCompositeModelInput) SetComposedAssetModelId added in v1.48.2 

func (s *CreateAssetModelCompositeModelInput) SetComposedAssetModelId(v string) *CreateAssetModelCompositeModelInput

SetComposedAssetModelId sets the ComposedAssetModelId field's value.

func (*CreateAssetModelCompositeModelInput) SetParentAssetModelCompositeModelId added in v1.48.2 

func (s *CreateAssetModelCompositeModelInput) SetParentAssetModelCompositeModelId(v string) *CreateAssetModelCompositeModelInput

SetParentAssetModelCompositeModelId sets the ParentAssetModelCompositeModelId field's value.

func (CreateAssetModelCompositeModelInput) String added in v1.48.2 

func (s CreateAssetModelCompositeModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssetModelCompositeModelInput) Validate added in v1.48.2 

func (s *CreateAssetModelCompositeModelInput) Validate() error

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

type CreateAssetModelCompositeModelOutput added in v1.48.2 

type CreateAssetModelCompositeModelOutput struct {

	// The ID of the composed asset model. You can use this ID when you call other
	// IoT SiteWise APIs.
	//
	// AssetModelCompositeModelId is a required field
	AssetModelCompositeModelId *string `locationName:"assetModelCompositeModelId" min:"36" type:"string" required:"true"`

	// The path to the composite model listing the parent composite models.
	//
	// AssetModelCompositeModelPath is a required field
	AssetModelCompositeModelPath []*AssetModelCompositeModelPathSegment `locationName:"assetModelCompositeModelPath" type:"list" required:"true"`

	// Contains current status information for an asset model. For more information,
	// see Asset and model states (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html)
	// in the IoT SiteWise User Guide.
	//
	// AssetModelStatus is a required field
	AssetModelStatus *AssetModelStatus `locationName:"assetModelStatus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAssetModelCompositeModelOutput) GoString added in v1.48.2 

func (s CreateAssetModelCompositeModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssetModelCompositeModelOutput) SetAssetModelCompositeModelId added in v1.48.2 

func (s *CreateAssetModelCompositeModelOutput) SetAssetModelCompositeModelId(v string) *CreateAssetModelCompositeModelOutput

SetAssetModelCompositeModelId sets the AssetModelCompositeModelId field's value.

func (*CreateAssetModelCompositeModelOutput) SetAssetModelCompositeModelPath added in v1.48.2 

func (s *CreateAssetModelCompositeModelOutput) SetAssetModelCompositeModelPath(v []*AssetModelCompositeModelPathSegment) *CreateAssetModelCompositeModelOutput

SetAssetModelCompositeModelPath sets the AssetModelCompositeModelPath field's value.

func (*CreateAssetModelCompositeModelOutput) SetAssetModelStatus added in v1.48.2 

func (s *CreateAssetModelCompositeModelOutput) SetAssetModelStatus(v *AssetModelStatus) *CreateAssetModelCompositeModelOutput

SetAssetModelStatus sets the AssetModelStatus field's value.

func (CreateAssetModelCompositeModelOutput) String added in v1.48.2 

func (s CreateAssetModelCompositeModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAssetModelInput 

type CreateAssetModelInput struct {

	// The composite models that are part of this asset model. It groups properties
	// (such as attributes, measurements, transforms, and metrics) and child composite
	// models that model parts of your industrial equipment. Each composite model
	// has a type that defines the properties that the composite model supports.
	// Use composite models to define alarms on this asset model.
	//
	// When creating custom composite models, you need to use CreateAssetModelCompositeModel
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html).
	// For more information, see <LINK>.
	AssetModelCompositeModels []*AssetModelCompositeModelDefinition `locationName:"assetModelCompositeModels" type:"list"`

	// A description for the asset model.
	AssetModelDescription *string `locationName:"assetModelDescription" min:"1" type:"string"`

	// An external ID to assign to the asset model. The external ID must be unique
	// within your Amazon Web Services account. For more information, see Using
	// external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	AssetModelExternalId *string `locationName:"assetModelExternalId" min:"2" type:"string"`

	// The hierarchy definitions of the asset model. Each hierarchy specifies an
	// asset model whose assets can be children of any other assets created from
	// this asset model. For more information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html)
	// in the IoT SiteWise User Guide.
	//
	// You can specify up to 10 hierarchies per asset model. For more information,
	// see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
	// in the IoT SiteWise User Guide.
	AssetModelHierarchies []*AssetModelHierarchyDefinition `locationName:"assetModelHierarchies" type:"list"`

	// The ID to assign to the asset model, if desired. IoT SiteWise automatically
	// generates a unique ID for you, so this parameter is never required. However,
	// if you prefer to supply your own ID instead, you can specify it here in UUID
	// format. If you specify your own ID, it must be globally unique.
	AssetModelId *string `locationName:"assetModelId" min:"36" type:"string"`

	// A unique, friendly name for the asset model.
	//
	// AssetModelName is a required field
	AssetModelName *string `locationName:"assetModelName" min:"1" type:"string" required:"true"`

	// The property definitions of the asset model. For more information, see Asset
	// properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html)
	// in the IoT SiteWise User Guide.
	//
	// You can specify up to 200 properties per asset model. For more information,
	// see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
	// in the IoT SiteWise User Guide.
	AssetModelProperties []*AssetModelPropertyDefinition `locationName:"assetModelProperties" type:"list"`

	// The type of asset model.
	//
	//    * ASSET_MODEL – (default) An asset model that you can use to create
	//    assets. Can't be included as a component in another asset model.
	//
	//    * COMPONENT_MODEL – A reusable component that you can include in the
	//    composite models of other asset models. You can't create assets directly
	//    from this type of asset model.
	AssetModelType *string `locationName:"assetModelType" type:"string" enum:"AssetModelType"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// A list of key-value pairs that contain metadata for the asset model. For
	// more information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the IoT SiteWise User Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateAssetModelInput) GoString 

func (s CreateAssetModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssetModelInput) SetAssetModelCompositeModels added in v1.36.7 

func (s *CreateAssetModelInput) SetAssetModelCompositeModels(v []*AssetModelCompositeModelDefinition) *CreateAssetModelInput

SetAssetModelCompositeModels sets the AssetModelCompositeModels field's value.

func (*CreateAssetModelInput) SetAssetModelDescription 

func (s *CreateAssetModelInput) SetAssetModelDescription(v string) *CreateAssetModelInput

SetAssetModelDescription sets the AssetModelDescription field's value.

func (*CreateAssetModelInput) SetAssetModelExternalId added in v1.48.2 

func (s *CreateAssetModelInput) SetAssetModelExternalId(v string) *CreateAssetModelInput

SetAssetModelExternalId sets the AssetModelExternalId field's value.

func (*CreateAssetModelInput) SetAssetModelHierarchies 

func (s *CreateAssetModelInput) SetAssetModelHierarchies(v []*AssetModelHierarchyDefinition) *CreateAssetModelInput

SetAssetModelHierarchies sets the AssetModelHierarchies field's value.

func (*CreateAssetModelInput) SetAssetModelId added in v1.48.2 

func (s *CreateAssetModelInput) SetAssetModelId(v string) *CreateAssetModelInput

SetAssetModelId sets the AssetModelId field's value.

func (*CreateAssetModelInput) SetAssetModelName 

func (s *CreateAssetModelInput) SetAssetModelName(v string) *CreateAssetModelInput

SetAssetModelName sets the AssetModelName field's value.

func (*CreateAssetModelInput) SetAssetModelProperties 

func (s *CreateAssetModelInput) SetAssetModelProperties(v []*AssetModelPropertyDefinition) *CreateAssetModelInput

SetAssetModelProperties sets the AssetModelProperties field's value.

func (*CreateAssetModelInput) SetAssetModelType added in v1.48.2 

func (s *CreateAssetModelInput) SetAssetModelType(v string) *CreateAssetModelInput

SetAssetModelType sets the AssetModelType field's value.

func (*CreateAssetModelInput) SetClientToken 

func (s *CreateAssetModelInput) SetClientToken(v string) *CreateAssetModelInput

SetClientToken sets the ClientToken field's value.

func (*CreateAssetModelInput) SetTags 

func (s *CreateAssetModelInput) SetTags(v map[string]*string) *CreateAssetModelInput

SetTags sets the Tags field's value.

func (CreateAssetModelInput) String 

func (s CreateAssetModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssetModelInput) Validate 

func (s *CreateAssetModelInput) Validate() error

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

type CreateAssetModelOutput 

type CreateAssetModelOutput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the asset model, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
	//
	// AssetModelArn is a required field
	AssetModelArn *string `locationName:"assetModelArn" min:"1" type:"string" required:"true"`

	// The ID of the asset model, in UUID format. You can use this ID when you call
	// other IoT SiteWise API operations.
	//
	// AssetModelId is a required field
	AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"`

	// The status of the asset model, which contains a state (CREATING after successfully
	// calling this operation) and any error message.
	//
	// AssetModelStatus is a required field
	AssetModelStatus *AssetModelStatus `locationName:"assetModelStatus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAssetModelOutput) GoString 

func (s CreateAssetModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssetModelOutput) SetAssetModelArn 

func (s *CreateAssetModelOutput) SetAssetModelArn(v string) *CreateAssetModelOutput

SetAssetModelArn sets the AssetModelArn field's value.

func (*CreateAssetModelOutput) SetAssetModelId 

func (s *CreateAssetModelOutput) SetAssetModelId(v string) *CreateAssetModelOutput

SetAssetModelId sets the AssetModelId field's value.

func (*CreateAssetModelOutput) SetAssetModelStatus 

func (s *CreateAssetModelOutput) SetAssetModelStatus(v *AssetModelStatus) *CreateAssetModelOutput

SetAssetModelStatus sets the AssetModelStatus field's value.

func (CreateAssetModelOutput) String 

func (s CreateAssetModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateAssetOutput 

type CreateAssetOutput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the asset, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
	//
	// AssetArn is a required field
	AssetArn *string `locationName:"assetArn" min:"1" type:"string" required:"true"`

	// The ID of the asset, in UUID format. This ID uniquely identifies the asset
	// within IoT SiteWise and can be used with other IoT SiteWise API operations.
	//
	// AssetId is a required field
	AssetId *string `locationName:"assetId" min:"36" type:"string" required:"true"`

	// The status of the asset, which contains a state (CREATING after successfully
	// calling this operation) and any error message.
	//
	// AssetStatus is a required field
	AssetStatus *AssetStatus `locationName:"assetStatus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateAssetOutput) GoString 

func (s CreateAssetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateAssetOutput) SetAssetArn 

func (s *CreateAssetOutput) SetAssetArn(v string) *CreateAssetOutput

SetAssetArn sets the AssetArn field's value.

func (*CreateAssetOutput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*CreateAssetOutput) SetAssetStatus 

func (s *CreateAssetOutput) SetAssetStatus(v *AssetStatus) *CreateAssetOutput

SetAssetStatus sets the AssetStatus field's value.

func (CreateAssetOutput) String 

func (s CreateAssetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateBulkImportJobInput added in v1.44.60 

type CreateBulkImportJobInput struct {

	// If set to true, ingest new data into IoT SiteWise storage. Measurements with
	// notifications, metrics and transforms are computed. If set to false, historical
	// data is ingested into IoT SiteWise as is.
	AdaptiveIngestion *bool `locationName:"adaptiveIngestion" type:"boolean"`

	// If set to true, your data files is deleted from S3, after ingestion into
	// IoT SiteWise storage.
	DeleteFilesAfterImport *bool `locationName:"deleteFilesAfterImport" type:"boolean"`

	// The Amazon S3 destination where errors associated with the job creation request
	// are saved.
	//
	// ErrorReportLocation is a required field
	ErrorReportLocation *ErrorReportLocation `locationName:"errorReportLocation" type:"structure" required:"true"`

	// The files in the specified Amazon S3 bucket that contain your data.
	//
	// Files is a required field
	Files []*File `locationName:"files" type:"list" required:"true"`

	// Contains the configuration information of a job, such as the file format
	// used to save data in Amazon S3.
	//
	// JobConfiguration is a required field
	JobConfiguration *JobConfiguration `locationName:"jobConfiguration" type:"structure" required:"true"`

	// The unique name that helps identify the job request.
	//
	// JobName is a required field
	JobName *string `locationName:"jobName" min:"1" type:"string" required:"true"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the IAM role that allows IoT SiteWise to read Amazon S3 data.
	//
	// JobRoleArn is a required field
	JobRoleArn *string `locationName:"jobRoleArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateBulkImportJobInput) GoString added in v1.44.60 

func (s CreateBulkImportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBulkImportJobInput) SetAdaptiveIngestion added in v1.48.2 

func (s *CreateBulkImportJobInput) SetAdaptiveIngestion(v bool) *CreateBulkImportJobInput

SetAdaptiveIngestion sets the AdaptiveIngestion field's value.

func (*CreateBulkImportJobInput) SetDeleteFilesAfterImport added in v1.48.2 

func (s *CreateBulkImportJobInput) SetDeleteFilesAfterImport(v bool) *CreateBulkImportJobInput

SetDeleteFilesAfterImport sets the DeleteFilesAfterImport field's value.

func (*CreateBulkImportJobInput) SetErrorReportLocation added in v1.44.60 

func (s *CreateBulkImportJobInput) SetErrorReportLocation(v *ErrorReportLocation) *CreateBulkImportJobInput

SetErrorReportLocation sets the ErrorReportLocation field's value.

func (*CreateBulkImportJobInput) SetFiles added in v1.44.60 

func (s *CreateBulkImportJobInput) SetFiles(v []*File) *CreateBulkImportJobInput

SetFiles sets the Files field's value.

func (*CreateBulkImportJobInput) SetJobConfiguration added in v1.44.60 

func (s *CreateBulkImportJobInput) SetJobConfiguration(v *JobConfiguration) *CreateBulkImportJobInput

SetJobConfiguration sets the JobConfiguration field's value.

func (*CreateBulkImportJobInput) SetJobName added in v1.44.60 

func (s *CreateBulkImportJobInput) SetJobName(v string) *CreateBulkImportJobInput

SetJobName sets the JobName field's value.

func (*CreateBulkImportJobInput) SetJobRoleArn added in v1.44.60 

func (s *CreateBulkImportJobInput) SetJobRoleArn(v string) *CreateBulkImportJobInput

SetJobRoleArn sets the JobRoleArn field's value.

func (CreateBulkImportJobInput) String added in v1.44.60 

func (s CreateBulkImportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBulkImportJobInput) Validate added in v1.44.60 

func (s *CreateBulkImportJobInput) Validate() error

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

type CreateBulkImportJobOutput added in v1.44.60 

type CreateBulkImportJobOutput struct {

	// The ID of the job.
	//
	// JobId is a required field
	JobId *string `locationName:"jobId" min:"36" type:"string" required:"true"`

	// The unique name that helps identify the job request.
	//
	// JobName is a required field
	JobName *string `locationName:"jobName" min:"1" type:"string" required:"true"`

	// The status of the bulk import job can be one of following values:
	//
	//    * PENDING – IoT SiteWise is waiting for the current bulk import job
	//    to finish.
	//
	//    * CANCELLED – The bulk import job has been canceled.
	//
	//    * RUNNING – IoT SiteWise is processing your request to import your data
	//    from Amazon S3.
	//
	//    * COMPLETED – IoT SiteWise successfully completed your request to import
	//    data from Amazon S3.
	//
	//    * FAILED – IoT SiteWise couldn't process your request to import data
	//    from Amazon S3. You can use logs saved in the specified error report location
	//    in Amazon S3 to troubleshoot issues.
	//
	//    * COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import
	//    data from Amazon S3 with errors. You can use logs saved in the specified
	//    error report location in Amazon S3 to troubleshoot issues.
	//
	// JobStatus is a required field
	JobStatus *string `locationName:"jobStatus" type:"string" required:"true" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (CreateBulkImportJobOutput) GoString added in v1.44.60 

func (s CreateBulkImportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateBulkImportJobOutput) SetJobId added in v1.44.60 

func (s *CreateBulkImportJobOutput) SetJobId(v string) *CreateBulkImportJobOutput

SetJobId sets the JobId field's value.

func (*CreateBulkImportJobOutput) SetJobName added in v1.44.60 

func (s *CreateBulkImportJobOutput) SetJobName(v string) *CreateBulkImportJobOutput

SetJobName sets the JobName field's value.

func (*CreateBulkImportJobOutput) SetJobStatus added in v1.44.60 

func (s *CreateBulkImportJobOutput) SetJobStatus(v string) *CreateBulkImportJobOutput

SetJobStatus sets the JobStatus field's value.

func (CreateBulkImportJobOutput) String added in v1.44.60 

func (s CreateBulkImportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateDashboardInput 

type CreateDashboardInput struct {

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The dashboard definition specified in a JSON literal. For detailed information,
	// see Creating dashboards (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html)
	// in the IoT SiteWise User Guide.
	//
	// DashboardDefinition is a required field
	DashboardDefinition *string `locationName:"dashboardDefinition" type:"string" required:"true"`

	// A description for the dashboard.
	DashboardDescription *string `locationName:"dashboardDescription" min:"1" type:"string"`

	// A friendly name for the dashboard.
	//
	// DashboardName is a required field
	DashboardName *string `locationName:"dashboardName" min:"1" type:"string" required:"true"`

	// The ID of the project in which to create the dashboard.
	//
	// ProjectId is a required field
	ProjectId *string `locationName:"projectId" min:"36" type:"string" required:"true"`

	// A list of key-value pairs that contain metadata for the dashboard. For more
	// information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the IoT SiteWise User Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateDashboardInput) GoString 

func (s CreateDashboardInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDashboardInput) SetClientToken 

func (s *CreateDashboardInput) SetClientToken(v string) *CreateDashboardInput

SetClientToken sets the ClientToken field's value.

func (*CreateDashboardInput) SetDashboardDefinition 

func (s *CreateDashboardInput) SetDashboardDefinition(v string) *CreateDashboardInput

SetDashboardDefinition sets the DashboardDefinition field's value.

func (*CreateDashboardInput) SetDashboardDescription 

func (s *CreateDashboardInput) SetDashboardDescription(v string) *CreateDashboardInput

SetDashboardDescription sets the DashboardDescription field's value.

func (*CreateDashboardInput) SetDashboardName 

func (s *CreateDashboardInput) SetDashboardName(v string) *CreateDashboardInput

SetDashboardName sets the DashboardName field's value.

func (*CreateDashboardInput) SetProjectId 

func (s *CreateDashboardInput) SetProjectId(v string) *CreateDashboardInput

SetProjectId sets the ProjectId field's value.

func (*CreateDashboardInput) SetTags 

func (s *CreateDashboardInput) SetTags(v map[string]*string) *CreateDashboardInput

SetTags sets the Tags field's value.

func (CreateDashboardInput) String 

func (s CreateDashboardInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDashboardInput) Validate 

func (s *CreateDashboardInput) Validate() error

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

type CreateDashboardOutput 

type CreateDashboardOutput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the dashboard, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
	//
	// DashboardArn is a required field
	DashboardArn *string `locationName:"dashboardArn" min:"1" type:"string" required:"true"`

	// The ID of the dashboard.
	//
	// DashboardId is a required field
	DashboardId *string `locationName:"dashboardId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDashboardOutput) GoString 

func (s CreateDashboardOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateDashboardOutput) SetDashboardArn 

func (s *CreateDashboardOutput) SetDashboardArn(v string) *CreateDashboardOutput

SetDashboardArn sets the DashboardArn field's value.

func (*CreateDashboardOutput) SetDashboardId 

func (s *CreateDashboardOutput) SetDashboardId(v string) *CreateDashboardOutput

SetDashboardId sets the DashboardId field's value.

func (CreateDashboardOutput) String 

func (s CreateDashboardOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateGatewayInput 

type CreateGatewayInput struct {

	// A unique, friendly name for the gateway.
	//
	// GatewayName is a required field
	GatewayName *string `locationName:"gatewayName" min:"1" type:"string" required:"true"`

	// The gateway's platform. You can only specify one platform in a gateway.
	//
	// GatewayPlatform is a required field
	GatewayPlatform *GatewayPlatform `locationName:"gatewayPlatform" type:"structure" required:"true"`

	// A list of key-value pairs that contain metadata for the gateway. For more
	// information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the IoT SiteWise User Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateGatewayInput) GoString 

func (s CreateGatewayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGatewayInput) SetGatewayName 

func (s *CreateGatewayInput) SetGatewayName(v string) *CreateGatewayInput

SetGatewayName sets the GatewayName field's value.

func (*CreateGatewayInput) SetGatewayPlatform 

func (s *CreateGatewayInput) SetGatewayPlatform(v *GatewayPlatform) *CreateGatewayInput

SetGatewayPlatform sets the GatewayPlatform field's value.

func (*CreateGatewayInput) SetTags 

func (s *CreateGatewayInput) SetTags(v map[string]*string) *CreateGatewayInput

SetTags sets the Tags field's value.

func (CreateGatewayInput) String 

func (s CreateGatewayInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGatewayInput) Validate 

func (s *CreateGatewayInput) Validate() error

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

type CreateGatewayOutput 

type CreateGatewayOutput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the gateway, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
	//
	// GatewayArn is a required field
	GatewayArn *string `locationName:"gatewayArn" min:"1" type:"string" required:"true"`

	// The ID of the gateway device. You can use this ID when you call other IoT
	// SiteWise API operations.
	//
	// GatewayId is a required field
	GatewayId *string `locationName:"gatewayId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateGatewayOutput) GoString 

func (s CreateGatewayOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateGatewayOutput) SetGatewayArn 

func (s *CreateGatewayOutput) SetGatewayArn(v string) *CreateGatewayOutput

SetGatewayArn sets the GatewayArn field's value.

func (*CreateGatewayOutput) SetGatewayId 

func (s *CreateGatewayOutput) SetGatewayId(v string) *CreateGatewayOutput

SetGatewayId sets the GatewayId field's value.

func (CreateGatewayOutput) String 

func (s CreateGatewayOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreatePortalInput 

type CreatePortalInput struct {

	// Contains the configuration information of an alarm created in an IoT SiteWise
	// Monitor portal. You can use the alarm to monitor an asset property and get
	// notified when the asset property value is outside a specified range. For
	// more information, see Monitoring with alarms (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html)
	// in the IoT SiteWise Application Guide.
	Alarms *Alarms `locationName:"alarms" type:"structure"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The email address that sends alarm notifications.
	//
	// If you use the IoT Events managed Lambda function (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html)
	// to manage your emails, you must verify the sender email address in Amazon
	// SES (https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html).
	NotificationSenderEmail *string `locationName:"notificationSenderEmail" min:"1" type:"string"`

	// The service to use to authenticate users to the portal. Choose from the following
	// options:
	//
	//    * SSO – The portal uses IAM Identity Center to authenticate users and
	//    manage user permissions. Before you can create a portal that uses IAM
	//    Identity Center, you must enable IAM Identity Center. For more information,
	//    see Enabling IAM Identity Center (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso)
	//    in the IoT SiteWise User Guide. This option is only available in Amazon
	//    Web Services Regions other than the China Regions.
	//
	//    * IAM – The portal uses Identity and Access Management to authenticate
	//    users and manage user permissions.
	//
	// You can't change this value after you create a portal.
	//
	// Default: SSO
	PortalAuthMode *string `locationName:"portalAuthMode" type:"string" enum:"AuthMode"`

	// The Amazon Web Services administrator's contact email address.
	//
	// PortalContactEmail is a required field
	PortalContactEmail *string `locationName:"portalContactEmail" min:"1" type:"string" required:"true"`

	// A description for the portal.
	PortalDescription *string `locationName:"portalDescription" min:"1" type:"string"`

	// A logo image to display in the portal. Upload a square, high-resolution image.
	// The image is displayed on a dark background.
	PortalLogoImageFile *ImageFile `locationName:"portalLogoImageFile" type:"structure"`

	// A friendly name for the portal.
	//
	// PortalName is a required field
	PortalName *string `locationName:"portalName" min:"1" type:"string" required:"true"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of a service role that allows the portal's users to access your IoT SiteWise
	// resources on your behalf. For more information, see Using service roles for
	// IoT SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html)
	// in the IoT SiteWise User Guide.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`

	// A list of key-value pairs that contain metadata for the portal. For more
	// information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the IoT SiteWise User Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreatePortalInput) GoString 

func (s CreatePortalInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePortalInput) SetAlarms added in v1.38.50 

func (s *CreatePortalInput) SetAlarms(v *Alarms) *CreatePortalInput

SetAlarms sets the Alarms field's value.

func (*CreatePortalInput) SetClientToken 

func (s *CreatePortalInput) SetClientToken(v string) *CreatePortalInput

SetClientToken sets the ClientToken field's value.

func (*CreatePortalInput) SetNotificationSenderEmail added in v1.38.50 

func (s *CreatePortalInput) SetNotificationSenderEmail(v string) *CreatePortalInput

SetNotificationSenderEmail sets the NotificationSenderEmail field's value.

func (*CreatePortalInput) SetPortalAuthMode added in v1.34.28 

func (s *CreatePortalInput) SetPortalAuthMode(v string) *CreatePortalInput

SetPortalAuthMode sets the PortalAuthMode field's value.

func (*CreatePortalInput) SetPortalContactEmail 

func (s *CreatePortalInput) SetPortalContactEmail(v string) *CreatePortalInput

SetPortalContactEmail sets the PortalContactEmail field's value.

func (*CreatePortalInput) SetPortalDescription 

func (s *CreatePortalInput) SetPortalDescription(v string) *CreatePortalInput

SetPortalDescription sets the PortalDescription field's value.

func (*CreatePortalInput) SetPortalLogoImageFile 

func (s *CreatePortalInput) SetPortalLogoImageFile(v *ImageFile) *CreatePortalInput

SetPortalLogoImageFile sets the PortalLogoImageFile field's value.

func (*CreatePortalInput) SetPortalName 

func (s *CreatePortalInput) SetPortalName(v string) *CreatePortalInput

SetPortalName sets the PortalName field's value.

func (*CreatePortalInput) SetRoleArn 

func (s *CreatePortalInput) SetRoleArn(v string) *CreatePortalInput

SetRoleArn sets the RoleArn field's value.

func (*CreatePortalInput) SetTags 

func (s *CreatePortalInput) SetTags(v map[string]*string) *CreatePortalInput

SetTags sets the Tags field's value.

func (CreatePortalInput) String 

func (s CreatePortalInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePortalInput) Validate 

func (s *CreatePortalInput) Validate() error

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

type CreatePortalOutput 

type CreatePortalOutput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the portal, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
	//
	// PortalArn is a required field
	PortalArn *string `locationName:"portalArn" min:"1" type:"string" required:"true"`

	// The ID of the created portal.
	//
	// PortalId is a required field
	PortalId *string `locationName:"portalId" min:"36" type:"string" required:"true"`

	// The URL for the IoT SiteWise Monitor portal. You can use this URL to access
	// portals that use IAM Identity Center for authentication. For portals that
	// use IAM for authentication, you must use the IoT SiteWise console to get
	// a URL that you can use to access the portal.
	//
	// PortalStartUrl is a required field
	PortalStartUrl *string `locationName:"portalStartUrl" min:"1" type:"string" required:"true"`

	// The status of the portal, which contains a state (CREATING after successfully
	// calling this operation) and any error message.
	//
	// PortalStatus is a required field
	PortalStatus *PortalStatus `locationName:"portalStatus" type:"structure" required:"true"`

	// The associated IAM Identity Center application ID, if the portal uses IAM
	// Identity Center.
	//
	// SsoApplicationId is a required field
	SsoApplicationId *string `locationName:"ssoApplicationId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreatePortalOutput) GoString 

func (s CreatePortalOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreatePortalOutput) SetPortalArn 

func (s *CreatePortalOutput) SetPortalArn(v string) *CreatePortalOutput

SetPortalArn sets the PortalArn field's value.

func (*CreatePortalOutput) SetPortalId 

func (s *CreatePortalOutput) SetPortalId(v string) *CreatePortalOutput

SetPortalId sets the PortalId field's value.

func (*CreatePortalOutput) SetPortalStartUrl 

func (s *CreatePortalOutput) SetPortalStartUrl(v string) *CreatePortalOutput

SetPortalStartUrl sets the PortalStartUrl field's value.

func (*CreatePortalOutput) SetPortalStatus 

func (s *CreatePortalOutput) SetPortalStatus(v *PortalStatus) *CreatePortalOutput

SetPortalStatus sets the PortalStatus field's value.

func (*CreatePortalOutput) SetSsoApplicationId 

func (s *CreatePortalOutput) SetSsoApplicationId(v string) *CreatePortalOutput

SetSsoApplicationId sets the SsoApplicationId field's value.

func (CreatePortalOutput) String 

func (s CreatePortalOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateProjectInput 

type CreateProjectInput struct {

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The ID of the portal in which to create the project.
	//
	// PortalId is a required field
	PortalId *string `locationName:"portalId" min:"36" type:"string" required:"true"`

	// A description for the project.
	ProjectDescription *string `locationName:"projectDescription" min:"1" type:"string"`

	// A friendly name for the project.
	//
	// ProjectName is a required field
	ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"`

	// A list of key-value pairs that contain metadata for the project. For more
	// information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the IoT SiteWise User Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (CreateProjectInput) GoString 

func (s CreateProjectInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProjectInput) SetClientToken 

func (s *CreateProjectInput) SetClientToken(v string) *CreateProjectInput

SetClientToken sets the ClientToken field's value.

func (*CreateProjectInput) SetPortalId 

func (s *CreateProjectInput) SetPortalId(v string) *CreateProjectInput

SetPortalId sets the PortalId field's value.

func (*CreateProjectInput) SetProjectDescription 

func (s *CreateProjectInput) SetProjectDescription(v string) *CreateProjectInput

SetProjectDescription sets the ProjectDescription field's value.

func (*CreateProjectInput) SetProjectName 

func (s *CreateProjectInput) SetProjectName(v string) *CreateProjectInput

SetProjectName sets the ProjectName field's value.

func (*CreateProjectInput) SetTags 

func (s *CreateProjectInput) SetTags(v map[string]*string) *CreateProjectInput

SetTags sets the Tags field's value.

func (CreateProjectInput) String 

func (s CreateProjectInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProjectInput) Validate 

func (s *CreateProjectInput) Validate() error

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

type CreateProjectOutput 

type CreateProjectOutput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the project, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
	//
	// ProjectArn is a required field
	ProjectArn *string `locationName:"projectArn" min:"1" type:"string" required:"true"`

	// The ID of the project.
	//
	// ProjectId is a required field
	ProjectId *string `locationName:"projectId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateProjectOutput) GoString 

func (s CreateProjectOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateProjectOutput) SetProjectArn 

func (s *CreateProjectOutput) SetProjectArn(v string) *CreateProjectOutput

SetProjectArn sets the ProjectArn field's value.

func (*CreateProjectOutput) SetProjectId 

func (s *CreateProjectOutput) SetProjectId(v string) *CreateProjectOutput

SetProjectId sets the ProjectId field's value.

func (CreateProjectOutput) String 

func (s CreateProjectOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Csv added in v1.44.60 

type Csv struct {

	// The column names specified in the .csv file.
	//
	// ColumnNames is a required field
	ColumnNames []*string `locationName:"columnNames" type:"list" required:"true" enum:"ColumnName"`
	// contains filtered or unexported fields
}

A .CSV file.

func (Csv) GoString added in v1.44.60 

func (s Csv) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Csv) SetColumnNames added in v1.44.60 

func (s *Csv) SetColumnNames(v []*string) *Csv

SetColumnNames sets the ColumnNames field's value.

func (Csv) String added in v1.44.60 

func (s Csv) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Csv) Validate added in v1.48.2 

func (s *Csv) Validate() error

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

type CustomerManagedS3Storage added in v1.39.2 

type CustomerManagedS3Storage struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the Identity and Access Management role that allows IoT SiteWise to send
	// data to Amazon S3.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the Amazon S3 object. For more information about how to find the ARN for
	// an Amazon S3 object, see Amazon S3 resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html)
	// in the Amazon Simple Storage Service User Guide.
	//
	// S3ResourceArn is a required field
	S3ResourceArn *string `locationName:"s3ResourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information about a customer managed Amazon S3 bucket.

func (CustomerManagedS3Storage) GoString added in v1.39.2 

func (s CustomerManagedS3Storage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomerManagedS3Storage) SetRoleArn added in v1.39.2 

func (s *CustomerManagedS3Storage) SetRoleArn(v string) *CustomerManagedS3Storage

SetRoleArn sets the RoleArn field's value.

func (*CustomerManagedS3Storage) SetS3ResourceArn added in v1.39.2 

func (s *CustomerManagedS3Storage) SetS3ResourceArn(v string) *CustomerManagedS3Storage

SetS3ResourceArn sets the S3ResourceArn field's value.

func (CustomerManagedS3Storage) String added in v1.39.2 

func (s CustomerManagedS3Storage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomerManagedS3Storage) Validate added in v1.39.2 

func (s *CustomerManagedS3Storage) Validate() error

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

type DashboardSummary 

type DashboardSummary struct {

	// The date the dashboard was created, in Unix epoch time.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// The dashboard's description.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The ID of the dashboard.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The date the dashboard was last updated, in Unix epoch time.
	LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp"`

	// The name of the dashboard
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains a dashboard summary.

func (DashboardSummary) GoString 

func (s DashboardSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DashboardSummary) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*DashboardSummary) SetDescription 

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

SetDescription sets the Description field's value.

func (*DashboardSummary) SetId 

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

SetId sets the Id field's value.

func (*DashboardSummary) SetLastUpdateDate 

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

SetLastUpdateDate sets the LastUpdateDate field's value.

func (*DashboardSummary) SetName 

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

SetName sets the Name field's value.

func (DashboardSummary) String 

func (s DashboardSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Datum added in v1.48.2 

type Datum struct {

	// Indicates if the data point is an array.
	ArrayValue []*Datum `locationName:"arrayValue" type:"list"`

	// Indicates if the data point is null.
	NullValue *bool `locationName:"nullValue" type:"boolean"`

	// Indicates if the data point is a row.
	RowValue *Row `locationName:"rowValue" type:"structure"`

	// Indicates if the data point is a scalar value such as integer, string, double,
	// or Boolean.
	ScalarValue *string `locationName:"scalarValue" type:"string"`
	// contains filtered or unexported fields
}

Represents a single data point in a query result.

func (Datum) GoString added in v1.48.2 

func (s Datum) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Datum) SetArrayValue added in v1.48.2 

func (s *Datum) SetArrayValue(v []*Datum) *Datum

SetArrayValue sets the ArrayValue field's value.

func (*Datum) SetNullValue added in v1.48.2 

func (s *Datum) SetNullValue(v bool) *Datum

SetNullValue sets the NullValue field's value.

func (*Datum) SetRowValue added in v1.48.2 

func (s *Datum) SetRowValue(v *Row) *Datum

SetRowValue sets the RowValue field's value.

func (*Datum) SetScalarValue added in v1.48.2 

func (s *Datum) SetScalarValue(v string) *Datum

SetScalarValue sets the ScalarValue field's value.

func (Datum) String added in v1.48.2 

func (s Datum) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAccessPolicyInput 

type DeleteAccessPolicyInput struct {

	// The ID of the access policy to be deleted.
	//
	// AccessPolicyId is a required field
	AccessPolicyId *string `location:"uri" locationName:"accessPolicyId" min:"36" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (DeleteAccessPolicyInput) GoString 

func (s DeleteAccessPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccessPolicyInput) SetAccessPolicyId 

func (s *DeleteAccessPolicyInput) SetAccessPolicyId(v string) *DeleteAccessPolicyInput

SetAccessPolicyId sets the AccessPolicyId field's value.

func (*DeleteAccessPolicyInput) SetClientToken 

func (s *DeleteAccessPolicyInput) SetClientToken(v string) *DeleteAccessPolicyInput

SetClientToken sets the ClientToken field's value.

func (DeleteAccessPolicyInput) String 

func (s DeleteAccessPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAccessPolicyInput) Validate 

func (s *DeleteAccessPolicyInput) Validate() error

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

type DeleteAccessPolicyOutput 

type DeleteAccessPolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteAccessPolicyOutput) GoString 

func (s DeleteAccessPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAccessPolicyOutput) String 

func (s DeleteAccessPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAssetInput 

type DeleteAssetInput struct {

	// The ID of the asset to delete. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"uri" locationName:"assetId" min:"13" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (DeleteAssetInput) GoString 

func (s DeleteAssetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssetInput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*DeleteAssetInput) SetClientToken 

func (s *DeleteAssetInput) SetClientToken(v string) *DeleteAssetInput

SetClientToken sets the ClientToken field's value.

func (DeleteAssetInput) String 

func (s DeleteAssetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssetInput) Validate 

func (s *DeleteAssetInput) Validate() error

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

type DeleteAssetModelCompositeModelInput added in v1.48.2 

type DeleteAssetModelCompositeModelInput struct {

	// The ID of a composite model on this asset model.
	//
	// AssetModelCompositeModelId is a required field
	AssetModelCompositeModelId *string `location:"uri" locationName:"assetModelCompositeModelId" min:"13" type:"string" required:"true"`

	// The ID of the asset model, in UUID format.
	//
	// AssetModelId is a required field
	AssetModelId *string `location:"uri" locationName:"assetModelId" min:"13" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (DeleteAssetModelCompositeModelInput) GoString added in v1.48.2 

func (s DeleteAssetModelCompositeModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssetModelCompositeModelInput) SetAssetModelCompositeModelId added in v1.48.2 

func (s *DeleteAssetModelCompositeModelInput) SetAssetModelCompositeModelId(v string) *DeleteAssetModelCompositeModelInput

SetAssetModelCompositeModelId sets the AssetModelCompositeModelId field's value.

func (*DeleteAssetModelCompositeModelInput) SetAssetModelId added in v1.48.2 

func (s *DeleteAssetModelCompositeModelInput) SetAssetModelId(v string) *DeleteAssetModelCompositeModelInput

SetAssetModelId sets the AssetModelId field's value.

func (*DeleteAssetModelCompositeModelInput) SetClientToken added in v1.48.2 

func (s *DeleteAssetModelCompositeModelInput) SetClientToken(v string) *DeleteAssetModelCompositeModelInput

SetClientToken sets the ClientToken field's value.

func (DeleteAssetModelCompositeModelInput) String added in v1.48.2 

func (s DeleteAssetModelCompositeModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssetModelCompositeModelInput) Validate added in v1.48.2 

func (s *DeleteAssetModelCompositeModelInput) Validate() error

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

type DeleteAssetModelCompositeModelOutput added in v1.48.2 

type DeleteAssetModelCompositeModelOutput struct {

	// Contains current status information for an asset model. For more information,
	// see Asset and model states (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html)
	// in the IoT SiteWise User Guide.
	//
	// AssetModelStatus is a required field
	AssetModelStatus *AssetModelStatus `locationName:"assetModelStatus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAssetModelCompositeModelOutput) GoString added in v1.48.2 

func (s DeleteAssetModelCompositeModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssetModelCompositeModelOutput) SetAssetModelStatus added in v1.48.2 

func (s *DeleteAssetModelCompositeModelOutput) SetAssetModelStatus(v *AssetModelStatus) *DeleteAssetModelCompositeModelOutput

SetAssetModelStatus sets the AssetModelStatus field's value.

func (DeleteAssetModelCompositeModelOutput) String added in v1.48.2 

func (s DeleteAssetModelCompositeModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAssetModelInput 

type DeleteAssetModelInput struct {

	// The ID of the asset model to delete. This can be either the actual ID in
	// UUID format, or else externalId: followed by the external ID, if it has one.
	// For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetModelId is a required field
	AssetModelId *string `location:"uri" locationName:"assetModelId" min:"13" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (DeleteAssetModelInput) GoString 

func (s DeleteAssetModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssetModelInput) SetAssetModelId 

func (s *DeleteAssetModelInput) SetAssetModelId(v string) *DeleteAssetModelInput

SetAssetModelId sets the AssetModelId field's value.

func (*DeleteAssetModelInput) SetClientToken 

func (s *DeleteAssetModelInput) SetClientToken(v string) *DeleteAssetModelInput

SetClientToken sets the ClientToken field's value.

func (DeleteAssetModelInput) String 

func (s DeleteAssetModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssetModelInput) Validate 

func (s *DeleteAssetModelInput) Validate() error

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

type DeleteAssetModelOutput 

type DeleteAssetModelOutput struct {

	// The status of the asset model, which contains a state (DELETING after successfully
	// calling this operation) and any error message.
	//
	// AssetModelStatus is a required field
	AssetModelStatus *AssetModelStatus `locationName:"assetModelStatus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAssetModelOutput) GoString 

func (s DeleteAssetModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssetModelOutput) SetAssetModelStatus 

func (s *DeleteAssetModelOutput) SetAssetModelStatus(v *AssetModelStatus) *DeleteAssetModelOutput

SetAssetModelStatus sets the AssetModelStatus field's value.

func (DeleteAssetModelOutput) String 

func (s DeleteAssetModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteAssetOutput 

type DeleteAssetOutput struct {

	// The status of the asset, which contains a state (DELETING after successfully
	// calling this operation) and any error message.
	//
	// AssetStatus is a required field
	AssetStatus *AssetStatus `locationName:"assetStatus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteAssetOutput) GoString 

func (s DeleteAssetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteAssetOutput) SetAssetStatus 

func (s *DeleteAssetOutput) SetAssetStatus(v *AssetStatus) *DeleteAssetOutput

SetAssetStatus sets the AssetStatus field's value.

func (DeleteAssetOutput) String 

func (s DeleteAssetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteDashboardInput 

type DeleteDashboardInput struct {

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The ID of the dashboard to delete.
	//
	// DashboardId is a required field
	DashboardId *string `location:"uri" locationName:"dashboardId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDashboardInput) GoString 

func (s DeleteDashboardInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDashboardInput) SetClientToken 

func (s *DeleteDashboardInput) SetClientToken(v string) *DeleteDashboardInput

SetClientToken sets the ClientToken field's value.

func (*DeleteDashboardInput) SetDashboardId 

func (s *DeleteDashboardInput) SetDashboardId(v string) *DeleteDashboardInput

SetDashboardId sets the DashboardId field's value.

func (DeleteDashboardInput) String 

func (s DeleteDashboardInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteDashboardInput) Validate 

func (s *DeleteDashboardInput) Validate() error

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

type DeleteDashboardOutput 

type DeleteDashboardOutput struct {
	// contains filtered or unexported fields
}

func (DeleteDashboardOutput) GoString 

func (s DeleteDashboardOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteDashboardOutput) String 

func (s DeleteDashboardOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteGatewayInput 

type DeleteGatewayInput struct {

	// The ID of the gateway to delete.
	//
	// GatewayId is a required field
	GatewayId *string `location:"uri" locationName:"gatewayId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGatewayInput) GoString 

func (s DeleteGatewayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGatewayInput) SetGatewayId 

func (s *DeleteGatewayInput) SetGatewayId(v string) *DeleteGatewayInput

SetGatewayId sets the GatewayId field's value.

func (DeleteGatewayInput) String 

func (s DeleteGatewayInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteGatewayInput) Validate 

func (s *DeleteGatewayInput) Validate() error

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

type DeleteGatewayOutput 

type DeleteGatewayOutput struct {
	// contains filtered or unexported fields
}

func (DeleteGatewayOutput) GoString 

func (s DeleteGatewayOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteGatewayOutput) String 

func (s DeleteGatewayOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeletePortalInput 

type DeletePortalInput struct {

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The ID of the portal to delete.
	//
	// PortalId is a required field
	PortalId *string `location:"uri" locationName:"portalId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePortalInput) GoString 

func (s DeletePortalInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePortalInput) SetClientToken 

func (s *DeletePortalInput) SetClientToken(v string) *DeletePortalInput

SetClientToken sets the ClientToken field's value.

func (*DeletePortalInput) SetPortalId 

func (s *DeletePortalInput) SetPortalId(v string) *DeletePortalInput

SetPortalId sets the PortalId field's value.

func (DeletePortalInput) String 

func (s DeletePortalInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePortalInput) Validate 

func (s *DeletePortalInput) Validate() error

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

type DeletePortalOutput 

type DeletePortalOutput struct {

	// The status of the portal, which contains a state (DELETING after successfully
	// calling this operation) and any error message.
	//
	// PortalStatus is a required field
	PortalStatus *PortalStatus `locationName:"portalStatus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeletePortalOutput) GoString 

func (s DeletePortalOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeletePortalOutput) SetPortalStatus 

func (s *DeletePortalOutput) SetPortalStatus(v *PortalStatus) *DeletePortalOutput

SetPortalStatus sets the PortalStatus field's value.

func (DeletePortalOutput) String 

func (s DeletePortalOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteProjectInput 

type DeleteProjectInput struct {

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `location:"querystring" locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The ID of the project.
	//
	// ProjectId is a required field
	ProjectId *string `location:"uri" locationName:"projectId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteProjectInput) GoString 

func (s DeleteProjectInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProjectInput) SetClientToken 

func (s *DeleteProjectInput) SetClientToken(v string) *DeleteProjectInput

SetClientToken sets the ClientToken field's value.

func (*DeleteProjectInput) SetProjectId 

func (s *DeleteProjectInput) SetProjectId(v string) *DeleteProjectInput

SetProjectId sets the ProjectId field's value.

func (DeleteProjectInput) String 

func (s DeleteProjectInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteProjectInput) Validate 

func (s *DeleteProjectInput) Validate() error

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

type DeleteProjectOutput 

type DeleteProjectOutput struct {
	// contains filtered or unexported fields
}

func (DeleteProjectOutput) GoString 

func (s DeleteProjectOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteProjectOutput) String 

func (s DeleteProjectOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTimeSeriesInput added in v1.42.12 

type DeleteTimeSeriesInput struct {

	// The alias that identifies the time series.
	Alias *string `location:"querystring" locationName:"alias" min:"1" type:"string"`

	// The ID of the asset in which the asset property was created. This can be
	// either the actual ID in UUID format, or else externalId: followed by the
	// external ID, if it has one. For more information, see Referencing objects
	// with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	AssetId *string `location:"querystring" locationName:"assetId" min:"13" type:"string"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The ID of the asset property. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	PropertyId *string `location:"querystring" locationName:"propertyId" min:"13" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteTimeSeriesInput) GoString added in v1.42.12 

func (s DeleteTimeSeriesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTimeSeriesInput) SetAlias added in v1.42.12 

func (s *DeleteTimeSeriesInput) SetAlias(v string) *DeleteTimeSeriesInput

SetAlias sets the Alias field's value.

func (*DeleteTimeSeriesInput) SetAssetId added in v1.42.12 

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

SetAssetId sets the AssetId field's value.

func (*DeleteTimeSeriesInput) SetClientToken added in v1.42.12 

func (s *DeleteTimeSeriesInput) SetClientToken(v string) *DeleteTimeSeriesInput

SetClientToken sets the ClientToken field's value.

func (*DeleteTimeSeriesInput) SetPropertyId added in v1.42.12 

func (s *DeleteTimeSeriesInput) SetPropertyId(v string) *DeleteTimeSeriesInput

SetPropertyId sets the PropertyId field's value.

func (DeleteTimeSeriesInput) String added in v1.42.12 

func (s DeleteTimeSeriesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTimeSeriesInput) Validate added in v1.42.12 

func (s *DeleteTimeSeriesInput) Validate() error

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

type DeleteTimeSeriesOutput added in v1.42.12 

type DeleteTimeSeriesOutput struct {
	// contains filtered or unexported fields
}

func (DeleteTimeSeriesOutput) GoString added in v1.42.12 

func (s DeleteTimeSeriesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteTimeSeriesOutput) String added in v1.42.12 

func (s DeleteTimeSeriesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAccessPolicyInput 

type DescribeAccessPolicyInput struct {

	// The ID of the access policy.
	//
	// AccessPolicyId is a required field
	AccessPolicyId *string `location:"uri" locationName:"accessPolicyId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAccessPolicyInput) GoString 

func (s DescribeAccessPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessPolicyInput) SetAccessPolicyId 

func (s *DescribeAccessPolicyInput) SetAccessPolicyId(v string) *DescribeAccessPolicyInput

SetAccessPolicyId sets the AccessPolicyId field's value.

func (DescribeAccessPolicyInput) String 

func (s DescribeAccessPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessPolicyInput) Validate 

func (s *DescribeAccessPolicyInput) Validate() error

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

type DescribeAccessPolicyOutput 

type DescribeAccessPolicyOutput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the access policy, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
	//
	// AccessPolicyArn is a required field
	AccessPolicyArn *string `locationName:"accessPolicyArn" min:"1" type:"string" required:"true"`

	// The date the access policy was created, in Unix epoch time.
	//
	// AccessPolicyCreationDate is a required field
	AccessPolicyCreationDate *time.Time `locationName:"accessPolicyCreationDate" type:"timestamp" required:"true"`

	// The ID of the access policy.
	//
	// AccessPolicyId is a required field
	AccessPolicyId *string `locationName:"accessPolicyId" min:"36" type:"string" required:"true"`

	// The identity (IAM Identity Center user, IAM Identity Center group, or IAM
	// user) to which this access policy applies.
	//
	// AccessPolicyIdentity is a required field
	AccessPolicyIdentity *Identity `locationName:"accessPolicyIdentity" type:"structure" required:"true"`

	// The date the access policy was last updated, in Unix epoch time.
	//
	// AccessPolicyLastUpdateDate is a required field
	AccessPolicyLastUpdateDate *time.Time `locationName:"accessPolicyLastUpdateDate" type:"timestamp" required:"true"`

	// The access policy permission. Note that a project ADMINISTRATOR is also known
	// as a project owner.
	//
	// AccessPolicyPermission is a required field
	AccessPolicyPermission *string `locationName:"accessPolicyPermission" type:"string" required:"true" enum:"Permission"`

	// The IoT SiteWise Monitor resource (portal or project) to which this access
	// policy provides access.
	//
	// AccessPolicyResource is a required field
	AccessPolicyResource *Resource `locationName:"accessPolicyResource" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAccessPolicyOutput) GoString 

func (s DescribeAccessPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAccessPolicyOutput) SetAccessPolicyArn 

func (s *DescribeAccessPolicyOutput) SetAccessPolicyArn(v string) *DescribeAccessPolicyOutput

SetAccessPolicyArn sets the AccessPolicyArn field's value.

func (*DescribeAccessPolicyOutput) SetAccessPolicyCreationDate 

func (s *DescribeAccessPolicyOutput) SetAccessPolicyCreationDate(v time.Time) *DescribeAccessPolicyOutput

SetAccessPolicyCreationDate sets the AccessPolicyCreationDate field's value.

func (*DescribeAccessPolicyOutput) SetAccessPolicyId 

func (s *DescribeAccessPolicyOutput) SetAccessPolicyId(v string) *DescribeAccessPolicyOutput

SetAccessPolicyId sets the AccessPolicyId field's value.

func (*DescribeAccessPolicyOutput) SetAccessPolicyIdentity 

func (s *DescribeAccessPolicyOutput) SetAccessPolicyIdentity(v *Identity) *DescribeAccessPolicyOutput

SetAccessPolicyIdentity sets the AccessPolicyIdentity field's value.

func (*DescribeAccessPolicyOutput) SetAccessPolicyLastUpdateDate 

func (s *DescribeAccessPolicyOutput) SetAccessPolicyLastUpdateDate(v time.Time) *DescribeAccessPolicyOutput

SetAccessPolicyLastUpdateDate sets the AccessPolicyLastUpdateDate field's value.

func (*DescribeAccessPolicyOutput) SetAccessPolicyPermission 

func (s *DescribeAccessPolicyOutput) SetAccessPolicyPermission(v string) *DescribeAccessPolicyOutput

SetAccessPolicyPermission sets the AccessPolicyPermission field's value.

func (*DescribeAccessPolicyOutput) SetAccessPolicyResource 

func (s *DescribeAccessPolicyOutput) SetAccessPolicyResource(v *Resource) *DescribeAccessPolicyOutput

SetAccessPolicyResource sets the AccessPolicyResource field's value.

func (DescribeAccessPolicyOutput) String 

func (s DescribeAccessPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeActionInput added in v1.48.2 

type DescribeActionInput struct {

	// The ID of the action.
	//
	// ActionId is a required field
	ActionId *string `location:"uri" locationName:"actionId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeActionInput) GoString added in v1.48.2 

func (s DescribeActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeActionInput) SetActionId added in v1.48.2 

func (s *DescribeActionInput) SetActionId(v string) *DescribeActionInput

SetActionId sets the ActionId field's value.

func (DescribeActionInput) String added in v1.48.2 

func (s DescribeActionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeActionInput) Validate added in v1.48.2 

func (s *DescribeActionInput) Validate() error

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

type DescribeActionOutput added in v1.48.2 

type DescribeActionOutput struct {

	// The ID of the action definition.
	//
	// ActionDefinitionId is a required field
	ActionDefinitionId *string `locationName:"actionDefinitionId" min:"36" type:"string" required:"true"`

	// The ID of the action.
	//
	// ActionId is a required field
	ActionId *string `locationName:"actionId" min:"36" type:"string" required:"true"`

	// The JSON payload of the action.
	//
	// ActionPayload is a required field
	ActionPayload *ActionPayload `locationName:"actionPayload" type:"structure" required:"true"`

	// The time the action was executed.
	//
	// ExecutionTime is a required field
	ExecutionTime *time.Time `locationName:"executionTime" type:"timestamp" required:"true"`

	// The resource the action will be taken on.
	//
	// TargetResource is a required field
	TargetResource *TargetResource `locationName:"targetResource" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeActionOutput) GoString added in v1.48.2 

func (s DescribeActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeActionOutput) SetActionDefinitionId added in v1.48.2 

func (s *DescribeActionOutput) SetActionDefinitionId(v string) *DescribeActionOutput

SetActionDefinitionId sets the ActionDefinitionId field's value.

func (*DescribeActionOutput) SetActionId added in v1.48.2 

func (s *DescribeActionOutput) SetActionId(v string) *DescribeActionOutput

SetActionId sets the ActionId field's value.

func (*DescribeActionOutput) SetActionPayload added in v1.48.2 

func (s *DescribeActionOutput) SetActionPayload(v *ActionPayload) *DescribeActionOutput

SetActionPayload sets the ActionPayload field's value.

func (*DescribeActionOutput) SetExecutionTime added in v1.48.2 

func (s *DescribeActionOutput) SetExecutionTime(v time.Time) *DescribeActionOutput

SetExecutionTime sets the ExecutionTime field's value.

func (*DescribeActionOutput) SetTargetResource added in v1.48.2 

func (s *DescribeActionOutput) SetTargetResource(v *TargetResource) *DescribeActionOutput

SetTargetResource sets the TargetResource field's value.

func (DescribeActionOutput) String added in v1.48.2 

func (s DescribeActionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAssetCompositeModelInput added in v1.48.2 

type DescribeAssetCompositeModelInput struct {

	// The ID of a composite model on this asset. This can be either the actual
	// ID in UUID format, or else externalId: followed by the external ID, if it
	// has one. For more information, see Referencing objects with external IDs
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetCompositeModelId is a required field
	AssetCompositeModelId *string `location:"uri" locationName:"assetCompositeModelId" min:"13" type:"string" required:"true"`

	// The ID of the asset. This can be either the actual ID in UUID format, or
	// else externalId: followed by the external ID, if it has one. For more information,
	// see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"uri" locationName:"assetId" min:"13" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAssetCompositeModelInput) GoString added in v1.48.2 

func (s DescribeAssetCompositeModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetCompositeModelInput) SetAssetCompositeModelId added in v1.48.2 

func (s *DescribeAssetCompositeModelInput) SetAssetCompositeModelId(v string) *DescribeAssetCompositeModelInput

SetAssetCompositeModelId sets the AssetCompositeModelId field's value.

func (*DescribeAssetCompositeModelInput) SetAssetId added in v1.48.2 

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

SetAssetId sets the AssetId field's value.

func (DescribeAssetCompositeModelInput) String added in v1.48.2 

func (s DescribeAssetCompositeModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetCompositeModelInput) Validate added in v1.48.2 

func (s *DescribeAssetCompositeModelInput) Validate() error

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

type DescribeAssetCompositeModelOutput added in v1.48.2 

type DescribeAssetCompositeModelOutput struct {

	// The available actions for a composite model on this asset.
	ActionDefinitions []*ActionDefinition `locationName:"actionDefinitions" type:"list"`

	// A description for the composite model.
	//
	// AssetCompositeModelDescription is a required field
	AssetCompositeModelDescription *string `locationName:"assetCompositeModelDescription" min:"1" type:"string" required:"true"`

	// An external ID to assign to the asset model.
	//
	// If the composite model is a component-based composite model, or one nested
	// inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel
	// and specifying the derived ID of the model or property from the created model
	// it's a part of.
	AssetCompositeModelExternalId *string `locationName:"assetCompositeModelExternalId" min:"2" type:"string"`

	// The ID of a composite model on this asset.
	//
	// AssetCompositeModelId is a required field
	AssetCompositeModelId *string `locationName:"assetCompositeModelId" min:"36" type:"string" required:"true"`

	// The unique, friendly name for the composite model.
	//
	// AssetCompositeModelName is a required field
	AssetCompositeModelName *string `locationName:"assetCompositeModelName" min:"1" type:"string" required:"true"`

	// The path to the composite model listing the parent composite models.
	//
	// AssetCompositeModelPath is a required field
	AssetCompositeModelPath []*AssetCompositeModelPathSegment `locationName:"assetCompositeModelPath" type:"list" required:"true"`

	// The property definitions of the composite model that was used to create the
	// asset.
	//
	// AssetCompositeModelProperties is a required field
	AssetCompositeModelProperties []*AssetProperty `locationName:"assetCompositeModelProperties" type:"list" required:"true"`

	// The list of composite model summaries.
	//
	// AssetCompositeModelSummaries is a required field
	AssetCompositeModelSummaries []*AssetCompositeModelSummary `locationName:"assetCompositeModelSummaries" type:"list" required:"true"`

	// The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
	//
	// AssetCompositeModelType is a required field
	AssetCompositeModelType *string `locationName:"assetCompositeModelType" min:"1" type:"string" required:"true"`

	// The ID of the asset, in UUID format. This ID uniquely identifies the asset
	// within IoT SiteWise and can be used with other IoT SiteWise APIs.
	//
	// AssetId is a required field
	AssetId *string `locationName:"assetId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAssetCompositeModelOutput) GoString added in v1.48.2 

func (s DescribeAssetCompositeModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetCompositeModelOutput) SetActionDefinitions added in v1.48.2 

func (s *DescribeAssetCompositeModelOutput) SetActionDefinitions(v []*ActionDefinition) *DescribeAssetCompositeModelOutput

SetActionDefinitions sets the ActionDefinitions field's value.

func (*DescribeAssetCompositeModelOutput) SetAssetCompositeModelDescription added in v1.48.2 

func (s *DescribeAssetCompositeModelOutput) SetAssetCompositeModelDescription(v string) *DescribeAssetCompositeModelOutput

SetAssetCompositeModelDescription sets the AssetCompositeModelDescription field's value.

func (*DescribeAssetCompositeModelOutput) SetAssetCompositeModelExternalId added in v1.48.2 

func (s *DescribeAssetCompositeModelOutput) SetAssetCompositeModelExternalId(v string) *DescribeAssetCompositeModelOutput

SetAssetCompositeModelExternalId sets the AssetCompositeModelExternalId field's value.

func (*DescribeAssetCompositeModelOutput) SetAssetCompositeModelId added in v1.48.2 

func (s *DescribeAssetCompositeModelOutput) SetAssetCompositeModelId(v string) *DescribeAssetCompositeModelOutput

SetAssetCompositeModelId sets the AssetCompositeModelId field's value.

func (*DescribeAssetCompositeModelOutput) SetAssetCompositeModelName added in v1.48.2 

func (s *DescribeAssetCompositeModelOutput) SetAssetCompositeModelName(v string) *DescribeAssetCompositeModelOutput

SetAssetCompositeModelName sets the AssetCompositeModelName field's value.

func (*DescribeAssetCompositeModelOutput) SetAssetCompositeModelPath added in v1.48.2 

func (s *DescribeAssetCompositeModelOutput) SetAssetCompositeModelPath(v []*AssetCompositeModelPathSegment) *DescribeAssetCompositeModelOutput

SetAssetCompositeModelPath sets the AssetCompositeModelPath field's value.

func (*DescribeAssetCompositeModelOutput) SetAssetCompositeModelProperties added in v1.48.2 

func (s *DescribeAssetCompositeModelOutput) SetAssetCompositeModelProperties(v []*AssetProperty) *DescribeAssetCompositeModelOutput

SetAssetCompositeModelProperties sets the AssetCompositeModelProperties field's value.

func (*DescribeAssetCompositeModelOutput) SetAssetCompositeModelSummaries added in v1.48.2 

func (s *DescribeAssetCompositeModelOutput) SetAssetCompositeModelSummaries(v []*AssetCompositeModelSummary) *DescribeAssetCompositeModelOutput

SetAssetCompositeModelSummaries sets the AssetCompositeModelSummaries field's value.

func (*DescribeAssetCompositeModelOutput) SetAssetCompositeModelType added in v1.48.2 

func (s *DescribeAssetCompositeModelOutput) SetAssetCompositeModelType(v string) *DescribeAssetCompositeModelOutput

SetAssetCompositeModelType sets the AssetCompositeModelType field's value.

func (*DescribeAssetCompositeModelOutput) SetAssetId added in v1.48.2 

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

SetAssetId sets the AssetId field's value.

func (DescribeAssetCompositeModelOutput) String added in v1.48.2 

func (s DescribeAssetCompositeModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAssetInput 

type DescribeAssetInput struct {

	// The ID of the asset. This can be either the actual ID in UUID format, or
	// else externalId: followed by the external ID, if it has one. For more information,
	// see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"uri" locationName:"assetId" min:"13" type:"string" required:"true"`

	// Whether or not to exclude asset properties from the response.
	ExcludeProperties *bool `location:"querystring" locationName:"excludeProperties" type:"boolean"`
	// contains filtered or unexported fields
}

func (DescribeAssetInput) GoString 

func (s DescribeAssetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetInput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*DescribeAssetInput) SetExcludeProperties added in v1.44.129 

func (s *DescribeAssetInput) SetExcludeProperties(v bool) *DescribeAssetInput

SetExcludeProperties sets the ExcludeProperties field's value.

func (DescribeAssetInput) String 

func (s DescribeAssetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetInput) Validate 

func (s *DescribeAssetInput) Validate() error

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

type DescribeAssetModelCompositeModelInput added in v1.48.2 

type DescribeAssetModelCompositeModelInput struct {

	// The ID of a composite model on this asset model. This can be either the actual
	// ID in UUID format, or else externalId: followed by the external ID, if it
	// has one. For more information, see Referencing objects with external IDs
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetModelCompositeModelId is a required field
	AssetModelCompositeModelId *string `location:"uri" locationName:"assetModelCompositeModelId" min:"13" type:"string" required:"true"`

	// The ID of the asset model. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetModelId is a required field
	AssetModelId *string `location:"uri" locationName:"assetModelId" min:"13" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAssetModelCompositeModelInput) GoString added in v1.48.2 

func (s DescribeAssetModelCompositeModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetModelCompositeModelInput) SetAssetModelCompositeModelId added in v1.48.2 

func (s *DescribeAssetModelCompositeModelInput) SetAssetModelCompositeModelId(v string) *DescribeAssetModelCompositeModelInput

SetAssetModelCompositeModelId sets the AssetModelCompositeModelId field's value.

func (*DescribeAssetModelCompositeModelInput) SetAssetModelId added in v1.48.2 

func (s *DescribeAssetModelCompositeModelInput) SetAssetModelId(v string) *DescribeAssetModelCompositeModelInput

SetAssetModelId sets the AssetModelId field's value.

func (DescribeAssetModelCompositeModelInput) String added in v1.48.2 

func (s DescribeAssetModelCompositeModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetModelCompositeModelInput) Validate added in v1.48.2 

func (s *DescribeAssetModelCompositeModelInput) Validate() error

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

type DescribeAssetModelCompositeModelOutput added in v1.48.2 

type DescribeAssetModelCompositeModelOutput struct {

	// The available actions for a composite model on this asset model.
	ActionDefinitions []*ActionDefinition `locationName:"actionDefinitions" type:"list"`

	// The description for the composite model.
	//
	// AssetModelCompositeModelDescription is a required field
	AssetModelCompositeModelDescription *string `locationName:"assetModelCompositeModelDescription" min:"1" type:"string" required:"true"`

	// The external ID of a composite model on this asset model.
	AssetModelCompositeModelExternalId *string `locationName:"assetModelCompositeModelExternalId" min:"2" type:"string"`

	// The ID of a composite model on this asset model.
	//
	// AssetModelCompositeModelId is a required field
	AssetModelCompositeModelId *string `locationName:"assetModelCompositeModelId" min:"36" type:"string" required:"true"`

	// The unique, friendly name for the composite model.
	//
	// AssetModelCompositeModelName is a required field
	AssetModelCompositeModelName *string `locationName:"assetModelCompositeModelName" min:"1" type:"string" required:"true"`

	// The path to the composite model listing the parent composite models.
	//
	// AssetModelCompositeModelPath is a required field
	AssetModelCompositeModelPath []*AssetModelCompositeModelPathSegment `locationName:"assetModelCompositeModelPath" type:"list" required:"true"`

	// The property definitions of the composite model.
	//
	// AssetModelCompositeModelProperties is a required field
	AssetModelCompositeModelProperties []*AssetModelProperty `locationName:"assetModelCompositeModelProperties" type:"list" required:"true"`

	// The list of composite model summaries for the composite model.
	//
	// AssetModelCompositeModelSummaries is a required field
	AssetModelCompositeModelSummaries []*AssetModelCompositeModelSummary `locationName:"assetModelCompositeModelSummaries" type:"list" required:"true"`

	// The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
	//
	// AssetModelCompositeModelType is a required field
	AssetModelCompositeModelType *string `locationName:"assetModelCompositeModelType" min:"1" type:"string" required:"true"`

	// The ID of the asset model, in UUID format.
	//
	// AssetModelId is a required field
	AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"`

	// Metadata for the composition relationship established by using composedAssetModelId
	// in CreateAssetModelCompositeModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html).
	// For instance, an array detailing the path of the composition relationship
	// for this composite model.
	CompositionDetails *CompositionDetails `locationName:"compositionDetails" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAssetModelCompositeModelOutput) GoString added in v1.48.2 

func (s DescribeAssetModelCompositeModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetModelCompositeModelOutput) SetActionDefinitions added in v1.48.2 

func (s *DescribeAssetModelCompositeModelOutput) SetActionDefinitions(v []*ActionDefinition) *DescribeAssetModelCompositeModelOutput

SetActionDefinitions sets the ActionDefinitions field's value.

func (*DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelDescription added in v1.48.2 

func (s *DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelDescription(v string) *DescribeAssetModelCompositeModelOutput

SetAssetModelCompositeModelDescription sets the AssetModelCompositeModelDescription field's value.

func (*DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelExternalId added in v1.48.2 

func (s *DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelExternalId(v string) *DescribeAssetModelCompositeModelOutput

SetAssetModelCompositeModelExternalId sets the AssetModelCompositeModelExternalId field's value.

func (*DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelId added in v1.48.2 

func (s *DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelId(v string) *DescribeAssetModelCompositeModelOutput

SetAssetModelCompositeModelId sets the AssetModelCompositeModelId field's value.

func (*DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelName added in v1.48.2 

func (s *DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelName(v string) *DescribeAssetModelCompositeModelOutput

SetAssetModelCompositeModelName sets the AssetModelCompositeModelName field's value.

func (*DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelPath added in v1.48.2 

func (s *DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelPath(v []*AssetModelCompositeModelPathSegment) *DescribeAssetModelCompositeModelOutput

SetAssetModelCompositeModelPath sets the AssetModelCompositeModelPath field's value.

func (*DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelProperties added in v1.48.2 

func (s *DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelProperties(v []*AssetModelProperty) *DescribeAssetModelCompositeModelOutput

SetAssetModelCompositeModelProperties sets the AssetModelCompositeModelProperties field's value.

func (*DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelSummaries added in v1.48.2 

func (s *DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelSummaries(v []*AssetModelCompositeModelSummary) *DescribeAssetModelCompositeModelOutput

SetAssetModelCompositeModelSummaries sets the AssetModelCompositeModelSummaries field's value.

func (*DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelType added in v1.48.2 

func (s *DescribeAssetModelCompositeModelOutput) SetAssetModelCompositeModelType(v string) *DescribeAssetModelCompositeModelOutput

SetAssetModelCompositeModelType sets the AssetModelCompositeModelType field's value.

func (*DescribeAssetModelCompositeModelOutput) SetAssetModelId added in v1.48.2 

func (s *DescribeAssetModelCompositeModelOutput) SetAssetModelId(v string) *DescribeAssetModelCompositeModelOutput

SetAssetModelId sets the AssetModelId field's value.

func (*DescribeAssetModelCompositeModelOutput) SetCompositionDetails added in v1.48.2 

func (s *DescribeAssetModelCompositeModelOutput) SetCompositionDetails(v *CompositionDetails) *DescribeAssetModelCompositeModelOutput

SetCompositionDetails sets the CompositionDetails field's value.

func (DescribeAssetModelCompositeModelOutput) String added in v1.48.2 

func (s DescribeAssetModelCompositeModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAssetModelInput 

type DescribeAssetModelInput struct {

	// The ID of the asset model. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetModelId is a required field
	AssetModelId *string `location:"uri" locationName:"assetModelId" min:"13" type:"string" required:"true"`

	// Whether or not to exclude asset model properties from the response.
	ExcludeProperties *bool `location:"querystring" locationName:"excludeProperties" type:"boolean"`
	// contains filtered or unexported fields
}

func (DescribeAssetModelInput) GoString 

func (s DescribeAssetModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetModelInput) SetAssetModelId 

func (s *DescribeAssetModelInput) SetAssetModelId(v string) *DescribeAssetModelInput

SetAssetModelId sets the AssetModelId field's value.

func (*DescribeAssetModelInput) SetExcludeProperties added in v1.44.129 

func (s *DescribeAssetModelInput) SetExcludeProperties(v bool) *DescribeAssetModelInput

SetExcludeProperties sets the ExcludeProperties field's value.

func (DescribeAssetModelInput) String 

func (s DescribeAssetModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetModelInput) Validate 

func (s *DescribeAssetModelInput) Validate() error

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

type DescribeAssetModelOutput 

type DescribeAssetModelOutput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the asset model, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
	//
	// AssetModelArn is a required field
	AssetModelArn *string `locationName:"assetModelArn" min:"1" type:"string" required:"true"`

	// The list of the immediate child custom composite model summaries for the
	// asset model.
	AssetModelCompositeModelSummaries []*AssetModelCompositeModelSummary `locationName:"assetModelCompositeModelSummaries" type:"list"`

	// The list of built-in composite models for the asset model, such as those
	// with those of type AWS/ALARMS.
	AssetModelCompositeModels []*AssetModelCompositeModel `locationName:"assetModelCompositeModels" type:"list"`

	// The date the asset model was created, in Unix epoch time.
	//
	// AssetModelCreationDate is a required field
	AssetModelCreationDate *time.Time `locationName:"assetModelCreationDate" type:"timestamp" required:"true"`

	// The asset model's description.
	//
	// AssetModelDescription is a required field
	AssetModelDescription *string `locationName:"assetModelDescription" min:"1" type:"string" required:"true"`

	// The external ID of the asset model, if any.
	AssetModelExternalId *string `locationName:"assetModelExternalId" min:"2" type:"string"`

	// A list of asset model hierarchies that each contain a childAssetModelId and
	// a hierarchyId (named id). A hierarchy specifies allowed parent/child asset
	// relationships for an asset model.
	//
	// AssetModelHierarchies is a required field
	AssetModelHierarchies []*AssetModelHierarchy `locationName:"assetModelHierarchies" type:"list" required:"true"`

	// The ID of the asset model, in UUID format.
	//
	// AssetModelId is a required field
	AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"`

	// The date the asset model was last updated, in Unix epoch time.
	//
	// AssetModelLastUpdateDate is a required field
	AssetModelLastUpdateDate *time.Time `locationName:"assetModelLastUpdateDate" type:"timestamp" required:"true"`

	// The name of the asset model.
	//
	// AssetModelName is a required field
	AssetModelName *string `locationName:"assetModelName" min:"1" type:"string" required:"true"`

	// The list of asset properties for the asset model.
	//
	// This object doesn't include properties that you define in composite models.
	// You can find composite model properties in the assetModelCompositeModels
	// object.
	//
	// AssetModelProperties is a required field
	AssetModelProperties []*AssetModelProperty `locationName:"assetModelProperties" type:"list" required:"true"`

	// The current status of the asset model, which contains a state and any error
	// message.
	//
	// AssetModelStatus is a required field
	AssetModelStatus *AssetModelStatus `locationName:"assetModelStatus" type:"structure" required:"true"`

	// The type of asset model.
	//
	//    * ASSET_MODEL – (default) An asset model that you can use to create
	//    assets. Can't be included as a component in another asset model.
	//
	//    * COMPONENT_MODEL – A reusable component that you can include in the
	//    composite models of other asset models. You can't create assets directly
	//    from this type of asset model.
	AssetModelType *string `locationName:"assetModelType" type:"string" enum:"AssetModelType"`
	// contains filtered or unexported fields
}

func (DescribeAssetModelOutput) GoString 

func (s DescribeAssetModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetModelOutput) SetAssetModelArn 

func (s *DescribeAssetModelOutput) SetAssetModelArn(v string) *DescribeAssetModelOutput

SetAssetModelArn sets the AssetModelArn field's value.

func (*DescribeAssetModelOutput) SetAssetModelCompositeModelSummaries added in v1.48.2 

func (s *DescribeAssetModelOutput) SetAssetModelCompositeModelSummaries(v []*AssetModelCompositeModelSummary) *DescribeAssetModelOutput

SetAssetModelCompositeModelSummaries sets the AssetModelCompositeModelSummaries field's value.

func (*DescribeAssetModelOutput) SetAssetModelCompositeModels added in v1.36.7 

func (s *DescribeAssetModelOutput) SetAssetModelCompositeModels(v []*AssetModelCompositeModel) *DescribeAssetModelOutput

SetAssetModelCompositeModels sets the AssetModelCompositeModels field's value.

func (*DescribeAssetModelOutput) SetAssetModelCreationDate 

func (s *DescribeAssetModelOutput) SetAssetModelCreationDate(v time.Time) *DescribeAssetModelOutput

SetAssetModelCreationDate sets the AssetModelCreationDate field's value.

func (*DescribeAssetModelOutput) SetAssetModelDescription 

func (s *DescribeAssetModelOutput) SetAssetModelDescription(v string) *DescribeAssetModelOutput

SetAssetModelDescription sets the AssetModelDescription field's value.

func (*DescribeAssetModelOutput) SetAssetModelExternalId added in v1.48.2 

func (s *DescribeAssetModelOutput) SetAssetModelExternalId(v string) *DescribeAssetModelOutput

SetAssetModelExternalId sets the AssetModelExternalId field's value.

func (*DescribeAssetModelOutput) SetAssetModelHierarchies 

func (s *DescribeAssetModelOutput) SetAssetModelHierarchies(v []*AssetModelHierarchy) *DescribeAssetModelOutput

SetAssetModelHierarchies sets the AssetModelHierarchies field's value.

func (*DescribeAssetModelOutput) SetAssetModelId 

func (s *DescribeAssetModelOutput) SetAssetModelId(v string) *DescribeAssetModelOutput

SetAssetModelId sets the AssetModelId field's value.

func (*DescribeAssetModelOutput) SetAssetModelLastUpdateDate 

func (s *DescribeAssetModelOutput) SetAssetModelLastUpdateDate(v time.Time) *DescribeAssetModelOutput

SetAssetModelLastUpdateDate sets the AssetModelLastUpdateDate field's value.

func (*DescribeAssetModelOutput) SetAssetModelName 

func (s *DescribeAssetModelOutput) SetAssetModelName(v string) *DescribeAssetModelOutput

SetAssetModelName sets the AssetModelName field's value.

func (*DescribeAssetModelOutput) SetAssetModelProperties 

func (s *DescribeAssetModelOutput) SetAssetModelProperties(v []*AssetModelProperty) *DescribeAssetModelOutput

SetAssetModelProperties sets the AssetModelProperties field's value.

func (*DescribeAssetModelOutput) SetAssetModelStatus 

func (s *DescribeAssetModelOutput) SetAssetModelStatus(v *AssetModelStatus) *DescribeAssetModelOutput

SetAssetModelStatus sets the AssetModelStatus field's value.

func (*DescribeAssetModelOutput) SetAssetModelType added in v1.48.2 

func (s *DescribeAssetModelOutput) SetAssetModelType(v string) *DescribeAssetModelOutput

SetAssetModelType sets the AssetModelType field's value.

func (DescribeAssetModelOutput) String 

func (s DescribeAssetModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAssetOutput 

type DescribeAssetOutput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the asset, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
	//
	// AssetArn is a required field
	AssetArn *string `locationName:"assetArn" min:"1" type:"string" required:"true"`

	// The list of the immediate child custom composite model summaries for the
	// asset.
	AssetCompositeModelSummaries []*AssetCompositeModelSummary `locationName:"assetCompositeModelSummaries" type:"list"`

	// The composite models for the asset.
	AssetCompositeModels []*AssetCompositeModel `locationName:"assetCompositeModels" type:"list"`

	// The date the asset was created, in Unix epoch time.
	//
	// AssetCreationDate is a required field
	AssetCreationDate *time.Time `locationName:"assetCreationDate" type:"timestamp" required:"true"`

	// A description for the asset.
	AssetDescription *string `locationName:"assetDescription" min:"1" type:"string"`

	// The external ID of the asset, if any.
	AssetExternalId *string `locationName:"assetExternalId" min:"2" type:"string"`

	// A list of asset hierarchies that each contain a hierarchyId. A hierarchy
	// specifies allowed parent/child asset relationships.
	//
	// AssetHierarchies is a required field
	AssetHierarchies []*AssetHierarchy `locationName:"assetHierarchies" type:"list" required:"true"`

	// The ID of the asset, in UUID format.
	//
	// AssetId is a required field
	AssetId *string `locationName:"assetId" min:"36" type:"string" required:"true"`

	// The date the asset was last updated, in Unix epoch time.
	//
	// AssetLastUpdateDate is a required field
	AssetLastUpdateDate *time.Time `locationName:"assetLastUpdateDate" type:"timestamp" required:"true"`

	// The ID of the asset model that was used to create the asset.
	//
	// AssetModelId is a required field
	AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"`

	// The name of the asset.
	//
	// AssetName is a required field
	AssetName *string `locationName:"assetName" min:"1" type:"string" required:"true"`

	// The list of asset properties for the asset.
	//
	// This object doesn't include properties that you define in composite models.
	// You can find composite model properties in the assetCompositeModels object.
	//
	// AssetProperties is a required field
	AssetProperties []*AssetProperty `locationName:"assetProperties" type:"list" required:"true"`

	// The current status of the asset, which contains a state and any error message.
	//
	// AssetStatus is a required field
	AssetStatus *AssetStatus `locationName:"assetStatus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAssetOutput) GoString 

func (s DescribeAssetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetOutput) SetAssetArn 

func (s *DescribeAssetOutput) SetAssetArn(v string) *DescribeAssetOutput

SetAssetArn sets the AssetArn field's value.

func (*DescribeAssetOutput) SetAssetCompositeModelSummaries added in v1.48.2 

func (s *DescribeAssetOutput) SetAssetCompositeModelSummaries(v []*AssetCompositeModelSummary) *DescribeAssetOutput

SetAssetCompositeModelSummaries sets the AssetCompositeModelSummaries field's value.

func (*DescribeAssetOutput) SetAssetCompositeModels added in v1.36.7 

func (s *DescribeAssetOutput) SetAssetCompositeModels(v []*AssetCompositeModel) *DescribeAssetOutput

SetAssetCompositeModels sets the AssetCompositeModels field's value.

func (*DescribeAssetOutput) SetAssetCreationDate 

func (s *DescribeAssetOutput) SetAssetCreationDate(v time.Time) *DescribeAssetOutput

SetAssetCreationDate sets the AssetCreationDate field's value.

func (*DescribeAssetOutput) SetAssetDescription added in v1.44.25 

func (s *DescribeAssetOutput) SetAssetDescription(v string) *DescribeAssetOutput

SetAssetDescription sets the AssetDescription field's value.

func (*DescribeAssetOutput) SetAssetExternalId added in v1.48.2 

func (s *DescribeAssetOutput) SetAssetExternalId(v string) *DescribeAssetOutput

SetAssetExternalId sets the AssetExternalId field's value.

func (*DescribeAssetOutput) SetAssetHierarchies 

func (s *DescribeAssetOutput) SetAssetHierarchies(v []*AssetHierarchy) *DescribeAssetOutput

SetAssetHierarchies sets the AssetHierarchies field's value.

func (*DescribeAssetOutput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*DescribeAssetOutput) SetAssetLastUpdateDate 

func (s *DescribeAssetOutput) SetAssetLastUpdateDate(v time.Time) *DescribeAssetOutput

SetAssetLastUpdateDate sets the AssetLastUpdateDate field's value.

func (*DescribeAssetOutput) SetAssetModelId 

func (s *DescribeAssetOutput) SetAssetModelId(v string) *DescribeAssetOutput

SetAssetModelId sets the AssetModelId field's value.

func (*DescribeAssetOutput) SetAssetName 

func (s *DescribeAssetOutput) SetAssetName(v string) *DescribeAssetOutput

SetAssetName sets the AssetName field's value.

func (*DescribeAssetOutput) SetAssetProperties 

func (s *DescribeAssetOutput) SetAssetProperties(v []*AssetProperty) *DescribeAssetOutput

SetAssetProperties sets the AssetProperties field's value.

func (*DescribeAssetOutput) SetAssetStatus 

func (s *DescribeAssetOutput) SetAssetStatus(v *AssetStatus) *DescribeAssetOutput

SetAssetStatus sets the AssetStatus field's value.

func (DescribeAssetOutput) String 

func (s DescribeAssetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeAssetPropertyInput 

type DescribeAssetPropertyInput struct {

	// The ID of the asset. This can be either the actual ID in UUID format, or
	// else externalId: followed by the external ID, if it has one. For more information,
	// see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"uri" locationName:"assetId" min:"13" type:"string" required:"true"`

	// The ID of the asset property. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// PropertyId is a required field
	PropertyId *string `location:"uri" locationName:"propertyId" min:"13" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeAssetPropertyInput) GoString 

func (s DescribeAssetPropertyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetPropertyInput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*DescribeAssetPropertyInput) SetPropertyId 

func (s *DescribeAssetPropertyInput) SetPropertyId(v string) *DescribeAssetPropertyInput

SetPropertyId sets the PropertyId field's value.

func (DescribeAssetPropertyInput) String 

func (s DescribeAssetPropertyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetPropertyInput) Validate 

func (s *DescribeAssetPropertyInput) Validate() error

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

type DescribeAssetPropertyOutput 

type DescribeAssetPropertyOutput struct {

	// The external ID of the asset. For more information, see Using external IDs
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	AssetExternalId *string `locationName:"assetExternalId" min:"2" type:"string"`

	// The ID of the asset, in UUID format.
	//
	// AssetId is a required field
	AssetId *string `locationName:"assetId" min:"36" type:"string" required:"true"`

	// The ID of the asset model, in UUID format.
	//
	// AssetModelId is a required field
	AssetModelId *string `locationName:"assetModelId" min:"36" type:"string" required:"true"`

	// The name of the asset.
	//
	// AssetName is a required field
	AssetName *string `locationName:"assetName" min:"1" type:"string" required:"true"`

	// The asset property's definition, alias, and notification state.
	//
	// This response includes this object for normal asset properties. If you describe
	// an asset property in a composite model, this response includes the asset
	// property information in compositeModel.
	AssetProperty *Property `locationName:"assetProperty" type:"structure"`

	// The composite model that declares this asset property, if this asset property
	// exists in a composite model.
	CompositeModel *CompositeModelProperty `locationName:"compositeModel" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeAssetPropertyOutput) GoString 

func (s DescribeAssetPropertyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeAssetPropertyOutput) SetAssetExternalId added in v1.48.2 

func (s *DescribeAssetPropertyOutput) SetAssetExternalId(v string) *DescribeAssetPropertyOutput

SetAssetExternalId sets the AssetExternalId field's value.

func (*DescribeAssetPropertyOutput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*DescribeAssetPropertyOutput) SetAssetModelId 

func (s *DescribeAssetPropertyOutput) SetAssetModelId(v string) *DescribeAssetPropertyOutput

SetAssetModelId sets the AssetModelId field's value.

func (*DescribeAssetPropertyOutput) SetAssetName 

func (s *DescribeAssetPropertyOutput) SetAssetName(v string) *DescribeAssetPropertyOutput

SetAssetName sets the AssetName field's value.

func (*DescribeAssetPropertyOutput) SetAssetProperty 

func (s *DescribeAssetPropertyOutput) SetAssetProperty(v *Property) *DescribeAssetPropertyOutput

SetAssetProperty sets the AssetProperty field's value.

func (*DescribeAssetPropertyOutput) SetCompositeModel added in v1.36.7 

func (s *DescribeAssetPropertyOutput) SetCompositeModel(v *CompositeModelProperty) *DescribeAssetPropertyOutput

SetCompositeModel sets the CompositeModel field's value.

func (DescribeAssetPropertyOutput) String 

func (s DescribeAssetPropertyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBulkImportJobInput added in v1.44.60 

type DescribeBulkImportJobInput struct {

	// The ID of the job.
	//
	// JobId is a required field
	JobId *string `location:"uri" locationName:"jobId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeBulkImportJobInput) GoString added in v1.44.60 

func (s DescribeBulkImportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBulkImportJobInput) SetJobId added in v1.44.60 

func (s *DescribeBulkImportJobInput) SetJobId(v string) *DescribeBulkImportJobInput

SetJobId sets the JobId field's value.

func (DescribeBulkImportJobInput) String added in v1.44.60 

func (s DescribeBulkImportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBulkImportJobInput) Validate added in v1.44.60 

func (s *DescribeBulkImportJobInput) Validate() error

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

type DescribeBulkImportJobOutput added in v1.44.60 

type DescribeBulkImportJobOutput struct {

	// If set to true, ingest new data into IoT SiteWise storage. Measurements with
	// notifications, metrics and transforms are computed. If set to false, historical
	// data is ingested into IoT SiteWise as is.
	AdaptiveIngestion *bool `locationName:"adaptiveIngestion" type:"boolean"`

	// If set to true, your data files is deleted from S3, after ingestion into
	// IoT SiteWise storage.
	DeleteFilesAfterImport *bool `locationName:"deleteFilesAfterImport" type:"boolean"`

	// The Amazon S3 destination where errors associated with the job creation request
	// are saved.
	//
	// ErrorReportLocation is a required field
	ErrorReportLocation *ErrorReportLocation `locationName:"errorReportLocation" type:"structure" required:"true"`

	// The files in the specified Amazon S3 bucket that contain your data.
	//
	// Files is a required field
	Files []*File `locationName:"files" type:"list" required:"true"`

	// Contains the configuration information of a job, such as the file format
	// used to save data in Amazon S3.
	//
	// JobConfiguration is a required field
	JobConfiguration *JobConfiguration `locationName:"jobConfiguration" type:"structure" required:"true"`

	// The date the job was created, in Unix epoch TIME.
	//
	// JobCreationDate is a required field
	JobCreationDate *time.Time `locationName:"jobCreationDate" type:"timestamp" required:"true"`

	// The ID of the job.
	//
	// JobId is a required field
	JobId *string `locationName:"jobId" min:"36" type:"string" required:"true"`

	// The date the job was last updated, in Unix epoch time.
	//
	// JobLastUpdateDate is a required field
	JobLastUpdateDate *time.Time `locationName:"jobLastUpdateDate" type:"timestamp" required:"true"`

	// The unique name that helps identify the job request.
	//
	// JobName is a required field
	JobName *string `locationName:"jobName" min:"1" type:"string" required:"true"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the IAM role that allows IoT SiteWise to read Amazon S3 data.
	//
	// JobRoleArn is a required field
	JobRoleArn *string `locationName:"jobRoleArn" min:"1" type:"string" required:"true"`

	// The status of the bulk import job can be one of following values:
	//
	//    * PENDING – IoT SiteWise is waiting for the current bulk import job
	//    to finish.
	//
	//    * CANCELLED – The bulk import job has been canceled.
	//
	//    * RUNNING – IoT SiteWise is processing your request to import your data
	//    from Amazon S3.
	//
	//    * COMPLETED – IoT SiteWise successfully completed your request to import
	//    data from Amazon S3.
	//
	//    * FAILED – IoT SiteWise couldn't process your request to import data
	//    from Amazon S3. You can use logs saved in the specified error report location
	//    in Amazon S3 to troubleshoot issues.
	//
	//    * COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import
	//    data from Amazon S3 with errors. You can use logs saved in the specified
	//    error report location in Amazon S3 to troubleshoot issues.
	//
	// JobStatus is a required field
	JobStatus *string `locationName:"jobStatus" type:"string" required:"true" enum:"JobStatus"`
	// contains filtered or unexported fields
}

func (DescribeBulkImportJobOutput) GoString added in v1.44.60 

func (s DescribeBulkImportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBulkImportJobOutput) SetAdaptiveIngestion added in v1.48.2 

func (s *DescribeBulkImportJobOutput) SetAdaptiveIngestion(v bool) *DescribeBulkImportJobOutput

SetAdaptiveIngestion sets the AdaptiveIngestion field's value.

func (*DescribeBulkImportJobOutput) SetDeleteFilesAfterImport added in v1.48.2 

func (s *DescribeBulkImportJobOutput) SetDeleteFilesAfterImport(v bool) *DescribeBulkImportJobOutput

SetDeleteFilesAfterImport sets the DeleteFilesAfterImport field's value.

func (*DescribeBulkImportJobOutput) SetErrorReportLocation added in v1.44.60 

func (s *DescribeBulkImportJobOutput) SetErrorReportLocation(v *ErrorReportLocation) *DescribeBulkImportJobOutput

SetErrorReportLocation sets the ErrorReportLocation field's value.

func (*DescribeBulkImportJobOutput) SetFiles added in v1.44.60 

func (s *DescribeBulkImportJobOutput) SetFiles(v []*File) *DescribeBulkImportJobOutput

SetFiles sets the Files field's value.

func (*DescribeBulkImportJobOutput) SetJobConfiguration added in v1.44.60 

func (s *DescribeBulkImportJobOutput) SetJobConfiguration(v *JobConfiguration) *DescribeBulkImportJobOutput

SetJobConfiguration sets the JobConfiguration field's value.

func (*DescribeBulkImportJobOutput) SetJobCreationDate added in v1.44.60 

func (s *DescribeBulkImportJobOutput) SetJobCreationDate(v time.Time) *DescribeBulkImportJobOutput

SetJobCreationDate sets the JobCreationDate field's value.

func (*DescribeBulkImportJobOutput) SetJobId added in v1.44.60 

func (s *DescribeBulkImportJobOutput) SetJobId(v string) *DescribeBulkImportJobOutput

SetJobId sets the JobId field's value.

func (*DescribeBulkImportJobOutput) SetJobLastUpdateDate added in v1.44.60 

func (s *DescribeBulkImportJobOutput) SetJobLastUpdateDate(v time.Time) *DescribeBulkImportJobOutput

SetJobLastUpdateDate sets the JobLastUpdateDate field's value.

func (*DescribeBulkImportJobOutput) SetJobName added in v1.44.60 

func (s *DescribeBulkImportJobOutput) SetJobName(v string) *DescribeBulkImportJobOutput

SetJobName sets the JobName field's value.

func (*DescribeBulkImportJobOutput) SetJobRoleArn added in v1.44.60 

func (s *DescribeBulkImportJobOutput) SetJobRoleArn(v string) *DescribeBulkImportJobOutput

SetJobRoleArn sets the JobRoleArn field's value.

func (*DescribeBulkImportJobOutput) SetJobStatus added in v1.44.60 

func (s *DescribeBulkImportJobOutput) SetJobStatus(v string) *DescribeBulkImportJobOutput

SetJobStatus sets the JobStatus field's value.

func (DescribeBulkImportJobOutput) String added in v1.44.60 

func (s DescribeBulkImportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDashboardInput 

type DescribeDashboardInput struct {

	// The ID of the dashboard.
	//
	// DashboardId is a required field
	DashboardId *string `location:"uri" locationName:"dashboardId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDashboardInput) GoString 

func (s DescribeDashboardInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDashboardInput) SetDashboardId 

func (s *DescribeDashboardInput) SetDashboardId(v string) *DescribeDashboardInput

SetDashboardId sets the DashboardId field's value.

func (DescribeDashboardInput) String 

func (s DescribeDashboardInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDashboardInput) Validate 

func (s *DescribeDashboardInput) Validate() error

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

type DescribeDashboardOutput 

type DescribeDashboardOutput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the dashboard, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
	//
	// DashboardArn is a required field
	DashboardArn *string `locationName:"dashboardArn" min:"1" type:"string" required:"true"`

	// The date the dashboard was created, in Unix epoch time.
	//
	// DashboardCreationDate is a required field
	DashboardCreationDate *time.Time `locationName:"dashboardCreationDate" type:"timestamp" required:"true"`

	// The dashboard's definition JSON literal. For detailed information, see Creating
	// dashboards (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html)
	// in the IoT SiteWise User Guide.
	//
	// DashboardDefinition is a required field
	DashboardDefinition *string `locationName:"dashboardDefinition" type:"string" required:"true"`

	// The dashboard's description.
	DashboardDescription *string `locationName:"dashboardDescription" min:"1" type:"string"`

	// The ID of the dashboard.
	//
	// DashboardId is a required field
	DashboardId *string `locationName:"dashboardId" min:"36" type:"string" required:"true"`

	// The date the dashboard was last updated, in Unix epoch time.
	//
	// DashboardLastUpdateDate is a required field
	DashboardLastUpdateDate *time.Time `locationName:"dashboardLastUpdateDate" type:"timestamp" required:"true"`

	// The name of the dashboard.
	//
	// DashboardName is a required field
	DashboardName *string `locationName:"dashboardName" min:"1" type:"string" required:"true"`

	// The ID of the project that the dashboard is in.
	//
	// ProjectId is a required field
	ProjectId *string `locationName:"projectId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDashboardOutput) GoString 

func (s DescribeDashboardOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDashboardOutput) SetDashboardArn 

func (s *DescribeDashboardOutput) SetDashboardArn(v string) *DescribeDashboardOutput

SetDashboardArn sets the DashboardArn field's value.

func (*DescribeDashboardOutput) SetDashboardCreationDate 

func (s *DescribeDashboardOutput) SetDashboardCreationDate(v time.Time) *DescribeDashboardOutput

SetDashboardCreationDate sets the DashboardCreationDate field's value.

func (*DescribeDashboardOutput) SetDashboardDefinition 

func (s *DescribeDashboardOutput) SetDashboardDefinition(v string) *DescribeDashboardOutput

SetDashboardDefinition sets the DashboardDefinition field's value.

func (*DescribeDashboardOutput) SetDashboardDescription 

func (s *DescribeDashboardOutput) SetDashboardDescription(v string) *DescribeDashboardOutput

SetDashboardDescription sets the DashboardDescription field's value.

func (*DescribeDashboardOutput) SetDashboardId 

func (s *DescribeDashboardOutput) SetDashboardId(v string) *DescribeDashboardOutput

SetDashboardId sets the DashboardId field's value.

func (*DescribeDashboardOutput) SetDashboardLastUpdateDate 

func (s *DescribeDashboardOutput) SetDashboardLastUpdateDate(v time.Time) *DescribeDashboardOutput

SetDashboardLastUpdateDate sets the DashboardLastUpdateDate field's value.

func (*DescribeDashboardOutput) SetDashboardName 

func (s *DescribeDashboardOutput) SetDashboardName(v string) *DescribeDashboardOutput

SetDashboardName sets the DashboardName field's value.

func (*DescribeDashboardOutput) SetProjectId 

func (s *DescribeDashboardOutput) SetProjectId(v string) *DescribeDashboardOutput

SetProjectId sets the ProjectId field's value.

func (DescribeDashboardOutput) String 

func (s DescribeDashboardOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDefaultEncryptionConfigurationInput added in v1.35.35 

type DescribeDefaultEncryptionConfigurationInput struct {
	// contains filtered or unexported fields
}

func (DescribeDefaultEncryptionConfigurationInput) GoString added in v1.35.35 

func (s DescribeDefaultEncryptionConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeDefaultEncryptionConfigurationInput) String added in v1.35.35 

func (s DescribeDefaultEncryptionConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeDefaultEncryptionConfigurationOutput added in v1.35.35 

type DescribeDefaultEncryptionConfigurationOutput struct {

	// The status of the account configuration. This contains the ConfigurationState.
	// If there's an error, it also contains the ErrorDetails.
	//
	// ConfigurationStatus is a required field
	ConfigurationStatus *ConfigurationStatus `locationName:"configurationStatus" type:"structure" required:"true"`

	// The type of encryption used for the encryption configuration.
	//
	// EncryptionType is a required field
	EncryptionType *string `locationName:"encryptionType" type:"string" required:"true" enum:"EncryptionType"`

	// The key ARN of the customer managed key used for KMS encryption if you use
	// KMS_BASED_ENCRYPTION.
	KmsKeyArn *string `locationName:"kmsKeyArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeDefaultEncryptionConfigurationOutput) GoString added in v1.35.35 

func (s DescribeDefaultEncryptionConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeDefaultEncryptionConfigurationOutput) SetConfigurationStatus added in v1.35.35 

func (s *DescribeDefaultEncryptionConfigurationOutput) SetConfigurationStatus(v *ConfigurationStatus) *DescribeDefaultEncryptionConfigurationOutput

SetConfigurationStatus sets the ConfigurationStatus field's value.

func (*DescribeDefaultEncryptionConfigurationOutput) SetEncryptionType added in v1.35.35 

func (s *DescribeDefaultEncryptionConfigurationOutput) SetEncryptionType(v string) *DescribeDefaultEncryptionConfigurationOutput

SetEncryptionType sets the EncryptionType field's value.

func (*DescribeDefaultEncryptionConfigurationOutput) SetKmsKeyArn added in v1.35.35 

func (s *DescribeDefaultEncryptionConfigurationOutput) SetKmsKeyArn(v string) *DescribeDefaultEncryptionConfigurationOutput

SetKmsKeyArn sets the KmsKeyArn field's value.

func (DescribeDefaultEncryptionConfigurationOutput) String added in v1.35.35 

func (s DescribeDefaultEncryptionConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGatewayCapabilityConfigurationInput 

type DescribeGatewayCapabilityConfigurationInput struct {

	// The namespace of the capability configuration. For example, if you configure
	// OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration
	// has the namespace iotsitewise:opcuacollector:version, where version is a
	// number such as 1.
	//
	// CapabilityNamespace is a required field
	CapabilityNamespace *string `location:"uri" locationName:"capabilityNamespace" min:"1" type:"string" required:"true"`

	// The ID of the gateway that defines the capability configuration.
	//
	// GatewayId is a required field
	GatewayId *string `location:"uri" locationName:"gatewayId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGatewayCapabilityConfigurationInput) GoString 

func (s DescribeGatewayCapabilityConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGatewayCapabilityConfigurationInput) SetCapabilityNamespace 

func (s *DescribeGatewayCapabilityConfigurationInput) SetCapabilityNamespace(v string) *DescribeGatewayCapabilityConfigurationInput

SetCapabilityNamespace sets the CapabilityNamespace field's value.

func (*DescribeGatewayCapabilityConfigurationInput) SetGatewayId 

func (s *DescribeGatewayCapabilityConfigurationInput) SetGatewayId(v string) *DescribeGatewayCapabilityConfigurationInput

SetGatewayId sets the GatewayId field's value.

func (DescribeGatewayCapabilityConfigurationInput) String 

func (s DescribeGatewayCapabilityConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGatewayCapabilityConfigurationInput) Validate 

func (s *DescribeGatewayCapabilityConfigurationInput) Validate() error

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

type DescribeGatewayCapabilityConfigurationOutput 

type DescribeGatewayCapabilityConfigurationOutput struct {

	// The JSON document that defines the gateway capability's configuration. For
	// more information, see Configuring data sources (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli)
	// in the IoT SiteWise User Guide.
	//
	// CapabilityConfiguration is a required field
	CapabilityConfiguration *string `locationName:"capabilityConfiguration" min:"1" type:"string" required:"true"`

	// The namespace of the gateway capability.
	//
	// CapabilityNamespace is a required field
	CapabilityNamespace *string `locationName:"capabilityNamespace" min:"1" type:"string" required:"true"`

	// The synchronization status of the capability configuration. The sync status
	// can be one of the following:
	//
	//    * IN_SYNC – The gateway is running the capability configuration.
	//
	//    * OUT_OF_SYNC – The gateway hasn't received the capability configuration.
	//
	//    * SYNC_FAILED – The gateway rejected the capability configuration.
	//
	// CapabilitySyncStatus is a required field
	CapabilitySyncStatus *string `locationName:"capabilitySyncStatus" type:"string" required:"true" enum:"CapabilitySyncStatus"`

	// The ID of the gateway that defines the capability configuration.
	//
	// GatewayId is a required field
	GatewayId *string `locationName:"gatewayId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGatewayCapabilityConfigurationOutput) GoString 

func (s DescribeGatewayCapabilityConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGatewayCapabilityConfigurationOutput) SetCapabilityConfiguration 

func (s *DescribeGatewayCapabilityConfigurationOutput) SetCapabilityConfiguration(v string) *DescribeGatewayCapabilityConfigurationOutput

SetCapabilityConfiguration sets the CapabilityConfiguration field's value.

func (*DescribeGatewayCapabilityConfigurationOutput) SetCapabilityNamespace 

func (s *DescribeGatewayCapabilityConfigurationOutput) SetCapabilityNamespace(v string) *DescribeGatewayCapabilityConfigurationOutput

SetCapabilityNamespace sets the CapabilityNamespace field's value.

func (*DescribeGatewayCapabilityConfigurationOutput) SetCapabilitySyncStatus 

func (s *DescribeGatewayCapabilityConfigurationOutput) SetCapabilitySyncStatus(v string) *DescribeGatewayCapabilityConfigurationOutput

SetCapabilitySyncStatus sets the CapabilitySyncStatus field's value.

func (*DescribeGatewayCapabilityConfigurationOutput) SetGatewayId 

func (s *DescribeGatewayCapabilityConfigurationOutput) SetGatewayId(v string) *DescribeGatewayCapabilityConfigurationOutput

SetGatewayId sets the GatewayId field's value.

func (DescribeGatewayCapabilityConfigurationOutput) String 

func (s DescribeGatewayCapabilityConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGatewayInput 

type DescribeGatewayInput struct {

	// The ID of the gateway device.
	//
	// GatewayId is a required field
	GatewayId *string `location:"uri" locationName:"gatewayId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGatewayInput) GoString 

func (s DescribeGatewayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGatewayInput) SetGatewayId 

func (s *DescribeGatewayInput) SetGatewayId(v string) *DescribeGatewayInput

SetGatewayId sets the GatewayId field's value.

func (DescribeGatewayInput) String 

func (s DescribeGatewayInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGatewayInput) Validate 

func (s *DescribeGatewayInput) Validate() error

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

type DescribeGatewayOutput 

type DescribeGatewayOutput struct {

	// The date the gateway was created, in Unix epoch time.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the gateway, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
	//
	// GatewayArn is a required field
	GatewayArn *string `locationName:"gatewayArn" min:"1" type:"string" required:"true"`

	// A list of gateway capability summaries that each contain a namespace and
	// status. Each gateway capability defines data sources for the gateway. To
	// retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html).
	//
	// GatewayCapabilitySummaries is a required field
	GatewayCapabilitySummaries []*GatewayCapabilitySummary `locationName:"gatewayCapabilitySummaries" type:"list" required:"true"`

	// The ID of the gateway device.
	//
	// GatewayId is a required field
	GatewayId *string `locationName:"gatewayId" min:"36" type:"string" required:"true"`

	// The name of the gateway.
	//
	// GatewayName is a required field
	GatewayName *string `locationName:"gatewayName" min:"1" type:"string" required:"true"`

	// The gateway's platform.
	GatewayPlatform *GatewayPlatform `locationName:"gatewayPlatform" type:"structure"`

	// The date the gateway was last updated, in Unix epoch time.
	//
	// LastUpdateDate is a required field
	LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGatewayOutput) GoString 

func (s DescribeGatewayOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeGatewayOutput) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*DescribeGatewayOutput) SetGatewayArn 

func (s *DescribeGatewayOutput) SetGatewayArn(v string) *DescribeGatewayOutput

SetGatewayArn sets the GatewayArn field's value.

func (*DescribeGatewayOutput) SetGatewayCapabilitySummaries 

func (s *DescribeGatewayOutput) SetGatewayCapabilitySummaries(v []*GatewayCapabilitySummary) *DescribeGatewayOutput

SetGatewayCapabilitySummaries sets the GatewayCapabilitySummaries field's value.

func (*DescribeGatewayOutput) SetGatewayId 

func (s *DescribeGatewayOutput) SetGatewayId(v string) *DescribeGatewayOutput

SetGatewayId sets the GatewayId field's value.

func (*DescribeGatewayOutput) SetGatewayName 

func (s *DescribeGatewayOutput) SetGatewayName(v string) *DescribeGatewayOutput

SetGatewayName sets the GatewayName field's value.

func (*DescribeGatewayOutput) SetGatewayPlatform 

func (s *DescribeGatewayOutput) SetGatewayPlatform(v *GatewayPlatform) *DescribeGatewayOutput

SetGatewayPlatform sets the GatewayPlatform field's value.

func (*DescribeGatewayOutput) SetLastUpdateDate 

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

SetLastUpdateDate sets the LastUpdateDate field's value.

func (DescribeGatewayOutput) String 

func (s DescribeGatewayOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLoggingOptionsInput 

type DescribeLoggingOptionsInput struct {
	// contains filtered or unexported fields
}

func (DescribeLoggingOptionsInput) GoString 

func (s DescribeLoggingOptionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeLoggingOptionsInput) String 

func (s DescribeLoggingOptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLoggingOptionsOutput 

type DescribeLoggingOptionsOutput struct {

	// The current logging options.
	//
	// LoggingOptions is a required field
	LoggingOptions *LoggingOptions `locationName:"loggingOptions" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeLoggingOptionsOutput) GoString 

func (s DescribeLoggingOptionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoggingOptionsOutput) SetLoggingOptions 

func (s *DescribeLoggingOptionsOutput) SetLoggingOptions(v *LoggingOptions) *DescribeLoggingOptionsOutput

SetLoggingOptions sets the LoggingOptions field's value.

func (DescribeLoggingOptionsOutput) String 

func (s DescribeLoggingOptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribePortalInput 

type DescribePortalInput struct {

	// The ID of the portal.
	//
	// PortalId is a required field
	PortalId *string `location:"uri" locationName:"portalId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribePortalInput) GoString 

func (s DescribePortalInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePortalInput) SetPortalId 

func (s *DescribePortalInput) SetPortalId(v string) *DescribePortalInput

SetPortalId sets the PortalId field's value.

func (DescribePortalInput) String 

func (s DescribePortalInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePortalInput) Validate 

func (s *DescribePortalInput) Validate() error

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

type DescribePortalOutput 

type DescribePortalOutput struct {

	// Contains the configuration information of an alarm created in an IoT SiteWise
	// Monitor portal.
	Alarms *Alarms `locationName:"alarms" type:"structure"`

	// The email address that sends alarm notifications.
	NotificationSenderEmail *string `locationName:"notificationSenderEmail" min:"1" type:"string"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the portal, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
	//
	// PortalArn is a required field
	PortalArn *string `locationName:"portalArn" min:"1" type:"string" required:"true"`

	// The service to use to authenticate users to the portal.
	PortalAuthMode *string `locationName:"portalAuthMode" type:"string" enum:"AuthMode"`

	// The IAM Identity Center application generated client ID (used with IAM Identity
	// Center API operations). IoT SiteWise includes portalClientId for only portals
	// that use IAM Identity Center to authenticate users.
	//
	// PortalClientId is a required field
	PortalClientId *string `locationName:"portalClientId" min:"1" type:"string" required:"true"`

	// The Amazon Web Services administrator's contact email address.
	//
	// PortalContactEmail is a required field
	PortalContactEmail *string `locationName:"portalContactEmail" min:"1" type:"string" required:"true"`

	// The date the portal was created, in Unix epoch time.
	//
	// PortalCreationDate is a required field
	PortalCreationDate *time.Time `locationName:"portalCreationDate" type:"timestamp" required:"true"`

	// The portal's description.
	PortalDescription *string `locationName:"portalDescription" min:"1" type:"string"`

	// The ID of the portal.
	//
	// PortalId is a required field
	PortalId *string `locationName:"portalId" min:"36" type:"string" required:"true"`

	// The date the portal was last updated, in Unix epoch time.
	//
	// PortalLastUpdateDate is a required field
	PortalLastUpdateDate *time.Time `locationName:"portalLastUpdateDate" type:"timestamp" required:"true"`

	// The portal's logo image, which is available at a URL.
	PortalLogoImageLocation *ImageLocation `locationName:"portalLogoImageLocation" type:"structure"`

	// The name of the portal.
	//
	// PortalName is a required field
	PortalName *string `locationName:"portalName" min:"1" type:"string" required:"true"`

	// The URL for the IoT SiteWise Monitor portal. You can use this URL to access
	// portals that use IAM Identity Center for authentication. For portals that
	// use IAM for authentication, you must use the IoT SiteWise console to get
	// a URL that you can use to access the portal.
	//
	// PortalStartUrl is a required field
	PortalStartUrl *string `locationName:"portalStartUrl" min:"1" type:"string" required:"true"`

	// The current status of the portal, which contains a state and any error message.
	//
	// PortalStatus is a required field
	PortalStatus *PortalStatus `locationName:"portalStatus" type:"structure" required:"true"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the service role that allows the portal's users to access your IoT SiteWise
	// resources on your behalf. For more information, see Using service roles for
	// IoT SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html)
	// in the IoT SiteWise User Guide.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribePortalOutput) GoString 

func (s DescribePortalOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribePortalOutput) SetAlarms added in v1.38.50 

func (s *DescribePortalOutput) SetAlarms(v *Alarms) *DescribePortalOutput

SetAlarms sets the Alarms field's value.

func (*DescribePortalOutput) SetNotificationSenderEmail added in v1.38.50 

func (s *DescribePortalOutput) SetNotificationSenderEmail(v string) *DescribePortalOutput

SetNotificationSenderEmail sets the NotificationSenderEmail field's value.

func (*DescribePortalOutput) SetPortalArn 

func (s *DescribePortalOutput) SetPortalArn(v string) *DescribePortalOutput

SetPortalArn sets the PortalArn field's value.

func (*DescribePortalOutput) SetPortalAuthMode added in v1.34.28 

func (s *DescribePortalOutput) SetPortalAuthMode(v string) *DescribePortalOutput

SetPortalAuthMode sets the PortalAuthMode field's value.

func (*DescribePortalOutput) SetPortalClientId 

func (s *DescribePortalOutput) SetPortalClientId(v string) *DescribePortalOutput

SetPortalClientId sets the PortalClientId field's value.

func (*DescribePortalOutput) SetPortalContactEmail 

func (s *DescribePortalOutput) SetPortalContactEmail(v string) *DescribePortalOutput

SetPortalContactEmail sets the PortalContactEmail field's value.

func (*DescribePortalOutput) SetPortalCreationDate 

func (s *DescribePortalOutput) SetPortalCreationDate(v time.Time) *DescribePortalOutput

SetPortalCreationDate sets the PortalCreationDate field's value.

func (*DescribePortalOutput) SetPortalDescription 

func (s *DescribePortalOutput) SetPortalDescription(v string) *DescribePortalOutput

SetPortalDescription sets the PortalDescription field's value.

func (*DescribePortalOutput) SetPortalId 

func (s *DescribePortalOutput) SetPortalId(v string) *DescribePortalOutput

SetPortalId sets the PortalId field's value.

func (*DescribePortalOutput) SetPortalLastUpdateDate 

func (s *DescribePortalOutput) SetPortalLastUpdateDate(v time.Time) *DescribePortalOutput

SetPortalLastUpdateDate sets the PortalLastUpdateDate field's value.

func (*DescribePortalOutput) SetPortalLogoImageLocation added in v1.31.4 

func (s *DescribePortalOutput) SetPortalLogoImageLocation(v *ImageLocation) *DescribePortalOutput

SetPortalLogoImageLocation sets the PortalLogoImageLocation field's value.

func (*DescribePortalOutput) SetPortalName 

func (s *DescribePortalOutput) SetPortalName(v string) *DescribePortalOutput

SetPortalName sets the PortalName field's value.

func (*DescribePortalOutput) SetPortalStartUrl 

func (s *DescribePortalOutput) SetPortalStartUrl(v string) *DescribePortalOutput

SetPortalStartUrl sets the PortalStartUrl field's value.

func (*DescribePortalOutput) SetPortalStatus 

func (s *DescribePortalOutput) SetPortalStatus(v *PortalStatus) *DescribePortalOutput

SetPortalStatus sets the PortalStatus field's value.

func (*DescribePortalOutput) SetRoleArn 

func (s *DescribePortalOutput) SetRoleArn(v string) *DescribePortalOutput

SetRoleArn sets the RoleArn field's value.

func (DescribePortalOutput) String 

func (s DescribePortalOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeProjectInput 

type DescribeProjectInput struct {

	// The ID of the project.
	//
	// ProjectId is a required field
	ProjectId *string `location:"uri" locationName:"projectId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeProjectInput) GoString 

func (s DescribeProjectInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProjectInput) SetProjectId 

func (s *DescribeProjectInput) SetProjectId(v string) *DescribeProjectInput

SetProjectId sets the ProjectId field's value.

func (DescribeProjectInput) String 

func (s DescribeProjectInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProjectInput) Validate 

func (s *DescribeProjectInput) Validate() error

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

type DescribeProjectOutput 

type DescribeProjectOutput struct {

	// The ID of the portal that the project is in.
	//
	// PortalId is a required field
	PortalId *string `locationName:"portalId" min:"36" type:"string" required:"true"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the project, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
	//
	// ProjectArn is a required field
	ProjectArn *string `locationName:"projectArn" min:"1" type:"string" required:"true"`

	// The date the project was created, in Unix epoch time.
	//
	// ProjectCreationDate is a required field
	ProjectCreationDate *time.Time `locationName:"projectCreationDate" type:"timestamp" required:"true"`

	// The project's description.
	ProjectDescription *string `locationName:"projectDescription" min:"1" type:"string"`

	// The ID of the project.
	//
	// ProjectId is a required field
	ProjectId *string `locationName:"projectId" min:"36" type:"string" required:"true"`

	// The date the project was last updated, in Unix epoch time.
	//
	// ProjectLastUpdateDate is a required field
	ProjectLastUpdateDate *time.Time `locationName:"projectLastUpdateDate" type:"timestamp" required:"true"`

	// The name of the project.
	//
	// ProjectName is a required field
	ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeProjectOutput) GoString 

func (s DescribeProjectOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProjectOutput) SetPortalId 

func (s *DescribeProjectOutput) SetPortalId(v string) *DescribeProjectOutput

SetPortalId sets the PortalId field's value.

func (*DescribeProjectOutput) SetProjectArn 

func (s *DescribeProjectOutput) SetProjectArn(v string) *DescribeProjectOutput

SetProjectArn sets the ProjectArn field's value.

func (*DescribeProjectOutput) SetProjectCreationDate 

func (s *DescribeProjectOutput) SetProjectCreationDate(v time.Time) *DescribeProjectOutput

SetProjectCreationDate sets the ProjectCreationDate field's value.

func (*DescribeProjectOutput) SetProjectDescription 

func (s *DescribeProjectOutput) SetProjectDescription(v string) *DescribeProjectOutput

SetProjectDescription sets the ProjectDescription field's value.

func (*DescribeProjectOutput) SetProjectId 

func (s *DescribeProjectOutput) SetProjectId(v string) *DescribeProjectOutput

SetProjectId sets the ProjectId field's value.

func (*DescribeProjectOutput) SetProjectLastUpdateDate 

func (s *DescribeProjectOutput) SetProjectLastUpdateDate(v time.Time) *DescribeProjectOutput

SetProjectLastUpdateDate sets the ProjectLastUpdateDate field's value.

func (*DescribeProjectOutput) SetProjectName 

func (s *DescribeProjectOutput) SetProjectName(v string) *DescribeProjectOutput

SetProjectName sets the ProjectName field's value.

func (DescribeProjectOutput) String 

func (s DescribeProjectOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStorageConfigurationInput added in v1.39.2 

type DescribeStorageConfigurationInput struct {
	// contains filtered or unexported fields
}

func (DescribeStorageConfigurationInput) GoString added in v1.39.2 

func (s DescribeStorageConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeStorageConfigurationInput) String added in v1.39.2 

func (s DescribeStorageConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeStorageConfigurationOutput added in v1.39.2 

type DescribeStorageConfigurationOutput struct {

	// Contains current status information for the configuration.
	//
	// ConfigurationStatus is a required field
	ConfigurationStatus *ConfigurationStatus `locationName:"configurationStatus" type:"structure" required:"true"`

	// Contains the storage configuration for time series (data streams) that aren't
	// associated with asset properties. The disassociatedDataStorage can be one
	// of the following values:
	//
	//    * ENABLED – IoT SiteWise accepts time series that aren't associated
	//    with asset properties. After the disassociatedDataStorage is enabled,
	//    you can't disable it.
	//
	//    * DISABLED – IoT SiteWise doesn't accept time series (data streams)
	//    that aren't associated with asset properties.
	//
	// For more information, see Data streams (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html)
	// in the IoT SiteWise User Guide.
	DisassociatedDataStorage *string `locationName:"disassociatedDataStorage" type:"string" enum:"DisassociatedDataStorageState"`

	// The date the storage configuration was last updated, in Unix epoch time.
	LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp"`

	// Contains information about the storage destination.
	MultiLayerStorage *MultiLayerStorage `locationName:"multiLayerStorage" type:"structure"`

	// The number of days your data is kept in the hot tier. By default, your data
	// is kept indefinitely in the hot tier.
	RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`

	// The storage tier that you specified for your data. The storageType parameter
	// can be one of the following values:
	//
	//    * SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot
	//    tier. The hot tier is a service-managed database.
	//
	//    * MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold
	//    tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
	//
	// StorageType is a required field
	StorageType *string `locationName:"storageType" type:"string" required:"true" enum:"StorageType"`

	// A service managed storage tier optimized for analytical queries. It stores
	// periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob
	// API.
	WarmTier *string `locationName:"warmTier" type:"string" enum:"WarmTierState"`

	// Set this period to specify how long your data is stored in the warm tier
	// before it is deleted. You can set this only if cold tier is enabled.
	WarmTierRetentionPeriod *WarmTierRetentionPeriod `locationName:"warmTierRetentionPeriod" type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeStorageConfigurationOutput) GoString added in v1.39.2 

func (s DescribeStorageConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeStorageConfigurationOutput) SetConfigurationStatus added in v1.39.2 

func (s *DescribeStorageConfigurationOutput) SetConfigurationStatus(v *ConfigurationStatus) *DescribeStorageConfigurationOutput

SetConfigurationStatus sets the ConfigurationStatus field's value.

func (*DescribeStorageConfigurationOutput) SetDisassociatedDataStorage added in v1.42.12 

func (s *DescribeStorageConfigurationOutput) SetDisassociatedDataStorage(v string) *DescribeStorageConfigurationOutput

SetDisassociatedDataStorage sets the DisassociatedDataStorage field's value.

func (*DescribeStorageConfigurationOutput) SetLastUpdateDate added in v1.39.2 

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

SetLastUpdateDate sets the LastUpdateDate field's value.

func (*DescribeStorageConfigurationOutput) SetMultiLayerStorage added in v1.39.2 

func (s *DescribeStorageConfigurationOutput) SetMultiLayerStorage(v *MultiLayerStorage) *DescribeStorageConfigurationOutput

SetMultiLayerStorage sets the MultiLayerStorage field's value.

func (*DescribeStorageConfigurationOutput) SetRetentionPeriod added in v1.42.15 

func (s *DescribeStorageConfigurationOutput) SetRetentionPeriod(v *RetentionPeriod) *DescribeStorageConfigurationOutput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*DescribeStorageConfigurationOutput) SetStorageType added in v1.39.2 

func (s *DescribeStorageConfigurationOutput) SetStorageType(v string) *DescribeStorageConfigurationOutput

SetStorageType sets the StorageType field's value.

func (*DescribeStorageConfigurationOutput) SetWarmTier added in v1.48.2 

func (s *DescribeStorageConfigurationOutput) SetWarmTier(v string) *DescribeStorageConfigurationOutput

SetWarmTier sets the WarmTier field's value.

func (*DescribeStorageConfigurationOutput) SetWarmTierRetentionPeriod added in v1.48.2 

func (s *DescribeStorageConfigurationOutput) SetWarmTierRetentionPeriod(v *WarmTierRetentionPeriod) *DescribeStorageConfigurationOutput

SetWarmTierRetentionPeriod sets the WarmTierRetentionPeriod field's value.

func (DescribeStorageConfigurationOutput) String added in v1.39.2 

func (s DescribeStorageConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeTimeSeriesInput added in v1.42.12 

type DescribeTimeSeriesInput struct {

	// The alias that identifies the time series.
	Alias *string `location:"querystring" locationName:"alias" min:"1" type:"string"`

	// The ID of the asset in which the asset property was created. This can be
	// either the actual ID in UUID format, or else externalId: followed by the
	// external ID, if it has one. For more information, see Referencing objects
	// with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	AssetId *string `location:"querystring" locationName:"assetId" min:"13" type:"string"`

	// The ID of the asset property. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	PropertyId *string `location:"querystring" locationName:"propertyId" min:"13" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeTimeSeriesInput) GoString added in v1.42.12 

func (s DescribeTimeSeriesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTimeSeriesInput) SetAlias added in v1.42.12 

func (s *DescribeTimeSeriesInput) SetAlias(v string) *DescribeTimeSeriesInput

SetAlias sets the Alias field's value.

func (*DescribeTimeSeriesInput) SetAssetId added in v1.42.12 

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

SetAssetId sets the AssetId field's value.

func (*DescribeTimeSeriesInput) SetPropertyId added in v1.42.12 

func (s *DescribeTimeSeriesInput) SetPropertyId(v string) *DescribeTimeSeriesInput

SetPropertyId sets the PropertyId field's value.

func (DescribeTimeSeriesInput) String added in v1.42.12 

func (s DescribeTimeSeriesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTimeSeriesInput) Validate added in v1.42.12 

func (s *DescribeTimeSeriesInput) Validate() error

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

type DescribeTimeSeriesOutput added in v1.42.12 

type DescribeTimeSeriesOutput struct {

	// The alias that identifies the time series.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// The ID of the asset in which the asset property was created.
	AssetId *string `locationName:"assetId" min:"36" type:"string"`

	// The data type of the time series.
	//
	// If you specify STRUCT, you must also specify dataTypeSpec to identify the
	// type of the structure for this time series.
	//
	// DataType is a required field
	DataType *string `locationName:"dataType" type:"string" required:"true" enum:"PropertyDataType"`

	// The data type of the structure for this time series. This parameter is required
	// for time series that have the STRUCT data type.
	//
	// The options for this parameter depend on the type of the composite model
	// in which you created the asset property that is associated with your time
	// series. Use AWS/ALARM_STATE for alarm state in alarm composite models.
	DataTypeSpec *string `locationName:"dataTypeSpec" min:"1" type:"string"`

	// The ID of the asset property, in UUID format.
	PropertyId *string `locationName:"propertyId" min:"36" type:"string"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the time series, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
	//
	// TimeSeriesArn is a required field
	TimeSeriesArn *string `locationName:"timeSeriesArn" min:"1" type:"string" required:"true"`

	// The date that the time series was created, in Unix epoch time.
	//
	// TimeSeriesCreationDate is a required field
	TimeSeriesCreationDate *time.Time `locationName:"timeSeriesCreationDate" type:"timestamp" required:"true"`

	// The ID of the time series.
	//
	// TimeSeriesId is a required field
	TimeSeriesId *string `locationName:"timeSeriesId" min:"36" type:"string" required:"true"`

	// The date that the time series was last updated, in Unix epoch time.
	//
	// TimeSeriesLastUpdateDate is a required field
	TimeSeriesLastUpdateDate *time.Time `locationName:"timeSeriesLastUpdateDate" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTimeSeriesOutput) GoString added in v1.42.12 

func (s DescribeTimeSeriesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeTimeSeriesOutput) SetAlias added in v1.42.12 

func (s *DescribeTimeSeriesOutput) SetAlias(v string) *DescribeTimeSeriesOutput

SetAlias sets the Alias field's value.

func (*DescribeTimeSeriesOutput) SetAssetId added in v1.42.12 

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

SetAssetId sets the AssetId field's value.

func (*DescribeTimeSeriesOutput) SetDataType added in v1.42.12 

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

SetDataType sets the DataType field's value.

func (*DescribeTimeSeriesOutput) SetDataTypeSpec added in v1.42.12 

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

SetDataTypeSpec sets the DataTypeSpec field's value.

func (*DescribeTimeSeriesOutput) SetPropertyId added in v1.42.12 

func (s *DescribeTimeSeriesOutput) SetPropertyId(v string) *DescribeTimeSeriesOutput

SetPropertyId sets the PropertyId field's value.

func (*DescribeTimeSeriesOutput) SetTimeSeriesArn added in v1.44.226 

func (s *DescribeTimeSeriesOutput) SetTimeSeriesArn(v string) *DescribeTimeSeriesOutput

SetTimeSeriesArn sets the TimeSeriesArn field's value.

func (*DescribeTimeSeriesOutput) SetTimeSeriesCreationDate added in v1.42.12 

func (s *DescribeTimeSeriesOutput) SetTimeSeriesCreationDate(v time.Time) *DescribeTimeSeriesOutput

SetTimeSeriesCreationDate sets the TimeSeriesCreationDate field's value.

func (*DescribeTimeSeriesOutput) SetTimeSeriesId added in v1.42.12 

func (s *DescribeTimeSeriesOutput) SetTimeSeriesId(v string) *DescribeTimeSeriesOutput

SetTimeSeriesId sets the TimeSeriesId field's value.

func (*DescribeTimeSeriesOutput) SetTimeSeriesLastUpdateDate added in v1.42.12 

func (s *DescribeTimeSeriesOutput) SetTimeSeriesLastUpdateDate(v time.Time) *DescribeTimeSeriesOutput

SetTimeSeriesLastUpdateDate sets the TimeSeriesLastUpdateDate field's value.

func (DescribeTimeSeriesOutput) String added in v1.42.12 

func (s DescribeTimeSeriesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DetailedError added in v1.40.11 

type DetailedError struct {

	// The error code.
	//
	// Code is a required field
	Code *string `locationName:"code" type:"string" required:"true" enum:"DetailedErrorCode"`

	// The error message.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains detailed error information.

func (DetailedError) GoString added in v1.40.11 

func (s DetailedError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DetailedError) SetCode added in v1.40.11 

func (s *DetailedError) SetCode(v string) *DetailedError

SetCode sets the Code field's value.

func (*DetailedError) SetMessage added in v1.40.11 

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

SetMessage sets the Message field's value.

func (DetailedError) String added in v1.40.11 

func (s DetailedError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateAssetsInput 

type DisassociateAssetsInput struct {

	// The ID of the parent asset from which to disassociate the child asset. This
	// can be either the actual ID in UUID format, or else externalId: followed
	// by the external ID, if it has one. For more information, see Referencing
	// objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"uri" locationName:"assetId" min:"13" type:"string" required:"true"`

	// The ID of the child asset to disassociate. This can be either the actual
	// ID in UUID format, or else externalId: followed by the external ID, if it
	// has one. For more information, see Referencing objects with external IDs
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// ChildAssetId is a required field
	ChildAssetId *string `locationName:"childAssetId" min:"13" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The ID of a hierarchy in the parent asset's model. (This can be either the
	// actual ID in UUID format, or else externalId: followed by the external ID,
	// if it has one. For more information, see Referencing objects with external
	// IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.) Hierarchies allow different groupings of
	// assets to be formed that all come from the same asset model. You can use
	// the hierarchy ID to identify the correct asset to disassociate. For more
	// information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html)
	// in the IoT SiteWise User Guide.
	//
	// HierarchyId is a required field
	HierarchyId *string `locationName:"hierarchyId" min:"13" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateAssetsInput) GoString 

func (s DisassociateAssetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateAssetsInput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*DisassociateAssetsInput) SetChildAssetId 

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

SetChildAssetId sets the ChildAssetId field's value.

func (*DisassociateAssetsInput) SetClientToken 

func (s *DisassociateAssetsInput) SetClientToken(v string) *DisassociateAssetsInput

SetClientToken sets the ClientToken field's value.

func (*DisassociateAssetsInput) SetHierarchyId 

func (s *DisassociateAssetsInput) SetHierarchyId(v string) *DisassociateAssetsInput

SetHierarchyId sets the HierarchyId field's value.

func (DisassociateAssetsInput) String 

func (s DisassociateAssetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateAssetsInput) Validate 

func (s *DisassociateAssetsInput) Validate() error

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

type DisassociateAssetsOutput 

type DisassociateAssetsOutput struct {
	// contains filtered or unexported fields
}

func (DisassociateAssetsOutput) GoString 

func (s DisassociateAssetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateAssetsOutput) String 

func (s DisassociateAssetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateTimeSeriesFromAssetPropertyInput added in v1.42.12 

type DisassociateTimeSeriesFromAssetPropertyInput struct {

	// The alias that identifies the time series.
	//
	// Alias is a required field
	Alias *string `location:"querystring" locationName:"alias" min:"1" type:"string" required:"true"`

	// The ID of the asset in which the asset property was created. This can be
	// either the actual ID in UUID format, or else externalId: followed by the
	// external ID, if it has one. For more information, see Referencing objects
	// with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"querystring" locationName:"assetId" min:"13" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The ID of the asset property. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// PropertyId is a required field
	PropertyId *string `location:"querystring" locationName:"propertyId" min:"13" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateTimeSeriesFromAssetPropertyInput) GoString added in v1.42.12 

func (s DisassociateTimeSeriesFromAssetPropertyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateTimeSeriesFromAssetPropertyInput) SetAlias added in v1.42.12 

func (s *DisassociateTimeSeriesFromAssetPropertyInput) SetAlias(v string) *DisassociateTimeSeriesFromAssetPropertyInput

SetAlias sets the Alias field's value.

func (*DisassociateTimeSeriesFromAssetPropertyInput) SetAssetId added in v1.42.12 

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

SetAssetId sets the AssetId field's value.

func (*DisassociateTimeSeriesFromAssetPropertyInput) SetClientToken added in v1.42.12 

func (s *DisassociateTimeSeriesFromAssetPropertyInput) SetClientToken(v string) *DisassociateTimeSeriesFromAssetPropertyInput

SetClientToken sets the ClientToken field's value.

func (*DisassociateTimeSeriesFromAssetPropertyInput) SetPropertyId added in v1.42.12 

func (s *DisassociateTimeSeriesFromAssetPropertyInput) SetPropertyId(v string) *DisassociateTimeSeriesFromAssetPropertyInput

SetPropertyId sets the PropertyId field's value.

func (DisassociateTimeSeriesFromAssetPropertyInput) String added in v1.42.12 

func (s DisassociateTimeSeriesFromAssetPropertyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateTimeSeriesFromAssetPropertyInput) Validate added in v1.42.12 

func (s *DisassociateTimeSeriesFromAssetPropertyInput) Validate() error

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

type DisassociateTimeSeriesFromAssetPropertyOutput added in v1.42.12 

type DisassociateTimeSeriesFromAssetPropertyOutput struct {
	// contains filtered or unexported fields
}

func (DisassociateTimeSeriesFromAssetPropertyOutput) GoString added in v1.42.12 

func (s DisassociateTimeSeriesFromAssetPropertyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateTimeSeriesFromAssetPropertyOutput) String added in v1.42.12 

func (s DisassociateTimeSeriesFromAssetPropertyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ErrorDetails 

type ErrorDetails struct {

	// The error code.
	//
	// Code is a required field
	Code *string `locationName:"code" type:"string" required:"true" enum:"ErrorCode"`

	// A list of detailed errors.
	Details []*DetailedError `locationName:"details" type:"list"`

	// The error message.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the details of an IoT SiteWise error.

func (ErrorDetails) GoString 

func (s ErrorDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ErrorDetails) SetCode 

func (s *ErrorDetails) SetCode(v string) *ErrorDetails

SetCode sets the Code field's value.

func (*ErrorDetails) SetDetails added in v1.40.11 

func (s *ErrorDetails) SetDetails(v []*DetailedError) *ErrorDetails

SetDetails sets the Details field's value.

func (*ErrorDetails) SetMessage 

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

SetMessage sets the Message field's value.

func (ErrorDetails) String 

func (s ErrorDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ErrorReportLocation added in v1.44.60 

type ErrorReportLocation struct {

	// The name of the Amazon S3 bucket to which errors associated with the bulk
	// import job are sent.
	//
	// Bucket is a required field
	Bucket *string `locationName:"bucket" min:"3" type:"string" required:"true"`

	// Amazon S3 uses the prefix as a folder name to organize data in the bucket.
	// Each Amazon S3 object has a key that is its unique identifier in the bucket.
	// Each object in a bucket has exactly one key. The prefix must end with a forward
	// slash (/). For more information, see Organizing objects using prefixes (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html)
	// in the Amazon Simple Storage Service User Guide.
	//
	// Prefix is a required field
	Prefix *string `locationName:"prefix" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The Amazon S3 destination where errors associated with the job creation request are saved.

func (ErrorReportLocation) GoString added in v1.44.60 

func (s ErrorReportLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ErrorReportLocation) SetBucket added in v1.44.60 

func (s *ErrorReportLocation) SetBucket(v string) *ErrorReportLocation

SetBucket sets the Bucket field's value.

func (*ErrorReportLocation) SetPrefix added in v1.44.60 

func (s *ErrorReportLocation) SetPrefix(v string) *ErrorReportLocation

SetPrefix sets the Prefix field's value.

func (ErrorReportLocation) String added in v1.44.60 

func (s ErrorReportLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ErrorReportLocation) Validate added in v1.44.60 

func (s *ErrorReportLocation) Validate() error

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

type ExecuteActionInput added in v1.48.2 

type ExecuteActionInput struct {

	// The ID of the action definition.
	//
	// ActionDefinitionId is a required field
	ActionDefinitionId *string `locationName:"actionDefinitionId" min:"36" type:"string" required:"true"`

	// The JSON payload of the action.
	//
	// ActionPayload is a required field
	ActionPayload *ActionPayload `locationName:"actionPayload" type:"structure" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string"`

	// The resource the action will be taken on.
	//
	// TargetResource is a required field
	TargetResource *TargetResource `locationName:"targetResource" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ExecuteActionInput) GoString added in v1.48.2 

func (s ExecuteActionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteActionInput) SetActionDefinitionId added in v1.48.2 

func (s *ExecuteActionInput) SetActionDefinitionId(v string) *ExecuteActionInput

SetActionDefinitionId sets the ActionDefinitionId field's value.

func (*ExecuteActionInput) SetActionPayload added in v1.48.2 

func (s *ExecuteActionInput) SetActionPayload(v *ActionPayload) *ExecuteActionInput

SetActionPayload sets the ActionPayload field's value.

func (*ExecuteActionInput) SetClientToken added in v1.48.2 

func (s *ExecuteActionInput) SetClientToken(v string) *ExecuteActionInput

SetClientToken sets the ClientToken field's value.

func (*ExecuteActionInput) SetTargetResource added in v1.48.2 

func (s *ExecuteActionInput) SetTargetResource(v *TargetResource) *ExecuteActionInput

SetTargetResource sets the TargetResource field's value.

func (ExecuteActionInput) String added in v1.48.2 

func (s ExecuteActionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteActionInput) Validate added in v1.48.2 

func (s *ExecuteActionInput) Validate() error

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

type ExecuteActionOutput added in v1.48.2 

type ExecuteActionOutput struct {

	// The ID of the action.
	//
	// ActionId is a required field
	ActionId *string `locationName:"actionId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExecuteActionOutput) GoString added in v1.48.2 

func (s ExecuteActionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteActionOutput) SetActionId added in v1.48.2 

func (s *ExecuteActionOutput) SetActionId(v string) *ExecuteActionOutput

SetActionId sets the ActionId field's value.

func (ExecuteActionOutput) String added in v1.48.2 

func (s ExecuteActionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExecuteQueryInput added in v1.48.2 

type ExecuteQueryInput struct {

	// The maximum number of results to return at one time. The default is 25.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The IoT SiteWise query statement.
	//
	// QueryStatement is a required field
	QueryStatement *string `locationName:"queryStatement" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExecuteQueryInput) GoString added in v1.48.2 

func (s ExecuteQueryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteQueryInput) SetMaxResults added in v1.48.2 

func (s *ExecuteQueryInput) SetMaxResults(v int64) *ExecuteQueryInput

SetMaxResults sets the MaxResults field's value.

func (*ExecuteQueryInput) SetNextToken added in v1.48.2 

func (s *ExecuteQueryInput) SetNextToken(v string) *ExecuteQueryInput

SetNextToken sets the NextToken field's value.

func (*ExecuteQueryInput) SetQueryStatement added in v1.48.2 

func (s *ExecuteQueryInput) SetQueryStatement(v string) *ExecuteQueryInput

SetQueryStatement sets the QueryStatement field's value.

func (ExecuteQueryInput) String added in v1.48.2 

func (s ExecuteQueryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteQueryInput) Validate added in v1.48.2 

func (s *ExecuteQueryInput) Validate() error

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

type ExecuteQueryOutput added in v1.48.2 

type ExecuteQueryOutput struct {

	// Represents a single column in the query results.
	Columns []*ColumnInfo `locationName:"columns" type:"list"`

	// The string that specifies the next page of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// Represents a single row in the query results.
	Rows []*Row `locationName:"rows" type:"list"`
	// contains filtered or unexported fields
}

func (ExecuteQueryOutput) GoString added in v1.48.2 

func (s ExecuteQueryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExecuteQueryOutput) SetColumns added in v1.48.2 

func (s *ExecuteQueryOutput) SetColumns(v []*ColumnInfo) *ExecuteQueryOutput

SetColumns sets the Columns field's value.

func (*ExecuteQueryOutput) SetNextToken added in v1.48.2 

func (s *ExecuteQueryOutput) SetNextToken(v string) *ExecuteQueryOutput

SetNextToken sets the NextToken field's value.

func (*ExecuteQueryOutput) SetRows added in v1.48.2 

func (s *ExecuteQueryOutput) SetRows(v []*Row) *ExecuteQueryOutput

SetRows sets the Rows field's value.

func (ExecuteQueryOutput) String added in v1.48.2 

func (s ExecuteQueryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExpressionVariable 

type ExpressionVariable struct {

	// The friendly name of the variable to be used in the expression.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The variable that identifies an asset property from which to use values.
	//
	// Value is a required field
	Value *VariableValue `locationName:"value" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains expression variable information.

func (ExpressionVariable) GoString 

func (s ExpressionVariable) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpressionVariable) SetName 

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

SetName sets the Name field's value.

func (*ExpressionVariable) SetValue 

func (s *ExpressionVariable) SetValue(v *VariableValue) *ExpressionVariable

SetValue sets the Value field's value.

func (ExpressionVariable) String 

func (s ExpressionVariable) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExpressionVariable) Validate 

func (s *ExpressionVariable) Validate() error

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

type File added in v1.44.60 

type File struct {

	// The name of the Amazon S3 bucket from which data is imported.
	//
	// Bucket is a required field
	Bucket *string `locationName:"bucket" min:"3" type:"string" required:"true"`

	// The key of the Amazon S3 object that contains your data. Each object has
	// a key that is a unique identifier. Each object has exactly one key.
	//
	// Key is a required field
	Key *string `locationName:"key" type:"string" required:"true"`

	// The version ID to identify a specific version of the Amazon S3 object that
	// contains your data.
	VersionId *string `locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

The file in Amazon S3 where your data is saved.

func (File) GoString added in v1.44.60 

func (s File) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*File) SetBucket added in v1.44.60 

func (s *File) SetBucket(v string) *File

SetBucket sets the Bucket field's value.

func (*File) SetKey added in v1.44.60 

func (s *File) SetKey(v string) *File

SetKey sets the Key field's value.

func (*File) SetVersionId added in v1.44.60 

func (s *File) SetVersionId(v string) *File

SetVersionId sets the VersionId field's value.

func (File) String added in v1.44.60 

func (s File) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*File) Validate added in v1.44.60 

func (s *File) Validate() error

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

type FileFormat added in v1.44.60 

type FileFormat struct {

	// The file is in .CSV format.
	Csv *Csv `locationName:"csv" type:"structure"`

	// The file is in parquet format.
	Parquet *Parquet `locationName:"parquet" type:"structure"`
	// contains filtered or unexported fields
}

The file format of the data in S3.

func (FileFormat) GoString added in v1.44.60 

func (s FileFormat) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileFormat) SetCsv added in v1.44.60 

func (s *FileFormat) SetCsv(v *Csv) *FileFormat

SetCsv sets the Csv field's value.

func (*FileFormat) SetParquet added in v1.48.2 

func (s *FileFormat) SetParquet(v *Parquet) *FileFormat

SetParquet sets the Parquet field's value.

func (FileFormat) String added in v1.44.60 

func (s FileFormat) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FileFormat) Validate added in v1.48.2 

func (s *FileFormat) Validate() error

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

type ForwardingConfig added in v1.40.11 

type ForwardingConfig struct {

	// The forwarding state for the given property.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"ForwardingConfigState"`
	// contains filtered or unexported fields
}

The forwarding configuration for a given property.

func (ForwardingConfig) GoString added in v1.40.11 

func (s ForwardingConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForwardingConfig) SetState added in v1.40.11 

func (s *ForwardingConfig) SetState(v string) *ForwardingConfig

SetState sets the State field's value.

func (ForwardingConfig) String added in v1.40.11 

func (s ForwardingConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ForwardingConfig) Validate added in v1.40.11 

func (s *ForwardingConfig) Validate() error

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

type GatewayCapabilitySummary 

type GatewayCapabilitySummary struct {

	// The namespace of the capability configuration. For example, if you configure
	// OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration
	// has the namespace iotsitewise:opcuacollector:version, where version is a
	// number such as 1.
	//
	// CapabilityNamespace is a required field
	CapabilityNamespace *string `locationName:"capabilityNamespace" min:"1" type:"string" required:"true"`

	// The synchronization status of the capability configuration. The sync status
	// can be one of the following:
	//
	//    * IN_SYNC – The gateway is running the capability configuration.
	//
	//    * OUT_OF_SYNC – The gateway hasn't received the capability configuration.
	//
	//    * SYNC_FAILED – The gateway rejected the capability configuration.
	//
	// CapabilitySyncStatus is a required field
	CapabilitySyncStatus *string `locationName:"capabilitySyncStatus" type:"string" required:"true" enum:"CapabilitySyncStatus"`
	// contains filtered or unexported fields
}

Contains a summary of a gateway capability configuration.

func (GatewayCapabilitySummary) GoString 

func (s GatewayCapabilitySummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GatewayCapabilitySummary) SetCapabilityNamespace 

func (s *GatewayCapabilitySummary) SetCapabilityNamespace(v string) *GatewayCapabilitySummary

SetCapabilityNamespace sets the CapabilityNamespace field's value.

func (*GatewayCapabilitySummary) SetCapabilitySyncStatus 

func (s *GatewayCapabilitySummary) SetCapabilitySyncStatus(v string) *GatewayCapabilitySummary

SetCapabilitySyncStatus sets the CapabilitySyncStatus field's value.

func (GatewayCapabilitySummary) String 

func (s GatewayCapabilitySummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GatewayPlatform 

type GatewayPlatform struct {

	// A gateway that runs on IoT Greengrass.
	Greengrass *Greengrass `locationName:"greengrass" type:"structure"`

	// A gateway that runs on IoT Greengrass V2.
	GreengrassV2 *GreengrassV2 `locationName:"greengrassV2" type:"structure"`
	// contains filtered or unexported fields
}

Contains a gateway's platform information.

func (GatewayPlatform) GoString 

func (s GatewayPlatform) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GatewayPlatform) SetGreengrass 

func (s *GatewayPlatform) SetGreengrass(v *Greengrass) *GatewayPlatform

SetGreengrass sets the Greengrass field's value.

func (*GatewayPlatform) SetGreengrassV2 added in v1.40.11 

func (s *GatewayPlatform) SetGreengrassV2(v *GreengrassV2) *GatewayPlatform

SetGreengrassV2 sets the GreengrassV2 field's value.

func (GatewayPlatform) String 

func (s GatewayPlatform) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GatewayPlatform) Validate 

func (s *GatewayPlatform) Validate() error

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

type GatewaySummary 

type GatewaySummary struct {

	// The date the gateway was created, in Unix epoch time.
	//
	// CreationDate is a required field
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp" required:"true"`

	// A list of gateway capability summaries that each contain a namespace and
	// status. Each gateway capability defines data sources for the gateway. To
	// retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html).
	GatewayCapabilitySummaries []*GatewayCapabilitySummary `locationName:"gatewayCapabilitySummaries" type:"list"`

	// The ID of the gateway device.
	//
	// GatewayId is a required field
	GatewayId *string `locationName:"gatewayId" min:"36" type:"string" required:"true"`

	// The name of the asset.
	//
	// GatewayName is a required field
	GatewayName *string `locationName:"gatewayName" min:"1" type:"string" required:"true"`

	// Contains a gateway's platform information.
	GatewayPlatform *GatewayPlatform `locationName:"gatewayPlatform" type:"structure"`

	// The date the gateway was last updated, in Unix epoch time.
	//
	// LastUpdateDate is a required field
	LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

Contains a summary of a gateway.

func (GatewaySummary) GoString 

func (s GatewaySummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GatewaySummary) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*GatewaySummary) SetGatewayCapabilitySummaries 

func (s *GatewaySummary) SetGatewayCapabilitySummaries(v []*GatewayCapabilitySummary) *GatewaySummary

SetGatewayCapabilitySummaries sets the GatewayCapabilitySummaries field's value.

func (*GatewaySummary) SetGatewayId 

func (s *GatewaySummary) SetGatewayId(v string) *GatewaySummary

SetGatewayId sets the GatewayId field's value.

func (*GatewaySummary) SetGatewayName 

func (s *GatewaySummary) SetGatewayName(v string) *GatewaySummary

SetGatewayName sets the GatewayName field's value.

func (*GatewaySummary) SetGatewayPlatform added in v1.40.11 

func (s *GatewaySummary) SetGatewayPlatform(v *GatewayPlatform) *GatewaySummary

SetGatewayPlatform sets the GatewayPlatform field's value.

func (*GatewaySummary) SetLastUpdateDate 

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

SetLastUpdateDate sets the LastUpdateDate field's value.

func (GatewaySummary) String 

func (s GatewaySummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAssetPropertyAggregatesInput 

type GetAssetPropertyAggregatesInput struct {

	// The data aggregating function.
	//
	// AggregateTypes is a required field
	AggregateTypes []*string `location:"querystring" locationName:"aggregateTypes" min:"1" type:"list" required:"true" enum:"AggregateType"`

	// The ID of the asset, in UUID format.
	AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"string"`

	// The inclusive end of the range from which to query historical data, expressed
	// in seconds in Unix epoch time.
	//
	// EndDate is a required field
	EndDate *time.Time `location:"querystring" locationName:"endDate" type:"timestamp" required:"true"`

	// The maximum number of results to return for each paginated request. A result
	// set is returned in the two cases, whichever occurs first.
	//
	//    * The size of the result set is equal to 1 MB.
	//
	//    * The number of data points in the result set is equal to the value of
	//    maxResults. The maximum value of maxResults is 2500.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
	// see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the IoT SiteWise User Guide.
	PropertyAlias *string `location:"querystring" locationName:"propertyAlias" min:"1" type:"string"`

	// The ID of the asset property, in UUID format.
	PropertyId *string `location:"querystring" locationName:"propertyId" min:"36" type:"string"`

	// The quality by which to filter asset data.
	Qualities []*string `location:"querystring" locationName:"qualities" min:"1" type:"list" enum:"Quality"`

	// The time interval over which to aggregate data.
	//
	// Resolution is a required field
	Resolution *string `location:"querystring" locationName:"resolution" min:"2" type:"string" required:"true"`

	// The exclusive start of the range from which to query historical data, expressed
	// in seconds in Unix epoch time.
	//
	// StartDate is a required field
	StartDate *time.Time `location:"querystring" locationName:"startDate" type:"timestamp" required:"true"`

	// The chronological sorting order of the requested information.
	//
	// Default: ASCENDING
	TimeOrdering *string `location:"querystring" locationName:"timeOrdering" type:"string" enum:"TimeOrdering"`
	// contains filtered or unexported fields
}

func (GetAssetPropertyAggregatesInput) GoString 

func (s GetAssetPropertyAggregatesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssetPropertyAggregatesInput) SetAggregateTypes 

func (s *GetAssetPropertyAggregatesInput) SetAggregateTypes(v []*string) *GetAssetPropertyAggregatesInput

SetAggregateTypes sets the AggregateTypes field's value.

func (*GetAssetPropertyAggregatesInput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*GetAssetPropertyAggregatesInput) SetEndDate 

func (s *GetAssetPropertyAggregatesInput) SetEndDate(v time.Time) *GetAssetPropertyAggregatesInput

SetEndDate sets the EndDate field's value.

func (*GetAssetPropertyAggregatesInput) SetMaxResults 

func (s *GetAssetPropertyAggregatesInput) SetMaxResults(v int64) *GetAssetPropertyAggregatesInput

SetMaxResults sets the MaxResults field's value.

func (*GetAssetPropertyAggregatesInput) SetNextToken 

func (s *GetAssetPropertyAggregatesInput) SetNextToken(v string) *GetAssetPropertyAggregatesInput

SetNextToken sets the NextToken field's value.

func (*GetAssetPropertyAggregatesInput) SetPropertyAlias 

func (s *GetAssetPropertyAggregatesInput) SetPropertyAlias(v string) *GetAssetPropertyAggregatesInput

SetPropertyAlias sets the PropertyAlias field's value.

func (*GetAssetPropertyAggregatesInput) SetPropertyId 

func (s *GetAssetPropertyAggregatesInput) SetPropertyId(v string) *GetAssetPropertyAggregatesInput

SetPropertyId sets the PropertyId field's value.

func (*GetAssetPropertyAggregatesInput) SetQualities 

func (s *GetAssetPropertyAggregatesInput) SetQualities(v []*string) *GetAssetPropertyAggregatesInput

SetQualities sets the Qualities field's value.

func (*GetAssetPropertyAggregatesInput) SetResolution 

func (s *GetAssetPropertyAggregatesInput) SetResolution(v string) *GetAssetPropertyAggregatesInput

SetResolution sets the Resolution field's value.

func (*GetAssetPropertyAggregatesInput) SetStartDate 

func (s *GetAssetPropertyAggregatesInput) SetStartDate(v time.Time) *GetAssetPropertyAggregatesInput

SetStartDate sets the StartDate field's value.

func (*GetAssetPropertyAggregatesInput) SetTimeOrdering 

func (s *GetAssetPropertyAggregatesInput) SetTimeOrdering(v string) *GetAssetPropertyAggregatesInput

SetTimeOrdering sets the TimeOrdering field's value.

func (GetAssetPropertyAggregatesInput) String 

func (s GetAssetPropertyAggregatesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssetPropertyAggregatesInput) Validate 

func (s *GetAssetPropertyAggregatesInput) Validate() error

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

type GetAssetPropertyAggregatesOutput 

type GetAssetPropertyAggregatesOutput struct {

	// The requested aggregated values.
	//
	// AggregatedValues is a required field
	AggregatedValues []*AggregatedValue `locationName:"aggregatedValues" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetAssetPropertyAggregatesOutput) GoString 

func (s GetAssetPropertyAggregatesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssetPropertyAggregatesOutput) SetAggregatedValues 

func (s *GetAssetPropertyAggregatesOutput) SetAggregatedValues(v []*AggregatedValue) *GetAssetPropertyAggregatesOutput

SetAggregatedValues sets the AggregatedValues field's value.

func (*GetAssetPropertyAggregatesOutput) SetNextToken 

func (s *GetAssetPropertyAggregatesOutput) SetNextToken(v string) *GetAssetPropertyAggregatesOutput

SetNextToken sets the NextToken field's value.

func (GetAssetPropertyAggregatesOutput) String 

func (s GetAssetPropertyAggregatesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAssetPropertyValueHistoryInput 

type GetAssetPropertyValueHistoryInput struct {

	// The ID of the asset, in UUID format.
	AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"string"`

	// The inclusive end of the range from which to query historical data, expressed
	// in seconds in Unix epoch time.
	EndDate *time.Time `location:"querystring" locationName:"endDate" type:"timestamp"`

	// The maximum number of results to return for each paginated request. A result
	// set is returned in the two cases, whichever occurs first.
	//
	//    * The size of the result set is equal to 4 MB.
	//
	//    * The number of data points in the result set is equal to the value of
	//    maxResults. The maximum value of maxResults is 20000.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
	// see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the IoT SiteWise User Guide.
	PropertyAlias *string `location:"querystring" locationName:"propertyAlias" min:"1" type:"string"`

	// The ID of the asset property, in UUID format.
	PropertyId *string `location:"querystring" locationName:"propertyId" min:"36" type:"string"`

	// The quality by which to filter asset data.
	Qualities []*string `location:"querystring" locationName:"qualities" min:"1" type:"list" enum:"Quality"`

	// The exclusive start of the range from which to query historical data, expressed
	// in seconds in Unix epoch time.
	StartDate *time.Time `location:"querystring" locationName:"startDate" type:"timestamp"`

	// The chronological sorting order of the requested information.
	//
	// Default: ASCENDING
	TimeOrdering *string `location:"querystring" locationName:"timeOrdering" type:"string" enum:"TimeOrdering"`
	// contains filtered or unexported fields
}

func (GetAssetPropertyValueHistoryInput) GoString 

func (s GetAssetPropertyValueHistoryInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssetPropertyValueHistoryInput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*GetAssetPropertyValueHistoryInput) SetEndDate 

func (s *GetAssetPropertyValueHistoryInput) SetEndDate(v time.Time) *GetAssetPropertyValueHistoryInput

SetEndDate sets the EndDate field's value.

func (*GetAssetPropertyValueHistoryInput) SetMaxResults 

func (s *GetAssetPropertyValueHistoryInput) SetMaxResults(v int64) *GetAssetPropertyValueHistoryInput

SetMaxResults sets the MaxResults field's value.

func (*GetAssetPropertyValueHistoryInput) SetNextToken 

func (s *GetAssetPropertyValueHistoryInput) SetNextToken(v string) *GetAssetPropertyValueHistoryInput

SetNextToken sets the NextToken field's value.

func (*GetAssetPropertyValueHistoryInput) SetPropertyAlias 

func (s *GetAssetPropertyValueHistoryInput) SetPropertyAlias(v string) *GetAssetPropertyValueHistoryInput

SetPropertyAlias sets the PropertyAlias field's value.

func (*GetAssetPropertyValueHistoryInput) SetPropertyId 

func (s *GetAssetPropertyValueHistoryInput) SetPropertyId(v string) *GetAssetPropertyValueHistoryInput

SetPropertyId sets the PropertyId field's value.

func (*GetAssetPropertyValueHistoryInput) SetQualities 

func (s *GetAssetPropertyValueHistoryInput) SetQualities(v []*string) *GetAssetPropertyValueHistoryInput

SetQualities sets the Qualities field's value.

func (*GetAssetPropertyValueHistoryInput) SetStartDate 

func (s *GetAssetPropertyValueHistoryInput) SetStartDate(v time.Time) *GetAssetPropertyValueHistoryInput

SetStartDate sets the StartDate field's value.

func (*GetAssetPropertyValueHistoryInput) SetTimeOrdering 

func (s *GetAssetPropertyValueHistoryInput) SetTimeOrdering(v string) *GetAssetPropertyValueHistoryInput

SetTimeOrdering sets the TimeOrdering field's value.

func (GetAssetPropertyValueHistoryInput) String 

func (s GetAssetPropertyValueHistoryInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssetPropertyValueHistoryInput) Validate 

func (s *GetAssetPropertyValueHistoryInput) Validate() error

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

type GetAssetPropertyValueHistoryOutput 

type GetAssetPropertyValueHistoryOutput struct {

	// The asset property's value history.
	//
	// AssetPropertyValueHistory is a required field
	AssetPropertyValueHistory []*AssetPropertyValue `locationName:"assetPropertyValueHistory" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetAssetPropertyValueHistoryOutput) GoString 

func (s GetAssetPropertyValueHistoryOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssetPropertyValueHistoryOutput) SetAssetPropertyValueHistory 

func (s *GetAssetPropertyValueHistoryOutput) SetAssetPropertyValueHistory(v []*AssetPropertyValue) *GetAssetPropertyValueHistoryOutput

SetAssetPropertyValueHistory sets the AssetPropertyValueHistory field's value.

func (*GetAssetPropertyValueHistoryOutput) SetNextToken 

func (s *GetAssetPropertyValueHistoryOutput) SetNextToken(v string) *GetAssetPropertyValueHistoryOutput

SetNextToken sets the NextToken field's value.

func (GetAssetPropertyValueHistoryOutput) String 

func (s GetAssetPropertyValueHistoryOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAssetPropertyValueInput 

type GetAssetPropertyValueInput struct {

	// The ID of the asset, in UUID format.
	AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"string"`

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
	// see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the IoT SiteWise User Guide.
	PropertyAlias *string `location:"querystring" locationName:"propertyAlias" min:"1" type:"string"`

	// The ID of the asset property, in UUID format.
	PropertyId *string `location:"querystring" locationName:"propertyId" min:"36" type:"string"`
	// contains filtered or unexported fields
}

func (GetAssetPropertyValueInput) GoString 

func (s GetAssetPropertyValueInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssetPropertyValueInput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*GetAssetPropertyValueInput) SetPropertyAlias 

func (s *GetAssetPropertyValueInput) SetPropertyAlias(v string) *GetAssetPropertyValueInput

SetPropertyAlias sets the PropertyAlias field's value.

func (*GetAssetPropertyValueInput) SetPropertyId 

func (s *GetAssetPropertyValueInput) SetPropertyId(v string) *GetAssetPropertyValueInput

SetPropertyId sets the PropertyId field's value.

func (GetAssetPropertyValueInput) String 

func (s GetAssetPropertyValueInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssetPropertyValueInput) Validate 

func (s *GetAssetPropertyValueInput) Validate() error

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

type GetAssetPropertyValueOutput 

type GetAssetPropertyValueOutput struct {

	// The current asset property value.
	PropertyValue *AssetPropertyValue `locationName:"propertyValue" type:"structure"`
	// contains filtered or unexported fields
}

func (GetAssetPropertyValueOutput) GoString 

func (s GetAssetPropertyValueOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAssetPropertyValueOutput) SetPropertyValue 

func (s *GetAssetPropertyValueOutput) SetPropertyValue(v *AssetPropertyValue) *GetAssetPropertyValueOutput

SetPropertyValue sets the PropertyValue field's value.

func (GetAssetPropertyValueOutput) String 

func (s GetAssetPropertyValueOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetInterpolatedAssetPropertyValuesInput added in v1.38.28 

type GetInterpolatedAssetPropertyValuesInput struct {

	// The ID of the asset, in UUID format.
	AssetId *string `location:"querystring" locationName:"assetId" min:"36" type:"string"`

	// The inclusive end of the range from which to interpolate data, expressed
	// in seconds in Unix epoch time.
	//
	// EndTimeInSeconds is a required field
	EndTimeInSeconds *int64 `location:"querystring" locationName:"endTimeInSeconds" min:"1" type:"long" required:"true"`

	// The nanosecond offset converted from endTimeInSeconds.
	EndTimeOffsetInNanos *int64 `location:"querystring" locationName:"endTimeOffsetInNanos" type:"integer"`

	// The time interval in seconds over which to interpolate data. Each interval
	// starts when the previous one ends.
	//
	// IntervalInSeconds is a required field
	IntervalInSeconds *int64 `location:"querystring" locationName:"intervalInSeconds" min:"1" type:"long" required:"true"`

	// The query interval for the window, in seconds. IoT SiteWise computes each
	// interpolated value by using data points from the timestamp of each interval,
	// minus the window to the timestamp of each interval plus the window. If not
	// specified, the window ranges between the start time minus the interval and
	// the end time plus the interval.
	//
	//    * If you specify a value for the intervalWindowInSeconds parameter, the
	//    value for the type parameter must be LINEAR_INTERPOLATION.
	//
	//    * If a data point isn't found during the specified query window, IoT SiteWise
	//    won't return an interpolated value for the interval. This indicates that
	//    there's a gap in the ingested data points.
	//
	// For example, you can get the interpolated temperature values for a wind turbine
	// every 24 hours over a duration of 7 days. If the interpolation starts on
	// July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data
	// points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July
	// 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses
	// the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours)
	// on July 3, 2021 to compute the second interpolated value, and so on.
	IntervalWindowInSeconds *int64 `location:"querystring" locationName:"intervalWindowInSeconds" min:"1" type:"long"`

	// The maximum number of results to return for each paginated request. If not
	// specified, the default value is 10.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
	// see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the IoT SiteWise User Guide.
	PropertyAlias *string `location:"querystring" locationName:"propertyAlias" min:"1" type:"string"`

	// The ID of the asset property, in UUID format.
	PropertyId *string `location:"querystring" locationName:"propertyId" min:"36" type:"string"`

	// The quality of the asset property value. You can use this parameter as a
	// filter to choose only the asset property values that have a specific quality.
	//
	// Quality is a required field
	Quality *string `location:"querystring" locationName:"quality" type:"string" required:"true" enum:"Quality"`

	// The exclusive start of the range from which to interpolate data, expressed
	// in seconds in Unix epoch time.
	//
	// StartTimeInSeconds is a required field
	StartTimeInSeconds *int64 `location:"querystring" locationName:"startTimeInSeconds" min:"1" type:"long" required:"true"`

	// The nanosecond offset converted from startTimeInSeconds.
	StartTimeOffsetInNanos *int64 `location:"querystring" locationName:"startTimeOffsetInNanos" type:"integer"`

	// The interpolation type.
	//
	// Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION
	//
	//    * LINEAR_INTERPOLATION – Estimates missing data using linear interpolation
	//    (https://en.wikipedia.org/wiki/Linear_interpolation). For example, you
	//    can use this operation to return the interpolated temperature values for
	//    a wind turbine every 24 hours over a duration of 7 days. If the interpolation
	//    starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated
	//    value on July 2, 2021, at 9 AM, the second interpolated value on July
	//    3, 2021, at 9 AM, and so on.
	//
	//    * LOCF_INTERPOLATION – Estimates missing data using last observation
	//    carried forward interpolation If no data point is found for an interval,
	//    IoT SiteWise returns the last observed data point for the previous interval
	//    and carries forward this interpolated value until a new data point is
	//    found. For example, you can get the state of an on-off valve every 24
	//    hours over a duration of 7 days. If the interpolation starts July 1, 2021,
	//    at 9 AM, IoT SiteWise returns the last observed data point between July
	//    1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value.
	//    If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses
	//    the same interpolated value for the rest of the days.
	//
	// Type is a required field
	Type *string `location:"querystring" locationName:"type" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetInterpolatedAssetPropertyValuesInput) GoString added in v1.38.28 

func (s GetInterpolatedAssetPropertyValuesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInterpolatedAssetPropertyValuesInput) SetAssetId added in v1.38.28 

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

SetAssetId sets the AssetId field's value.

func (*GetInterpolatedAssetPropertyValuesInput) SetEndTimeInSeconds added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesInput) SetEndTimeInSeconds(v int64) *GetInterpolatedAssetPropertyValuesInput

SetEndTimeInSeconds sets the EndTimeInSeconds field's value.

func (*GetInterpolatedAssetPropertyValuesInput) SetEndTimeOffsetInNanos added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesInput) SetEndTimeOffsetInNanos(v int64) *GetInterpolatedAssetPropertyValuesInput

SetEndTimeOffsetInNanos sets the EndTimeOffsetInNanos field's value.

func (*GetInterpolatedAssetPropertyValuesInput) SetIntervalInSeconds added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesInput) SetIntervalInSeconds(v int64) *GetInterpolatedAssetPropertyValuesInput

SetIntervalInSeconds sets the IntervalInSeconds field's value.

func (*GetInterpolatedAssetPropertyValuesInput) SetIntervalWindowInSeconds added in v1.40.23 

func (s *GetInterpolatedAssetPropertyValuesInput) SetIntervalWindowInSeconds(v int64) *GetInterpolatedAssetPropertyValuesInput

SetIntervalWindowInSeconds sets the IntervalWindowInSeconds field's value.

func (*GetInterpolatedAssetPropertyValuesInput) SetMaxResults added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesInput) SetMaxResults(v int64) *GetInterpolatedAssetPropertyValuesInput

SetMaxResults sets the MaxResults field's value.

func (*GetInterpolatedAssetPropertyValuesInput) SetNextToken added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesInput) SetNextToken(v string) *GetInterpolatedAssetPropertyValuesInput

SetNextToken sets the NextToken field's value.

func (*GetInterpolatedAssetPropertyValuesInput) SetPropertyAlias added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesInput) SetPropertyAlias(v string) *GetInterpolatedAssetPropertyValuesInput

SetPropertyAlias sets the PropertyAlias field's value.

func (*GetInterpolatedAssetPropertyValuesInput) SetPropertyId added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesInput) SetPropertyId(v string) *GetInterpolatedAssetPropertyValuesInput

SetPropertyId sets the PropertyId field's value.

func (*GetInterpolatedAssetPropertyValuesInput) SetQuality added in v1.38.28 

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

SetQuality sets the Quality field's value.

func (*GetInterpolatedAssetPropertyValuesInput) SetStartTimeInSeconds added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesInput) SetStartTimeInSeconds(v int64) *GetInterpolatedAssetPropertyValuesInput

SetStartTimeInSeconds sets the StartTimeInSeconds field's value.

func (*GetInterpolatedAssetPropertyValuesInput) SetStartTimeOffsetInNanos added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesInput) SetStartTimeOffsetInNanos(v int64) *GetInterpolatedAssetPropertyValuesInput

SetStartTimeOffsetInNanos sets the StartTimeOffsetInNanos field's value.

func (*GetInterpolatedAssetPropertyValuesInput) SetType added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesInput) SetType(v string) *GetInterpolatedAssetPropertyValuesInput

SetType sets the Type field's value.

func (GetInterpolatedAssetPropertyValuesInput) String added in v1.38.28 

func (s GetInterpolatedAssetPropertyValuesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInterpolatedAssetPropertyValuesInput) Validate added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesInput) Validate() error

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

type GetInterpolatedAssetPropertyValuesOutput added in v1.38.28 

type GetInterpolatedAssetPropertyValuesOutput struct {

	// The requested interpolated values.
	//
	// InterpolatedAssetPropertyValues is a required field
	InterpolatedAssetPropertyValues []*InterpolatedAssetPropertyValue `locationName:"interpolatedAssetPropertyValues" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetInterpolatedAssetPropertyValuesOutput) GoString added in v1.38.28 

func (s GetInterpolatedAssetPropertyValuesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetInterpolatedAssetPropertyValuesOutput) SetInterpolatedAssetPropertyValues added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesOutput) SetInterpolatedAssetPropertyValues(v []*InterpolatedAssetPropertyValue) *GetInterpolatedAssetPropertyValuesOutput

SetInterpolatedAssetPropertyValues sets the InterpolatedAssetPropertyValues field's value.

func (*GetInterpolatedAssetPropertyValuesOutput) SetNextToken added in v1.38.28 

func (s *GetInterpolatedAssetPropertyValuesOutput) SetNextToken(v string) *GetInterpolatedAssetPropertyValuesOutput

SetNextToken sets the NextToken field's value.

func (GetInterpolatedAssetPropertyValuesOutput) String added in v1.38.28 

func (s GetInterpolatedAssetPropertyValuesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Greengrass 

type Greengrass struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the Greengrass group. For more information about how to find a group's
	// ARN, see ListGroups (https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html)
	// and GetGroup (https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html)
	// in the IoT Greengrass API Reference.
	//
	// GroupArn is a required field
	GroupArn *string `locationName:"groupArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details for a gateway that runs on IoT Greengrass. To create a gateway that runs on IoT Greengrass, you must add the IoT SiteWise connector to a Greengrass group and deploy it. Your Greengrass group must also have permissions to upload data to IoT SiteWise. For more information, see Ingesting data using a gateway (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) in the IoT SiteWise User Guide.

func (Greengrass) GoString 

func (s Greengrass) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Greengrass) SetGroupArn 

func (s *Greengrass) SetGroupArn(v string) *Greengrass

SetGroupArn sets the GroupArn field's value.

func (Greengrass) String 

func (s Greengrass) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Greengrass) Validate 

func (s *Greengrass) Validate() error

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

type GreengrassV2 added in v1.40.11 

type GreengrassV2 struct {

	// The name of the IoT thing for your IoT Greengrass V2 core device.
	//
	// CoreDeviceThingName is a required field
	CoreDeviceThingName *string `locationName:"coreDeviceThingName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your Greengrass device role (https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html) must use the AWSIoTSiteWiseEdgeAccess policy. For more information, see Using IoT SiteWise at the edge (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html) in the IoT SiteWise User Guide.

func (GreengrassV2) GoString added in v1.40.11 

func (s GreengrassV2) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GreengrassV2) SetCoreDeviceThingName added in v1.40.11 

func (s *GreengrassV2) SetCoreDeviceThingName(v string) *GreengrassV2

SetCoreDeviceThingName sets the CoreDeviceThingName field's value.

func (GreengrassV2) String added in v1.40.11 

func (s GreengrassV2) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GreengrassV2) Validate added in v1.40.11 

func (s *GreengrassV2) Validate() error

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

type GroupIdentity 

type GroupIdentity struct {

	// The IAM Identity Center ID of the group.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information for a group identity in an access policy.

func (GroupIdentity) GoString 

func (s GroupIdentity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupIdentity) SetId 

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

SetId sets the Id field's value.

func (GroupIdentity) String 

func (s GroupIdentity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GroupIdentity) Validate 

func (s *GroupIdentity) Validate() error

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

type IAMRoleIdentity added in v1.37.3 

type IAMRoleIdentity struct {

	// The ARN of the IAM role. For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
	// in the IAM User Guide.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information about an Identity and Access Management role. For more information, see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the IAM User Guide.

func (IAMRoleIdentity) GoString added in v1.37.3 

func (s IAMRoleIdentity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IAMRoleIdentity) SetArn added in v1.37.3 

func (s *IAMRoleIdentity) SetArn(v string) *IAMRoleIdentity

SetArn sets the Arn field's value.

func (IAMRoleIdentity) String added in v1.37.3 

func (s IAMRoleIdentity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IAMRoleIdentity) Validate added in v1.37.3 

func (s *IAMRoleIdentity) Validate() error

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

type IAMUserIdentity added in v1.34.28 

type IAMUserIdentity struct {

	// The ARN of the IAM user. For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
	// in the IAM User Guide.
	//
	// If you delete the IAM user, access policies that contain this identity include
	// an empty arn. You can delete the access policy for the IAM user that no longer
	// exists.
	//
	// Arn is a required field
	Arn *string `locationName:"arn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information about an Identity and Access Management user.

func (IAMUserIdentity) GoString added in v1.34.28 

func (s IAMUserIdentity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IAMUserIdentity) SetArn added in v1.34.28 

func (s *IAMUserIdentity) SetArn(v string) *IAMUserIdentity

SetArn sets the Arn field's value.

func (IAMUserIdentity) String added in v1.34.28 

func (s IAMUserIdentity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IAMUserIdentity) Validate added in v1.34.28 

func (s *IAMUserIdentity) Validate() error

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

type Identity 

type Identity struct {

	// An IAM Identity Center group identity.
	Group *GroupIdentity `locationName:"group" type:"structure"`

	// An IAM role identity.
	IamRole *IAMRoleIdentity `locationName:"iamRole" type:"structure"`

	// An IAM user identity.
	IamUser *IAMUserIdentity `locationName:"iamUser" type:"structure"`

	// An IAM Identity Center user identity.
	User *UserIdentity `locationName:"user" type:"structure"`
	// contains filtered or unexported fields
}

Contains an identity that can access an IoT SiteWise Monitor resource.

Currently, you can't use Amazon Web Services API operations to retrieve IAM Identity Center identity IDs. You can find the IAM Identity Center identity IDs in the URL of user and group pages in the IAM Identity Center console (https://console.aws.amazon.com/singlesignon).

func (Identity) GoString 

func (s Identity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Identity) SetGroup 

func (s *Identity) SetGroup(v *GroupIdentity) *Identity

SetGroup sets the Group field's value.

func (*Identity) SetIamRole added in v1.37.3 

func (s *Identity) SetIamRole(v *IAMRoleIdentity) *Identity

SetIamRole sets the IamRole field's value.

func (*Identity) SetIamUser added in v1.34.28 

func (s *Identity) SetIamUser(v *IAMUserIdentity) *Identity

SetIamUser sets the IamUser field's value.

func (*Identity) SetUser 

func (s *Identity) SetUser(v *UserIdentity) *Identity

SetUser sets the User field's value.

func (Identity) String 

func (s Identity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Identity) Validate 

func (s *Identity) Validate() error

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

type Image 

type Image struct {

	// Contains an image file.
	File *ImageFile `locationName:"file" type:"structure"`

	// The ID of an existing image. Specify this parameter to keep an existing image.
	Id *string `locationName:"id" min:"36" type:"string"`
	// contains filtered or unexported fields
}

Contains an image that is one of the following:

  • An image file. Choose this option to upload a new image.

  • The ID of an existing image. Choose this option to keep an existing image.

func (Image) GoString 

func (s Image) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Image) SetFile added in v1.31.4 

func (s *Image) SetFile(v *ImageFile) *Image

SetFile sets the File field's value.

func (*Image) SetId added in v1.31.4 

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

SetId sets the Id field's value.

func (Image) String 

func (s Image) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Image) Validate added in v1.31.4 

func (s *Image) Validate() error

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

type ImageFile 

type ImageFile struct {

	// The image file contents, represented as a base64-encoded string. The file
	// size must be less than 1 MB.
	// Data is automatically base64 encoded/decoded by the SDK.
	//
	// Data is a required field
	Data []byte `locationName:"data" min:"1" type:"blob" required:"true"`

	// The file type of the image.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"ImageFileType"`
	// contains filtered or unexported fields
}

Contains an image file.

func (ImageFile) GoString 

func (s ImageFile) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImageFile) SetData added in v1.31.4 

func (s *ImageFile) SetData(v []byte) *ImageFile

SetData sets the Data field's value.

func (*ImageFile) SetType added in v1.31.4 

func (s *ImageFile) SetType(v string) *ImageFile

SetType sets the Type field's value.

func (ImageFile) String 

func (s ImageFile) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImageFile) Validate 

func (s *ImageFile) Validate() error

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

type ImageLocation added in v1.31.4 

type ImageLocation struct {

	// The ID of the image.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The URL where the image is available. The URL is valid for 15 minutes so
	// that you can view and download the image
	//
	// Url is a required field
	Url *string `locationName:"url" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains an image that is uploaded to IoT SiteWise and available at a URL.

func (ImageLocation) GoString added in v1.31.4 

func (s ImageLocation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImageLocation) SetId added in v1.31.4 

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

SetId sets the Id field's value.

func (*ImageLocation) SetUrl added in v1.31.4 

func (s *ImageLocation) SetUrl(v string) *ImageLocation

SetUrl sets the Url field's value.

func (ImageLocation) String added in v1.31.4 

func (s ImageLocation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalFailureException 

type InternalFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

IoT SiteWise can't process your request right now. Try again later.

func (*InternalFailureException) Code 

func (s *InternalFailureException) Code() string

Code returns the exception type name.

func (*InternalFailureException) Error 

func (s *InternalFailureException) Error() string

func (InternalFailureException) GoString 

func (s InternalFailureException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalFailureException) Message 

func (s *InternalFailureException) Message() string

Message returns the exception's message.

func (*InternalFailureException) OrigErr 

func (s *InternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalFailureException) RequestID 

func (s *InternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalFailureException) StatusCode 

func (s *InternalFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalFailureException) String 

func (s InternalFailureException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InterpolatedAssetPropertyValue added in v1.38.28 

type InterpolatedAssetPropertyValue struct {

	// Contains a timestamp with optional nanosecond granularity.
	//
	// Timestamp is a required field
	Timestamp *TimeInNanos `locationName:"timestamp" type:"structure" required:"true"`

	// Contains an asset property value (of a single type only).
	//
	// Value is a required field
	Value *Variant `locationName:"value" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains information about an interpolated asset property value.

func (InterpolatedAssetPropertyValue) GoString added in v1.38.28 

func (s InterpolatedAssetPropertyValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InterpolatedAssetPropertyValue) SetTimestamp added in v1.38.28 

func (s *InterpolatedAssetPropertyValue) SetTimestamp(v *TimeInNanos) *InterpolatedAssetPropertyValue

SetTimestamp sets the Timestamp field's value.

func (*InterpolatedAssetPropertyValue) SetValue added in v1.38.28 

func (s *InterpolatedAssetPropertyValue) SetValue(v *Variant) *InterpolatedAssetPropertyValue

SetValue sets the Value field's value.

func (InterpolatedAssetPropertyValue) String added in v1.38.28 

func (s InterpolatedAssetPropertyValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException 

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

func (*InvalidRequestException) Code 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString 

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String 

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IoTSiteWise 

type IoTSiteWise struct {
	*client.Client
}

IoTSiteWise provides the API operation methods for making requests to AWS IoT SiteWise. See this package's package overview docs for details on the service.

IoTSiteWise methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *IoTSiteWise

New creates a new instance of the IoTSiteWise client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a IoTSiteWise client from just a session.
svc := iotsitewise.New(mySession)

// Create a IoTSiteWise client with additional configuration
svc := iotsitewise.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*IoTSiteWise) AssociateAssets 

func (c *IoTSiteWise) AssociateAssets(input *AssociateAssetsInput) (*AssociateAssetsOutput, error)

AssociateAssets API operation for AWS IoT SiteWise.

Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation AssociateAssets for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceAlreadyExistsException The resource already exists.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • 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 IoT SiteWise User Guide.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/AssociateAssets

func (*IoTSiteWise) AssociateAssetsRequest 

func (c *IoTSiteWise) AssociateAssetsRequest(input *AssociateAssetsInput) (req *request.Request, output *AssociateAssetsOutput)

AssociateAssetsRequest generates a "aws/request.Request" representing the client's request for the AssociateAssets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateAssets for more information on using the AssociateAssets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateAssetsRequest method.
req, resp := client.AssociateAssetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/AssociateAssets

func (*IoTSiteWise) AssociateAssetsWithContext 

func (c *IoTSiteWise) AssociateAssetsWithContext(ctx aws.Context, input *AssociateAssetsInput, opts ...request.Option) (*AssociateAssetsOutput, error)

AssociateAssetsWithContext is the same as AssociateAssets with the addition of the ability to pass a context and additional request options.

See AssociateAssets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) AssociateTimeSeriesToAssetProperty added in v1.42.12 

func (c *IoTSiteWise) AssociateTimeSeriesToAssetProperty(input *AssociateTimeSeriesToAssetPropertyInput) (*AssociateTimeSeriesToAssetPropertyOutput, error)

AssociateTimeSeriesToAssetProperty API operation for AWS IoT SiteWise.

Associates a time series (data stream) with an asset property.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation AssociateTimeSeriesToAssetProperty for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty

func (*IoTSiteWise) AssociateTimeSeriesToAssetPropertyRequest added in v1.42.12 

func (c *IoTSiteWise) AssociateTimeSeriesToAssetPropertyRequest(input *AssociateTimeSeriesToAssetPropertyInput) (req *request.Request, output *AssociateTimeSeriesToAssetPropertyOutput)

AssociateTimeSeriesToAssetPropertyRequest generates a "aws/request.Request" representing the client's request for the AssociateTimeSeriesToAssetProperty operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateTimeSeriesToAssetProperty for more information on using the AssociateTimeSeriesToAssetProperty API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateTimeSeriesToAssetPropertyRequest method.
req, resp := client.AssociateTimeSeriesToAssetPropertyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/AssociateTimeSeriesToAssetProperty

func (*IoTSiteWise) AssociateTimeSeriesToAssetPropertyWithContext added in v1.42.12 

func (c *IoTSiteWise) AssociateTimeSeriesToAssetPropertyWithContext(ctx aws.Context, input *AssociateTimeSeriesToAssetPropertyInput, opts ...request.Option) (*AssociateTimeSeriesToAssetPropertyOutput, error)

AssociateTimeSeriesToAssetPropertyWithContext is the same as AssociateTimeSeriesToAssetProperty with the addition of the ability to pass a context and additional request options.

See AssociateTimeSeriesToAssetProperty for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) BatchAssociateProjectAssets 

func (c *IoTSiteWise) BatchAssociateProjectAssets(input *BatchAssociateProjectAssetsInput) (*BatchAssociateProjectAssetsOutput, error)

BatchAssociateProjectAssets API operation for AWS IoT SiteWise.

Associates a group (batch) of assets with an IoT SiteWise Monitor project.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation BatchAssociateProjectAssets for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchAssociateProjectAssets

func (*IoTSiteWise) BatchAssociateProjectAssetsRequest 

func (c *IoTSiteWise) BatchAssociateProjectAssetsRequest(input *BatchAssociateProjectAssetsInput) (req *request.Request, output *BatchAssociateProjectAssetsOutput)

BatchAssociateProjectAssetsRequest generates a "aws/request.Request" representing the client's request for the BatchAssociateProjectAssets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchAssociateProjectAssets for more information on using the BatchAssociateProjectAssets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchAssociateProjectAssetsRequest method.
req, resp := client.BatchAssociateProjectAssetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchAssociateProjectAssets

func (*IoTSiteWise) BatchAssociateProjectAssetsWithContext 

func (c *IoTSiteWise) BatchAssociateProjectAssetsWithContext(ctx aws.Context, input *BatchAssociateProjectAssetsInput, opts ...request.Option) (*BatchAssociateProjectAssetsOutput, error)

BatchAssociateProjectAssetsWithContext is the same as BatchAssociateProjectAssets with the addition of the ability to pass a context and additional request options.

See BatchAssociateProjectAssets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) BatchDisassociateProjectAssets 

func (c *IoTSiteWise) BatchDisassociateProjectAssets(input *BatchDisassociateProjectAssetsInput) (*BatchDisassociateProjectAssetsOutput, error)

BatchDisassociateProjectAssets API operation for AWS IoT SiteWise.

Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation BatchDisassociateProjectAssets for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchDisassociateProjectAssets

func (*IoTSiteWise) BatchDisassociateProjectAssetsRequest 

func (c *IoTSiteWise) BatchDisassociateProjectAssetsRequest(input *BatchDisassociateProjectAssetsInput) (req *request.Request, output *BatchDisassociateProjectAssetsOutput)

BatchDisassociateProjectAssetsRequest generates a "aws/request.Request" representing the client's request for the BatchDisassociateProjectAssets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchDisassociateProjectAssets for more information on using the BatchDisassociateProjectAssets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchDisassociateProjectAssetsRequest method.
req, resp := client.BatchDisassociateProjectAssetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchDisassociateProjectAssets

func (*IoTSiteWise) BatchDisassociateProjectAssetsWithContext 

func (c *IoTSiteWise) BatchDisassociateProjectAssetsWithContext(ctx aws.Context, input *BatchDisassociateProjectAssetsInput, opts ...request.Option) (*BatchDisassociateProjectAssetsOutput, error)

BatchDisassociateProjectAssetsWithContext is the same as BatchDisassociateProjectAssets with the addition of the ability to pass a context and additional request options.

See BatchDisassociateProjectAssets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) BatchGetAssetPropertyAggregates added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyAggregates(input *BatchGetAssetPropertyAggregatesInput) (*BatchGetAssetPropertyAggregatesOutput, error)

BatchGetAssetPropertyAggregates API operation for AWS IoT SiteWise.

Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation BatchGetAssetPropertyAggregates for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • ServiceUnavailableException The requested service is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates

func (*IoTSiteWise) BatchGetAssetPropertyAggregatesPages added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyAggregatesPages(input *BatchGetAssetPropertyAggregatesInput, fn func(*BatchGetAssetPropertyAggregatesOutput, bool) bool) error

BatchGetAssetPropertyAggregatesPages iterates over the pages of a BatchGetAssetPropertyAggregates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See BatchGetAssetPropertyAggregates method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a BatchGetAssetPropertyAggregates operation.
pageNum := 0
err := client.BatchGetAssetPropertyAggregatesPages(params,
    func(page *iotsitewise.BatchGetAssetPropertyAggregatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) BatchGetAssetPropertyAggregatesPagesWithContext added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyAggregatesPagesWithContext(ctx aws.Context, input *BatchGetAssetPropertyAggregatesInput, fn func(*BatchGetAssetPropertyAggregatesOutput, bool) bool, opts ...request.Option) error

BatchGetAssetPropertyAggregatesPagesWithContext same as BatchGetAssetPropertyAggregatesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) BatchGetAssetPropertyAggregatesRequest added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyAggregatesRequest(input *BatchGetAssetPropertyAggregatesInput) (req *request.Request, output *BatchGetAssetPropertyAggregatesOutput)

BatchGetAssetPropertyAggregatesRequest generates a "aws/request.Request" representing the client's request for the BatchGetAssetPropertyAggregates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetAssetPropertyAggregates for more information on using the BatchGetAssetPropertyAggregates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchGetAssetPropertyAggregatesRequest method.
req, resp := client.BatchGetAssetPropertyAggregatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyAggregates

func (*IoTSiteWise) BatchGetAssetPropertyAggregatesWithContext added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyAggregatesWithContext(ctx aws.Context, input *BatchGetAssetPropertyAggregatesInput, opts ...request.Option) (*BatchGetAssetPropertyAggregatesOutput, error)

BatchGetAssetPropertyAggregatesWithContext is the same as BatchGetAssetPropertyAggregates with the addition of the ability to pass a context and additional request options.

See BatchGetAssetPropertyAggregates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) BatchGetAssetPropertyValue added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyValue(input *BatchGetAssetPropertyValueInput) (*BatchGetAssetPropertyValueOutput, error)

BatchGetAssetPropertyValue API operation for AWS IoT SiteWise.

Gets the current value for one or more asset properties. For more information, see Querying current values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation BatchGetAssetPropertyValue for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • ServiceUnavailableException The requested service is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyValue

func (*IoTSiteWise) BatchGetAssetPropertyValueHistory added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyValueHistory(input *BatchGetAssetPropertyValueHistoryInput) (*BatchGetAssetPropertyValueHistoryOutput, error)

BatchGetAssetPropertyValueHistory API operation for AWS IoT SiteWise.

Gets the historical values for one or more asset properties. For more information, see Querying historical values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation BatchGetAssetPropertyValueHistory for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • ServiceUnavailableException The requested service is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory

func (*IoTSiteWise) BatchGetAssetPropertyValueHistoryPages added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyValueHistoryPages(input *BatchGetAssetPropertyValueHistoryInput, fn func(*BatchGetAssetPropertyValueHistoryOutput, bool) bool) error

BatchGetAssetPropertyValueHistoryPages iterates over the pages of a BatchGetAssetPropertyValueHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See BatchGetAssetPropertyValueHistory method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a BatchGetAssetPropertyValueHistory operation.
pageNum := 0
err := client.BatchGetAssetPropertyValueHistoryPages(params,
    func(page *iotsitewise.BatchGetAssetPropertyValueHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) BatchGetAssetPropertyValueHistoryPagesWithContext added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyValueHistoryPagesWithContext(ctx aws.Context, input *BatchGetAssetPropertyValueHistoryInput, fn func(*BatchGetAssetPropertyValueHistoryOutput, bool) bool, opts ...request.Option) error

BatchGetAssetPropertyValueHistoryPagesWithContext same as BatchGetAssetPropertyValueHistoryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) BatchGetAssetPropertyValueHistoryRequest added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyValueHistoryRequest(input *BatchGetAssetPropertyValueHistoryInput) (req *request.Request, output *BatchGetAssetPropertyValueHistoryOutput)

BatchGetAssetPropertyValueHistoryRequest generates a "aws/request.Request" representing the client's request for the BatchGetAssetPropertyValueHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetAssetPropertyValueHistory for more information on using the BatchGetAssetPropertyValueHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchGetAssetPropertyValueHistoryRequest method.
req, resp := client.BatchGetAssetPropertyValueHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyValueHistory

func (*IoTSiteWise) BatchGetAssetPropertyValueHistoryWithContext added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyValueHistoryWithContext(ctx aws.Context, input *BatchGetAssetPropertyValueHistoryInput, opts ...request.Option) (*BatchGetAssetPropertyValueHistoryOutput, error)

BatchGetAssetPropertyValueHistoryWithContext is the same as BatchGetAssetPropertyValueHistory with the addition of the ability to pass a context and additional request options.

See BatchGetAssetPropertyValueHistory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) BatchGetAssetPropertyValuePages added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyValuePages(input *BatchGetAssetPropertyValueInput, fn func(*BatchGetAssetPropertyValueOutput, bool) bool) error

BatchGetAssetPropertyValuePages iterates over the pages of a BatchGetAssetPropertyValue operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See BatchGetAssetPropertyValue method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a BatchGetAssetPropertyValue operation.
pageNum := 0
err := client.BatchGetAssetPropertyValuePages(params,
    func(page *iotsitewise.BatchGetAssetPropertyValueOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) BatchGetAssetPropertyValuePagesWithContext added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyValuePagesWithContext(ctx aws.Context, input *BatchGetAssetPropertyValueInput, fn func(*BatchGetAssetPropertyValueOutput, bool) bool, opts ...request.Option) error

BatchGetAssetPropertyValuePagesWithContext same as BatchGetAssetPropertyValuePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) BatchGetAssetPropertyValueRequest added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyValueRequest(input *BatchGetAssetPropertyValueInput) (req *request.Request, output *BatchGetAssetPropertyValueOutput)

BatchGetAssetPropertyValueRequest generates a "aws/request.Request" representing the client's request for the BatchGetAssetPropertyValue operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchGetAssetPropertyValue for more information on using the BatchGetAssetPropertyValue API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchGetAssetPropertyValueRequest method.
req, resp := client.BatchGetAssetPropertyValueRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchGetAssetPropertyValue

func (*IoTSiteWise) BatchGetAssetPropertyValueWithContext added in v1.43.44 

func (c *IoTSiteWise) BatchGetAssetPropertyValueWithContext(ctx aws.Context, input *BatchGetAssetPropertyValueInput, opts ...request.Option) (*BatchGetAssetPropertyValueOutput, error)

BatchGetAssetPropertyValueWithContext is the same as BatchGetAssetPropertyValue with the addition of the ability to pass a context and additional request options.

See BatchGetAssetPropertyValue for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) BatchPutAssetPropertyValue 

func (c *IoTSiteWise) BatchPutAssetPropertyValue(input *BatchPutAssetPropertyValueInput) (*BatchPutAssetPropertyValueOutput, error)

BatchPutAssetPropertyValue API operation for AWS IoT SiteWise.

Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html) in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.

For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV.

IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation BatchPutAssetPropertyValue for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

  • ServiceUnavailableException The requested service is unavailable.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchPutAssetPropertyValue

func (*IoTSiteWise) BatchPutAssetPropertyValueRequest 

func (c *IoTSiteWise) BatchPutAssetPropertyValueRequest(input *BatchPutAssetPropertyValueInput) (req *request.Request, output *BatchPutAssetPropertyValueOutput)

BatchPutAssetPropertyValueRequest generates a "aws/request.Request" representing the client's request for the BatchPutAssetPropertyValue operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchPutAssetPropertyValue for more information on using the BatchPutAssetPropertyValue API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the BatchPutAssetPropertyValueRequest method.
req, resp := client.BatchPutAssetPropertyValueRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/BatchPutAssetPropertyValue

func (*IoTSiteWise) BatchPutAssetPropertyValueWithContext 

func (c *IoTSiteWise) BatchPutAssetPropertyValueWithContext(ctx aws.Context, input *BatchPutAssetPropertyValueInput, opts ...request.Option) (*BatchPutAssetPropertyValueOutput, error)

BatchPutAssetPropertyValueWithContext is the same as BatchPutAssetPropertyValue with the addition of the ability to pass a context and additional request options.

See BatchPutAssetPropertyValue for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) CreateAccessPolicy 

func (c *IoTSiteWise) CreateAccessPolicy(input *CreateAccessPolicyInput) (*CreateAccessPolicyOutput, error)

CreateAccessPolicy API operation for AWS IoT SiteWise.

Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation CreateAccessPolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAccessPolicy

func (*IoTSiteWise) CreateAccessPolicyRequest 

func (c *IoTSiteWise) CreateAccessPolicyRequest(input *CreateAccessPolicyInput) (req *request.Request, output *CreateAccessPolicyOutput)

CreateAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the CreateAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAccessPolicy for more information on using the CreateAccessPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateAccessPolicyRequest method.
req, resp := client.CreateAccessPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAccessPolicy

func (*IoTSiteWise) CreateAccessPolicyWithContext 

func (c *IoTSiteWise) CreateAccessPolicyWithContext(ctx aws.Context, input *CreateAccessPolicyInput, opts ...request.Option) (*CreateAccessPolicyOutput, error)

CreateAccessPolicyWithContext is the same as CreateAccessPolicy with the addition of the ability to pass a context and additional request options.

See CreateAccessPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) CreateAsset 

func (c *IoTSiteWise) CreateAsset(input *CreateAssetInput) (*CreateAssetOutput, error)

CreateAsset API operation for AWS IoT SiteWise.

Creates an asset from an existing asset model. For more information, see Creating assets (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation CreateAsset for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceAlreadyExistsException The resource already exists.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAsset

func (*IoTSiteWise) CreateAssetModel 

func (c *IoTSiteWise) CreateAssetModel(input *CreateAssetModelInput) (*CreateAssetModelOutput, error)

CreateAssetModel API operation for AWS IoT SiteWise.

Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) in the IoT SiteWise User Guide.

You can create two types of asset models, ASSET_MODEL or COMPONENT_MODEL.

  • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

  • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation CreateAssetModel for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceAlreadyExistsException The resource already exists.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAssetModel

func (*IoTSiteWise) CreateAssetModelCompositeModel added in v1.48.2 

func (c *IoTSiteWise) CreateAssetModelCompositeModel(input *CreateAssetModelCompositeModelInput) (*CreateAssetModelCompositeModelOutput, error)

CreateAssetModelCompositeModel API operation for AWS IoT SiteWise.

Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based.

Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html) in the IoT SiteWise User Guide.

Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets.

To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL.

To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation CreateAssetModelCompositeModel for usage and error information.

Returned Error Types:

  • 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.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceAlreadyExistsException The resource already exists.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAssetModelCompositeModel

func (*IoTSiteWise) CreateAssetModelCompositeModelRequest added in v1.48.2 

func (c *IoTSiteWise) CreateAssetModelCompositeModelRequest(input *CreateAssetModelCompositeModelInput) (req *request.Request, output *CreateAssetModelCompositeModelOutput)

CreateAssetModelCompositeModelRequest generates a "aws/request.Request" representing the client's request for the CreateAssetModelCompositeModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAssetModelCompositeModel for more information on using the CreateAssetModelCompositeModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateAssetModelCompositeModelRequest method.
req, resp := client.CreateAssetModelCompositeModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAssetModelCompositeModel

func (*IoTSiteWise) CreateAssetModelCompositeModelWithContext added in v1.48.2 

func (c *IoTSiteWise) CreateAssetModelCompositeModelWithContext(ctx aws.Context, input *CreateAssetModelCompositeModelInput, opts ...request.Option) (*CreateAssetModelCompositeModelOutput, error)

CreateAssetModelCompositeModelWithContext is the same as CreateAssetModelCompositeModel with the addition of the ability to pass a context and additional request options.

See CreateAssetModelCompositeModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) CreateAssetModelRequest 

func (c *IoTSiteWise) CreateAssetModelRequest(input *CreateAssetModelInput) (req *request.Request, output *CreateAssetModelOutput)

CreateAssetModelRequest generates a "aws/request.Request" representing the client's request for the CreateAssetModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAssetModel for more information on using the CreateAssetModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateAssetModelRequest method.
req, resp := client.CreateAssetModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAssetModel

func (*IoTSiteWise) CreateAssetModelWithContext 

func (c *IoTSiteWise) CreateAssetModelWithContext(ctx aws.Context, input *CreateAssetModelInput, opts ...request.Option) (*CreateAssetModelOutput, error)

CreateAssetModelWithContext is the same as CreateAssetModel with the addition of the ability to pass a context and additional request options.

See CreateAssetModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) CreateAssetRequest 

func (c *IoTSiteWise) CreateAssetRequest(input *CreateAssetInput) (req *request.Request, output *CreateAssetOutput)

CreateAssetRequest generates a "aws/request.Request" representing the client's request for the CreateAsset operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAsset for more information on using the CreateAsset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateAssetRequest method.
req, resp := client.CreateAssetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateAsset

func (*IoTSiteWise) CreateAssetWithContext 

func (c *IoTSiteWise) CreateAssetWithContext(ctx aws.Context, input *CreateAssetInput, opts ...request.Option) (*CreateAssetOutput, error)

CreateAssetWithContext is the same as CreateAsset with the addition of the ability to pass a context and additional request options.

See CreateAsset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) CreateBulkImportJob added in v1.44.60 

func (c *IoTSiteWise) CreateBulkImportJob(input *CreateBulkImportJobInput) (*CreateBulkImportJobOutput, error)

CreateBulkImportJob API operation for AWS IoT SiteWise.

Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html) in the Amazon Simple Storage Service User Guide.

Before you create a bulk import job, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html).

Bulk import is designed to store historical data to IoT SiteWise. It does not trigger computations or notifications on IoT SiteWise warm or cold tier storage.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation CreateBulkImportJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceAlreadyExistsException The resource already exists.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateBulkImportJob

func (*IoTSiteWise) CreateBulkImportJobRequest added in v1.44.60 

func (c *IoTSiteWise) CreateBulkImportJobRequest(input *CreateBulkImportJobInput) (req *request.Request, output *CreateBulkImportJobOutput)

CreateBulkImportJobRequest generates a "aws/request.Request" representing the client's request for the CreateBulkImportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBulkImportJob for more information on using the CreateBulkImportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateBulkImportJobRequest method.
req, resp := client.CreateBulkImportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateBulkImportJob

func (*IoTSiteWise) CreateBulkImportJobWithContext added in v1.44.60 

func (c *IoTSiteWise) CreateBulkImportJobWithContext(ctx aws.Context, input *CreateBulkImportJobInput, opts ...request.Option) (*CreateBulkImportJobOutput, error)

CreateBulkImportJobWithContext is the same as CreateBulkImportJob with the addition of the ability to pass a context and additional request options.

See CreateBulkImportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) CreateDashboard 

func (c *IoTSiteWise) CreateDashboard(input *CreateDashboardInput) (*CreateDashboardOutput, error)

CreateDashboard API operation for AWS IoT SiteWise.

Creates a dashboard in an IoT SiteWise Monitor project.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation CreateDashboard for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateDashboard

func (*IoTSiteWise) CreateDashboardRequest 

func (c *IoTSiteWise) CreateDashboardRequest(input *CreateDashboardInput) (req *request.Request, output *CreateDashboardOutput)

CreateDashboardRequest generates a "aws/request.Request" representing the client's request for the CreateDashboard operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDashboard for more information on using the CreateDashboard API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateDashboardRequest method.
req, resp := client.CreateDashboardRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateDashboard

func (*IoTSiteWise) CreateDashboardWithContext 

func (c *IoTSiteWise) CreateDashboardWithContext(ctx aws.Context, input *CreateDashboardInput, opts ...request.Option) (*CreateDashboardOutput, error)

CreateDashboardWithContext is the same as CreateDashboard with the addition of the ability to pass a context and additional request options.

See CreateDashboard for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) CreateGateway 

func (c *IoTSiteWise) CreateGateway(input *CreateGatewayInput) (*CreateGatewayOutput, error)

CreateGateway API operation for AWS IoT SiteWise.

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation CreateGateway for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceAlreadyExistsException The resource already exists.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateGateway

func (*IoTSiteWise) CreateGatewayRequest 

func (c *IoTSiteWise) CreateGatewayRequest(input *CreateGatewayInput) (req *request.Request, output *CreateGatewayOutput)

CreateGatewayRequest generates a "aws/request.Request" representing the client's request for the CreateGateway operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGateway for more information on using the CreateGateway API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateGatewayRequest method.
req, resp := client.CreateGatewayRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateGateway

func (*IoTSiteWise) CreateGatewayWithContext 

func (c *IoTSiteWise) CreateGatewayWithContext(ctx aws.Context, input *CreateGatewayInput, opts ...request.Option) (*CreateGatewayOutput, error)

CreateGatewayWithContext is the same as CreateGateway with the addition of the ability to pass a context and additional request options.

See CreateGateway for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) CreatePortal 

func (c *IoTSiteWise) CreatePortal(input *CreatePortalInput) (*CreatePortalOutput, error)

CreatePortal API operation for AWS IoT SiteWise.

Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.

Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation CreatePortal for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreatePortal

func (*IoTSiteWise) CreatePortalRequest 

func (c *IoTSiteWise) CreatePortalRequest(input *CreatePortalInput) (req *request.Request, output *CreatePortalOutput)

CreatePortalRequest generates a "aws/request.Request" representing the client's request for the CreatePortal operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreatePortal for more information on using the CreatePortal API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreatePortalRequest method.
req, resp := client.CreatePortalRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreatePortal

func (*IoTSiteWise) CreatePortalWithContext 

func (c *IoTSiteWise) CreatePortalWithContext(ctx aws.Context, input *CreatePortalInput, opts ...request.Option) (*CreatePortalOutput, error)

CreatePortalWithContext is the same as CreatePortal with the addition of the ability to pass a context and additional request options.

See CreatePortal for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) CreateProject 

func (c *IoTSiteWise) CreateProject(input *CreateProjectInput) (*CreateProjectOutput, error)

CreateProject API operation for AWS IoT SiteWise.

Creates a project in the specified portal.

Make sure that the project name and description don't contain confidential information.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation CreateProject for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateProject

func (*IoTSiteWise) CreateProjectRequest 

func (c *IoTSiteWise) CreateProjectRequest(input *CreateProjectInput) (req *request.Request, output *CreateProjectOutput)

CreateProjectRequest generates a "aws/request.Request" representing the client's request for the CreateProject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateProject for more information on using the CreateProject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateProjectRequest method.
req, resp := client.CreateProjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/CreateProject

func (*IoTSiteWise) CreateProjectWithContext 

func (c *IoTSiteWise) CreateProjectWithContext(ctx aws.Context, input *CreateProjectInput, opts ...request.Option) (*CreateProjectOutput, error)

CreateProjectWithContext is the same as CreateProject with the addition of the ability to pass a context and additional request options.

See CreateProject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DeleteAccessPolicy 

func (c *IoTSiteWise) DeleteAccessPolicy(input *DeleteAccessPolicyInput) (*DeleteAccessPolicyOutput, error)

DeleteAccessPolicy API operation for AWS IoT SiteWise.

Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteAccessPolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAccessPolicy

func (*IoTSiteWise) DeleteAccessPolicyRequest 

func (c *IoTSiteWise) DeleteAccessPolicyRequest(input *DeleteAccessPolicyInput) (req *request.Request, output *DeleteAccessPolicyOutput)

DeleteAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAccessPolicy for more information on using the DeleteAccessPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAccessPolicyRequest method.
req, resp := client.DeleteAccessPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAccessPolicy

func (*IoTSiteWise) DeleteAccessPolicyWithContext 

func (c *IoTSiteWise) DeleteAccessPolicyWithContext(ctx aws.Context, input *DeleteAccessPolicyInput, opts ...request.Option) (*DeleteAccessPolicyOutput, error)

DeleteAccessPolicyWithContext is the same as DeleteAccessPolicy with the addition of the ability to pass a context and additional request options.

See DeleteAccessPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DeleteAsset 

func (c *IoTSiteWise) DeleteAsset(input *DeleteAssetInput) (*DeleteAssetOutput, error)

DeleteAsset API operation for AWS IoT SiteWise.

Deletes an asset. This action can't be undone. For more information, see Deleting assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) in the IoT SiteWise User Guide.

You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DisassociateAssets.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteAsset for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAsset

func (*IoTSiteWise) DeleteAssetModel 

func (c *IoTSiteWise) DeleteAssetModel(input *DeleteAssetModelInput) (*DeleteAssetModelOutput, error)

DeleteAssetModel API operation for AWS IoT SiteWise.

Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteAssetModel for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAssetModel

func (*IoTSiteWise) DeleteAssetModelCompositeModel added in v1.48.2 

func (c *IoTSiteWise) DeleteAssetModelCompositeModel(input *DeleteAssetModelCompositeModelInput) (*DeleteAssetModelCompositeModelOutput, error)

DeleteAssetModelCompositeModel API operation for AWS IoT SiteWise.

Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteAssetModelCompositeModel for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAssetModelCompositeModel

func (*IoTSiteWise) DeleteAssetModelCompositeModelRequest added in v1.48.2 

func (c *IoTSiteWise) DeleteAssetModelCompositeModelRequest(input *DeleteAssetModelCompositeModelInput) (req *request.Request, output *DeleteAssetModelCompositeModelOutput)

DeleteAssetModelCompositeModelRequest generates a "aws/request.Request" representing the client's request for the DeleteAssetModelCompositeModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAssetModelCompositeModel for more information on using the DeleteAssetModelCompositeModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAssetModelCompositeModelRequest method.
req, resp := client.DeleteAssetModelCompositeModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAssetModelCompositeModel

func (*IoTSiteWise) DeleteAssetModelCompositeModelWithContext added in v1.48.2 

func (c *IoTSiteWise) DeleteAssetModelCompositeModelWithContext(ctx aws.Context, input *DeleteAssetModelCompositeModelInput, opts ...request.Option) (*DeleteAssetModelCompositeModelOutput, error)

DeleteAssetModelCompositeModelWithContext is the same as DeleteAssetModelCompositeModel with the addition of the ability to pass a context and additional request options.

See DeleteAssetModelCompositeModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DeleteAssetModelRequest 

func (c *IoTSiteWise) DeleteAssetModelRequest(input *DeleteAssetModelInput) (req *request.Request, output *DeleteAssetModelOutput)

DeleteAssetModelRequest generates a "aws/request.Request" representing the client's request for the DeleteAssetModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAssetModel for more information on using the DeleteAssetModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAssetModelRequest method.
req, resp := client.DeleteAssetModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAssetModel

func (*IoTSiteWise) DeleteAssetModelWithContext 

func (c *IoTSiteWise) DeleteAssetModelWithContext(ctx aws.Context, input *DeleteAssetModelInput, opts ...request.Option) (*DeleteAssetModelOutput, error)

DeleteAssetModelWithContext is the same as DeleteAssetModel with the addition of the ability to pass a context and additional request options.

See DeleteAssetModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DeleteAssetRequest 

func (c *IoTSiteWise) DeleteAssetRequest(input *DeleteAssetInput) (req *request.Request, output *DeleteAssetOutput)

DeleteAssetRequest generates a "aws/request.Request" representing the client's request for the DeleteAsset operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAsset for more information on using the DeleteAsset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteAssetRequest method.
req, resp := client.DeleteAssetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteAsset

func (*IoTSiteWise) DeleteAssetWithContext 

func (c *IoTSiteWise) DeleteAssetWithContext(ctx aws.Context, input *DeleteAssetInput, opts ...request.Option) (*DeleteAssetOutput, error)

DeleteAssetWithContext is the same as DeleteAsset with the addition of the ability to pass a context and additional request options.

See DeleteAsset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DeleteDashboard 

func (c *IoTSiteWise) DeleteDashboard(input *DeleteDashboardInput) (*DeleteDashboardOutput, error)

DeleteDashboard API operation for AWS IoT SiteWise.

Deletes a dashboard from IoT SiteWise Monitor.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteDashboard for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteDashboard

func (*IoTSiteWise) DeleteDashboardRequest 

func (c *IoTSiteWise) DeleteDashboardRequest(input *DeleteDashboardInput) (req *request.Request, output *DeleteDashboardOutput)

DeleteDashboardRequest generates a "aws/request.Request" representing the client's request for the DeleteDashboard operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDashboard for more information on using the DeleteDashboard API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteDashboardRequest method.
req, resp := client.DeleteDashboardRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteDashboard

func (*IoTSiteWise) DeleteDashboardWithContext 

func (c *IoTSiteWise) DeleteDashboardWithContext(ctx aws.Context, input *DeleteDashboardInput, opts ...request.Option) (*DeleteDashboardOutput, error)

DeleteDashboardWithContext is the same as DeleteDashboard with the addition of the ability to pass a context and additional request options.

See DeleteDashboard for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DeleteGateway 

func (c *IoTSiteWise) DeleteGateway(input *DeleteGatewayInput) (*DeleteGatewayOutput, error)

DeleteGateway API operation for AWS IoT SiteWise.

Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteGateway for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteGateway

func (*IoTSiteWise) DeleteGatewayRequest 

func (c *IoTSiteWise) DeleteGatewayRequest(input *DeleteGatewayInput) (req *request.Request, output *DeleteGatewayOutput)

DeleteGatewayRequest generates a "aws/request.Request" representing the client's request for the DeleteGateway operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGateway for more information on using the DeleteGateway API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteGatewayRequest method.
req, resp := client.DeleteGatewayRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteGateway

func (*IoTSiteWise) DeleteGatewayWithContext 

func (c *IoTSiteWise) DeleteGatewayWithContext(ctx aws.Context, input *DeleteGatewayInput, opts ...request.Option) (*DeleteGatewayOutput, error)

DeleteGatewayWithContext is the same as DeleteGateway with the addition of the ability to pass a context and additional request options.

See DeleteGateway for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DeletePortal 

func (c *IoTSiteWise) DeletePortal(input *DeletePortalInput) (*DeletePortalOutput, error)

DeletePortal API operation for AWS IoT SiteWise.

Deletes a portal from IoT SiteWise Monitor.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DeletePortal for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeletePortal

func (*IoTSiteWise) DeletePortalRequest 

func (c *IoTSiteWise) DeletePortalRequest(input *DeletePortalInput) (req *request.Request, output *DeletePortalOutput)

DeletePortalRequest generates a "aws/request.Request" representing the client's request for the DeletePortal operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeletePortal for more information on using the DeletePortal API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeletePortalRequest method.
req, resp := client.DeletePortalRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeletePortal

func (*IoTSiteWise) DeletePortalWithContext 

func (c *IoTSiteWise) DeletePortalWithContext(ctx aws.Context, input *DeletePortalInput, opts ...request.Option) (*DeletePortalOutput, error)

DeletePortalWithContext is the same as DeletePortal with the addition of the ability to pass a context and additional request options.

See DeletePortal for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DeleteProject 

func (c *IoTSiteWise) DeleteProject(input *DeleteProjectInput) (*DeleteProjectOutput, error)

DeleteProject API operation for AWS IoT SiteWise.

Deletes a project from IoT SiteWise Monitor.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteProject for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteProject

func (*IoTSiteWise) DeleteProjectRequest 

func (c *IoTSiteWise) DeleteProjectRequest(input *DeleteProjectInput) (req *request.Request, output *DeleteProjectOutput)

DeleteProjectRequest generates a "aws/request.Request" representing the client's request for the DeleteProject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteProject for more information on using the DeleteProject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteProjectRequest method.
req, resp := client.DeleteProjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteProject

func (*IoTSiteWise) DeleteProjectWithContext 

func (c *IoTSiteWise) DeleteProjectWithContext(ctx aws.Context, input *DeleteProjectInput, opts ...request.Option) (*DeleteProjectOutput, error)

DeleteProjectWithContext is the same as DeleteProject with the addition of the ability to pass a context and additional request options.

See DeleteProject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DeleteTimeSeries added in v1.42.12 

func (c *IoTSiteWise) DeleteTimeSeries(input *DeleteTimeSeriesInput) (*DeleteTimeSeriesOutput, error)

DeleteTimeSeries API operation for AWS IoT SiteWise.

Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property.

To identify a time series, do one of the following:

  • If the time series isn't associated with an asset property, specify the alias of the time series.

  • If the time series is associated with an asset property, specify one of the following: The alias of the time series. The assetId and propertyId that identifies the asset property.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DeleteTimeSeries for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteTimeSeries

func (*IoTSiteWise) DeleteTimeSeriesRequest added in v1.42.12 

func (c *IoTSiteWise) DeleteTimeSeriesRequest(input *DeleteTimeSeriesInput) (req *request.Request, output *DeleteTimeSeriesOutput)

DeleteTimeSeriesRequest generates a "aws/request.Request" representing the client's request for the DeleteTimeSeries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTimeSeries for more information on using the DeleteTimeSeries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteTimeSeriesRequest method.
req, resp := client.DeleteTimeSeriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DeleteTimeSeries

func (*IoTSiteWise) DeleteTimeSeriesWithContext added in v1.42.12 

func (c *IoTSiteWise) DeleteTimeSeriesWithContext(ctx aws.Context, input *DeleteTimeSeriesInput, opts ...request.Option) (*DeleteTimeSeriesOutput, error)

DeleteTimeSeriesWithContext is the same as DeleteTimeSeries with the addition of the ability to pass a context and additional request options.

See DeleteTimeSeries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeAccessPolicy 

func (c *IoTSiteWise) DescribeAccessPolicy(input *DescribeAccessPolicyInput) (*DescribeAccessPolicyOutput, error)

DescribeAccessPolicy API operation for AWS IoT SiteWise.

Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeAccessPolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAccessPolicy

func (*IoTSiteWise) DescribeAccessPolicyRequest 

func (c *IoTSiteWise) DescribeAccessPolicyRequest(input *DescribeAccessPolicyInput) (req *request.Request, output *DescribeAccessPolicyOutput)

DescribeAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the DescribeAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAccessPolicy for more information on using the DescribeAccessPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAccessPolicyRequest method.
req, resp := client.DescribeAccessPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAccessPolicy

func (*IoTSiteWise) DescribeAccessPolicyWithContext 

func (c *IoTSiteWise) DescribeAccessPolicyWithContext(ctx aws.Context, input *DescribeAccessPolicyInput, opts ...request.Option) (*DescribeAccessPolicyOutput, error)

DescribeAccessPolicyWithContext is the same as DescribeAccessPolicy with the addition of the ability to pass a context and additional request options.

See DescribeAccessPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeAction added in v1.48.2 

func (c *IoTSiteWise) DescribeAction(input *DescribeActionInput) (*DescribeActionOutput, error)

DescribeAction API operation for AWS IoT SiteWise.

Retrieves information about an action.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeAction for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAction

func (*IoTSiteWise) DescribeActionRequest added in v1.48.2 

func (c *IoTSiteWise) DescribeActionRequest(input *DescribeActionInput) (req *request.Request, output *DescribeActionOutput)

DescribeActionRequest generates a "aws/request.Request" representing the client's request for the DescribeAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAction for more information on using the DescribeAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeActionRequest method.
req, resp := client.DescribeActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAction

func (*IoTSiteWise) DescribeActionWithContext added in v1.48.2 

func (c *IoTSiteWise) DescribeActionWithContext(ctx aws.Context, input *DescribeActionInput, opts ...request.Option) (*DescribeActionOutput, error)

DescribeActionWithContext is the same as DescribeAction with the addition of the ability to pass a context and additional request options.

See DescribeAction for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeAsset 

func (c *IoTSiteWise) DescribeAsset(input *DescribeAssetInput) (*DescribeAssetOutput, error)

DescribeAsset API operation for AWS IoT SiteWise.

Retrieves information about an asset.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeAsset for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAsset

func (*IoTSiteWise) DescribeAssetCompositeModel added in v1.48.2 

func (c *IoTSiteWise) DescribeAssetCompositeModel(input *DescribeAssetCompositeModelInput) (*DescribeAssetCompositeModelOutput, error)

DescribeAssetCompositeModel API operation for AWS IoT SiteWise.

Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModelCompositeModel.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeAssetCompositeModel for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetCompositeModel

func (*IoTSiteWise) DescribeAssetCompositeModelRequest added in v1.48.2 

func (c *IoTSiteWise) DescribeAssetCompositeModelRequest(input *DescribeAssetCompositeModelInput) (req *request.Request, output *DescribeAssetCompositeModelOutput)

DescribeAssetCompositeModelRequest generates a "aws/request.Request" representing the client's request for the DescribeAssetCompositeModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAssetCompositeModel for more information on using the DescribeAssetCompositeModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAssetCompositeModelRequest method.
req, resp := client.DescribeAssetCompositeModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetCompositeModel

func (*IoTSiteWise) DescribeAssetCompositeModelWithContext added in v1.48.2 

func (c *IoTSiteWise) DescribeAssetCompositeModelWithContext(ctx aws.Context, input *DescribeAssetCompositeModelInput, opts ...request.Option) (*DescribeAssetCompositeModelOutput, error)

DescribeAssetCompositeModelWithContext is the same as DescribeAssetCompositeModel with the addition of the ability to pass a context and additional request options.

See DescribeAssetCompositeModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeAssetModel 

func (c *IoTSiteWise) DescribeAssetModel(input *DescribeAssetModelInput) (*DescribeAssetModelOutput, error)

DescribeAssetModel API operation for AWS IoT SiteWise.

Retrieves information about an asset model.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeAssetModel for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetModel

func (*IoTSiteWise) DescribeAssetModelCompositeModel added in v1.48.2 

func (c *IoTSiteWise) DescribeAssetModelCompositeModel(input *DescribeAssetModelCompositeModelInput) (*DescribeAssetModelCompositeModelOutput, error)

DescribeAssetModelCompositeModel API operation for AWS IoT SiteWise.

Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeAssetModelCompositeModel for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetModelCompositeModel

func (*IoTSiteWise) DescribeAssetModelCompositeModelRequest added in v1.48.2 

func (c *IoTSiteWise) DescribeAssetModelCompositeModelRequest(input *DescribeAssetModelCompositeModelInput) (req *request.Request, output *DescribeAssetModelCompositeModelOutput)

DescribeAssetModelCompositeModelRequest generates a "aws/request.Request" representing the client's request for the DescribeAssetModelCompositeModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAssetModelCompositeModel for more information on using the DescribeAssetModelCompositeModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAssetModelCompositeModelRequest method.
req, resp := client.DescribeAssetModelCompositeModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetModelCompositeModel

func (*IoTSiteWise) DescribeAssetModelCompositeModelWithContext added in v1.48.2 

func (c *IoTSiteWise) DescribeAssetModelCompositeModelWithContext(ctx aws.Context, input *DescribeAssetModelCompositeModelInput, opts ...request.Option) (*DescribeAssetModelCompositeModelOutput, error)

DescribeAssetModelCompositeModelWithContext is the same as DescribeAssetModelCompositeModel with the addition of the ability to pass a context and additional request options.

See DescribeAssetModelCompositeModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeAssetModelRequest 

func (c *IoTSiteWise) DescribeAssetModelRequest(input *DescribeAssetModelInput) (req *request.Request, output *DescribeAssetModelOutput)

DescribeAssetModelRequest generates a "aws/request.Request" representing the client's request for the DescribeAssetModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAssetModel for more information on using the DescribeAssetModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAssetModelRequest method.
req, resp := client.DescribeAssetModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetModel

func (*IoTSiteWise) DescribeAssetModelWithContext 

func (c *IoTSiteWise) DescribeAssetModelWithContext(ctx aws.Context, input *DescribeAssetModelInput, opts ...request.Option) (*DescribeAssetModelOutput, error)

DescribeAssetModelWithContext is the same as DescribeAssetModel with the addition of the ability to pass a context and additional request options.

See DescribeAssetModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeAssetProperty 

func (c *IoTSiteWise) DescribeAssetProperty(input *DescribeAssetPropertyInput) (*DescribeAssetPropertyOutput, error)

DescribeAssetProperty API operation for AWS IoT SiteWise.

Retrieves information about an asset property.

When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeAssetProperty for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetProperty

func (*IoTSiteWise) DescribeAssetPropertyRequest 

func (c *IoTSiteWise) DescribeAssetPropertyRequest(input *DescribeAssetPropertyInput) (req *request.Request, output *DescribeAssetPropertyOutput)

DescribeAssetPropertyRequest generates a "aws/request.Request" representing the client's request for the DescribeAssetProperty operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAssetProperty for more information on using the DescribeAssetProperty API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAssetPropertyRequest method.
req, resp := client.DescribeAssetPropertyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAssetProperty

func (*IoTSiteWise) DescribeAssetPropertyWithContext 

func (c *IoTSiteWise) DescribeAssetPropertyWithContext(ctx aws.Context, input *DescribeAssetPropertyInput, opts ...request.Option) (*DescribeAssetPropertyOutput, error)

DescribeAssetPropertyWithContext is the same as DescribeAssetProperty with the addition of the ability to pass a context and additional request options.

See DescribeAssetProperty for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeAssetRequest 

func (c *IoTSiteWise) DescribeAssetRequest(input *DescribeAssetInput) (req *request.Request, output *DescribeAssetOutput)

DescribeAssetRequest generates a "aws/request.Request" representing the client's request for the DescribeAsset operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeAsset for more information on using the DescribeAsset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeAssetRequest method.
req, resp := client.DescribeAssetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeAsset

func (*IoTSiteWise) DescribeAssetWithContext 

func (c *IoTSiteWise) DescribeAssetWithContext(ctx aws.Context, input *DescribeAssetInput, opts ...request.Option) (*DescribeAssetOutput, error)

DescribeAssetWithContext is the same as DescribeAsset with the addition of the ability to pass a context and additional request options.

See DescribeAsset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeBulkImportJob added in v1.44.60 

func (c *IoTSiteWise) DescribeBulkImportJob(input *DescribeBulkImportJobInput) (*DescribeBulkImportJobOutput, error)

DescribeBulkImportJob API operation for AWS IoT SiteWise.

Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html) in the Amazon Simple Storage Service User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeBulkImportJob for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeBulkImportJob

func (*IoTSiteWise) DescribeBulkImportJobRequest added in v1.44.60 

func (c *IoTSiteWise) DescribeBulkImportJobRequest(input *DescribeBulkImportJobInput) (req *request.Request, output *DescribeBulkImportJobOutput)

DescribeBulkImportJobRequest generates a "aws/request.Request" representing the client's request for the DescribeBulkImportJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBulkImportJob for more information on using the DescribeBulkImportJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeBulkImportJobRequest method.
req, resp := client.DescribeBulkImportJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeBulkImportJob

func (*IoTSiteWise) DescribeBulkImportJobWithContext added in v1.44.60 

func (c *IoTSiteWise) DescribeBulkImportJobWithContext(ctx aws.Context, input *DescribeBulkImportJobInput, opts ...request.Option) (*DescribeBulkImportJobOutput, error)

DescribeBulkImportJobWithContext is the same as DescribeBulkImportJob with the addition of the ability to pass a context and additional request options.

See DescribeBulkImportJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeDashboard 

func (c *IoTSiteWise) DescribeDashboard(input *DescribeDashboardInput) (*DescribeDashboardOutput, error)

DescribeDashboard API operation for AWS IoT SiteWise.

Retrieves information about a dashboard.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeDashboard for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeDashboard

func (*IoTSiteWise) DescribeDashboardRequest 

func (c *IoTSiteWise) DescribeDashboardRequest(input *DescribeDashboardInput) (req *request.Request, output *DescribeDashboardOutput)

DescribeDashboardRequest generates a "aws/request.Request" representing the client's request for the DescribeDashboard operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDashboard for more information on using the DescribeDashboard API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeDashboardRequest method.
req, resp := client.DescribeDashboardRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeDashboard

func (*IoTSiteWise) DescribeDashboardWithContext 

func (c *IoTSiteWise) DescribeDashboardWithContext(ctx aws.Context, input *DescribeDashboardInput, opts ...request.Option) (*DescribeDashboardOutput, error)

DescribeDashboardWithContext is the same as DescribeDashboard with the addition of the ability to pass a context and additional request options.

See DescribeDashboard for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeDefaultEncryptionConfiguration added in v1.35.35 

func (c *IoTSiteWise) DescribeDefaultEncryptionConfiguration(input *DescribeDefaultEncryptionConfigurationInput) (*DescribeDefaultEncryptionConfigurationOutput, error)

DescribeDefaultEncryptionConfiguration API operation for AWS IoT SiteWise.

Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeDefaultEncryptionConfiguration for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration

func (*IoTSiteWise) DescribeDefaultEncryptionConfigurationRequest added in v1.35.35 

func (c *IoTSiteWise) DescribeDefaultEncryptionConfigurationRequest(input *DescribeDefaultEncryptionConfigurationInput) (req *request.Request, output *DescribeDefaultEncryptionConfigurationOutput)

DescribeDefaultEncryptionConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeDefaultEncryptionConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDefaultEncryptionConfiguration for more information on using the DescribeDefaultEncryptionConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeDefaultEncryptionConfigurationRequest method.
req, resp := client.DescribeDefaultEncryptionConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeDefaultEncryptionConfiguration

func (*IoTSiteWise) DescribeDefaultEncryptionConfigurationWithContext added in v1.35.35 

func (c *IoTSiteWise) DescribeDefaultEncryptionConfigurationWithContext(ctx aws.Context, input *DescribeDefaultEncryptionConfigurationInput, opts ...request.Option) (*DescribeDefaultEncryptionConfigurationOutput, error)

DescribeDefaultEncryptionConfigurationWithContext is the same as DescribeDefaultEncryptionConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeDefaultEncryptionConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeGateway 

func (c *IoTSiteWise) DescribeGateway(input *DescribeGatewayInput) (*DescribeGatewayOutput, error)

DescribeGateway API operation for AWS IoT SiteWise.

Retrieves information about a gateway.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeGateway for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeGateway

func (*IoTSiteWise) DescribeGatewayCapabilityConfiguration 

func (c *IoTSiteWise) DescribeGatewayCapabilityConfiguration(input *DescribeGatewayCapabilityConfigurationInput) (*DescribeGatewayCapabilityConfigurationOutput, error)

DescribeGatewayCapabilityConfiguration API operation for AWS IoT SiteWise.

Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeGatewayCapabilityConfiguration for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration

func (*IoTSiteWise) DescribeGatewayCapabilityConfigurationRequest 

func (c *IoTSiteWise) DescribeGatewayCapabilityConfigurationRequest(input *DescribeGatewayCapabilityConfigurationInput) (req *request.Request, output *DescribeGatewayCapabilityConfigurationOutput)

DescribeGatewayCapabilityConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeGatewayCapabilityConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGatewayCapabilityConfiguration for more information on using the DescribeGatewayCapabilityConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeGatewayCapabilityConfigurationRequest method.
req, resp := client.DescribeGatewayCapabilityConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeGatewayCapabilityConfiguration

func (*IoTSiteWise) DescribeGatewayCapabilityConfigurationWithContext 

func (c *IoTSiteWise) DescribeGatewayCapabilityConfigurationWithContext(ctx aws.Context, input *DescribeGatewayCapabilityConfigurationInput, opts ...request.Option) (*DescribeGatewayCapabilityConfigurationOutput, error)

DescribeGatewayCapabilityConfigurationWithContext is the same as DescribeGatewayCapabilityConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeGatewayCapabilityConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeGatewayRequest 

func (c *IoTSiteWise) DescribeGatewayRequest(input *DescribeGatewayInput) (req *request.Request, output *DescribeGatewayOutput)

DescribeGatewayRequest generates a "aws/request.Request" representing the client's request for the DescribeGateway operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGateway for more information on using the DescribeGateway API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeGatewayRequest method.
req, resp := client.DescribeGatewayRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeGateway

func (*IoTSiteWise) DescribeGatewayWithContext 

func (c *IoTSiteWise) DescribeGatewayWithContext(ctx aws.Context, input *DescribeGatewayInput, opts ...request.Option) (*DescribeGatewayOutput, error)

DescribeGatewayWithContext is the same as DescribeGateway with the addition of the ability to pass a context and additional request options.

See DescribeGateway for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeLoggingOptions 

func (c *IoTSiteWise) DescribeLoggingOptions(input *DescribeLoggingOptionsInput) (*DescribeLoggingOptionsOutput, error)

DescribeLoggingOptions API operation for AWS IoT SiteWise.

Retrieves the current IoT SiteWise logging options.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeLoggingOptions for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ResourceNotFoundException The requested resource can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeLoggingOptions

func (*IoTSiteWise) DescribeLoggingOptionsRequest 

func (c *IoTSiteWise) DescribeLoggingOptionsRequest(input *DescribeLoggingOptionsInput) (req *request.Request, output *DescribeLoggingOptionsOutput)

DescribeLoggingOptionsRequest generates a "aws/request.Request" representing the client's request for the DescribeLoggingOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLoggingOptions for more information on using the DescribeLoggingOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeLoggingOptionsRequest method.
req, resp := client.DescribeLoggingOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeLoggingOptions

func (*IoTSiteWise) DescribeLoggingOptionsWithContext 

func (c *IoTSiteWise) DescribeLoggingOptionsWithContext(ctx aws.Context, input *DescribeLoggingOptionsInput, opts ...request.Option) (*DescribeLoggingOptionsOutput, error)

DescribeLoggingOptionsWithContext is the same as DescribeLoggingOptions with the addition of the ability to pass a context and additional request options.

See DescribeLoggingOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribePortal 

func (c *IoTSiteWise) DescribePortal(input *DescribePortalInput) (*DescribePortalOutput, error)

DescribePortal API operation for AWS IoT SiteWise.

Retrieves information about a portal.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribePortal for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribePortal

func (*IoTSiteWise) DescribePortalRequest 

func (c *IoTSiteWise) DescribePortalRequest(input *DescribePortalInput) (req *request.Request, output *DescribePortalOutput)

DescribePortalRequest generates a "aws/request.Request" representing the client's request for the DescribePortal operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribePortal for more information on using the DescribePortal API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribePortalRequest method.
req, resp := client.DescribePortalRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribePortal

func (*IoTSiteWise) DescribePortalWithContext 

func (c *IoTSiteWise) DescribePortalWithContext(ctx aws.Context, input *DescribePortalInput, opts ...request.Option) (*DescribePortalOutput, error)

DescribePortalWithContext is the same as DescribePortal with the addition of the ability to pass a context and additional request options.

See DescribePortal for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeProject 

func (c *IoTSiteWise) DescribeProject(input *DescribeProjectInput) (*DescribeProjectOutput, error)

DescribeProject API operation for AWS IoT SiteWise.

Retrieves information about a project.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeProject for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeProject

func (*IoTSiteWise) DescribeProjectRequest 

func (c *IoTSiteWise) DescribeProjectRequest(input *DescribeProjectInput) (req *request.Request, output *DescribeProjectOutput)

DescribeProjectRequest generates a "aws/request.Request" representing the client's request for the DescribeProject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeProject for more information on using the DescribeProject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeProjectRequest method.
req, resp := client.DescribeProjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeProject

func (*IoTSiteWise) DescribeProjectWithContext 

func (c *IoTSiteWise) DescribeProjectWithContext(ctx aws.Context, input *DescribeProjectInput, opts ...request.Option) (*DescribeProjectOutput, error)

DescribeProjectWithContext is the same as DescribeProject with the addition of the ability to pass a context and additional request options.

See DescribeProject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeStorageConfiguration added in v1.39.2 

func (c *IoTSiteWise) DescribeStorageConfiguration(input *DescribeStorageConfigurationInput) (*DescribeStorageConfigurationOutput, error)

DescribeStorageConfiguration API operation for AWS IoT SiteWise.

Retrieves information about the storage configuration for IoT SiteWise.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeStorageConfiguration for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeStorageConfiguration

func (*IoTSiteWise) DescribeStorageConfigurationRequest added in v1.39.2 

func (c *IoTSiteWise) DescribeStorageConfigurationRequest(input *DescribeStorageConfigurationInput) (req *request.Request, output *DescribeStorageConfigurationOutput)

DescribeStorageConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeStorageConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeStorageConfiguration for more information on using the DescribeStorageConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeStorageConfigurationRequest method.
req, resp := client.DescribeStorageConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeStorageConfiguration

func (*IoTSiteWise) DescribeStorageConfigurationWithContext added in v1.39.2 

func (c *IoTSiteWise) DescribeStorageConfigurationWithContext(ctx aws.Context, input *DescribeStorageConfigurationInput, opts ...request.Option) (*DescribeStorageConfigurationOutput, error)

DescribeStorageConfigurationWithContext is the same as DescribeStorageConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeStorageConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DescribeTimeSeries added in v1.42.12 

func (c *IoTSiteWise) DescribeTimeSeries(input *DescribeTimeSeriesInput) (*DescribeTimeSeriesOutput, error)

DescribeTimeSeries API operation for AWS IoT SiteWise.

Retrieves information about a time series (data stream).

To identify a time series, do one of the following:

  • If the time series isn't associated with an asset property, specify the alias of the time series.

  • If the time series is associated with an asset property, specify one of the following: The alias of the time series. The assetId and propertyId that identifies the asset property.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DescribeTimeSeries for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeTimeSeries

func (*IoTSiteWise) DescribeTimeSeriesRequest added in v1.42.12 

func (c *IoTSiteWise) DescribeTimeSeriesRequest(input *DescribeTimeSeriesInput) (req *request.Request, output *DescribeTimeSeriesOutput)

DescribeTimeSeriesRequest generates a "aws/request.Request" representing the client's request for the DescribeTimeSeries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTimeSeries for more information on using the DescribeTimeSeries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTimeSeriesRequest method.
req, resp := client.DescribeTimeSeriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DescribeTimeSeries

func (*IoTSiteWise) DescribeTimeSeriesWithContext added in v1.42.12 

func (c *IoTSiteWise) DescribeTimeSeriesWithContext(ctx aws.Context, input *DescribeTimeSeriesInput, opts ...request.Option) (*DescribeTimeSeriesOutput, error)

DescribeTimeSeriesWithContext is the same as DescribeTimeSeries with the addition of the ability to pass a context and additional request options.

See DescribeTimeSeries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DisassociateAssets 

func (c *IoTSiteWise) DisassociateAssets(input *DisassociateAssetsInput) (*DisassociateAssetsOutput, error)

DisassociateAssets API operation for AWS IoT SiteWise.

Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DisassociateAssets for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DisassociateAssets

func (*IoTSiteWise) DisassociateAssetsRequest 

func (c *IoTSiteWise) DisassociateAssetsRequest(input *DisassociateAssetsInput) (req *request.Request, output *DisassociateAssetsOutput)

DisassociateAssetsRequest generates a "aws/request.Request" representing the client's request for the DisassociateAssets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateAssets for more information on using the DisassociateAssets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateAssetsRequest method.
req, resp := client.DisassociateAssetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DisassociateAssets

func (*IoTSiteWise) DisassociateAssetsWithContext 

func (c *IoTSiteWise) DisassociateAssetsWithContext(ctx aws.Context, input *DisassociateAssetsInput, opts ...request.Option) (*DisassociateAssetsOutput, error)

DisassociateAssetsWithContext is the same as DisassociateAssets with the addition of the ability to pass a context and additional request options.

See DisassociateAssets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) DisassociateTimeSeriesFromAssetProperty added in v1.42.12 

func (c *IoTSiteWise) DisassociateTimeSeriesFromAssetProperty(input *DisassociateTimeSeriesFromAssetPropertyInput) (*DisassociateTimeSeriesFromAssetPropertyOutput, error)

DisassociateTimeSeriesFromAssetProperty API operation for AWS IoT SiteWise.

Disassociates a time series (data stream) from an asset property.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation DisassociateTimeSeriesFromAssetProperty for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DisassociateTimeSeriesFromAssetProperty

func (*IoTSiteWise) DisassociateTimeSeriesFromAssetPropertyRequest added in v1.42.12 

func (c *IoTSiteWise) DisassociateTimeSeriesFromAssetPropertyRequest(input *DisassociateTimeSeriesFromAssetPropertyInput) (req *request.Request, output *DisassociateTimeSeriesFromAssetPropertyOutput)

DisassociateTimeSeriesFromAssetPropertyRequest generates a "aws/request.Request" representing the client's request for the DisassociateTimeSeriesFromAssetProperty operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateTimeSeriesFromAssetProperty for more information on using the DisassociateTimeSeriesFromAssetProperty API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateTimeSeriesFromAssetPropertyRequest method.
req, resp := client.DisassociateTimeSeriesFromAssetPropertyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/DisassociateTimeSeriesFromAssetProperty

func (*IoTSiteWise) DisassociateTimeSeriesFromAssetPropertyWithContext added in v1.42.12 

func (c *IoTSiteWise) DisassociateTimeSeriesFromAssetPropertyWithContext(ctx aws.Context, input *DisassociateTimeSeriesFromAssetPropertyInput, opts ...request.Option) (*DisassociateTimeSeriesFromAssetPropertyOutput, error)

DisassociateTimeSeriesFromAssetPropertyWithContext is the same as DisassociateTimeSeriesFromAssetProperty with the addition of the ability to pass a context and additional request options.

See DisassociateTimeSeriesFromAssetProperty for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ExecuteAction added in v1.48.2 

func (c *IoTSiteWise) ExecuteAction(input *ExecuteActionInput) (*ExecuteActionOutput, error)

ExecuteAction API operation for AWS IoT SiteWise.

Executes an action on a target resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ExecuteAction for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ExecuteAction

func (*IoTSiteWise) ExecuteActionRequest added in v1.48.2 

func (c *IoTSiteWise) ExecuteActionRequest(input *ExecuteActionInput) (req *request.Request, output *ExecuteActionOutput)

ExecuteActionRequest generates a "aws/request.Request" representing the client's request for the ExecuteAction operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExecuteAction for more information on using the ExecuteAction API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ExecuteActionRequest method.
req, resp := client.ExecuteActionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ExecuteAction

func (*IoTSiteWise) ExecuteActionWithContext added in v1.48.2 

func (c *IoTSiteWise) ExecuteActionWithContext(ctx aws.Context, input *ExecuteActionInput, opts ...request.Option) (*ExecuteActionOutput, error)

ExecuteActionWithContext is the same as ExecuteAction with the addition of the ability to pass a context and additional request options.

See ExecuteAction for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ExecuteQuery added in v1.48.2 

func (c *IoTSiteWise) ExecuteQuery(input *ExecuteQueryInput) (*ExecuteQueryOutput, error)

ExecuteQuery API operation for AWS IoT SiteWise.

Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ExecuteQuery for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • AccessDeniedException Access is denied.

  • ValidationException The validation failed for this query.

  • QueryTimeoutException The query timed out.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ServiceUnavailableException The requested service is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ExecuteQuery

func (*IoTSiteWise) ExecuteQueryPages added in v1.48.2 

func (c *IoTSiteWise) ExecuteQueryPages(input *ExecuteQueryInput, fn func(*ExecuteQueryOutput, bool) bool) error

ExecuteQueryPages iterates over the pages of a ExecuteQuery operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ExecuteQuery method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ExecuteQuery operation.
pageNum := 0
err := client.ExecuteQueryPages(params,
    func(page *iotsitewise.ExecuteQueryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ExecuteQueryPagesWithContext added in v1.48.2 

func (c *IoTSiteWise) ExecuteQueryPagesWithContext(ctx aws.Context, input *ExecuteQueryInput, fn func(*ExecuteQueryOutput, bool) bool, opts ...request.Option) error

ExecuteQueryPagesWithContext same as ExecuteQueryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ExecuteQueryRequest added in v1.48.2 

func (c *IoTSiteWise) ExecuteQueryRequest(input *ExecuteQueryInput) (req *request.Request, output *ExecuteQueryOutput)

ExecuteQueryRequest generates a "aws/request.Request" representing the client's request for the ExecuteQuery operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExecuteQuery for more information on using the ExecuteQuery API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ExecuteQueryRequest method.
req, resp := client.ExecuteQueryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ExecuteQuery

func (*IoTSiteWise) ExecuteQueryWithContext added in v1.48.2 

func (c *IoTSiteWise) ExecuteQueryWithContext(ctx aws.Context, input *ExecuteQueryInput, opts ...request.Option) (*ExecuteQueryOutput, error)

ExecuteQueryWithContext is the same as ExecuteQuery with the addition of the ability to pass a context and additional request options.

See ExecuteQuery for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) GetAssetPropertyAggregates 

func (c *IoTSiteWise) GetAssetPropertyAggregates(input *GetAssetPropertyAggregatesInput) (*GetAssetPropertyAggregatesOutput, error)

GetAssetPropertyAggregates API operation for AWS IoT SiteWise.

Gets aggregated values for an asset property. For more information, see Querying aggregates (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation GetAssetPropertyAggregates for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • ServiceUnavailableException The requested service is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GetAssetPropertyAggregates

func (*IoTSiteWise) GetAssetPropertyAggregatesPages 

func (c *IoTSiteWise) GetAssetPropertyAggregatesPages(input *GetAssetPropertyAggregatesInput, fn func(*GetAssetPropertyAggregatesOutput, bool) bool) error

GetAssetPropertyAggregatesPages iterates over the pages of a GetAssetPropertyAggregates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetAssetPropertyAggregates method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetAssetPropertyAggregates operation.
pageNum := 0
err := client.GetAssetPropertyAggregatesPages(params,
    func(page *iotsitewise.GetAssetPropertyAggregatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) GetAssetPropertyAggregatesPagesWithContext 

func (c *IoTSiteWise) GetAssetPropertyAggregatesPagesWithContext(ctx aws.Context, input *GetAssetPropertyAggregatesInput, fn func(*GetAssetPropertyAggregatesOutput, bool) bool, opts ...request.Option) error

GetAssetPropertyAggregatesPagesWithContext same as GetAssetPropertyAggregatesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) GetAssetPropertyAggregatesRequest 

func (c *IoTSiteWise) GetAssetPropertyAggregatesRequest(input *GetAssetPropertyAggregatesInput) (req *request.Request, output *GetAssetPropertyAggregatesOutput)

GetAssetPropertyAggregatesRequest generates a "aws/request.Request" representing the client's request for the GetAssetPropertyAggregates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAssetPropertyAggregates for more information on using the GetAssetPropertyAggregates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAssetPropertyAggregatesRequest method.
req, resp := client.GetAssetPropertyAggregatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GetAssetPropertyAggregates

func (*IoTSiteWise) GetAssetPropertyAggregatesWithContext 

func (c *IoTSiteWise) GetAssetPropertyAggregatesWithContext(ctx aws.Context, input *GetAssetPropertyAggregatesInput, opts ...request.Option) (*GetAssetPropertyAggregatesOutput, error)

GetAssetPropertyAggregatesWithContext is the same as GetAssetPropertyAggregates with the addition of the ability to pass a context and additional request options.

See GetAssetPropertyAggregates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) GetAssetPropertyValue 

func (c *IoTSiteWise) GetAssetPropertyValue(input *GetAssetPropertyValueInput) (*GetAssetPropertyValueOutput, error)

GetAssetPropertyValue API operation for AWS IoT SiteWise.

Gets an asset property's current value. For more information, see Querying current values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation GetAssetPropertyValue for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • ServiceUnavailableException The requested service is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GetAssetPropertyValue

func (*IoTSiteWise) GetAssetPropertyValueHistory 

func (c *IoTSiteWise) GetAssetPropertyValueHistory(input *GetAssetPropertyValueHistoryInput) (*GetAssetPropertyValueHistoryOutput, error)

GetAssetPropertyValueHistory API operation for AWS IoT SiteWise.

Gets the history of an asset property's values. For more information, see Querying historical values (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation GetAssetPropertyValueHistory for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • ServiceUnavailableException The requested service is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GetAssetPropertyValueHistory

func (*IoTSiteWise) GetAssetPropertyValueHistoryPages 

func (c *IoTSiteWise) GetAssetPropertyValueHistoryPages(input *GetAssetPropertyValueHistoryInput, fn func(*GetAssetPropertyValueHistoryOutput, bool) bool) error

GetAssetPropertyValueHistoryPages iterates over the pages of a GetAssetPropertyValueHistory operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetAssetPropertyValueHistory method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetAssetPropertyValueHistory operation.
pageNum := 0
err := client.GetAssetPropertyValueHistoryPages(params,
    func(page *iotsitewise.GetAssetPropertyValueHistoryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) GetAssetPropertyValueHistoryPagesWithContext 

func (c *IoTSiteWise) GetAssetPropertyValueHistoryPagesWithContext(ctx aws.Context, input *GetAssetPropertyValueHistoryInput, fn func(*GetAssetPropertyValueHistoryOutput, bool) bool, opts ...request.Option) error

GetAssetPropertyValueHistoryPagesWithContext same as GetAssetPropertyValueHistoryPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) GetAssetPropertyValueHistoryRequest 

func (c *IoTSiteWise) GetAssetPropertyValueHistoryRequest(input *GetAssetPropertyValueHistoryInput) (req *request.Request, output *GetAssetPropertyValueHistoryOutput)

GetAssetPropertyValueHistoryRequest generates a "aws/request.Request" representing the client's request for the GetAssetPropertyValueHistory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAssetPropertyValueHistory for more information on using the GetAssetPropertyValueHistory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAssetPropertyValueHistoryRequest method.
req, resp := client.GetAssetPropertyValueHistoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GetAssetPropertyValueHistory

func (*IoTSiteWise) GetAssetPropertyValueHistoryWithContext 

func (c *IoTSiteWise) GetAssetPropertyValueHistoryWithContext(ctx aws.Context, input *GetAssetPropertyValueHistoryInput, opts ...request.Option) (*GetAssetPropertyValueHistoryOutput, error)

GetAssetPropertyValueHistoryWithContext is the same as GetAssetPropertyValueHistory with the addition of the ability to pass a context and additional request options.

See GetAssetPropertyValueHistory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) GetAssetPropertyValueRequest 

func (c *IoTSiteWise) GetAssetPropertyValueRequest(input *GetAssetPropertyValueInput) (req *request.Request, output *GetAssetPropertyValueOutput)

GetAssetPropertyValueRequest generates a "aws/request.Request" representing the client's request for the GetAssetPropertyValue operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAssetPropertyValue for more information on using the GetAssetPropertyValue API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetAssetPropertyValueRequest method.
req, resp := client.GetAssetPropertyValueRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GetAssetPropertyValue

func (*IoTSiteWise) GetAssetPropertyValueWithContext 

func (c *IoTSiteWise) GetAssetPropertyValueWithContext(ctx aws.Context, input *GetAssetPropertyValueInput, opts ...request.Option) (*GetAssetPropertyValueOutput, error)

GetAssetPropertyValueWithContext is the same as GetAssetPropertyValue with the addition of the ability to pass a context and additional request options.

See GetAssetPropertyValue for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) GetInterpolatedAssetPropertyValues added in v1.38.28 

func (c *IoTSiteWise) GetInterpolatedAssetPropertyValues(input *GetInterpolatedAssetPropertyValuesInput) (*GetInterpolatedAssetPropertyValuesOutput, error)

GetInterpolatedAssetPropertyValues API operation for AWS IoT SiteWise.

Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.

For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.

To identify an asset property, you must specify one of the following:

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation GetInterpolatedAssetPropertyValues for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • ServiceUnavailableException The requested service is unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GetInterpolatedAssetPropertyValues

func (*IoTSiteWise) GetInterpolatedAssetPropertyValuesPages added in v1.38.28 

func (c *IoTSiteWise) GetInterpolatedAssetPropertyValuesPages(input *GetInterpolatedAssetPropertyValuesInput, fn func(*GetInterpolatedAssetPropertyValuesOutput, bool) bool) error

GetInterpolatedAssetPropertyValuesPages iterates over the pages of a GetInterpolatedAssetPropertyValues operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetInterpolatedAssetPropertyValues method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a GetInterpolatedAssetPropertyValues operation.
pageNum := 0
err := client.GetInterpolatedAssetPropertyValuesPages(params,
    func(page *iotsitewise.GetInterpolatedAssetPropertyValuesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) GetInterpolatedAssetPropertyValuesPagesWithContext added in v1.38.28 

func (c *IoTSiteWise) GetInterpolatedAssetPropertyValuesPagesWithContext(ctx aws.Context, input *GetInterpolatedAssetPropertyValuesInput, fn func(*GetInterpolatedAssetPropertyValuesOutput, bool) bool, opts ...request.Option) error

GetInterpolatedAssetPropertyValuesPagesWithContext same as GetInterpolatedAssetPropertyValuesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) GetInterpolatedAssetPropertyValuesRequest added in v1.38.28 

func (c *IoTSiteWise) GetInterpolatedAssetPropertyValuesRequest(input *GetInterpolatedAssetPropertyValuesInput) (req *request.Request, output *GetInterpolatedAssetPropertyValuesOutput)

GetInterpolatedAssetPropertyValuesRequest generates a "aws/request.Request" representing the client's request for the GetInterpolatedAssetPropertyValues operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetInterpolatedAssetPropertyValues for more information on using the GetInterpolatedAssetPropertyValues API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetInterpolatedAssetPropertyValuesRequest method.
req, resp := client.GetInterpolatedAssetPropertyValuesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/GetInterpolatedAssetPropertyValues

func (*IoTSiteWise) GetInterpolatedAssetPropertyValuesWithContext added in v1.38.28 

func (c *IoTSiteWise) GetInterpolatedAssetPropertyValuesWithContext(ctx aws.Context, input *GetInterpolatedAssetPropertyValuesInput, opts ...request.Option) (*GetInterpolatedAssetPropertyValuesOutput, error)

GetInterpolatedAssetPropertyValuesWithContext is the same as GetInterpolatedAssetPropertyValues with the addition of the ability to pass a context and additional request options.

See GetInterpolatedAssetPropertyValues for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAccessPolicies 

func (c *IoTSiteWise) ListAccessPolicies(input *ListAccessPoliciesInput) (*ListAccessPoliciesOutput, error)

ListAccessPolicies API operation for AWS IoT SiteWise.

Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListAccessPolicies for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAccessPolicies

func (*IoTSiteWise) ListAccessPoliciesPages 

func (c *IoTSiteWise) ListAccessPoliciesPages(input *ListAccessPoliciesInput, fn func(*ListAccessPoliciesOutput, bool) bool) error

ListAccessPoliciesPages iterates over the pages of a ListAccessPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAccessPolicies method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAccessPolicies operation.
pageNum := 0
err := client.ListAccessPoliciesPages(params,
    func(page *iotsitewise.ListAccessPoliciesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListAccessPoliciesPagesWithContext 

func (c *IoTSiteWise) ListAccessPoliciesPagesWithContext(ctx aws.Context, input *ListAccessPoliciesInput, fn func(*ListAccessPoliciesOutput, bool) bool, opts ...request.Option) error

ListAccessPoliciesPagesWithContext same as ListAccessPoliciesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAccessPoliciesRequest 

func (c *IoTSiteWise) ListAccessPoliciesRequest(input *ListAccessPoliciesInput) (req *request.Request, output *ListAccessPoliciesOutput)

ListAccessPoliciesRequest generates a "aws/request.Request" representing the client's request for the ListAccessPolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAccessPolicies for more information on using the ListAccessPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAccessPoliciesRequest method.
req, resp := client.ListAccessPoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAccessPolicies

func (*IoTSiteWise) ListAccessPoliciesWithContext 

func (c *IoTSiteWise) ListAccessPoliciesWithContext(ctx aws.Context, input *ListAccessPoliciesInput, opts ...request.Option) (*ListAccessPoliciesOutput, error)

ListAccessPoliciesWithContext is the same as ListAccessPolicies with the addition of the ability to pass a context and additional request options.

See ListAccessPolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListActions added in v1.48.2 

func (c *IoTSiteWise) ListActions(input *ListActionsInput) (*ListActionsOutput, error)

ListActions API operation for AWS IoT SiteWise.

Retrieves a paginated list of actions for a specific target resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListActions for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListActions

func (*IoTSiteWise) ListActionsPages added in v1.48.2 

func (c *IoTSiteWise) ListActionsPages(input *ListActionsInput, fn func(*ListActionsOutput, bool) bool) error

ListActionsPages iterates over the pages of a ListActions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListActions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListActions operation.
pageNum := 0
err := client.ListActionsPages(params,
    func(page *iotsitewise.ListActionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListActionsPagesWithContext added in v1.48.2 

func (c *IoTSiteWise) ListActionsPagesWithContext(ctx aws.Context, input *ListActionsInput, fn func(*ListActionsOutput, bool) bool, opts ...request.Option) error

ListActionsPagesWithContext same as ListActionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListActionsRequest added in v1.48.2 

func (c *IoTSiteWise) ListActionsRequest(input *ListActionsInput) (req *request.Request, output *ListActionsOutput)

ListActionsRequest generates a "aws/request.Request" representing the client's request for the ListActions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListActions for more information on using the ListActions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListActionsRequest method.
req, resp := client.ListActionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListActions

func (*IoTSiteWise) ListActionsWithContext added in v1.48.2 

func (c *IoTSiteWise) ListActionsWithContext(ctx aws.Context, input *ListActionsInput, opts ...request.Option) (*ListActionsOutput, error)

ListActionsWithContext is the same as ListActions with the addition of the ability to pass a context and additional request options.

See ListActions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssetModelCompositeModels added in v1.48.2 

func (c *IoTSiteWise) ListAssetModelCompositeModels(input *ListAssetModelCompositeModelsInput) (*ListAssetModelCompositeModelsOutput, error)

ListAssetModelCompositeModels API operation for AWS IoT SiteWise.

Retrieves a paginated list of composite models associated with the asset model

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListAssetModelCompositeModels for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • ResourceNotFoundException The requested resource can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssetModelCompositeModels

func (*IoTSiteWise) ListAssetModelCompositeModelsPages added in v1.48.2 

func (c *IoTSiteWise) ListAssetModelCompositeModelsPages(input *ListAssetModelCompositeModelsInput, fn func(*ListAssetModelCompositeModelsOutput, bool) bool) error

ListAssetModelCompositeModelsPages iterates over the pages of a ListAssetModelCompositeModels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAssetModelCompositeModels method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAssetModelCompositeModels operation.
pageNum := 0
err := client.ListAssetModelCompositeModelsPages(params,
    func(page *iotsitewise.ListAssetModelCompositeModelsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListAssetModelCompositeModelsPagesWithContext added in v1.48.2 

func (c *IoTSiteWise) ListAssetModelCompositeModelsPagesWithContext(ctx aws.Context, input *ListAssetModelCompositeModelsInput, fn func(*ListAssetModelCompositeModelsOutput, bool) bool, opts ...request.Option) error

ListAssetModelCompositeModelsPagesWithContext same as ListAssetModelCompositeModelsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssetModelCompositeModelsRequest added in v1.48.2 

func (c *IoTSiteWise) ListAssetModelCompositeModelsRequest(input *ListAssetModelCompositeModelsInput) (req *request.Request, output *ListAssetModelCompositeModelsOutput)

ListAssetModelCompositeModelsRequest generates a "aws/request.Request" representing the client's request for the ListAssetModelCompositeModels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAssetModelCompositeModels for more information on using the ListAssetModelCompositeModels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAssetModelCompositeModelsRequest method.
req, resp := client.ListAssetModelCompositeModelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssetModelCompositeModels

func (*IoTSiteWise) ListAssetModelCompositeModelsWithContext added in v1.48.2 

func (c *IoTSiteWise) ListAssetModelCompositeModelsWithContext(ctx aws.Context, input *ListAssetModelCompositeModelsInput, opts ...request.Option) (*ListAssetModelCompositeModelsOutput, error)

ListAssetModelCompositeModelsWithContext is the same as ListAssetModelCompositeModels with the addition of the ability to pass a context and additional request options.

See ListAssetModelCompositeModels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssetModelProperties added in v1.44.129 

func (c *IoTSiteWise) ListAssetModelProperties(input *ListAssetModelPropertiesInput) (*ListAssetModelPropertiesOutput, error)

ListAssetModelProperties API operation for AWS IoT SiteWise.

Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListAssetModelProperties for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssetModelProperties

func (*IoTSiteWise) ListAssetModelPropertiesPages added in v1.44.129 

func (c *IoTSiteWise) ListAssetModelPropertiesPages(input *ListAssetModelPropertiesInput, fn func(*ListAssetModelPropertiesOutput, bool) bool) error

ListAssetModelPropertiesPages iterates over the pages of a ListAssetModelProperties operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAssetModelProperties method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAssetModelProperties operation.
pageNum := 0
err := client.ListAssetModelPropertiesPages(params,
    func(page *iotsitewise.ListAssetModelPropertiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListAssetModelPropertiesPagesWithContext added in v1.44.129 

func (c *IoTSiteWise) ListAssetModelPropertiesPagesWithContext(ctx aws.Context, input *ListAssetModelPropertiesInput, fn func(*ListAssetModelPropertiesOutput, bool) bool, opts ...request.Option) error

ListAssetModelPropertiesPagesWithContext same as ListAssetModelPropertiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssetModelPropertiesRequest added in v1.44.129 

func (c *IoTSiteWise) ListAssetModelPropertiesRequest(input *ListAssetModelPropertiesInput) (req *request.Request, output *ListAssetModelPropertiesOutput)

ListAssetModelPropertiesRequest generates a "aws/request.Request" representing the client's request for the ListAssetModelProperties operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAssetModelProperties for more information on using the ListAssetModelProperties API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAssetModelPropertiesRequest method.
req, resp := client.ListAssetModelPropertiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssetModelProperties

func (*IoTSiteWise) ListAssetModelPropertiesWithContext added in v1.44.129 

func (c *IoTSiteWise) ListAssetModelPropertiesWithContext(ctx aws.Context, input *ListAssetModelPropertiesInput, opts ...request.Option) (*ListAssetModelPropertiesOutput, error)

ListAssetModelPropertiesWithContext is the same as ListAssetModelProperties with the addition of the ability to pass a context and additional request options.

See ListAssetModelProperties for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssetModels 

func (c *IoTSiteWise) ListAssetModels(input *ListAssetModelsInput) (*ListAssetModelsOutput, error)

ListAssetModels API operation for AWS IoT SiteWise.

Retrieves a paginated list of summaries of all asset models.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListAssetModels for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssetModels

func (*IoTSiteWise) ListAssetModelsPages 

func (c *IoTSiteWise) ListAssetModelsPages(input *ListAssetModelsInput, fn func(*ListAssetModelsOutput, bool) bool) error

ListAssetModelsPages iterates over the pages of a ListAssetModels operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAssetModels method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAssetModels operation.
pageNum := 0
err := client.ListAssetModelsPages(params,
    func(page *iotsitewise.ListAssetModelsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListAssetModelsPagesWithContext 

func (c *IoTSiteWise) ListAssetModelsPagesWithContext(ctx aws.Context, input *ListAssetModelsInput, fn func(*ListAssetModelsOutput, bool) bool, opts ...request.Option) error

ListAssetModelsPagesWithContext same as ListAssetModelsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssetModelsRequest 

func (c *IoTSiteWise) ListAssetModelsRequest(input *ListAssetModelsInput) (req *request.Request, output *ListAssetModelsOutput)

ListAssetModelsRequest generates a "aws/request.Request" representing the client's request for the ListAssetModels operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAssetModels for more information on using the ListAssetModels API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAssetModelsRequest method.
req, resp := client.ListAssetModelsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssetModels

func (*IoTSiteWise) ListAssetModelsWithContext 

func (c *IoTSiteWise) ListAssetModelsWithContext(ctx aws.Context, input *ListAssetModelsInput, opts ...request.Option) (*ListAssetModelsOutput, error)

ListAssetModelsWithContext is the same as ListAssetModels with the addition of the ability to pass a context and additional request options.

See ListAssetModels for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssetProperties added in v1.44.129 

func (c *IoTSiteWise) ListAssetProperties(input *ListAssetPropertiesInput) (*ListAssetPropertiesOutput, error)

ListAssetProperties API operation for AWS IoT SiteWise.

Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListAssetProperties for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssetProperties

func (*IoTSiteWise) ListAssetPropertiesPages added in v1.44.129 

func (c *IoTSiteWise) ListAssetPropertiesPages(input *ListAssetPropertiesInput, fn func(*ListAssetPropertiesOutput, bool) bool) error

ListAssetPropertiesPages iterates over the pages of a ListAssetProperties operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAssetProperties method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAssetProperties operation.
pageNum := 0
err := client.ListAssetPropertiesPages(params,
    func(page *iotsitewise.ListAssetPropertiesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListAssetPropertiesPagesWithContext added in v1.44.129 

func (c *IoTSiteWise) ListAssetPropertiesPagesWithContext(ctx aws.Context, input *ListAssetPropertiesInput, fn func(*ListAssetPropertiesOutput, bool) bool, opts ...request.Option) error

ListAssetPropertiesPagesWithContext same as ListAssetPropertiesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssetPropertiesRequest added in v1.44.129 

func (c *IoTSiteWise) ListAssetPropertiesRequest(input *ListAssetPropertiesInput) (req *request.Request, output *ListAssetPropertiesOutput)

ListAssetPropertiesRequest generates a "aws/request.Request" representing the client's request for the ListAssetProperties operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAssetProperties for more information on using the ListAssetProperties API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAssetPropertiesRequest method.
req, resp := client.ListAssetPropertiesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssetProperties

func (*IoTSiteWise) ListAssetPropertiesWithContext added in v1.44.129 

func (c *IoTSiteWise) ListAssetPropertiesWithContext(ctx aws.Context, input *ListAssetPropertiesInput, opts ...request.Option) (*ListAssetPropertiesOutput, error)

ListAssetPropertiesWithContext is the same as ListAssetProperties with the addition of the ability to pass a context and additional request options.

See ListAssetProperties for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssetRelationships added in v1.36.7 

func (c *IoTSiteWise) ListAssetRelationships(input *ListAssetRelationshipsInput) (*ListAssetRelationshipsOutput, error)

ListAssetRelationships API operation for AWS IoT SiteWise.

Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListAssetRelationships for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssetRelationships

func (*IoTSiteWise) ListAssetRelationshipsPages added in v1.36.7 

func (c *IoTSiteWise) ListAssetRelationshipsPages(input *ListAssetRelationshipsInput, fn func(*ListAssetRelationshipsOutput, bool) bool) error

ListAssetRelationshipsPages iterates over the pages of a ListAssetRelationships operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAssetRelationships method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAssetRelationships operation.
pageNum := 0
err := client.ListAssetRelationshipsPages(params,
    func(page *iotsitewise.ListAssetRelationshipsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListAssetRelationshipsPagesWithContext added in v1.36.7 

func (c *IoTSiteWise) ListAssetRelationshipsPagesWithContext(ctx aws.Context, input *ListAssetRelationshipsInput, fn func(*ListAssetRelationshipsOutput, bool) bool, opts ...request.Option) error

ListAssetRelationshipsPagesWithContext same as ListAssetRelationshipsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssetRelationshipsRequest added in v1.36.7 

func (c *IoTSiteWise) ListAssetRelationshipsRequest(input *ListAssetRelationshipsInput) (req *request.Request, output *ListAssetRelationshipsOutput)

ListAssetRelationshipsRequest generates a "aws/request.Request" representing the client's request for the ListAssetRelationships operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAssetRelationships for more information on using the ListAssetRelationships API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAssetRelationshipsRequest method.
req, resp := client.ListAssetRelationshipsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssetRelationships

func (*IoTSiteWise) ListAssetRelationshipsWithContext added in v1.36.7 

func (c *IoTSiteWise) ListAssetRelationshipsWithContext(ctx aws.Context, input *ListAssetRelationshipsInput, opts ...request.Option) (*ListAssetRelationshipsOutput, error)

ListAssetRelationshipsWithContext is the same as ListAssetRelationships with the addition of the ability to pass a context and additional request options.

See ListAssetRelationships for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssets 

func (c *IoTSiteWise) ListAssets(input *ListAssetsInput) (*ListAssetsOutput, error)

ListAssets API operation for AWS IoT SiteWise.

Retrieves a paginated list of asset summaries.

You can use this operation to do the following:

  • List assets based on a specific asset model.

  • List top-level assets.

You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssetModels.html) to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListAssets for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssets

func (*IoTSiteWise) ListAssetsPages 

func (c *IoTSiteWise) ListAssetsPages(input *ListAssetsInput, fn func(*ListAssetsOutput, bool) bool) error

ListAssetsPages iterates over the pages of a ListAssets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAssets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAssets operation.
pageNum := 0
err := client.ListAssetsPages(params,
    func(page *iotsitewise.ListAssetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListAssetsPagesWithContext 

func (c *IoTSiteWise) ListAssetsPagesWithContext(ctx aws.Context, input *ListAssetsInput, fn func(*ListAssetsOutput, bool) bool, opts ...request.Option) error

ListAssetsPagesWithContext same as ListAssetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssetsRequest 

func (c *IoTSiteWise) ListAssetsRequest(input *ListAssetsInput) (req *request.Request, output *ListAssetsOutput)

ListAssetsRequest generates a "aws/request.Request" representing the client's request for the ListAssets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAssets for more information on using the ListAssets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAssetsRequest method.
req, resp := client.ListAssetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssets

func (*IoTSiteWise) ListAssetsWithContext 

func (c *IoTSiteWise) ListAssetsWithContext(ctx aws.Context, input *ListAssetsInput, opts ...request.Option) (*ListAssetsOutput, error)

ListAssetsWithContext is the same as ListAssets with the addition of the ability to pass a context and additional request options.

See ListAssets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssociatedAssets 

func (c *IoTSiteWise) ListAssociatedAssets(input *ListAssociatedAssetsInput) (*ListAssociatedAssetsOutput, error)

ListAssociatedAssets API operation for AWS IoT SiteWise.

Retrieves a paginated list of associated assets.

You can use this operation to do the following:

  • List child assets associated to a parent asset by a hierarchy that you specify.

  • List an asset's parent asset.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListAssociatedAssets for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssociatedAssets

func (*IoTSiteWise) ListAssociatedAssetsPages 

func (c *IoTSiteWise) ListAssociatedAssetsPages(input *ListAssociatedAssetsInput, fn func(*ListAssociatedAssetsOutput, bool) bool) error

ListAssociatedAssetsPages iterates over the pages of a ListAssociatedAssets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAssociatedAssets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListAssociatedAssets operation.
pageNum := 0
err := client.ListAssociatedAssetsPages(params,
    func(page *iotsitewise.ListAssociatedAssetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListAssociatedAssetsPagesWithContext 

func (c *IoTSiteWise) ListAssociatedAssetsPagesWithContext(ctx aws.Context, input *ListAssociatedAssetsInput, fn func(*ListAssociatedAssetsOutput, bool) bool, opts ...request.Option) error

ListAssociatedAssetsPagesWithContext same as ListAssociatedAssetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListAssociatedAssetsRequest 

func (c *IoTSiteWise) ListAssociatedAssetsRequest(input *ListAssociatedAssetsInput) (req *request.Request, output *ListAssociatedAssetsOutput)

ListAssociatedAssetsRequest generates a "aws/request.Request" representing the client's request for the ListAssociatedAssets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAssociatedAssets for more information on using the ListAssociatedAssets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListAssociatedAssetsRequest method.
req, resp := client.ListAssociatedAssetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListAssociatedAssets

func (*IoTSiteWise) ListAssociatedAssetsWithContext 

func (c *IoTSiteWise) ListAssociatedAssetsWithContext(ctx aws.Context, input *ListAssociatedAssetsInput, opts ...request.Option) (*ListAssociatedAssetsOutput, error)

ListAssociatedAssetsWithContext is the same as ListAssociatedAssets with the addition of the ability to pass a context and additional request options.

See ListAssociatedAssets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListBulkImportJobs added in v1.44.60 

func (c *IoTSiteWise) ListBulkImportJobs(input *ListBulkImportJobsInput) (*ListBulkImportJobsOutput, error)

ListBulkImportJobs API operation for AWS IoT SiteWise.

Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListBulkImportJobs for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListBulkImportJobs

func (*IoTSiteWise) ListBulkImportJobsPages added in v1.44.60 

func (c *IoTSiteWise) ListBulkImportJobsPages(input *ListBulkImportJobsInput, fn func(*ListBulkImportJobsOutput, bool) bool) error

ListBulkImportJobsPages iterates over the pages of a ListBulkImportJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListBulkImportJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListBulkImportJobs operation.
pageNum := 0
err := client.ListBulkImportJobsPages(params,
    func(page *iotsitewise.ListBulkImportJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListBulkImportJobsPagesWithContext added in v1.44.60 

func (c *IoTSiteWise) ListBulkImportJobsPagesWithContext(ctx aws.Context, input *ListBulkImportJobsInput, fn func(*ListBulkImportJobsOutput, bool) bool, opts ...request.Option) error

ListBulkImportJobsPagesWithContext same as ListBulkImportJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListBulkImportJobsRequest added in v1.44.60 

func (c *IoTSiteWise) ListBulkImportJobsRequest(input *ListBulkImportJobsInput) (req *request.Request, output *ListBulkImportJobsOutput)

ListBulkImportJobsRequest generates a "aws/request.Request" representing the client's request for the ListBulkImportJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListBulkImportJobs for more information on using the ListBulkImportJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListBulkImportJobsRequest method.
req, resp := client.ListBulkImportJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListBulkImportJobs

func (*IoTSiteWise) ListBulkImportJobsWithContext added in v1.44.60 

func (c *IoTSiteWise) ListBulkImportJobsWithContext(ctx aws.Context, input *ListBulkImportJobsInput, opts ...request.Option) (*ListBulkImportJobsOutput, error)

ListBulkImportJobsWithContext is the same as ListBulkImportJobs with the addition of the ability to pass a context and additional request options.

See ListBulkImportJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListCompositionRelationships added in v1.48.2 

func (c *IoTSiteWise) ListCompositionRelationships(input *ListCompositionRelationshipsInput) (*ListCompositionRelationshipsOutput, error)

ListCompositionRelationships API operation for AWS IoT SiteWise.

Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListCompositionRelationships for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListCompositionRelationships

func (*IoTSiteWise) ListCompositionRelationshipsPages added in v1.48.2 

func (c *IoTSiteWise) ListCompositionRelationshipsPages(input *ListCompositionRelationshipsInput, fn func(*ListCompositionRelationshipsOutput, bool) bool) error

ListCompositionRelationshipsPages iterates over the pages of a ListCompositionRelationships operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCompositionRelationships method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListCompositionRelationships operation.
pageNum := 0
err := client.ListCompositionRelationshipsPages(params,
    func(page *iotsitewise.ListCompositionRelationshipsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListCompositionRelationshipsPagesWithContext added in v1.48.2 

func (c *IoTSiteWise) ListCompositionRelationshipsPagesWithContext(ctx aws.Context, input *ListCompositionRelationshipsInput, fn func(*ListCompositionRelationshipsOutput, bool) bool, opts ...request.Option) error

ListCompositionRelationshipsPagesWithContext same as ListCompositionRelationshipsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListCompositionRelationshipsRequest added in v1.48.2 

func (c *IoTSiteWise) ListCompositionRelationshipsRequest(input *ListCompositionRelationshipsInput) (req *request.Request, output *ListCompositionRelationshipsOutput)

ListCompositionRelationshipsRequest generates a "aws/request.Request" representing the client's request for the ListCompositionRelationships operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCompositionRelationships for more information on using the ListCompositionRelationships API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListCompositionRelationshipsRequest method.
req, resp := client.ListCompositionRelationshipsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListCompositionRelationships

func (*IoTSiteWise) ListCompositionRelationshipsWithContext added in v1.48.2 

func (c *IoTSiteWise) ListCompositionRelationshipsWithContext(ctx aws.Context, input *ListCompositionRelationshipsInput, opts ...request.Option) (*ListCompositionRelationshipsOutput, error)

ListCompositionRelationshipsWithContext is the same as ListCompositionRelationships with the addition of the ability to pass a context and additional request options.

See ListCompositionRelationships for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListDashboards 

func (c *IoTSiteWise) ListDashboards(input *ListDashboardsInput) (*ListDashboardsOutput, error)

ListDashboards API operation for AWS IoT SiteWise.

Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListDashboards for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListDashboards

func (*IoTSiteWise) ListDashboardsPages 

func (c *IoTSiteWise) ListDashboardsPages(input *ListDashboardsInput, fn func(*ListDashboardsOutput, bool) bool) error

ListDashboardsPages iterates over the pages of a ListDashboards operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDashboards method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDashboards operation.
pageNum := 0
err := client.ListDashboardsPages(params,
    func(page *iotsitewise.ListDashboardsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListDashboardsPagesWithContext 

func (c *IoTSiteWise) ListDashboardsPagesWithContext(ctx aws.Context, input *ListDashboardsInput, fn func(*ListDashboardsOutput, bool) bool, opts ...request.Option) error

ListDashboardsPagesWithContext same as ListDashboardsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListDashboardsRequest 

func (c *IoTSiteWise) ListDashboardsRequest(input *ListDashboardsInput) (req *request.Request, output *ListDashboardsOutput)

ListDashboardsRequest generates a "aws/request.Request" representing the client's request for the ListDashboards operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDashboards for more information on using the ListDashboards API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDashboardsRequest method.
req, resp := client.ListDashboardsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListDashboards

func (*IoTSiteWise) ListDashboardsWithContext 

func (c *IoTSiteWise) ListDashboardsWithContext(ctx aws.Context, input *ListDashboardsInput, opts ...request.Option) (*ListDashboardsOutput, error)

ListDashboardsWithContext is the same as ListDashboards with the addition of the ability to pass a context and additional request options.

See ListDashboards for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListGateways 

func (c *IoTSiteWise) ListGateways(input *ListGatewaysInput) (*ListGatewaysOutput, error)

ListGateways API operation for AWS IoT SiteWise.

Retrieves a paginated list of gateways.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListGateways for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListGateways

func (*IoTSiteWise) ListGatewaysPages 

func (c *IoTSiteWise) ListGatewaysPages(input *ListGatewaysInput, fn func(*ListGatewaysOutput, bool) bool) error

ListGatewaysPages iterates over the pages of a ListGateways operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGateways method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListGateways operation.
pageNum := 0
err := client.ListGatewaysPages(params,
    func(page *iotsitewise.ListGatewaysOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListGatewaysPagesWithContext 

func (c *IoTSiteWise) ListGatewaysPagesWithContext(ctx aws.Context, input *ListGatewaysInput, fn func(*ListGatewaysOutput, bool) bool, opts ...request.Option) error

ListGatewaysPagesWithContext same as ListGatewaysPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListGatewaysRequest 

func (c *IoTSiteWise) ListGatewaysRequest(input *ListGatewaysInput) (req *request.Request, output *ListGatewaysOutput)

ListGatewaysRequest generates a "aws/request.Request" representing the client's request for the ListGateways operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGateways for more information on using the ListGateways API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListGatewaysRequest method.
req, resp := client.ListGatewaysRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListGateways

func (*IoTSiteWise) ListGatewaysWithContext 

func (c *IoTSiteWise) ListGatewaysWithContext(ctx aws.Context, input *ListGatewaysInput, opts ...request.Option) (*ListGatewaysOutput, error)

ListGatewaysWithContext is the same as ListGateways with the addition of the ability to pass a context and additional request options.

See ListGateways for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListPortals 

func (c *IoTSiteWise) ListPortals(input *ListPortalsInput) (*ListPortalsOutput, error)

ListPortals API operation for AWS IoT SiteWise.

Retrieves a paginated list of IoT SiteWise Monitor portals.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListPortals for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListPortals

func (*IoTSiteWise) ListPortalsPages 

func (c *IoTSiteWise) ListPortalsPages(input *ListPortalsInput, fn func(*ListPortalsOutput, bool) bool) error

ListPortalsPages iterates over the pages of a ListPortals operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPortals method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListPortals operation.
pageNum := 0
err := client.ListPortalsPages(params,
    func(page *iotsitewise.ListPortalsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListPortalsPagesWithContext 

func (c *IoTSiteWise) ListPortalsPagesWithContext(ctx aws.Context, input *ListPortalsInput, fn func(*ListPortalsOutput, bool) bool, opts ...request.Option) error

ListPortalsPagesWithContext same as ListPortalsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListPortalsRequest 

func (c *IoTSiteWise) ListPortalsRequest(input *ListPortalsInput) (req *request.Request, output *ListPortalsOutput)

ListPortalsRequest generates a "aws/request.Request" representing the client's request for the ListPortals operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPortals for more information on using the ListPortals API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListPortalsRequest method.
req, resp := client.ListPortalsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListPortals

func (*IoTSiteWise) ListPortalsWithContext 

func (c *IoTSiteWise) ListPortalsWithContext(ctx aws.Context, input *ListPortalsInput, opts ...request.Option) (*ListPortalsOutput, error)

ListPortalsWithContext is the same as ListPortals with the addition of the ability to pass a context and additional request options.

See ListPortals for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListProjectAssets 

func (c *IoTSiteWise) ListProjectAssets(input *ListProjectAssetsInput) (*ListProjectAssetsOutput, error)

ListProjectAssets API operation for AWS IoT SiteWise.

Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListProjectAssets for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListProjectAssets

func (*IoTSiteWise) ListProjectAssetsPages 

func (c *IoTSiteWise) ListProjectAssetsPages(input *ListProjectAssetsInput, fn func(*ListProjectAssetsOutput, bool) bool) error

ListProjectAssetsPages iterates over the pages of a ListProjectAssets operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListProjectAssets method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListProjectAssets operation.
pageNum := 0
err := client.ListProjectAssetsPages(params,
    func(page *iotsitewise.ListProjectAssetsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListProjectAssetsPagesWithContext 

func (c *IoTSiteWise) ListProjectAssetsPagesWithContext(ctx aws.Context, input *ListProjectAssetsInput, fn func(*ListProjectAssetsOutput, bool) bool, opts ...request.Option) error

ListProjectAssetsPagesWithContext same as ListProjectAssetsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListProjectAssetsRequest 

func (c *IoTSiteWise) ListProjectAssetsRequest(input *ListProjectAssetsInput) (req *request.Request, output *ListProjectAssetsOutput)

ListProjectAssetsRequest generates a "aws/request.Request" representing the client's request for the ListProjectAssets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListProjectAssets for more information on using the ListProjectAssets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListProjectAssetsRequest method.
req, resp := client.ListProjectAssetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListProjectAssets

func (*IoTSiteWise) ListProjectAssetsWithContext 

func (c *IoTSiteWise) ListProjectAssetsWithContext(ctx aws.Context, input *ListProjectAssetsInput, opts ...request.Option) (*ListProjectAssetsOutput, error)

ListProjectAssetsWithContext is the same as ListProjectAssets with the addition of the ability to pass a context and additional request options.

See ListProjectAssets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListProjects 

func (c *IoTSiteWise) ListProjects(input *ListProjectsInput) (*ListProjectsOutput, error)

ListProjects API operation for AWS IoT SiteWise.

Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListProjects for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListProjects

func (*IoTSiteWise) ListProjectsPages 

func (c *IoTSiteWise) ListProjectsPages(input *ListProjectsInput, fn func(*ListProjectsOutput, bool) bool) error

ListProjectsPages iterates over the pages of a ListProjects operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListProjects method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListProjects operation.
pageNum := 0
err := client.ListProjectsPages(params,
    func(page *iotsitewise.ListProjectsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListProjectsPagesWithContext 

func (c *IoTSiteWise) ListProjectsPagesWithContext(ctx aws.Context, input *ListProjectsInput, fn func(*ListProjectsOutput, bool) bool, opts ...request.Option) error

ListProjectsPagesWithContext same as ListProjectsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListProjectsRequest 

func (c *IoTSiteWise) ListProjectsRequest(input *ListProjectsInput) (req *request.Request, output *ListProjectsOutput)

ListProjectsRequest generates a "aws/request.Request" representing the client's request for the ListProjects operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListProjects for more information on using the ListProjects API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListProjectsRequest method.
req, resp := client.ListProjectsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListProjects

func (*IoTSiteWise) ListProjectsWithContext 

func (c *IoTSiteWise) ListProjectsWithContext(ctx aws.Context, input *ListProjectsInput, opts ...request.Option) (*ListProjectsOutput, error)

ListProjectsWithContext is the same as ListProjects with the addition of the ability to pass a context and additional request options.

See ListProjects for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListTagsForResource 

func (c *IoTSiteWise) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS IoT SiteWise.

Retrieves the list of tags for an IoT SiteWise resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • ResourceNotFoundException The requested resource can't be found.

  • 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.

  • 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 IoT SiteWise User Guide.

  • UnauthorizedException You are not authorized.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListTagsForResource

func (*IoTSiteWise) ListTagsForResourceRequest 

func (c *IoTSiteWise) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListTagsForResource

func (*IoTSiteWise) ListTagsForResourceWithContext 

func (c *IoTSiteWise) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListTimeSeries added in v1.42.12 

func (c *IoTSiteWise) ListTimeSeries(input *ListTimeSeriesInput) (*ListTimeSeriesOutput, error)

ListTimeSeries API operation for AWS IoT SiteWise.

Retrieves a paginated list of time series (data streams).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation ListTimeSeries for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListTimeSeries

func (*IoTSiteWise) ListTimeSeriesPages added in v1.42.12 

func (c *IoTSiteWise) ListTimeSeriesPages(input *ListTimeSeriesInput, fn func(*ListTimeSeriesOutput, bool) bool) error

ListTimeSeriesPages iterates over the pages of a ListTimeSeries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTimeSeries method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTimeSeries operation.
pageNum := 0
err := client.ListTimeSeriesPages(params,
    func(page *iotsitewise.ListTimeSeriesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*IoTSiteWise) ListTimeSeriesPagesWithContext added in v1.42.12 

func (c *IoTSiteWise) ListTimeSeriesPagesWithContext(ctx aws.Context, input *ListTimeSeriesInput, fn func(*ListTimeSeriesOutput, bool) bool, opts ...request.Option) error

ListTimeSeriesPagesWithContext same as ListTimeSeriesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) ListTimeSeriesRequest added in v1.42.12 

func (c *IoTSiteWise) ListTimeSeriesRequest(input *ListTimeSeriesInput) (req *request.Request, output *ListTimeSeriesOutput)

ListTimeSeriesRequest generates a "aws/request.Request" representing the client's request for the ListTimeSeries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTimeSeries for more information on using the ListTimeSeries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTimeSeriesRequest method.
req, resp := client.ListTimeSeriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListTimeSeries

func (*IoTSiteWise) ListTimeSeriesWithContext added in v1.42.12 

func (c *IoTSiteWise) ListTimeSeriesWithContext(ctx aws.Context, input *ListTimeSeriesInput, opts ...request.Option) (*ListTimeSeriesOutput, error)

ListTimeSeriesWithContext is the same as ListTimeSeries with the addition of the ability to pass a context and additional request options.

See ListTimeSeries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) PutDefaultEncryptionConfiguration added in v1.35.35 

func (c *IoTSiteWise) PutDefaultEncryptionConfiguration(input *PutDefaultEncryptionConfigurationInput) (*PutDefaultEncryptionConfigurationOutput, error)

PutDefaultEncryptionConfiguration API operation for AWS IoT SiteWise.

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/key-management.html) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation PutDefaultEncryptionConfiguration for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/PutDefaultEncryptionConfiguration

func (*IoTSiteWise) PutDefaultEncryptionConfigurationRequest added in v1.35.35 

func (c *IoTSiteWise) PutDefaultEncryptionConfigurationRequest(input *PutDefaultEncryptionConfigurationInput) (req *request.Request, output *PutDefaultEncryptionConfigurationOutput)

PutDefaultEncryptionConfigurationRequest generates a "aws/request.Request" representing the client's request for the PutDefaultEncryptionConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutDefaultEncryptionConfiguration for more information on using the PutDefaultEncryptionConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutDefaultEncryptionConfigurationRequest method.
req, resp := client.PutDefaultEncryptionConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/PutDefaultEncryptionConfiguration

func (*IoTSiteWise) PutDefaultEncryptionConfigurationWithContext added in v1.35.35 

func (c *IoTSiteWise) PutDefaultEncryptionConfigurationWithContext(ctx aws.Context, input *PutDefaultEncryptionConfigurationInput, opts ...request.Option) (*PutDefaultEncryptionConfigurationOutput, error)

PutDefaultEncryptionConfigurationWithContext is the same as PutDefaultEncryptionConfiguration with the addition of the ability to pass a context and additional request options.

See PutDefaultEncryptionConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) PutLoggingOptions 

func (c *IoTSiteWise) PutLoggingOptions(input *PutLoggingOptionsInput) (*PutLoggingOptionsOutput, error)

PutLoggingOptions API operation for AWS IoT SiteWise.

Sets logging options for IoT SiteWise.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation PutLoggingOptions for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • 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.

  • ResourceNotFoundException The requested resource can't be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/PutLoggingOptions

func (*IoTSiteWise) PutLoggingOptionsRequest 

func (c *IoTSiteWise) PutLoggingOptionsRequest(input *PutLoggingOptionsInput) (req *request.Request, output *PutLoggingOptionsOutput)

PutLoggingOptionsRequest generates a "aws/request.Request" representing the client's request for the PutLoggingOptions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutLoggingOptions for more information on using the PutLoggingOptions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutLoggingOptionsRequest method.
req, resp := client.PutLoggingOptionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/PutLoggingOptions

func (*IoTSiteWise) PutLoggingOptionsWithContext 

func (c *IoTSiteWise) PutLoggingOptionsWithContext(ctx aws.Context, input *PutLoggingOptionsInput, opts ...request.Option) (*PutLoggingOptionsOutput, error)

PutLoggingOptionsWithContext is the same as PutLoggingOptions with the addition of the ability to pass a context and additional request options.

See PutLoggingOptions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) PutStorageConfiguration added in v1.39.2 

func (c *IoTSiteWise) PutStorageConfiguration(input *PutStorageConfigurationInput) (*PutStorageConfigurationOutput, error)

PutStorageConfiguration API operation for AWS IoT SiteWise.

Configures storage settings for IoT SiteWise.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation PutStorageConfiguration for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceAlreadyExistsException The resource already exists.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/PutStorageConfiguration

func (*IoTSiteWise) PutStorageConfigurationRequest added in v1.39.2 

func (c *IoTSiteWise) PutStorageConfigurationRequest(input *PutStorageConfigurationInput) (req *request.Request, output *PutStorageConfigurationOutput)

PutStorageConfigurationRequest generates a "aws/request.Request" representing the client's request for the PutStorageConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutStorageConfiguration for more information on using the PutStorageConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the PutStorageConfigurationRequest method.
req, resp := client.PutStorageConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/PutStorageConfiguration

func (*IoTSiteWise) PutStorageConfigurationWithContext added in v1.39.2 

func (c *IoTSiteWise) PutStorageConfigurationWithContext(ctx aws.Context, input *PutStorageConfigurationInput, opts ...request.Option) (*PutStorageConfigurationOutput, error)

PutStorageConfigurationWithContext is the same as PutStorageConfiguration with the addition of the ability to pass a context and additional request options.

See PutStorageConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) TagResource 

func (c *IoTSiteWise) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS IoT SiteWise.

Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation TagResource for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • ResourceNotFoundException The requested resource can't be found.

  • 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.

  • 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 IoT SiteWise User Guide.

  • UnauthorizedException You are not authorized.

  • 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 Amazon Web Services General Reference.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/TagResource

func (*IoTSiteWise) TagResourceRequest 

func (c *IoTSiteWise) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/TagResource

func (*IoTSiteWise) TagResourceWithContext 

func (c *IoTSiteWise) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) UntagResource 

func (c *IoTSiteWise) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS IoT SiteWise.

Removes a tag from an IoT SiteWise resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation UntagResource for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • ResourceNotFoundException The requested resource can't be found.

  • 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.

  • 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 IoT SiteWise User Guide.

  • UnauthorizedException You are not authorized.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UntagResource

func (*IoTSiteWise) UntagResourceRequest 

func (c *IoTSiteWise) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UntagResource

func (*IoTSiteWise) UntagResourceWithContext 

func (c *IoTSiteWise) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) UpdateAccessPolicy 

func (c *IoTSiteWise) UpdateAccessPolicy(input *UpdateAccessPolicyInput) (*UpdateAccessPolicyOutput, error)

UpdateAccessPolicy API operation for AWS IoT SiteWise.

Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation UpdateAccessPolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAccessPolicy

func (*IoTSiteWise) UpdateAccessPolicyRequest 

func (c *IoTSiteWise) UpdateAccessPolicyRequest(input *UpdateAccessPolicyInput) (req *request.Request, output *UpdateAccessPolicyOutput)

UpdateAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the UpdateAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAccessPolicy for more information on using the UpdateAccessPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateAccessPolicyRequest method.
req, resp := client.UpdateAccessPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAccessPolicy

func (*IoTSiteWise) UpdateAccessPolicyWithContext 

func (c *IoTSiteWise) UpdateAccessPolicyWithContext(ctx aws.Context, input *UpdateAccessPolicyInput, opts ...request.Option) (*UpdateAccessPolicyOutput, error)

UpdateAccessPolicyWithContext is the same as UpdateAccessPolicy with the addition of the ability to pass a context and additional request options.

See UpdateAccessPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) UpdateAsset 

func (c *IoTSiteWise) UpdateAsset(input *UpdateAssetInput) (*UpdateAssetOutput, error)

UpdateAsset API operation for AWS IoT SiteWise.

Updates an asset's name. For more information, see Updating assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) in the IoT SiteWise User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation UpdateAsset for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceAlreadyExistsException The resource already exists.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAsset

func (*IoTSiteWise) UpdateAssetModel 

func (c *IoTSiteWise) UpdateAssetModel(input *UpdateAssetModelInput) (*UpdateAssetModelOutput, error)

UpdateAssetModel API operation for AWS IoT SiteWise.

Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) in the IoT SiteWise User Guide.

This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html).

If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation UpdateAssetModel for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceAlreadyExistsException The resource already exists.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • 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 IoT SiteWise User Guide.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAssetModel

func (*IoTSiteWise) UpdateAssetModelCompositeModel added in v1.48.2 

func (c *IoTSiteWise) UpdateAssetModelCompositeModel(input *UpdateAssetModelCompositeModelInput) (*UpdateAssetModelCompositeModelOutput, error)

UpdateAssetModelCompositeModel API operation for AWS IoT SiteWise.

Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html) in the IoT SiteWise User Guide.

If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

To replace an existing composite asset model property with a new one with the same name, do the following:

Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.

Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation UpdateAssetModelCompositeModel for usage and error information.

Returned Error Types:

  • 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.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceAlreadyExistsException The resource already exists.

  • ResourceNotFoundException The requested resource can't be found.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAssetModelCompositeModel

func (*IoTSiteWise) UpdateAssetModelCompositeModelRequest added in v1.48.2 

func (c *IoTSiteWise) UpdateAssetModelCompositeModelRequest(input *UpdateAssetModelCompositeModelInput) (req *request.Request, output *UpdateAssetModelCompositeModelOutput)

UpdateAssetModelCompositeModelRequest generates a "aws/request.Request" representing the client's request for the UpdateAssetModelCompositeModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAssetModelCompositeModel for more information on using the UpdateAssetModelCompositeModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateAssetModelCompositeModelRequest method.
req, resp := client.UpdateAssetModelCompositeModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAssetModelCompositeModel

func (*IoTSiteWise) UpdateAssetModelCompositeModelWithContext added in v1.48.2 

func (c *IoTSiteWise) UpdateAssetModelCompositeModelWithContext(ctx aws.Context, input *UpdateAssetModelCompositeModelInput, opts ...request.Option) (*UpdateAssetModelCompositeModelOutput, error)

UpdateAssetModelCompositeModelWithContext is the same as UpdateAssetModelCompositeModel with the addition of the ability to pass a context and additional request options.

See UpdateAssetModelCompositeModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) UpdateAssetModelRequest 

func (c *IoTSiteWise) UpdateAssetModelRequest(input *UpdateAssetModelInput) (req *request.Request, output *UpdateAssetModelOutput)

UpdateAssetModelRequest generates a "aws/request.Request" representing the client's request for the UpdateAssetModel operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAssetModel for more information on using the UpdateAssetModel API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateAssetModelRequest method.
req, resp := client.UpdateAssetModelRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAssetModel

func (*IoTSiteWise) UpdateAssetModelWithContext 

func (c *IoTSiteWise) UpdateAssetModelWithContext(ctx aws.Context, input *UpdateAssetModelInput, opts ...request.Option) (*UpdateAssetModelOutput, error)

UpdateAssetModelWithContext is the same as UpdateAssetModel with the addition of the ability to pass a context and additional request options.

See UpdateAssetModel for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) UpdateAssetProperty 

func (c *IoTSiteWise) UpdateAssetProperty(input *UpdateAssetPropertyInput) (*UpdateAssetPropertyOutput, error)

UpdateAssetProperty API operation for AWS IoT SiteWise.

Updates an asset property's alias and notification state.

This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetProperty.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation UpdateAssetProperty for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAssetProperty

func (*IoTSiteWise) UpdateAssetPropertyRequest 

func (c *IoTSiteWise) UpdateAssetPropertyRequest(input *UpdateAssetPropertyInput) (req *request.Request, output *UpdateAssetPropertyOutput)

UpdateAssetPropertyRequest generates a "aws/request.Request" representing the client's request for the UpdateAssetProperty operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAssetProperty for more information on using the UpdateAssetProperty API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateAssetPropertyRequest method.
req, resp := client.UpdateAssetPropertyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAssetProperty

func (*IoTSiteWise) UpdateAssetPropertyWithContext 

func (c *IoTSiteWise) UpdateAssetPropertyWithContext(ctx aws.Context, input *UpdateAssetPropertyInput, opts ...request.Option) (*UpdateAssetPropertyOutput, error)

UpdateAssetPropertyWithContext is the same as UpdateAssetProperty with the addition of the ability to pass a context and additional request options.

See UpdateAssetProperty for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) UpdateAssetRequest 

func (c *IoTSiteWise) UpdateAssetRequest(input *UpdateAssetInput) (req *request.Request, output *UpdateAssetOutput)

UpdateAssetRequest generates a "aws/request.Request" representing the client's request for the UpdateAsset operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAsset for more information on using the UpdateAsset API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateAssetRequest method.
req, resp := client.UpdateAssetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateAsset

func (*IoTSiteWise) UpdateAssetWithContext 

func (c *IoTSiteWise) UpdateAssetWithContext(ctx aws.Context, input *UpdateAssetInput, opts ...request.Option) (*UpdateAssetOutput, error)

UpdateAssetWithContext is the same as UpdateAsset with the addition of the ability to pass a context and additional request options.

See UpdateAsset for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) UpdateDashboard 

func (c *IoTSiteWise) UpdateDashboard(input *UpdateDashboardInput) (*UpdateDashboardOutput, error)

UpdateDashboard API operation for AWS IoT SiteWise.

Updates an IoT SiteWise Monitor dashboard.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation UpdateDashboard for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateDashboard

func (*IoTSiteWise) UpdateDashboardRequest 

func (c *IoTSiteWise) UpdateDashboardRequest(input *UpdateDashboardInput) (req *request.Request, output *UpdateDashboardOutput)

UpdateDashboardRequest generates a "aws/request.Request" representing the client's request for the UpdateDashboard operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateDashboard for more information on using the UpdateDashboard API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateDashboardRequest method.
req, resp := client.UpdateDashboardRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateDashboard

func (*IoTSiteWise) UpdateDashboardWithContext 

func (c *IoTSiteWise) UpdateDashboardWithContext(ctx aws.Context, input *UpdateDashboardInput, opts ...request.Option) (*UpdateDashboardOutput, error)

UpdateDashboardWithContext is the same as UpdateDashboard with the addition of the ability to pass a context and additional request options.

See UpdateDashboard for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) UpdateGateway 

func (c *IoTSiteWise) UpdateGateway(input *UpdateGatewayInput) (*UpdateGatewayOutput, error)

UpdateGateway API operation for AWS IoT SiteWise.

Updates a gateway's name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation UpdateGateway for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • 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.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateGateway

func (*IoTSiteWise) UpdateGatewayCapabilityConfiguration 

func (c *IoTSiteWise) UpdateGatewayCapabilityConfiguration(input *UpdateGatewayCapabilityConfigurationInput) (*UpdateGatewayCapabilityConfigurationOutput, error)

UpdateGatewayCapabilityConfiguration API operation for AWS IoT SiteWise.

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGateway.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation UpdateGatewayCapabilityConfiguration for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • 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.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration

func (*IoTSiteWise) UpdateGatewayCapabilityConfigurationRequest 

func (c *IoTSiteWise) UpdateGatewayCapabilityConfigurationRequest(input *UpdateGatewayCapabilityConfigurationInput) (req *request.Request, output *UpdateGatewayCapabilityConfigurationOutput)

UpdateGatewayCapabilityConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateGatewayCapabilityConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGatewayCapabilityConfiguration for more information on using the UpdateGatewayCapabilityConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateGatewayCapabilityConfigurationRequest method.
req, resp := client.UpdateGatewayCapabilityConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateGatewayCapabilityConfiguration

func (*IoTSiteWise) UpdateGatewayCapabilityConfigurationWithContext 

func (c *IoTSiteWise) UpdateGatewayCapabilityConfigurationWithContext(ctx aws.Context, input *UpdateGatewayCapabilityConfigurationInput, opts ...request.Option) (*UpdateGatewayCapabilityConfigurationOutput, error)

UpdateGatewayCapabilityConfigurationWithContext is the same as UpdateGatewayCapabilityConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateGatewayCapabilityConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) UpdateGatewayRequest 

func (c *IoTSiteWise) UpdateGatewayRequest(input *UpdateGatewayInput) (req *request.Request, output *UpdateGatewayOutput)

UpdateGatewayRequest generates a "aws/request.Request" representing the client's request for the UpdateGateway operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGateway for more information on using the UpdateGateway API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateGatewayRequest method.
req, resp := client.UpdateGatewayRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateGateway

func (*IoTSiteWise) UpdateGatewayWithContext 

func (c *IoTSiteWise) UpdateGatewayWithContext(ctx aws.Context, input *UpdateGatewayInput, opts ...request.Option) (*UpdateGatewayOutput, error)

UpdateGatewayWithContext is the same as UpdateGateway with the addition of the ability to pass a context and additional request options.

See UpdateGateway for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) UpdatePortal 

func (c *IoTSiteWise) UpdatePortal(input *UpdatePortalInput) (*UpdatePortalOutput, error)

UpdatePortal API operation for AWS IoT SiteWise.

Updates an IoT SiteWise Monitor portal.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation UpdatePortal for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

  • 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdatePortal

func (*IoTSiteWise) UpdatePortalRequest 

func (c *IoTSiteWise) UpdatePortalRequest(input *UpdatePortalInput) (req *request.Request, output *UpdatePortalOutput)

UpdatePortalRequest generates a "aws/request.Request" representing the client's request for the UpdatePortal operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdatePortal for more information on using the UpdatePortal API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdatePortalRequest method.
req, resp := client.UpdatePortalRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdatePortal

func (*IoTSiteWise) UpdatePortalWithContext 

func (c *IoTSiteWise) UpdatePortalWithContext(ctx aws.Context, input *UpdatePortalInput, opts ...request.Option) (*UpdatePortalOutput, error)

UpdatePortalWithContext is the same as UpdatePortal with the addition of the ability to pass a context and additional request options.

See UpdatePortal for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) UpdateProject 

func (c *IoTSiteWise) UpdateProject(input *UpdateProjectInput) (*UpdateProjectOutput, error)

UpdateProject API operation for AWS IoT SiteWise.

Updates an IoT SiteWise Monitor project.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS IoT SiteWise's API operation UpdateProject for usage and error information.

Returned Error Types:

  • InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

  • ResourceNotFoundException The requested resource can't be found.

  • InternalFailureException IoT SiteWise can't process your request right now. Try again later.

  • ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateProject

func (*IoTSiteWise) UpdateProjectRequest 

func (c *IoTSiteWise) UpdateProjectRequest(input *UpdateProjectInput) (req *request.Request, output *UpdateProjectOutput)

UpdateProjectRequest generates a "aws/request.Request" representing the client's request for the UpdateProject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateProject for more information on using the UpdateProject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateProjectRequest method.
req, resp := client.UpdateProjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateProject

func (*IoTSiteWise) UpdateProjectWithContext 

func (c *IoTSiteWise) UpdateProjectWithContext(ctx aws.Context, input *UpdateProjectInput, opts ...request.Option) (*UpdateProjectOutput, error)

UpdateProjectWithContext is the same as UpdateProject with the addition of the ability to pass a context and additional request options.

See UpdateProject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) WaitUntilAssetActive 

func (c *IoTSiteWise) WaitUntilAssetActive(input *DescribeAssetInput) error

WaitUntilAssetActive uses the AWS IoT SiteWise API operation DescribeAsset to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*IoTSiteWise) WaitUntilAssetActiveWithContext 

func (c *IoTSiteWise) WaitUntilAssetActiveWithContext(ctx aws.Context, input *DescribeAssetInput, opts ...request.WaiterOption) error

WaitUntilAssetActiveWithContext is an extended version of WaitUntilAssetActive. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) WaitUntilAssetModelActive 

func (c *IoTSiteWise) WaitUntilAssetModelActive(input *DescribeAssetModelInput) error

WaitUntilAssetModelActive uses the AWS IoT SiteWise API operation DescribeAssetModel to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*IoTSiteWise) WaitUntilAssetModelActiveWithContext 

func (c *IoTSiteWise) WaitUntilAssetModelActiveWithContext(ctx aws.Context, input *DescribeAssetModelInput, opts ...request.WaiterOption) error

WaitUntilAssetModelActiveWithContext is an extended version of WaitUntilAssetModelActive. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) WaitUntilAssetModelNotExists 

func (c *IoTSiteWise) WaitUntilAssetModelNotExists(input *DescribeAssetModelInput) error

WaitUntilAssetModelNotExists uses the AWS IoT SiteWise API operation DescribeAssetModel to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*IoTSiteWise) WaitUntilAssetModelNotExistsWithContext 

func (c *IoTSiteWise) WaitUntilAssetModelNotExistsWithContext(ctx aws.Context, input *DescribeAssetModelInput, opts ...request.WaiterOption) error

WaitUntilAssetModelNotExistsWithContext is an extended version of WaitUntilAssetModelNotExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) WaitUntilAssetNotExists 

func (c *IoTSiteWise) WaitUntilAssetNotExists(input *DescribeAssetInput) error

WaitUntilAssetNotExists uses the AWS IoT SiteWise API operation DescribeAsset to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*IoTSiteWise) WaitUntilAssetNotExistsWithContext 

func (c *IoTSiteWise) WaitUntilAssetNotExistsWithContext(ctx aws.Context, input *DescribeAssetInput, opts ...request.WaiterOption) error

WaitUntilAssetNotExistsWithContext is an extended version of WaitUntilAssetNotExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) WaitUntilPortalActive 

func (c *IoTSiteWise) WaitUntilPortalActive(input *DescribePortalInput) error

WaitUntilPortalActive uses the AWS IoT SiteWise API operation DescribePortal to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*IoTSiteWise) WaitUntilPortalActiveWithContext 

func (c *IoTSiteWise) WaitUntilPortalActiveWithContext(ctx aws.Context, input *DescribePortalInput, opts ...request.WaiterOption) error

WaitUntilPortalActiveWithContext is an extended version of WaitUntilPortalActive. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*IoTSiteWise) WaitUntilPortalNotExists 

func (c *IoTSiteWise) WaitUntilPortalNotExists(input *DescribePortalInput) error

WaitUntilPortalNotExists uses the AWS IoT SiteWise API operation DescribePortal to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*IoTSiteWise) WaitUntilPortalNotExistsWithContext 

func (c *IoTSiteWise) WaitUntilPortalNotExistsWithContext(ctx aws.Context, input *DescribePortalInput, opts ...request.WaiterOption) error

WaitUntilPortalNotExistsWithContext is an extended version of WaitUntilPortalNotExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type JobConfiguration added in v1.44.60 

type JobConfiguration struct {

	// The file format of the data in S3.
	//
	// FileFormat is a required field
	FileFormat *FileFormat `locationName:"fileFormat" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

func (JobConfiguration) GoString added in v1.44.60 

func (s JobConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobConfiguration) SetFileFormat added in v1.44.60 

func (s *JobConfiguration) SetFileFormat(v *FileFormat) *JobConfiguration

SetFileFormat sets the FileFormat field's value.

func (JobConfiguration) String added in v1.44.60 

func (s JobConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobConfiguration) Validate added in v1.44.60 

func (s *JobConfiguration) Validate() error

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

type JobSummary added in v1.44.60 

type JobSummary struct {

	// The ID of the job.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The unique name that helps identify the job request.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The status of the bulk import job can be one of following values:
	//
	//    * PENDING – IoT SiteWise is waiting for the current bulk import job
	//    to finish.
	//
	//    * CANCELLED – The bulk import job has been canceled.
	//
	//    * RUNNING – IoT SiteWise is processing your request to import your data
	//    from Amazon S3.
	//
	//    * COMPLETED – IoT SiteWise successfully completed your request to import
	//    data from Amazon S3.
	//
	//    * FAILED – IoT SiteWise couldn't process your request to import data
	//    from Amazon S3. You can use logs saved in the specified error report location
	//    in Amazon S3 to troubleshoot issues.
	//
	//    * COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import
	//    data from Amazon S3 with errors. You can use logs saved in the specified
	//    error report location in Amazon S3 to troubleshoot issues.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"JobStatus"`
	// contains filtered or unexported fields
}

Contains the job summary information.

func (JobSummary) GoString added in v1.44.60 

func (s JobSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*JobSummary) SetId added in v1.44.60 

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

SetId sets the Id field's value.

func (*JobSummary) SetName added in v1.44.60 

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

SetName sets the Name field's value.

func (*JobSummary) SetStatus added in v1.44.60 

func (s *JobSummary) SetStatus(v string) *JobSummary

SetStatus sets the Status field's value.

func (JobSummary) String added in v1.44.60 

func (s JobSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException 

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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 IoT SiteWise User Guide.

func (*LimitExceededException) Code 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString 

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode 

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String 

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAccessPoliciesInput 

type ListAccessPoliciesInput struct {

	// The ARN of the IAM user. For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
	// in the IAM User Guide. This parameter is required if you specify IAM for
	// identityType.
	IamArn *string `location:"querystring" locationName:"iamArn" min:"1" type:"string"`

	// The ID of the identity. This parameter is required if you specify USER or
	// GROUP for identityType.
	IdentityId *string `location:"querystring" locationName:"identityId" min:"1" type:"string"`

	// The type of identity (IAM Identity Center user, IAM Identity Center group,
	// or IAM user). This parameter is required if you specify identityId.
	IdentityType *string `location:"querystring" locationName:"identityType" type:"string" enum:"IdentityType"`

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The ID of the resource. This parameter is required if you specify resourceType.
	ResourceId *string `location:"querystring" locationName:"resourceId" min:"36" type:"string"`

	// The type of resource (portal or project). This parameter is required if you
	// specify resourceId.
	ResourceType *string `location:"querystring" locationName:"resourceType" type:"string" enum:"ResourceType"`
	// contains filtered or unexported fields
}

func (ListAccessPoliciesInput) GoString 

func (s ListAccessPoliciesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccessPoliciesInput) SetIamArn added in v1.34.28 

func (s *ListAccessPoliciesInput) SetIamArn(v string) *ListAccessPoliciesInput

SetIamArn sets the IamArn field's value.

func (*ListAccessPoliciesInput) SetIdentityId 

func (s *ListAccessPoliciesInput) SetIdentityId(v string) *ListAccessPoliciesInput

SetIdentityId sets the IdentityId field's value.

func (*ListAccessPoliciesInput) SetIdentityType 

func (s *ListAccessPoliciesInput) SetIdentityType(v string) *ListAccessPoliciesInput

SetIdentityType sets the IdentityType field's value.

func (*ListAccessPoliciesInput) SetMaxResults 

func (s *ListAccessPoliciesInput) SetMaxResults(v int64) *ListAccessPoliciesInput

SetMaxResults sets the MaxResults field's value.

func (*ListAccessPoliciesInput) SetNextToken 

func (s *ListAccessPoliciesInput) SetNextToken(v string) *ListAccessPoliciesInput

SetNextToken sets the NextToken field's value.

func (*ListAccessPoliciesInput) SetResourceId 

func (s *ListAccessPoliciesInput) SetResourceId(v string) *ListAccessPoliciesInput

SetResourceId sets the ResourceId field's value.

func (*ListAccessPoliciesInput) SetResourceType 

func (s *ListAccessPoliciesInput) SetResourceType(v string) *ListAccessPoliciesInput

SetResourceType sets the ResourceType field's value.

func (ListAccessPoliciesInput) String 

func (s ListAccessPoliciesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccessPoliciesInput) Validate 

func (s *ListAccessPoliciesInput) Validate() error

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

type ListAccessPoliciesOutput 

type ListAccessPoliciesOutput struct {

	// A list that summarizes each access policy.
	//
	// AccessPolicySummaries is a required field
	AccessPolicySummaries []*AccessPolicySummary `locationName:"accessPolicySummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAccessPoliciesOutput) GoString 

func (s ListAccessPoliciesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAccessPoliciesOutput) SetAccessPolicySummaries 

func (s *ListAccessPoliciesOutput) SetAccessPolicySummaries(v []*AccessPolicySummary) *ListAccessPoliciesOutput

SetAccessPolicySummaries sets the AccessPolicySummaries field's value.

func (*ListAccessPoliciesOutput) SetNextToken 

func (s *ListAccessPoliciesOutput) SetNextToken(v string) *ListAccessPoliciesOutput

SetNextToken sets the NextToken field's value.

func (ListAccessPoliciesOutput) String 

func (s ListAccessPoliciesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListActionsInput added in v1.48.2 

type ListActionsInput struct {

	// The maximum number of results to return for each paginated request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The ID of the target resource.
	//
	// TargetResourceId is a required field
	TargetResourceId *string `location:"querystring" locationName:"targetResourceId" min:"13" type:"string" required:"true"`

	// The type of resource.
	//
	// TargetResourceType is a required field
	TargetResourceType *string `location:"querystring" locationName:"targetResourceType" type:"string" required:"true" enum:"TargetResourceType"`
	// contains filtered or unexported fields
}

func (ListActionsInput) GoString added in v1.48.2 

func (s ListActionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListActionsInput) SetMaxResults added in v1.48.2 

func (s *ListActionsInput) SetMaxResults(v int64) *ListActionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListActionsInput) SetNextToken added in v1.48.2 

func (s *ListActionsInput) SetNextToken(v string) *ListActionsInput

SetNextToken sets the NextToken field's value.

func (*ListActionsInput) SetTargetResourceId added in v1.48.2 

func (s *ListActionsInput) SetTargetResourceId(v string) *ListActionsInput

SetTargetResourceId sets the TargetResourceId field's value.

func (*ListActionsInput) SetTargetResourceType added in v1.48.2 

func (s *ListActionsInput) SetTargetResourceType(v string) *ListActionsInput

SetTargetResourceType sets the TargetResourceType field's value.

func (ListActionsInput) String added in v1.48.2 

func (s ListActionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListActionsInput) Validate added in v1.48.2 

func (s *ListActionsInput) Validate() error

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

type ListActionsOutput added in v1.48.2 

type ListActionsOutput struct {

	// A list that summarizes the actions associated with the specified asset.
	//
	// ActionSummaries is a required field
	ActionSummaries []*ActionSummary `locationName:"actionSummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	//
	// NextToken is a required field
	NextToken *string `locationName:"nextToken" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListActionsOutput) GoString added in v1.48.2 

func (s ListActionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListActionsOutput) SetActionSummaries added in v1.48.2 

func (s *ListActionsOutput) SetActionSummaries(v []*ActionSummary) *ListActionsOutput

SetActionSummaries sets the ActionSummaries field's value.

func (*ListActionsOutput) SetNextToken added in v1.48.2 

func (s *ListActionsOutput) SetNextToken(v string) *ListActionsOutput

SetNextToken sets the NextToken field's value.

func (ListActionsOutput) String added in v1.48.2 

func (s ListActionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAssetModelCompositeModelsInput added in v1.48.2 

type ListAssetModelCompositeModelsInput struct {

	// The ID of the asset model. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetModelId is a required field
	AssetModelId *string `location:"uri" locationName:"assetModelId" min:"13" type:"string" required:"true"`

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssetModelCompositeModelsInput) GoString added in v1.48.2 

func (s ListAssetModelCompositeModelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetModelCompositeModelsInput) SetAssetModelId added in v1.48.2 

func (s *ListAssetModelCompositeModelsInput) SetAssetModelId(v string) *ListAssetModelCompositeModelsInput

SetAssetModelId sets the AssetModelId field's value.

func (*ListAssetModelCompositeModelsInput) SetMaxResults added in v1.48.2 

func (s *ListAssetModelCompositeModelsInput) SetMaxResults(v int64) *ListAssetModelCompositeModelsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAssetModelCompositeModelsInput) SetNextToken added in v1.48.2 

func (s *ListAssetModelCompositeModelsInput) SetNextToken(v string) *ListAssetModelCompositeModelsInput

SetNextToken sets the NextToken field's value.

func (ListAssetModelCompositeModelsInput) String added in v1.48.2 

func (s ListAssetModelCompositeModelsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetModelCompositeModelsInput) Validate added in v1.48.2 

func (s *ListAssetModelCompositeModelsInput) Validate() error

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

type ListAssetModelCompositeModelsOutput added in v1.48.2 

type ListAssetModelCompositeModelsOutput struct {

	// A list that summarizes each composite model.
	//
	// AssetModelCompositeModelSummaries is a required field
	AssetModelCompositeModelSummaries []*AssetModelCompositeModelSummary `locationName:"assetModelCompositeModelSummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssetModelCompositeModelsOutput) GoString added in v1.48.2 

func (s ListAssetModelCompositeModelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetModelCompositeModelsOutput) SetAssetModelCompositeModelSummaries added in v1.48.2 

func (s *ListAssetModelCompositeModelsOutput) SetAssetModelCompositeModelSummaries(v []*AssetModelCompositeModelSummary) *ListAssetModelCompositeModelsOutput

SetAssetModelCompositeModelSummaries sets the AssetModelCompositeModelSummaries field's value.

func (*ListAssetModelCompositeModelsOutput) SetNextToken added in v1.48.2 

func (s *ListAssetModelCompositeModelsOutput) SetNextToken(v string) *ListAssetModelCompositeModelsOutput

SetNextToken sets the NextToken field's value.

func (ListAssetModelCompositeModelsOutput) String added in v1.48.2 

func (s ListAssetModelCompositeModelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAssetModelPropertiesInput added in v1.44.129 

type ListAssetModelPropertiesInput struct {

	// The ID of the asset model. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetModelId is a required field
	AssetModelId *string `location:"uri" locationName:"assetModelId" min:"13" type:"string" required:"true"`

	// Filters the requested list of asset model properties. You can choose one
	// of the following options:
	//
	//    * ALL – The list includes all asset model properties for a given asset
	//    model ID.
	//
	//    * BASE – The list includes only base asset model properties for a given
	//    asset model ID.
	//
	// Default: BASE
	Filter *string `location:"querystring" locationName:"filter" type:"string" enum:"ListAssetModelPropertiesFilter"`

	// The maximum number of results to return for each paginated request. If not
	// specified, the default value is 50.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssetModelPropertiesInput) GoString added in v1.44.129 

func (s ListAssetModelPropertiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetModelPropertiesInput) SetAssetModelId added in v1.44.129 

func (s *ListAssetModelPropertiesInput) SetAssetModelId(v string) *ListAssetModelPropertiesInput

SetAssetModelId sets the AssetModelId field's value.

func (*ListAssetModelPropertiesInput) SetFilter added in v1.44.129 

func (s *ListAssetModelPropertiesInput) SetFilter(v string) *ListAssetModelPropertiesInput

SetFilter sets the Filter field's value.

func (*ListAssetModelPropertiesInput) SetMaxResults added in v1.44.129 

func (s *ListAssetModelPropertiesInput) SetMaxResults(v int64) *ListAssetModelPropertiesInput

SetMaxResults sets the MaxResults field's value.

func (*ListAssetModelPropertiesInput) SetNextToken added in v1.44.129 

func (s *ListAssetModelPropertiesInput) SetNextToken(v string) *ListAssetModelPropertiesInput

SetNextToken sets the NextToken field's value.

func (ListAssetModelPropertiesInput) String added in v1.44.129 

func (s ListAssetModelPropertiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetModelPropertiesInput) Validate added in v1.44.129 

func (s *ListAssetModelPropertiesInput) Validate() error

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

type ListAssetModelPropertiesOutput added in v1.44.129 

type ListAssetModelPropertiesOutput struct {

	// A list that summarizes the properties associated with the specified asset
	// model.
	//
	// AssetModelPropertySummaries is a required field
	AssetModelPropertySummaries []*AssetModelPropertySummary `locationName:"assetModelPropertySummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssetModelPropertiesOutput) GoString added in v1.44.129 

func (s ListAssetModelPropertiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetModelPropertiesOutput) SetAssetModelPropertySummaries added in v1.44.129 

func (s *ListAssetModelPropertiesOutput) SetAssetModelPropertySummaries(v []*AssetModelPropertySummary) *ListAssetModelPropertiesOutput

SetAssetModelPropertySummaries sets the AssetModelPropertySummaries field's value.

func (*ListAssetModelPropertiesOutput) SetNextToken added in v1.44.129 

func (s *ListAssetModelPropertiesOutput) SetNextToken(v string) *ListAssetModelPropertiesOutput

SetNextToken sets the NextToken field's value.

func (ListAssetModelPropertiesOutput) String added in v1.44.129 

func (s ListAssetModelPropertiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAssetModelsInput 

type ListAssetModelsInput struct {

	// The type of asset model.
	//
	//    * ASSET_MODEL – (default) An asset model that you can use to create
	//    assets. Can't be included as a component in another asset model.
	//
	//    * COMPONENT_MODEL – A reusable component that you can include in the
	//    composite models of other asset models. You can't create assets directly
	//    from this type of asset model.
	AssetModelTypes []*string `location:"querystring" locationName:"assetModelTypes" type:"list" enum:"AssetModelType"`

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssetModelsInput) GoString 

func (s ListAssetModelsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetModelsInput) SetAssetModelTypes added in v1.48.2 

func (s *ListAssetModelsInput) SetAssetModelTypes(v []*string) *ListAssetModelsInput

SetAssetModelTypes sets the AssetModelTypes field's value.

func (*ListAssetModelsInput) SetMaxResults 

func (s *ListAssetModelsInput) SetMaxResults(v int64) *ListAssetModelsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAssetModelsInput) SetNextToken 

func (s *ListAssetModelsInput) SetNextToken(v string) *ListAssetModelsInput

SetNextToken sets the NextToken field's value.

func (ListAssetModelsInput) String 

func (s ListAssetModelsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetModelsInput) Validate 

func (s *ListAssetModelsInput) Validate() error

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

type ListAssetModelsOutput 

type ListAssetModelsOutput struct {

	// A list that summarizes each asset model.
	//
	// AssetModelSummaries is a required field
	AssetModelSummaries []*AssetModelSummary `locationName:"assetModelSummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssetModelsOutput) GoString 

func (s ListAssetModelsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetModelsOutput) SetAssetModelSummaries 

func (s *ListAssetModelsOutput) SetAssetModelSummaries(v []*AssetModelSummary) *ListAssetModelsOutput

SetAssetModelSummaries sets the AssetModelSummaries field's value.

func (*ListAssetModelsOutput) SetNextToken 

func (s *ListAssetModelsOutput) SetNextToken(v string) *ListAssetModelsOutput

SetNextToken sets the NextToken field's value.

func (ListAssetModelsOutput) String 

func (s ListAssetModelsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAssetPropertiesInput added in v1.44.129 

type ListAssetPropertiesInput struct {

	// The ID of the asset. This can be either the actual ID in UUID format, or
	// else externalId: followed by the external ID, if it has one. For more information,
	// see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"uri" locationName:"assetId" min:"13" type:"string" required:"true"`

	// Filters the requested list of asset properties. You can choose one of the
	// following options:
	//
	//    * ALL – The list includes all asset properties for a given asset model
	//    ID.
	//
	//    * BASE – The list includes only base asset properties for a given asset
	//    model ID.
	//
	// Default: BASE
	Filter *string `location:"querystring" locationName:"filter" type:"string" enum:"ListAssetPropertiesFilter"`

	// The maximum number of results to return for each paginated request. If not
	// specified, the default value is 50.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssetPropertiesInput) GoString added in v1.44.129 

func (s ListAssetPropertiesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetPropertiesInput) SetAssetId added in v1.44.129 

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

SetAssetId sets the AssetId field's value.

func (*ListAssetPropertiesInput) SetFilter added in v1.44.129 

func (s *ListAssetPropertiesInput) SetFilter(v string) *ListAssetPropertiesInput

SetFilter sets the Filter field's value.

func (*ListAssetPropertiesInput) SetMaxResults added in v1.44.129 

func (s *ListAssetPropertiesInput) SetMaxResults(v int64) *ListAssetPropertiesInput

SetMaxResults sets the MaxResults field's value.

func (*ListAssetPropertiesInput) SetNextToken added in v1.44.129 

func (s *ListAssetPropertiesInput) SetNextToken(v string) *ListAssetPropertiesInput

SetNextToken sets the NextToken field's value.

func (ListAssetPropertiesInput) String added in v1.44.129 

func (s ListAssetPropertiesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetPropertiesInput) Validate added in v1.44.129 

func (s *ListAssetPropertiesInput) Validate() error

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

type ListAssetPropertiesOutput added in v1.44.129 

type ListAssetPropertiesOutput struct {

	// A list that summarizes the properties associated with the specified asset.
	//
	// AssetPropertySummaries is a required field
	AssetPropertySummaries []*AssetPropertySummary `locationName:"assetPropertySummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssetPropertiesOutput) GoString added in v1.44.129 

func (s ListAssetPropertiesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetPropertiesOutput) SetAssetPropertySummaries added in v1.44.129 

func (s *ListAssetPropertiesOutput) SetAssetPropertySummaries(v []*AssetPropertySummary) *ListAssetPropertiesOutput

SetAssetPropertySummaries sets the AssetPropertySummaries field's value.

func (*ListAssetPropertiesOutput) SetNextToken added in v1.44.129 

func (s *ListAssetPropertiesOutput) SetNextToken(v string) *ListAssetPropertiesOutput

SetNextToken sets the NextToken field's value.

func (ListAssetPropertiesOutput) String added in v1.44.129 

func (s ListAssetPropertiesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAssetRelationshipsInput added in v1.36.7 

type ListAssetRelationshipsInput struct {

	// The ID of the asset. This can be either the actual ID in UUID format, or
	// else externalId: followed by the external ID, if it has one. For more information,
	// see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"uri" locationName:"assetId" min:"13" type:"string" required:"true"`

	// The maximum number of results to return for each paginated request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The type of traversal to use to identify asset relationships. Choose the
	// following option:
	//
	//    * PATH_TO_ROOT – Identify the asset's parent assets up to the root asset.
	//    The asset that you specify in assetId is the first result in the list
	//    of assetRelationshipSummaries, and the root asset is the last result.
	//
	// TraversalType is a required field
	TraversalType *string `location:"querystring" locationName:"traversalType" type:"string" required:"true" enum:"TraversalType"`
	// contains filtered or unexported fields
}

func (ListAssetRelationshipsInput) GoString added in v1.36.7 

func (s ListAssetRelationshipsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetRelationshipsInput) SetAssetId added in v1.36.7 

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

SetAssetId sets the AssetId field's value.

func (*ListAssetRelationshipsInput) SetMaxResults added in v1.36.7 

func (s *ListAssetRelationshipsInput) SetMaxResults(v int64) *ListAssetRelationshipsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAssetRelationshipsInput) SetNextToken added in v1.36.7 

func (s *ListAssetRelationshipsInput) SetNextToken(v string) *ListAssetRelationshipsInput

SetNextToken sets the NextToken field's value.

func (*ListAssetRelationshipsInput) SetTraversalType added in v1.36.7 

func (s *ListAssetRelationshipsInput) SetTraversalType(v string) *ListAssetRelationshipsInput

SetTraversalType sets the TraversalType field's value.

func (ListAssetRelationshipsInput) String added in v1.36.7 

func (s ListAssetRelationshipsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetRelationshipsInput) Validate added in v1.36.7 

func (s *ListAssetRelationshipsInput) Validate() error

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

type ListAssetRelationshipsOutput added in v1.36.7 

type ListAssetRelationshipsOutput struct {

	// A list that summarizes each asset relationship.
	//
	// AssetRelationshipSummaries is a required field
	AssetRelationshipSummaries []*AssetRelationshipSummary `locationName:"assetRelationshipSummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssetRelationshipsOutput) GoString added in v1.36.7 

func (s ListAssetRelationshipsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetRelationshipsOutput) SetAssetRelationshipSummaries added in v1.36.7 

func (s *ListAssetRelationshipsOutput) SetAssetRelationshipSummaries(v []*AssetRelationshipSummary) *ListAssetRelationshipsOutput

SetAssetRelationshipSummaries sets the AssetRelationshipSummaries field's value.

func (*ListAssetRelationshipsOutput) SetNextToken added in v1.36.7 

func (s *ListAssetRelationshipsOutput) SetNextToken(v string) *ListAssetRelationshipsOutput

SetNextToken sets the NextToken field's value.

func (ListAssetRelationshipsOutput) String added in v1.36.7 

func (s ListAssetRelationshipsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAssetsInput 

type ListAssetsInput struct {

	// The ID of the asset model by which to filter the list of assets. This parameter
	// is required if you choose ALL for filter. This can be either the actual ID
	// in UUID format, or else externalId: followed by the external ID, if it has
	// one. For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	AssetModelId *string `location:"querystring" locationName:"assetModelId" min:"13" type:"string"`

	// The filter for the requested list of assets. Choose one of the following
	// options:
	//
	//    * ALL – The list includes all assets for a given asset model ID. The
	//    assetModelId parameter is required if you filter by ALL.
	//
	//    * TOP_LEVEL – The list includes only top-level assets in the asset hierarchy
	//    tree.
	//
	// Default: ALL
	Filter *string `location:"querystring" locationName:"filter" type:"string" enum:"ListAssetsFilter"`

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssetsInput) GoString 

func (s ListAssetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetsInput) SetAssetModelId 

func (s *ListAssetsInput) SetAssetModelId(v string) *ListAssetsInput

SetAssetModelId sets the AssetModelId field's value.

func (*ListAssetsInput) SetFilter 

func (s *ListAssetsInput) SetFilter(v string) *ListAssetsInput

SetFilter sets the Filter field's value.

func (*ListAssetsInput) SetMaxResults 

func (s *ListAssetsInput) SetMaxResults(v int64) *ListAssetsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAssetsInput) SetNextToken 

func (s *ListAssetsInput) SetNextToken(v string) *ListAssetsInput

SetNextToken sets the NextToken field's value.

func (ListAssetsInput) String 

func (s ListAssetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetsInput) Validate 

func (s *ListAssetsInput) Validate() error

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

type ListAssetsOutput 

type ListAssetsOutput struct {

	// A list that summarizes each asset.
	//
	// AssetSummaries is a required field
	AssetSummaries []*AssetSummary `locationName:"assetSummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssetsOutput) GoString 

func (s ListAssetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssetsOutput) SetAssetSummaries 

func (s *ListAssetsOutput) SetAssetSummaries(v []*AssetSummary) *ListAssetsOutput

SetAssetSummaries sets the AssetSummaries field's value.

func (*ListAssetsOutput) SetNextToken 

func (s *ListAssetsOutput) SetNextToken(v string) *ListAssetsOutput

SetNextToken sets the NextToken field's value.

func (ListAssetsOutput) String 

func (s ListAssetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAssociatedAssetsInput 

type ListAssociatedAssetsInput struct {

	// The ID of the asset to query. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"uri" locationName:"assetId" min:"13" type:"string" required:"true"`

	// The ID of the hierarchy by which child assets are associated to the asset.
	// (This can be either the actual ID in UUID format, or else externalId: followed
	// by the external ID, if it has one. For more information, see Referencing
	// objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.) To find a hierarchy ID, use the DescribeAsset
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html)
	// or DescribeAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html)
	// operations. This parameter is required if you choose CHILD for traversalDirection.
	//
	// For more information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html)
	// in the IoT SiteWise User Guide.
	HierarchyId *string `location:"querystring" locationName:"hierarchyId" min:"13" type:"string"`

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The direction to list associated assets. Choose one of the following options:
	//
	//    * CHILD – The list includes all child assets associated to the asset.
	//    The hierarchyId parameter is required if you choose CHILD.
	//
	//    * PARENT – The list includes the asset's parent asset.
	//
	// Default: CHILD
	TraversalDirection *string `location:"querystring" locationName:"traversalDirection" type:"string" enum:"TraversalDirection"`
	// contains filtered or unexported fields
}

func (ListAssociatedAssetsInput) GoString 

func (s ListAssociatedAssetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssociatedAssetsInput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*ListAssociatedAssetsInput) SetHierarchyId 

func (s *ListAssociatedAssetsInput) SetHierarchyId(v string) *ListAssociatedAssetsInput

SetHierarchyId sets the HierarchyId field's value.

func (*ListAssociatedAssetsInput) SetMaxResults 

func (s *ListAssociatedAssetsInput) SetMaxResults(v int64) *ListAssociatedAssetsInput

SetMaxResults sets the MaxResults field's value.

func (*ListAssociatedAssetsInput) SetNextToken 

func (s *ListAssociatedAssetsInput) SetNextToken(v string) *ListAssociatedAssetsInput

SetNextToken sets the NextToken field's value.

func (*ListAssociatedAssetsInput) SetTraversalDirection added in v1.34.10 

func (s *ListAssociatedAssetsInput) SetTraversalDirection(v string) *ListAssociatedAssetsInput

SetTraversalDirection sets the TraversalDirection field's value.

func (ListAssociatedAssetsInput) String 

func (s ListAssociatedAssetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssociatedAssetsInput) Validate 

func (s *ListAssociatedAssetsInput) Validate() error

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

type ListAssociatedAssetsOutput 

type ListAssociatedAssetsOutput struct {

	// A list that summarizes the associated assets.
	//
	// AssetSummaries is a required field
	AssetSummaries []*AssociatedAssetsSummary `locationName:"assetSummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListAssociatedAssetsOutput) GoString 

func (s ListAssociatedAssetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAssociatedAssetsOutput) SetAssetSummaries 

func (s *ListAssociatedAssetsOutput) SetAssetSummaries(v []*AssociatedAssetsSummary) *ListAssociatedAssetsOutput

SetAssetSummaries sets the AssetSummaries field's value.

func (*ListAssociatedAssetsOutput) SetNextToken 

func (s *ListAssociatedAssetsOutput) SetNextToken(v string) *ListAssociatedAssetsOutput

SetNextToken sets the NextToken field's value.

func (ListAssociatedAssetsOutput) String 

func (s ListAssociatedAssetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListBulkImportJobsInput added in v1.44.60 

type ListBulkImportJobsInput struct {

	// You can use a filter to select the bulk import jobs that you want to retrieve.
	Filter *string `location:"querystring" locationName:"filter" type:"string" enum:"ListBulkImportJobsFilter"`

	// The maximum number of results to return for each paginated request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListBulkImportJobsInput) GoString added in v1.44.60 

func (s ListBulkImportJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBulkImportJobsInput) SetFilter added in v1.44.60 

func (s *ListBulkImportJobsInput) SetFilter(v string) *ListBulkImportJobsInput

SetFilter sets the Filter field's value.

func (*ListBulkImportJobsInput) SetMaxResults added in v1.44.60 

func (s *ListBulkImportJobsInput) SetMaxResults(v int64) *ListBulkImportJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListBulkImportJobsInput) SetNextToken added in v1.44.60 

func (s *ListBulkImportJobsInput) SetNextToken(v string) *ListBulkImportJobsInput

SetNextToken sets the NextToken field's value.

func (ListBulkImportJobsInput) String added in v1.44.60 

func (s ListBulkImportJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBulkImportJobsInput) Validate added in v1.44.60 

func (s *ListBulkImportJobsInput) Validate() error

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

type ListBulkImportJobsOutput added in v1.44.60 

type ListBulkImportJobsOutput struct {

	// One or more job summaries to list.
	//
	// JobSummaries is a required field
	JobSummaries []*JobSummary `locationName:"jobSummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListBulkImportJobsOutput) GoString added in v1.44.60 

func (s ListBulkImportJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListBulkImportJobsOutput) SetJobSummaries added in v1.44.60 

func (s *ListBulkImportJobsOutput) SetJobSummaries(v []*JobSummary) *ListBulkImportJobsOutput

SetJobSummaries sets the JobSummaries field's value.

func (*ListBulkImportJobsOutput) SetNextToken added in v1.44.60 

func (s *ListBulkImportJobsOutput) SetNextToken(v string) *ListBulkImportJobsOutput

SetNextToken sets the NextToken field's value.

func (ListBulkImportJobsOutput) String added in v1.44.60 

func (s ListBulkImportJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListCompositionRelationshipsInput added in v1.48.2 

type ListCompositionRelationshipsInput struct {

	// The ID of the asset model. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetModelId is a required field
	AssetModelId *string `location:"uri" locationName:"assetModelId" min:"36" type:"string" required:"true"`

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListCompositionRelationshipsInput) GoString added in v1.48.2 

func (s ListCompositionRelationshipsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCompositionRelationshipsInput) SetAssetModelId added in v1.48.2 

func (s *ListCompositionRelationshipsInput) SetAssetModelId(v string) *ListCompositionRelationshipsInput

SetAssetModelId sets the AssetModelId field's value.

func (*ListCompositionRelationshipsInput) SetMaxResults added in v1.48.2 

func (s *ListCompositionRelationshipsInput) SetMaxResults(v int64) *ListCompositionRelationshipsInput

SetMaxResults sets the MaxResults field's value.

func (*ListCompositionRelationshipsInput) SetNextToken added in v1.48.2 

func (s *ListCompositionRelationshipsInput) SetNextToken(v string) *ListCompositionRelationshipsInput

SetNextToken sets the NextToken field's value.

func (ListCompositionRelationshipsInput) String added in v1.48.2 

func (s ListCompositionRelationshipsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCompositionRelationshipsInput) Validate added in v1.48.2 

func (s *ListCompositionRelationshipsInput) Validate() error

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

type ListCompositionRelationshipsOutput added in v1.48.2 

type ListCompositionRelationshipsOutput struct {

	// A list that summarizes each composition relationship.
	//
	// CompositionRelationshipSummaries is a required field
	CompositionRelationshipSummaries []*CompositionRelationshipSummary `locationName:"compositionRelationshipSummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListCompositionRelationshipsOutput) GoString added in v1.48.2 

func (s ListCompositionRelationshipsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCompositionRelationshipsOutput) SetCompositionRelationshipSummaries added in v1.48.2 

func (s *ListCompositionRelationshipsOutput) SetCompositionRelationshipSummaries(v []*CompositionRelationshipSummary) *ListCompositionRelationshipsOutput

SetCompositionRelationshipSummaries sets the CompositionRelationshipSummaries field's value.

func (*ListCompositionRelationshipsOutput) SetNextToken added in v1.48.2 

func (s *ListCompositionRelationshipsOutput) SetNextToken(v string) *ListCompositionRelationshipsOutput

SetNextToken sets the NextToken field's value.

func (ListCompositionRelationshipsOutput) String added in v1.48.2 

func (s ListCompositionRelationshipsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListDashboardsInput 

type ListDashboardsInput struct {

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The ID of the project.
	//
	// ProjectId is a required field
	ProjectId *string `location:"querystring" locationName:"projectId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListDashboardsInput) GoString 

func (s ListDashboardsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDashboardsInput) SetMaxResults 

func (s *ListDashboardsInput) SetMaxResults(v int64) *ListDashboardsInput

SetMaxResults sets the MaxResults field's value.

func (*ListDashboardsInput) SetNextToken 

func (s *ListDashboardsInput) SetNextToken(v string) *ListDashboardsInput

SetNextToken sets the NextToken field's value.

func (*ListDashboardsInput) SetProjectId 

func (s *ListDashboardsInput) SetProjectId(v string) *ListDashboardsInput

SetProjectId sets the ProjectId field's value.

func (ListDashboardsInput) String 

func (s ListDashboardsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDashboardsInput) Validate 

func (s *ListDashboardsInput) Validate() error

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

type ListDashboardsOutput 

type ListDashboardsOutput struct {

	// A list that summarizes each dashboard in the project.
	//
	// DashboardSummaries is a required field
	DashboardSummaries []*DashboardSummary `locationName:"dashboardSummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDashboardsOutput) GoString 

func (s ListDashboardsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListDashboardsOutput) SetDashboardSummaries 

func (s *ListDashboardsOutput) SetDashboardSummaries(v []*DashboardSummary) *ListDashboardsOutput

SetDashboardSummaries sets the DashboardSummaries field's value.

func (*ListDashboardsOutput) SetNextToken 

func (s *ListDashboardsOutput) SetNextToken(v string) *ListDashboardsOutput

SetNextToken sets the NextToken field's value.

func (ListDashboardsOutput) String 

func (s ListDashboardsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListGatewaysInput 

type ListGatewaysInput struct {

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGatewaysInput) GoString 

func (s ListGatewaysInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGatewaysInput) SetMaxResults 

func (s *ListGatewaysInput) SetMaxResults(v int64) *ListGatewaysInput

SetMaxResults sets the MaxResults field's value.

func (*ListGatewaysInput) SetNextToken 

func (s *ListGatewaysInput) SetNextToken(v string) *ListGatewaysInput

SetNextToken sets the NextToken field's value.

func (ListGatewaysInput) String 

func (s ListGatewaysInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGatewaysInput) Validate 

func (s *ListGatewaysInput) Validate() error

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

type ListGatewaysOutput 

type ListGatewaysOutput struct {

	// A list that summarizes each gateway.
	//
	// GatewaySummaries is a required field
	GatewaySummaries []*GatewaySummary `locationName:"gatewaySummaries" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListGatewaysOutput) GoString 

func (s ListGatewaysOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListGatewaysOutput) SetGatewaySummaries 

func (s *ListGatewaysOutput) SetGatewaySummaries(v []*GatewaySummary) *ListGatewaysOutput

SetGatewaySummaries sets the GatewaySummaries field's value.

func (*ListGatewaysOutput) SetNextToken 

func (s *ListGatewaysOutput) SetNextToken(v string) *ListGatewaysOutput

SetNextToken sets the NextToken field's value.

func (ListGatewaysOutput) String 

func (s ListGatewaysOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPortalsInput 

type ListPortalsInput struct {

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListPortalsInput) GoString 

func (s ListPortalsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPortalsInput) SetMaxResults 

func (s *ListPortalsInput) SetMaxResults(v int64) *ListPortalsInput

SetMaxResults sets the MaxResults field's value.

func (*ListPortalsInput) SetNextToken 

func (s *ListPortalsInput) SetNextToken(v string) *ListPortalsInput

SetNextToken sets the NextToken field's value.

func (ListPortalsInput) String 

func (s ListPortalsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPortalsInput) Validate 

func (s *ListPortalsInput) Validate() error

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

type ListPortalsOutput 

type ListPortalsOutput struct {

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A list that summarizes each portal.
	PortalSummaries []*PortalSummary `locationName:"portalSummaries" type:"list"`
	// contains filtered or unexported fields
}

func (ListPortalsOutput) GoString 

func (s ListPortalsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPortalsOutput) SetNextToken 

func (s *ListPortalsOutput) SetNextToken(v string) *ListPortalsOutput

SetNextToken sets the NextToken field's value.

func (*ListPortalsOutput) SetPortalSummaries 

func (s *ListPortalsOutput) SetPortalSummaries(v []*PortalSummary) *ListPortalsOutput

SetPortalSummaries sets the PortalSummaries field's value.

func (ListPortalsOutput) String 

func (s ListPortalsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListProjectAssetsInput 

type ListProjectAssetsInput struct {

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The ID of the project.
	//
	// ProjectId is a required field
	ProjectId *string `location:"uri" locationName:"projectId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListProjectAssetsInput) GoString 

func (s ListProjectAssetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProjectAssetsInput) SetMaxResults 

func (s *ListProjectAssetsInput) SetMaxResults(v int64) *ListProjectAssetsInput

SetMaxResults sets the MaxResults field's value.

func (*ListProjectAssetsInput) SetNextToken 

func (s *ListProjectAssetsInput) SetNextToken(v string) *ListProjectAssetsInput

SetNextToken sets the NextToken field's value.

func (*ListProjectAssetsInput) SetProjectId 

func (s *ListProjectAssetsInput) SetProjectId(v string) *ListProjectAssetsInput

SetProjectId sets the ProjectId field's value.

func (ListProjectAssetsInput) String 

func (s ListProjectAssetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProjectAssetsInput) Validate 

func (s *ListProjectAssetsInput) Validate() error

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

type ListProjectAssetsOutput 

type ListProjectAssetsOutput struct {

	// A list that contains the IDs of each asset associated with the project.
	//
	// AssetIds is a required field
	AssetIds []*string `locationName:"assetIds" type:"list" required:"true"`

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListProjectAssetsOutput) GoString 

func (s ListProjectAssetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProjectAssetsOutput) SetAssetIds 

func (s *ListProjectAssetsOutput) SetAssetIds(v []*string) *ListProjectAssetsOutput

SetAssetIds sets the AssetIds field's value.

func (*ListProjectAssetsOutput) SetNextToken 

func (s *ListProjectAssetsOutput) SetNextToken(v string) *ListProjectAssetsOutput

SetNextToken sets the NextToken field's value.

func (ListProjectAssetsOutput) String 

func (s ListProjectAssetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListProjectsInput 

type ListProjectsInput struct {

	// The maximum number of results to return for each paginated request.
	//
	// Default: 50
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The ID of the portal.
	//
	// PortalId is a required field
	PortalId *string `location:"querystring" locationName:"portalId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListProjectsInput) GoString 

func (s ListProjectsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProjectsInput) SetMaxResults 

func (s *ListProjectsInput) SetMaxResults(v int64) *ListProjectsInput

SetMaxResults sets the MaxResults field's value.

func (*ListProjectsInput) SetNextToken 

func (s *ListProjectsInput) SetNextToken(v string) *ListProjectsInput

SetNextToken sets the NextToken field's value.

func (*ListProjectsInput) SetPortalId 

func (s *ListProjectsInput) SetPortalId(v string) *ListProjectsInput

SetPortalId sets the PortalId field's value.

func (ListProjectsInput) String 

func (s ListProjectsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProjectsInput) Validate 

func (s *ListProjectsInput) Validate() error

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

type ListProjectsOutput 

type ListProjectsOutput struct {

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A list that summarizes each project in the portal.
	//
	// ProjectSummaries is a required field
	ProjectSummaries []*ProjectSummary `locationName:"projectSummaries" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListProjectsOutput) GoString 

func (s ListProjectsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListProjectsOutput) SetNextToken 

func (s *ListProjectsOutput) SetNextToken(v string) *ListProjectsOutput

SetNextToken sets the NextToken field's value.

func (*ListProjectsOutput) SetProjectSummaries 

func (s *ListProjectsOutput) SetProjectSummaries(v []*ProjectSummary) *ListProjectsOutput

SetProjectSummaries sets the ProjectSummaries field's value.

func (ListProjectsOutput) String 

func (s ListProjectsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of key-value pairs that contain metadata for the resource. For more
	// information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the IoT SiteWise User Guide.
	Tags map[string]*string `locationName:"tags" min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTimeSeriesInput added in v1.42.12 

type ListTimeSeriesInput struct {

	// The alias prefix of the time series.
	AliasPrefix *string `location:"querystring" locationName:"aliasPrefix" min:"1" type:"string"`

	// The ID of the asset in which the asset property was created. This can be
	// either the actual ID in UUID format, or else externalId: followed by the
	// external ID, if it has one. For more information, see Referencing objects
	// with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	AssetId *string `location:"querystring" locationName:"assetId" min:"13" type:"string"`

	// The maximum number of results to return for each paginated request.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to be used for the next set of paginated results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// The type of the time series. The time series type can be one of the following
	// values:
	//
	//    * ASSOCIATED – The time series is associated with an asset property.
	//
	//    * DISASSOCIATED – The time series isn't associated with any asset property.
	TimeSeriesType *string `location:"querystring" locationName:"timeSeriesType" type:"string" enum:"ListTimeSeriesType"`
	// contains filtered or unexported fields
}

func (ListTimeSeriesInput) GoString added in v1.42.12 

func (s ListTimeSeriesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTimeSeriesInput) SetAliasPrefix added in v1.42.12 

func (s *ListTimeSeriesInput) SetAliasPrefix(v string) *ListTimeSeriesInput

SetAliasPrefix sets the AliasPrefix field's value.

func (*ListTimeSeriesInput) SetAssetId added in v1.42.12 

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

SetAssetId sets the AssetId field's value.

func (*ListTimeSeriesInput) SetMaxResults added in v1.42.12 

func (s *ListTimeSeriesInput) SetMaxResults(v int64) *ListTimeSeriesInput

SetMaxResults sets the MaxResults field's value.

func (*ListTimeSeriesInput) SetNextToken added in v1.42.12 

func (s *ListTimeSeriesInput) SetNextToken(v string) *ListTimeSeriesInput

SetNextToken sets the NextToken field's value.

func (*ListTimeSeriesInput) SetTimeSeriesType added in v1.42.12 

func (s *ListTimeSeriesInput) SetTimeSeriesType(v string) *ListTimeSeriesInput

SetTimeSeriesType sets the TimeSeriesType field's value.

func (ListTimeSeriesInput) String added in v1.42.12 

func (s ListTimeSeriesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTimeSeriesInput) Validate added in v1.42.12 

func (s *ListTimeSeriesInput) Validate() error

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

type ListTimeSeriesOutput added in v1.42.12 

type ListTimeSeriesOutput struct {

	// The token for the next set of results, or null if there are no additional
	// results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// One or more time series summaries to list.
	//
	// TimeSeriesSummaries is a required field
	TimeSeriesSummaries []*TimeSeriesSummary `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListTimeSeriesOutput) GoString added in v1.42.12 

func (s ListTimeSeriesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTimeSeriesOutput) SetNextToken added in v1.42.12 

func (s *ListTimeSeriesOutput) SetNextToken(v string) *ListTimeSeriesOutput

SetNextToken sets the NextToken field's value.

func (*ListTimeSeriesOutput) SetTimeSeriesSummaries added in v1.42.12 

func (s *ListTimeSeriesOutput) SetTimeSeriesSummaries(v []*TimeSeriesSummary) *ListTimeSeriesOutput

SetTimeSeriesSummaries sets the TimeSeriesSummaries field's value.

func (ListTimeSeriesOutput) String added in v1.42.12 

func (s ListTimeSeriesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoggingOptions 

type LoggingOptions struct {

	// The IoT SiteWise logging verbosity level.
	//
	// Level is a required field
	Level *string `locationName:"level" type:"string" required:"true" enum:"LoggingLevel"`
	// contains filtered or unexported fields
}

Contains logging options.

func (LoggingOptions) GoString 

func (s LoggingOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingOptions) SetLevel 

func (s *LoggingOptions) SetLevel(v string) *LoggingOptions

SetLevel sets the Level field's value.

func (LoggingOptions) String 

func (s LoggingOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingOptions) Validate 

func (s *LoggingOptions) Validate() error

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

type Measurement 

type Measurement struct {

	// The processing configuration for the given measurement property. You can
	// configure measurements to be kept at the edge or forwarded to the Amazon
	// Web Services Cloud. By default, measurements are forwarded to the cloud.
	ProcessingConfig *MeasurementProcessingConfig `locationName:"processingConfig" type:"structure"`
	// contains filtered or unexported fields
}

Contains an asset measurement property. For more information, see Measurements (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements) in the IoT SiteWise User Guide.

func (Measurement) GoString 

func (s Measurement) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Measurement) SetProcessingConfig added in v1.40.11 

func (s *Measurement) SetProcessingConfig(v *MeasurementProcessingConfig) *Measurement

SetProcessingConfig sets the ProcessingConfig field's value.

func (Measurement) String 

func (s Measurement) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Measurement) Validate added in v1.40.11 

func (s *Measurement) Validate() error

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

type MeasurementProcessingConfig added in v1.40.11 

type MeasurementProcessingConfig struct {

	// The forwarding configuration for the given measurement property.
	//
	// ForwardingConfig is a required field
	ForwardingConfig *ForwardingConfig `locationName:"forwardingConfig" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud.

func (MeasurementProcessingConfig) GoString added in v1.40.11 

func (s MeasurementProcessingConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MeasurementProcessingConfig) SetForwardingConfig added in v1.40.11 

func (s *MeasurementProcessingConfig) SetForwardingConfig(v *ForwardingConfig) *MeasurementProcessingConfig

SetForwardingConfig sets the ForwardingConfig field's value.

func (MeasurementProcessingConfig) String added in v1.40.11 

func (s MeasurementProcessingConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MeasurementProcessingConfig) Validate added in v1.40.11 

func (s *MeasurementProcessingConfig) Validate() error

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

type Metric 

type Metric struct {

	// The mathematical expression that defines the metric aggregation function.
	// You can specify up to 10 variables per expression. You can specify up to
	// 10 functions per expression.
	//
	// For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
	// in the IoT SiteWise User Guide.
	//
	// Expression is a required field
	Expression *string `locationName:"expression" min:"1" type:"string" required:"true"`

	// The processing configuration for the given metric property. You can configure
	// metrics to be computed at the edge or in the Amazon Web Services Cloud. By
	// default, metrics are forwarded to the cloud.
	ProcessingConfig *MetricProcessingConfig `locationName:"processingConfig" type:"structure"`

	// The list of variables used in the expression.
	//
	// Variables is a required field
	Variables []*ExpressionVariable `locationName:"variables" type:"list" required:"true"`

	// The window (time interval) over which IoT SiteWise computes the metric's
	// aggregation expression. IoT SiteWise computes one data point per window.
	//
	// Window is a required field
	Window *MetricWindow `locationName:"window" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains an asset metric property. With metrics, you can calculate aggregate functions, such as an average, maximum, or minimum, as specified through an expression. A metric maps several values to a single value (such as a sum).

The maximum number of dependent/cascading variables used in any one metric calculation is 10. Therefore, a root metric can have up to 10 cascading metrics in its computational dependency tree. Additionally, a metric can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.

For more information, see Metrics (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics) in the IoT SiteWise User Guide.

func (Metric) GoString 

func (s Metric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Metric) SetExpression 

func (s *Metric) SetExpression(v string) *Metric

SetExpression sets the Expression field's value.

func (*Metric) SetProcessingConfig added in v1.40.11 

func (s *Metric) SetProcessingConfig(v *MetricProcessingConfig) *Metric

SetProcessingConfig sets the ProcessingConfig field's value.

func (*Metric) SetVariables 

func (s *Metric) SetVariables(v []*ExpressionVariable) *Metric

SetVariables sets the Variables field's value.

func (*Metric) SetWindow 

func (s *Metric) SetWindow(v *MetricWindow) *Metric

SetWindow sets the Window field's value.

func (Metric) String 

func (s Metric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Metric) Validate 

func (s *Metric) Validate() error

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

type MetricProcessingConfig added in v1.40.11 

type MetricProcessingConfig struct {

	// The compute location for the given metric property.
	//
	// ComputeLocation is a required field
	ComputeLocation *string `locationName:"computeLocation" type:"string" required:"true" enum:"ComputeLocation"`
	// contains filtered or unexported fields
}

The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud.

func (MetricProcessingConfig) GoString added in v1.40.11 

func (s MetricProcessingConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricProcessingConfig) SetComputeLocation added in v1.40.11 

func (s *MetricProcessingConfig) SetComputeLocation(v string) *MetricProcessingConfig

SetComputeLocation sets the ComputeLocation field's value.

func (MetricProcessingConfig) String added in v1.40.11 

func (s MetricProcessingConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricProcessingConfig) Validate added in v1.40.11 

func (s *MetricProcessingConfig) Validate() error

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

type MetricWindow 

type MetricWindow struct {

	// The tumbling time interval window.
	Tumbling *TumblingWindow `locationName:"tumbling" type:"structure"`
	// contains filtered or unexported fields
}

Contains a time interval window used for data aggregate computations (for example, average, sum, count, and so on).

func (MetricWindow) GoString 

func (s MetricWindow) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricWindow) SetTumbling 

func (s *MetricWindow) SetTumbling(v *TumblingWindow) *MetricWindow

SetTumbling sets the Tumbling field's value.

func (MetricWindow) String 

func (s MetricWindow) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MetricWindow) Validate 

func (s *MetricWindow) Validate() error

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

type MonitorErrorDetails 

type MonitorErrorDetails struct {

	// The error code.
	Code *string `locationName:"code" type:"string" enum:"MonitorErrorCode"`

	// The error message.
	Message *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Contains IoT SiteWise Monitor error details.

func (MonitorErrorDetails) GoString 

func (s MonitorErrorDetails) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MonitorErrorDetails) SetCode 

func (s *MonitorErrorDetails) SetCode(v string) *MonitorErrorDetails

SetCode sets the Code field's value.

func (*MonitorErrorDetails) SetMessage 

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

SetMessage sets the Message field's value.

func (MonitorErrorDetails) String 

func (s MonitorErrorDetails) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MultiLayerStorage added in v1.39.2 

type MultiLayerStorage struct {

	// Contains information about a customer managed Amazon S3 bucket.
	//
	// CustomerManagedS3Storage is a required field
	CustomerManagedS3Storage *CustomerManagedS3Storage `locationName:"customerManagedS3Storage" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains information about the storage destination.

func (MultiLayerStorage) GoString added in v1.39.2 

func (s MultiLayerStorage) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MultiLayerStorage) SetCustomerManagedS3Storage added in v1.39.2 

func (s *MultiLayerStorage) SetCustomerManagedS3Storage(v *CustomerManagedS3Storage) *MultiLayerStorage

SetCustomerManagedS3Storage sets the CustomerManagedS3Storage field's value.

func (MultiLayerStorage) String added in v1.39.2 

func (s MultiLayerStorage) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MultiLayerStorage) Validate added in v1.39.2 

func (s *MultiLayerStorage) Validate() error

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

type Parquet added in v1.48.2 

type Parquet struct {
	// contains filtered or unexported fields
}

A parquet file.

func (Parquet) GoString added in v1.48.2 

func (s Parquet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (Parquet) String added in v1.48.2 

func (s Parquet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PortalResource 

type PortalResource struct {

	// The ID of the portal.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Identifies an IoT SiteWise Monitor portal.

func (PortalResource) GoString 

func (s PortalResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortalResource) SetId 

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

SetId sets the Id field's value.

func (PortalResource) String 

func (s PortalResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortalResource) Validate 

func (s *PortalResource) Validate() error

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

type PortalStatus 

type PortalStatus struct {

	// Contains associated error information, if any.
	Error *MonitorErrorDetails `locationName:"error" type:"structure"`

	// The current state of the portal.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"PortalState"`
	// contains filtered or unexported fields
}

Contains information about the current status of a portal.

func (PortalStatus) GoString 

func (s PortalStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortalStatus) SetError 

func (s *PortalStatus) SetError(v *MonitorErrorDetails) *PortalStatus

SetError sets the Error field's value.

func (*PortalStatus) SetState 

func (s *PortalStatus) SetState(v string) *PortalStatus

SetState sets the State field's value.

func (PortalStatus) String 

func (s PortalStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PortalSummary 

type PortalSummary struct {

	// The date the portal was created, in Unix epoch time.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// The portal's description.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The ID of the portal.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The date the portal was last updated, in Unix epoch time.
	LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp"`

	// The name of the portal.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the service role that allows the portal's users to access your IoT SiteWise
	// resources on your behalf. For more information, see Using service roles for
	// IoT SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html)
	// in the IoT SiteWise User Guide.
	RoleArn *string `locationName:"roleArn" min:"1" type:"string"`

	// The URL for the IoT SiteWise Monitor portal. You can use this URL to access
	// portals that use IAM Identity Center for authentication. For portals that
	// use IAM for authentication, you must use the IoT SiteWise console to get
	// a URL that you can use to access the portal.
	//
	// StartUrl is a required field
	StartUrl *string `locationName:"startUrl" min:"1" type:"string" required:"true"`

	// Contains information about the current status of a portal.
	//
	// Status is a required field
	Status *PortalStatus `locationName:"status" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains a portal summary.

func (PortalSummary) GoString 

func (s PortalSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortalSummary) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*PortalSummary) SetDescription 

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

SetDescription sets the Description field's value.

func (*PortalSummary) SetId 

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

SetId sets the Id field's value.

func (*PortalSummary) SetLastUpdateDate 

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

SetLastUpdateDate sets the LastUpdateDate field's value.

func (*PortalSummary) SetName 

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

SetName sets the Name field's value.

func (*PortalSummary) SetRoleArn 

func (s *PortalSummary) SetRoleArn(v string) *PortalSummary

SetRoleArn sets the RoleArn field's value.

func (*PortalSummary) SetStartUrl 

func (s *PortalSummary) SetStartUrl(v string) *PortalSummary

SetStartUrl sets the StartUrl field's value.

func (*PortalSummary) SetStatus added in v1.34.10 

func (s *PortalSummary) SetStatus(v *PortalStatus) *PortalSummary

SetStatus sets the Status field's value.

func (PortalSummary) String 

func (s PortalSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ProjectResource 

type ProjectResource struct {

	// The ID of the project.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Identifies a specific IoT SiteWise Monitor project.

func (ProjectResource) GoString 

func (s ProjectResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProjectResource) SetId 

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

SetId sets the Id field's value.

func (ProjectResource) String 

func (s ProjectResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProjectResource) Validate 

func (s *ProjectResource) Validate() error

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

type ProjectSummary 

type ProjectSummary struct {

	// The date the project was created, in Unix epoch time.
	CreationDate *time.Time `locationName:"creationDate" type:"timestamp"`

	// The project's description.
	Description *string `locationName:"description" min:"1" type:"string"`

	// The ID of the project.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The date the project was last updated, in Unix epoch time.
	LastUpdateDate *time.Time `locationName:"lastUpdateDate" type:"timestamp"`

	// The name of the project.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains project summary information.

func (ProjectSummary) GoString 

func (s ProjectSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ProjectSummary) SetCreationDate 

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

SetCreationDate sets the CreationDate field's value.

func (*ProjectSummary) SetDescription 

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

SetDescription sets the Description field's value.

func (*ProjectSummary) SetId 

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

SetId sets the Id field's value.

func (*ProjectSummary) SetLastUpdateDate 

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

SetLastUpdateDate sets the LastUpdateDate field's value.

func (*ProjectSummary) SetName 

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

SetName sets the Name field's value.

func (ProjectSummary) String 

func (s ProjectSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Property 

type Property struct {

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
	// see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the IoT SiteWise User Guide.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// The property data type.
	//
	// DataType is a required field
	DataType *string `locationName:"dataType" type:"string" required:"true" enum:"PropertyDataType"`

	// The external ID of the asset property. For more information, see Using external
	// IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	ExternalId *string `locationName:"externalId" min:"2" type:"string"`

	// The ID of the asset property.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"36" type:"string" required:"true"`

	// The name of the property.
	//
	// Name is a required field
	Name *string `locationName:"name" min:"1" type:"string" required:"true"`

	// The asset property's notification topic and state. For more information,
	// see UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html).
	Notification *PropertyNotification `locationName:"notification" type:"structure"`

	// The structured path to the property from the root of the asset.
	Path []*AssetPropertyPathSegment `locationName:"path" type:"list"`

	// The property type (see PropertyType). A property contains one type.
	Type *PropertyType `locationName:"type" type:"structure"`

	// The unit (such as Newtons or RPM) of the asset property.
	Unit *string `locationName:"unit" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains asset property information.

func (Property) GoString 

func (s Property) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Property) SetAlias 

func (s *Property) SetAlias(v string) *Property

SetAlias sets the Alias field's value.

func (*Property) SetDataType 

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

SetDataType sets the DataType field's value.

func (*Property) SetExternalId added in v1.48.2 

func (s *Property) SetExternalId(v string) *Property

SetExternalId sets the ExternalId field's value.

func (*Property) SetId 

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

SetId sets the Id field's value.

func (*Property) SetName 

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

SetName sets the Name field's value.

func (*Property) SetNotification 

func (s *Property) SetNotification(v *PropertyNotification) *Property

SetNotification sets the Notification field's value.

func (*Property) SetPath added in v1.48.2 

func (s *Property) SetPath(v []*AssetPropertyPathSegment) *Property

SetPath sets the Path field's value.

func (*Property) SetType 

func (s *Property) SetType(v *PropertyType) *Property

SetType sets the Type field's value.

func (*Property) SetUnit 

func (s *Property) SetUnit(v string) *Property

SetUnit sets the Unit field's value.

func (Property) String 

func (s Property) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PropertyNotification 

type PropertyNotification struct {

	// The current notification state.
	//
	// State is a required field
	State *string `locationName:"state" type:"string" required:"true" enum:"PropertyNotificationState"`

	// The MQTT topic to which IoT SiteWise publishes property value update notifications.
	//
	// Topic is a required field
	Topic *string `locationName:"topic" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) in the IoT SiteWise User Guide.

func (PropertyNotification) GoString 

func (s PropertyNotification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyNotification) SetState 

func (s *PropertyNotification) SetState(v string) *PropertyNotification

SetState sets the State field's value.

func (*PropertyNotification) SetTopic 

func (s *PropertyNotification) SetTopic(v string) *PropertyNotification

SetTopic sets the Topic field's value.

func (PropertyNotification) String 

func (s PropertyNotification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PropertyType 

type PropertyType struct {

	// Specifies an asset attribute property. An attribute generally contains static
	// information, such as the serial number of an IIoT (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications)
	// wind turbine.
	Attribute *Attribute `locationName:"attribute" type:"structure"`

	// Specifies an asset measurement property. A measurement represents a device's
	// raw sensor data stream, such as timestamped temperature values or timestamped
	// power values.
	Measurement *Measurement `locationName:"measurement" type:"structure"`

	// Specifies an asset metric property. A metric contains a mathematical expression
	// that uses aggregate functions to process all input data points over a time
	// interval and output a single data point, such as to calculate the average
	// hourly temperature.
	Metric *Metric `locationName:"metric" type:"structure"`

	// Specifies an asset transform property. A transform contains a mathematical
	// expression that maps a property's data points from one form to another, such
	// as a unit conversion from Celsius to Fahrenheit.
	Transform *Transform `locationName:"transform" type:"structure"`
	// contains filtered or unexported fields
}

Contains a property type, which can be one of attribute, measurement, metric, or transform.

func (PropertyType) GoString 

func (s PropertyType) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyType) SetAttribute 

func (s *PropertyType) SetAttribute(v *Attribute) *PropertyType

SetAttribute sets the Attribute field's value.

func (*PropertyType) SetMeasurement 

func (s *PropertyType) SetMeasurement(v *Measurement) *PropertyType

SetMeasurement sets the Measurement field's value.

func (*PropertyType) SetMetric 

func (s *PropertyType) SetMetric(v *Metric) *PropertyType

SetMetric sets the Metric field's value.

func (*PropertyType) SetTransform 

func (s *PropertyType) SetTransform(v *Transform) *PropertyType

SetTransform sets the Transform field's value.

func (PropertyType) String 

func (s PropertyType) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PropertyType) Validate 

func (s *PropertyType) Validate() error

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

type PutAssetPropertyValueEntry 

type PutAssetPropertyValueEntry struct {

	// The ID of the asset to update.
	AssetId *string `locationName:"assetId" min:"36" type:"string"`

	// The user specified ID for the entry. You can use this ID to identify which
	// entries failed.
	//
	// EntryId is a required field
	EntryId *string `locationName:"entryId" min:"1" type:"string" required:"true"`

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
	// see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the IoT SiteWise User Guide.
	PropertyAlias *string `locationName:"propertyAlias" min:"1" type:"string"`

	// The ID of the asset property for this entry.
	PropertyId *string `locationName:"propertyId" min:"36" type:"string"`

	// The list of property values to upload. You can specify up to 10 propertyValues
	// array elements.
	//
	// PropertyValues is a required field
	PropertyValues []*AssetPropertyValue `locationName:"propertyValues" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) API operation.

func (PutAssetPropertyValueEntry) GoString 

func (s PutAssetPropertyValueEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAssetPropertyValueEntry) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*PutAssetPropertyValueEntry) SetEntryId 

func (s *PutAssetPropertyValueEntry) SetEntryId(v string) *PutAssetPropertyValueEntry

SetEntryId sets the EntryId field's value.

func (*PutAssetPropertyValueEntry) SetPropertyAlias 

func (s *PutAssetPropertyValueEntry) SetPropertyAlias(v string) *PutAssetPropertyValueEntry

SetPropertyAlias sets the PropertyAlias field's value.

func (*PutAssetPropertyValueEntry) SetPropertyId 

func (s *PutAssetPropertyValueEntry) SetPropertyId(v string) *PutAssetPropertyValueEntry

SetPropertyId sets the PropertyId field's value.

func (*PutAssetPropertyValueEntry) SetPropertyValues 

func (s *PutAssetPropertyValueEntry) SetPropertyValues(v []*AssetPropertyValue) *PutAssetPropertyValueEntry

SetPropertyValues sets the PropertyValues field's value.

func (PutAssetPropertyValueEntry) String 

func (s PutAssetPropertyValueEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutAssetPropertyValueEntry) Validate 

func (s *PutAssetPropertyValueEntry) Validate() error

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

type PutDefaultEncryptionConfigurationInput added in v1.35.35 

type PutDefaultEncryptionConfigurationInput struct {

	// The type of encryption used for the encryption configuration.
	//
	// EncryptionType is a required field
	EncryptionType *string `locationName:"encryptionType" type:"string" required:"true" enum:"EncryptionType"`

	// The Key ID of the customer managed key used for KMS encryption. This is required
	// if you use KMS_BASED_ENCRYPTION.
	KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutDefaultEncryptionConfigurationInput) GoString added in v1.35.35 

func (s PutDefaultEncryptionConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDefaultEncryptionConfigurationInput) SetEncryptionType added in v1.35.35 

func (s *PutDefaultEncryptionConfigurationInput) SetEncryptionType(v string) *PutDefaultEncryptionConfigurationInput

SetEncryptionType sets the EncryptionType field's value.

func (*PutDefaultEncryptionConfigurationInput) SetKmsKeyId added in v1.35.35 

func (s *PutDefaultEncryptionConfigurationInput) SetKmsKeyId(v string) *PutDefaultEncryptionConfigurationInput

SetKmsKeyId sets the KmsKeyId field's value.

func (PutDefaultEncryptionConfigurationInput) String added in v1.35.35 

func (s PutDefaultEncryptionConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDefaultEncryptionConfigurationInput) Validate added in v1.35.35 

func (s *PutDefaultEncryptionConfigurationInput) Validate() error

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

type PutDefaultEncryptionConfigurationOutput added in v1.35.35 

type PutDefaultEncryptionConfigurationOutput struct {

	// The status of the account configuration. This contains the ConfigurationState.
	// If there is an error, it also contains the ErrorDetails.
	//
	// ConfigurationStatus is a required field
	ConfigurationStatus *ConfigurationStatus `locationName:"configurationStatus" type:"structure" required:"true"`

	// The type of encryption used for the encryption configuration.
	//
	// EncryptionType is a required field
	EncryptionType *string `locationName:"encryptionType" type:"string" required:"true" enum:"EncryptionType"`

	// The Key ARN of the KMS key used for KMS encryption if you use KMS_BASED_ENCRYPTION.
	KmsKeyArn *string `locationName:"kmsKeyArn" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (PutDefaultEncryptionConfigurationOutput) GoString added in v1.35.35 

func (s PutDefaultEncryptionConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutDefaultEncryptionConfigurationOutput) SetConfigurationStatus added in v1.35.35 

func (s *PutDefaultEncryptionConfigurationOutput) SetConfigurationStatus(v *ConfigurationStatus) *PutDefaultEncryptionConfigurationOutput

SetConfigurationStatus sets the ConfigurationStatus field's value.

func (*PutDefaultEncryptionConfigurationOutput) SetEncryptionType added in v1.35.35 

func (s *PutDefaultEncryptionConfigurationOutput) SetEncryptionType(v string) *PutDefaultEncryptionConfigurationOutput

SetEncryptionType sets the EncryptionType field's value.

func (*PutDefaultEncryptionConfigurationOutput) SetKmsKeyArn added in v1.35.35 

func (s *PutDefaultEncryptionConfigurationOutput) SetKmsKeyArn(v string) *PutDefaultEncryptionConfigurationOutput

SetKmsKeyArn sets the KmsKeyArn field's value.

func (PutDefaultEncryptionConfigurationOutput) String added in v1.35.35 

func (s PutDefaultEncryptionConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutLoggingOptionsInput 

type PutLoggingOptionsInput struct {

	// The logging options to set.
	//
	// LoggingOptions is a required field
	LoggingOptions *LoggingOptions `locationName:"loggingOptions" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (PutLoggingOptionsInput) GoString 

func (s PutLoggingOptionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutLoggingOptionsInput) SetLoggingOptions 

func (s *PutLoggingOptionsInput) SetLoggingOptions(v *LoggingOptions) *PutLoggingOptionsInput

SetLoggingOptions sets the LoggingOptions field's value.

func (PutLoggingOptionsInput) String 

func (s PutLoggingOptionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutLoggingOptionsInput) Validate 

func (s *PutLoggingOptionsInput) Validate() error

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

type PutLoggingOptionsOutput 

type PutLoggingOptionsOutput struct {
	// contains filtered or unexported fields
}

func (PutLoggingOptionsOutput) GoString 

func (s PutLoggingOptionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutLoggingOptionsOutput) String 

func (s PutLoggingOptionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutStorageConfigurationInput added in v1.39.2 

type PutStorageConfigurationInput struct {

	// Contains the storage configuration for time series (data streams) that aren't
	// associated with asset properties. The disassociatedDataStorage can be one
	// of the following values:
	//
	//    * ENABLED – IoT SiteWise accepts time series that aren't associated
	//    with asset properties. After the disassociatedDataStorage is enabled,
	//    you can't disable it.
	//
	//    * DISABLED – IoT SiteWise doesn't accept time series (data streams)
	//    that aren't associated with asset properties.
	//
	// For more information, see Data streams (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html)
	// in the IoT SiteWise User Guide.
	DisassociatedDataStorage *string `locationName:"disassociatedDataStorage" type:"string" enum:"DisassociatedDataStorageState"`

	// Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for
	// the storage type, you must specify a MultiLayerStorage object.
	MultiLayerStorage *MultiLayerStorage `locationName:"multiLayerStorage" type:"structure"`

	// The number of days your data is kept in the hot tier. By default, your data
	// is kept indefinitely in the hot tier.
	RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`

	// The storage tier that you specified for your data. The storageType parameter
	// can be one of the following values:
	//
	//    * SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot
	//    tier. The hot tier is a service-managed database.
	//
	//    * MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold
	//    tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
	//
	// StorageType is a required field
	StorageType *string `locationName:"storageType" type:"string" required:"true" enum:"StorageType"`

	// A service managed storage tier optimized for analytical queries. It stores
	// periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob
	// API.
	WarmTier *string `locationName:"warmTier" type:"string" enum:"WarmTierState"`

	// Set this period to specify how long your data is stored in the warm tier
	// before it is deleted. You can set this only if cold tier is enabled.
	WarmTierRetentionPeriod *WarmTierRetentionPeriod `locationName:"warmTierRetentionPeriod" type:"structure"`
	// contains filtered or unexported fields
}

func (PutStorageConfigurationInput) GoString added in v1.39.2 

func (s PutStorageConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutStorageConfigurationInput) SetDisassociatedDataStorage added in v1.42.12 

func (s *PutStorageConfigurationInput) SetDisassociatedDataStorage(v string) *PutStorageConfigurationInput

SetDisassociatedDataStorage sets the DisassociatedDataStorage field's value.

func (*PutStorageConfigurationInput) SetMultiLayerStorage added in v1.39.2 

func (s *PutStorageConfigurationInput) SetMultiLayerStorage(v *MultiLayerStorage) *PutStorageConfigurationInput

SetMultiLayerStorage sets the MultiLayerStorage field's value.

func (*PutStorageConfigurationInput) SetRetentionPeriod added in v1.42.15 

func (s *PutStorageConfigurationInput) SetRetentionPeriod(v *RetentionPeriod) *PutStorageConfigurationInput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*PutStorageConfigurationInput) SetStorageType added in v1.39.2 

func (s *PutStorageConfigurationInput) SetStorageType(v string) *PutStorageConfigurationInput

SetStorageType sets the StorageType field's value.

func (*PutStorageConfigurationInput) SetWarmTier added in v1.48.2 

func (s *PutStorageConfigurationInput) SetWarmTier(v string) *PutStorageConfigurationInput

SetWarmTier sets the WarmTier field's value.

func (*PutStorageConfigurationInput) SetWarmTierRetentionPeriod added in v1.48.2 

func (s *PutStorageConfigurationInput) SetWarmTierRetentionPeriod(v *WarmTierRetentionPeriod) *PutStorageConfigurationInput

SetWarmTierRetentionPeriod sets the WarmTierRetentionPeriod field's value.

func (PutStorageConfigurationInput) String added in v1.39.2 

func (s PutStorageConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutStorageConfigurationInput) Validate added in v1.39.2 

func (s *PutStorageConfigurationInput) Validate() error

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

type PutStorageConfigurationOutput added in v1.39.2 

type PutStorageConfigurationOutput struct {

	// Contains current status information for the configuration.
	//
	// ConfigurationStatus is a required field
	ConfigurationStatus *ConfigurationStatus `locationName:"configurationStatus" type:"structure" required:"true"`

	// Contains the storage configuration for time series (data streams) that aren't
	// associated with asset properties. The disassociatedDataStorage can be one
	// of the following values:
	//
	//    * ENABLED – IoT SiteWise accepts time series that aren't associated
	//    with asset properties. After the disassociatedDataStorage is enabled,
	//    you can't disable it.
	//
	//    * DISABLED – IoT SiteWise doesn't accept time series (data streams)
	//    that aren't associated with asset properties.
	//
	// For more information, see Data streams (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html)
	// in the IoT SiteWise User Guide.
	DisassociatedDataStorage *string `locationName:"disassociatedDataStorage" type:"string" enum:"DisassociatedDataStorageState"`

	// Contains information about the storage destination.
	MultiLayerStorage *MultiLayerStorage `locationName:"multiLayerStorage" type:"structure"`

	// The number of days your data is kept in the hot tier. By default, your data
	// is kept indefinitely in the hot tier.
	RetentionPeriod *RetentionPeriod `locationName:"retentionPeriod" type:"structure"`

	// The storage tier that you specified for your data. The storageType parameter
	// can be one of the following values:
	//
	//    * SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot
	//    tier. The hot tier is a service-managed database.
	//
	//    * MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold
	//    tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.
	//
	// StorageType is a required field
	StorageType *string `locationName:"storageType" type:"string" required:"true" enum:"StorageType"`

	// A service managed storage tier optimized for analytical queries. It stores
	// periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob
	// API.
	WarmTier *string `locationName:"warmTier" type:"string" enum:"WarmTierState"`

	// Set this period to specify how long your data is stored in the warm tier
	// before it is deleted. You can set this only if cold tier is enabled.
	WarmTierRetentionPeriod *WarmTierRetentionPeriod `locationName:"warmTierRetentionPeriod" type:"structure"`
	// contains filtered or unexported fields
}

func (PutStorageConfigurationOutput) GoString added in v1.39.2 

func (s PutStorageConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutStorageConfigurationOutput) SetConfigurationStatus added in v1.39.2 

func (s *PutStorageConfigurationOutput) SetConfigurationStatus(v *ConfigurationStatus) *PutStorageConfigurationOutput

SetConfigurationStatus sets the ConfigurationStatus field's value.

func (*PutStorageConfigurationOutput) SetDisassociatedDataStorage added in v1.42.12 

func (s *PutStorageConfigurationOutput) SetDisassociatedDataStorage(v string) *PutStorageConfigurationOutput

SetDisassociatedDataStorage sets the DisassociatedDataStorage field's value.

func (*PutStorageConfigurationOutput) SetMultiLayerStorage added in v1.39.2 

func (s *PutStorageConfigurationOutput) SetMultiLayerStorage(v *MultiLayerStorage) *PutStorageConfigurationOutput

SetMultiLayerStorage sets the MultiLayerStorage field's value.

func (*PutStorageConfigurationOutput) SetRetentionPeriod added in v1.42.15 

func (s *PutStorageConfigurationOutput) SetRetentionPeriod(v *RetentionPeriod) *PutStorageConfigurationOutput

SetRetentionPeriod sets the RetentionPeriod field's value.

func (*PutStorageConfigurationOutput) SetStorageType added in v1.39.2 

func (s *PutStorageConfigurationOutput) SetStorageType(v string) *PutStorageConfigurationOutput

SetStorageType sets the StorageType field's value.

func (*PutStorageConfigurationOutput) SetWarmTier added in v1.48.2 

func (s *PutStorageConfigurationOutput) SetWarmTier(v string) *PutStorageConfigurationOutput

SetWarmTier sets the WarmTier field's value.

func (*PutStorageConfigurationOutput) SetWarmTierRetentionPeriod added in v1.48.2 

func (s *PutStorageConfigurationOutput) SetWarmTierRetentionPeriod(v *WarmTierRetentionPeriod) *PutStorageConfigurationOutput

SetWarmTierRetentionPeriod sets the WarmTierRetentionPeriod field's value.

func (PutStorageConfigurationOutput) String added in v1.39.2 

func (s PutStorageConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QueryTimeoutException added in v1.48.2 

type QueryTimeoutException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The query timed out.

func (*QueryTimeoutException) Code added in v1.48.2 

func (s *QueryTimeoutException) Code() string

Code returns the exception type name.

func (*QueryTimeoutException) Error added in v1.48.2 

func (s *QueryTimeoutException) Error() string

func (QueryTimeoutException) GoString added in v1.48.2 

func (s QueryTimeoutException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QueryTimeoutException) Message added in v1.48.2 

func (s *QueryTimeoutException) Message() string

Message returns the exception's message.

func (*QueryTimeoutException) OrigErr added in v1.48.2 

func (s *QueryTimeoutException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*QueryTimeoutException) RequestID added in v1.48.2 

func (s *QueryTimeoutException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*QueryTimeoutException) StatusCode added in v1.48.2 

func (s *QueryTimeoutException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (QueryTimeoutException) String added in v1.48.2 

func (s QueryTimeoutException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Resource 

type Resource struct {

	// A portal resource.
	Portal *PortalResource `locationName:"portal" type:"structure"`

	// A project resource.
	Project *ProjectResource `locationName:"project" type:"structure"`
	// contains filtered or unexported fields
}

Contains an IoT SiteWise Monitor resource ID for a portal or project.

func (Resource) GoString 

func (s Resource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Resource) SetPortal 

func (s *Resource) SetPortal(v *PortalResource) *Resource

SetPortal sets the Portal field's value.

func (*Resource) SetProject 

func (s *Resource) SetProject(v *ProjectResource) *Resource

SetProject sets the Project field's value.

func (Resource) String 

func (s Resource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Resource) Validate 

func (s *Resource) Validate() error

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

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The ARN of the resource that already exists.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" type:"string" required:"true"`

	// The ID of the resource that already exists.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The resource already exists.

func (*ResourceAlreadyExistsException) Code 

func (s *ResourceAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ResourceAlreadyExistsException) Error 

func (s *ResourceAlreadyExistsException) Error() string

func (ResourceAlreadyExistsException) GoString 

func (s ResourceAlreadyExistsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceAlreadyExistsException) Message 

func (s *ResourceAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ResourceAlreadyExistsException) OrigErr 

func (s *ResourceAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceAlreadyExistsException) RequestID 

func (s *ResourceAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceAlreadyExistsException) StatusCode 

func (s *ResourceAlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceAlreadyExistsException) String 

func (s ResourceAlreadyExistsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The requested resource can't be found.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RetentionPeriod added in v1.42.15 

type RetentionPeriod struct {

	// The number of days that your data is kept.
	//
	// If you specified a value for this parameter, the unlimited parameter must
	// be false.
	NumberOfDays *int64 `locationName:"numberOfDays" min:"30" type:"integer"`

	// If true, your data is kept indefinitely.
	//
	// If configured to true, you must not specify a value for the numberOfDays
	// parameter.
	Unlimited *bool `locationName:"unlimited" type:"boolean"`
	// contains filtered or unexported fields
}

The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

func (RetentionPeriod) GoString added in v1.42.15 

func (s RetentionPeriod) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetentionPeriod) SetNumberOfDays added in v1.42.15 

func (s *RetentionPeriod) SetNumberOfDays(v int64) *RetentionPeriod

SetNumberOfDays sets the NumberOfDays field's value.

func (*RetentionPeriod) SetUnlimited added in v1.42.15 

func (s *RetentionPeriod) SetUnlimited(v bool) *RetentionPeriod

SetUnlimited sets the Unlimited field's value.

func (RetentionPeriod) String added in v1.42.15 

func (s RetentionPeriod) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RetentionPeriod) Validate added in v1.42.15 

func (s *RetentionPeriod) Validate() error

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

type Row added in v1.48.2 

type Row struct {

	// List of data points in a single row of the result set.
	//
	// Data is a required field
	Data []*Datum `locationName:"data" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents a single row in the query results.

func (Row) GoString added in v1.48.2 

func (s Row) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Row) SetData added in v1.48.2 

func (s *Row) SetData(v []*Datum) *Row

SetData sets the Data field's value.

func (Row) String added in v1.48.2 

func (s Row) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceUnavailableException 

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The requested service is unavailable.

func (*ServiceUnavailableException) Code 

func (s *ServiceUnavailableException) Code() string

Code returns the exception type name.

func (*ServiceUnavailableException) Error 

func (s *ServiceUnavailableException) Error() string

func (ServiceUnavailableException) GoString 

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceUnavailableException) Message 

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr 

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID 

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode 

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String 

func (s ServiceUnavailableException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput 

type TagResourceInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the resource to tag.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// A list of key-value pairs that contain metadata for the resource. For more
	// information, see Tagging your IoT SiteWise resources (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)
	// in the IoT SiteWise User Guide.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TargetResource added in v1.48.2 

type TargetResource struct {

	// The ID of the asset, in UUID format.
	//
	// AssetId is a required field
	AssetId *string `locationName:"assetId" min:"13" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The resource the action will be taken on.

func (TargetResource) GoString added in v1.48.2 

func (s TargetResource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetResource) SetAssetId added in v1.48.2 

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

SetAssetId sets the AssetId field's value.

func (TargetResource) String added in v1.48.2 

func (s TargetResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TargetResource) Validate added in v1.48.2 

func (s *TargetResource) Validate() error

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

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Your request exceeded a rate limit. For example, you might have exceeded the number of 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 IoT SiteWise User Guide.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TimeInNanos 

type TimeInNanos struct {

	// The nanosecond offset from timeInSeconds.
	OffsetInNanos *int64 `locationName:"offsetInNanos" type:"integer"`

	// The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond
	// data is provided by offsetInNanos.
	//
	// TimeInSeconds is a required field
	TimeInSeconds *int64 `locationName:"timeInSeconds" min:"1" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Contains a timestamp with optional nanosecond granularity.

func (TimeInNanos) GoString 

func (s TimeInNanos) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeInNanos) SetOffsetInNanos 

func (s *TimeInNanos) SetOffsetInNanos(v int64) *TimeInNanos

SetOffsetInNanos sets the OffsetInNanos field's value.

func (*TimeInNanos) SetTimeInSeconds 

func (s *TimeInNanos) SetTimeInSeconds(v int64) *TimeInNanos

SetTimeInSeconds sets the TimeInSeconds field's value.

func (TimeInNanos) String 

func (s TimeInNanos) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeInNanos) Validate 

func (s *TimeInNanos) Validate() error

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

type TimeSeriesSummary added in v1.42.12 

type TimeSeriesSummary struct {

	// The alias that identifies the time series.
	Alias *string `locationName:"alias" min:"1" type:"string"`

	// The ID of the asset in which the asset property was created.
	AssetId *string `locationName:"assetId" min:"36" type:"string"`

	// The data type of the time series.
	//
	// If you specify STRUCT, you must also specify dataTypeSpec to identify the
	// type of the structure for this time series.
	//
	// DataType is a required field
	DataType *string `locationName:"dataType" type:"string" required:"true" enum:"PropertyDataType"`

	// The data type of the structure for this time series. This parameter is required
	// for time series that have the STRUCT data type.
	//
	// The options for this parameter depend on the type of the composite model
	// in which you created the asset property that is associated with your time
	// series. Use AWS/ALARM_STATE for alarm state in alarm composite models.
	DataTypeSpec *string `locationName:"dataTypeSpec" min:"1" type:"string"`

	// The ID of the asset property, in UUID format.
	PropertyId *string `locationName:"propertyId" min:"36" type:"string"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the time series, which has the following format.
	//
	// arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
	//
	// TimeSeriesArn is a required field
	TimeSeriesArn *string `locationName:"timeSeriesArn" min:"1" type:"string" required:"true"`

	// The date that the time series was created, in Unix epoch time.
	//
	// TimeSeriesCreationDate is a required field
	TimeSeriesCreationDate *time.Time `locationName:"timeSeriesCreationDate" type:"timestamp" required:"true"`

	// The ID of the time series.
	//
	// TimeSeriesId is a required field
	TimeSeriesId *string `locationName:"timeSeriesId" min:"36" type:"string" required:"true"`

	// The date that the time series was last updated, in Unix epoch time.
	//
	// TimeSeriesLastUpdateDate is a required field
	TimeSeriesLastUpdateDate *time.Time `locationName:"timeSeriesLastUpdateDate" type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

Contains a summary of a time series (data stream).

func (TimeSeriesSummary) GoString added in v1.42.12 

func (s TimeSeriesSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeSeriesSummary) SetAlias added in v1.42.12 

func (s *TimeSeriesSummary) SetAlias(v string) *TimeSeriesSummary

SetAlias sets the Alias field's value.

func (*TimeSeriesSummary) SetAssetId added in v1.42.12 

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

SetAssetId sets the AssetId field's value.

func (*TimeSeriesSummary) SetDataType added in v1.42.12 

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

SetDataType sets the DataType field's value.

func (*TimeSeriesSummary) SetDataTypeSpec added in v1.42.12 

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

SetDataTypeSpec sets the DataTypeSpec field's value.

func (*TimeSeriesSummary) SetPropertyId added in v1.42.12 

func (s *TimeSeriesSummary) SetPropertyId(v string) *TimeSeriesSummary

SetPropertyId sets the PropertyId field's value.

func (*TimeSeriesSummary) SetTimeSeriesArn added in v1.44.226 

func (s *TimeSeriesSummary) SetTimeSeriesArn(v string) *TimeSeriesSummary

SetTimeSeriesArn sets the TimeSeriesArn field's value.

func (*TimeSeriesSummary) SetTimeSeriesCreationDate added in v1.42.12 

func (s *TimeSeriesSummary) SetTimeSeriesCreationDate(v time.Time) *TimeSeriesSummary

SetTimeSeriesCreationDate sets the TimeSeriesCreationDate field's value.

func (*TimeSeriesSummary) SetTimeSeriesId added in v1.42.12 

func (s *TimeSeriesSummary) SetTimeSeriesId(v string) *TimeSeriesSummary

SetTimeSeriesId sets the TimeSeriesId field's value.

func (*TimeSeriesSummary) SetTimeSeriesLastUpdateDate added in v1.42.12 

func (s *TimeSeriesSummary) SetTimeSeriesLastUpdateDate(v time.Time) *TimeSeriesSummary

SetTimeSeriesLastUpdateDate sets the TimeSeriesLastUpdateDate field's value.

func (TimeSeriesSummary) String added in v1.42.12 

func (s TimeSeriesSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TooManyTagsException 

type TooManyTagsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The name of the resource with too many tags.
	ResourceName *string `locationName:"resourceName" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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 Amazon Web Services General Reference.

func (*TooManyTagsException) Code 

func (s *TooManyTagsException) Code() string

Code returns the exception type name.

func (*TooManyTagsException) Error 

func (s *TooManyTagsException) Error() string

func (TooManyTagsException) GoString 

func (s TooManyTagsException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TooManyTagsException) Message 

func (s *TooManyTagsException) Message() string

Message returns the exception's message.

func (*TooManyTagsException) OrigErr 

func (s *TooManyTagsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TooManyTagsException) RequestID 

func (s *TooManyTagsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TooManyTagsException) StatusCode 

func (s *TooManyTagsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TooManyTagsException) String 

func (s TooManyTagsException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Transform 

type Transform struct {

	// The mathematical expression that defines the transformation function. You
	// can specify up to 10 variables per expression. You can specify up to 10 functions
	// per expression.
	//
	// For more information, see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
	// in the IoT SiteWise User Guide.
	//
	// Expression is a required field
	Expression *string `locationName:"expression" min:"1" type:"string" required:"true"`

	// The processing configuration for the given transform property. You can configure
	// transforms to be kept at the edge or forwarded to the Amazon Web Services
	// Cloud. You can also configure transforms to be computed at the edge or in
	// the cloud.
	ProcessingConfig *TransformProcessingConfig `locationName:"processingConfig" type:"structure"`

	// The list of variables used in the expression.
	//
	// Variables is a required field
	Variables []*ExpressionVariable `locationName:"variables" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains an asset transform property. A transform is a one-to-one mapping of a property's data points from one form to another. For example, you can use a transform to convert a Celsius data stream to Fahrenheit by applying the transformation expression to each data point of the Celsius stream. A transform can only have a data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE.

For more information, see Transforms (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms) in the IoT SiteWise User Guide.

func (Transform) GoString 

func (s Transform) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Transform) SetExpression 

func (s *Transform) SetExpression(v string) *Transform

SetExpression sets the Expression field's value.

func (*Transform) SetProcessingConfig added in v1.40.11 

func (s *Transform) SetProcessingConfig(v *TransformProcessingConfig) *Transform

SetProcessingConfig sets the ProcessingConfig field's value.

func (*Transform) SetVariables 

func (s *Transform) SetVariables(v []*ExpressionVariable) *Transform

SetVariables sets the Variables field's value.

func (Transform) String 

func (s Transform) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Transform) Validate 

func (s *Transform) Validate() error

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

type TransformProcessingConfig added in v1.40.11 

type TransformProcessingConfig struct {

	// The compute location for the given transform property.
	//
	// ComputeLocation is a required field
	ComputeLocation *string `locationName:"computeLocation" type:"string" required:"true" enum:"ComputeLocation"`

	// The forwarding configuration for a given property.
	ForwardingConfig *ForwardingConfig `locationName:"forwardingConfig" type:"structure"`
	// contains filtered or unexported fields
}

The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud.

func (TransformProcessingConfig) GoString added in v1.40.11 

func (s TransformProcessingConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TransformProcessingConfig) SetComputeLocation added in v1.40.11 

func (s *TransformProcessingConfig) SetComputeLocation(v string) *TransformProcessingConfig

SetComputeLocation sets the ComputeLocation field's value.

func (*TransformProcessingConfig) SetForwardingConfig added in v1.40.11 

func (s *TransformProcessingConfig) SetForwardingConfig(v *ForwardingConfig) *TransformProcessingConfig

SetForwardingConfig sets the ForwardingConfig field's value.

func (TransformProcessingConfig) String added in v1.40.11 

func (s TransformProcessingConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TransformProcessingConfig) Validate added in v1.40.11 

func (s *TransformProcessingConfig) Validate() error

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

type TumblingWindow 

type TumblingWindow struct {

	// The time interval for the tumbling window. The interval time must be between
	// 1 minute and 1 week.
	//
	// IoT SiteWise computes the 1w interval the end of Sunday at midnight each
	// week (UTC), the 1d interval at the end of each day at midnight (UTC), the
	// 1h interval at the end of each hour, and so on.
	//
	// When IoT SiteWise aggregates data points for metric computations, the start
	// of each interval is exclusive and the end of each interval is inclusive.
	// IoT SiteWise places the computed data point at the end of the interval.
	//
	// Interval is a required field
	Interval *string `locationName:"interval" min:"2" type:"string" required:"true"`

	// The offset for the tumbling window. The offset parameter accepts the following:
	//
	//    * The offset time. For example, if you specify 18h for offset and 1d for
	//    interval, IoT SiteWise aggregates data in one of the following ways: If
	//    you create the metric before or at 6 PM (UTC), you get the first aggregation
	//    result at 6 PM (UTC) on the day when you create the metric. If you create
	//    the metric after 6 PM (UTC), you get the first aggregation result at 6
	//    PM (UTC) the next day.
	//
	//    * The ISO 8601 format. For example, if you specify PT18H for offset and
	//    1d for interval, IoT SiteWise aggregates data in one of the following
	//    ways: If you create the metric before or at 6 PM (UTC), you get the first
	//    aggregation result at 6 PM (UTC) on the day when you create the metric.
	//    If you create the metric after 6 PM (UTC), you get the first aggregation
	//    result at 6 PM (UTC) the next day.
	//
	//    * The 24-hour clock. For example, if you specify 00:03:00 for offset,
	//    5m for interval, and you create the metric at 2 PM (UTC), you get the
	//    first aggregation result at 2:03 PM (UTC). You get the second aggregation
	//    result at 2:08 PM (UTC).
	//
	//    * The offset time zone. For example, if you specify 2021-07-23T18:00-08
	//    for offset and 1d for interval, IoT SiteWise aggregates data in one of
	//    the following ways: If you create the metric before or at 6 PM (PST),
	//    you get the first aggregation result at 6 PM (PST) on the day when you
	//    create the metric. If you create the metric after 6 PM (PST), you get
	//    the first aggregation result at 6 PM (PST) the next day.
	Offset *string `locationName:"offset" min:"2" type:"string"`
	// contains filtered or unexported fields
}

Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and contiguous time window. You can use this window in metrics to aggregate data from properties and other assets.

You can use m, h, d, and w when you specify an interval or offset. Note that m represents minutes, h represents hours, d represents days, and w represents weeks. You can also use s to represent seconds in offset.

The interval and offset parameters support the ISO 8601 format (https://en.wikipedia.org/wiki/ISO_8601). For example, PT5S represents 5 seconds, PT5M represents 5 minutes, and PT5H represents 5 hours.

func (TumblingWindow) GoString 

func (s TumblingWindow) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TumblingWindow) SetInterval 

func (s *TumblingWindow) SetInterval(v string) *TumblingWindow

SetInterval sets the Interval field's value.

func (*TumblingWindow) SetOffset added in v1.40.14 

func (s *TumblingWindow) SetOffset(v string) *TumblingWindow

SetOffset sets the Offset field's value.

func (TumblingWindow) String 

func (s TumblingWindow) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TumblingWindow) Validate 

func (s *TumblingWindow) Validate() error

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

type UnauthorizedException added in v1.36.7 

type UnauthorizedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You are not authorized.

func (*UnauthorizedException) Code added in v1.36.7 

func (s *UnauthorizedException) Code() string

Code returns the exception type name.

func (*UnauthorizedException) Error added in v1.36.7 

func (s *UnauthorizedException) Error() string

func (UnauthorizedException) GoString added in v1.36.7 

func (s UnauthorizedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnauthorizedException) Message added in v1.36.7 

func (s *UnauthorizedException) Message() string

Message returns the exception's message.

func (*UnauthorizedException) OrigErr added in v1.36.7 

func (s *UnauthorizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnauthorizedException) RequestID added in v1.36.7 

func (s *UnauthorizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnauthorizedException) StatusCode added in v1.36.7 

func (s *UnauthorizedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnauthorizedException) String added in v1.36.7 

func (s UnauthorizedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of the resource to untag.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"querystring" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// A list of keys for tags to remove from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAccessPolicyInput 

type UpdateAccessPolicyInput struct {

	// The ID of the access policy.
	//
	// AccessPolicyId is a required field
	AccessPolicyId *string `location:"uri" locationName:"accessPolicyId" min:"36" type:"string" required:"true"`

	// The identity for this access policy. Choose an IAM Identity Center user,
	// an IAM Identity Center group, or an IAM user.
	//
	// AccessPolicyIdentity is a required field
	AccessPolicyIdentity *Identity `locationName:"accessPolicyIdentity" type:"structure" required:"true"`

	// The permission level for this access policy. Note that a project ADMINISTRATOR
	// is also known as a project owner.
	//
	// AccessPolicyPermission is a required field
	AccessPolicyPermission *string `locationName:"accessPolicyPermission" type:"string" required:"true" enum:"Permission"`

	// The IoT SiteWise Monitor resource for this access policy. Choose either a
	// portal or a project.
	//
	// AccessPolicyResource is a required field
	AccessPolicyResource *Resource `locationName:"accessPolicyResource" type:"structure" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (UpdateAccessPolicyInput) GoString 

func (s UpdateAccessPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccessPolicyInput) SetAccessPolicyId 

func (s *UpdateAccessPolicyInput) SetAccessPolicyId(v string) *UpdateAccessPolicyInput

SetAccessPolicyId sets the AccessPolicyId field's value.

func (*UpdateAccessPolicyInput) SetAccessPolicyIdentity 

func (s *UpdateAccessPolicyInput) SetAccessPolicyIdentity(v *Identity) *UpdateAccessPolicyInput

SetAccessPolicyIdentity sets the AccessPolicyIdentity field's value.

func (*UpdateAccessPolicyInput) SetAccessPolicyPermission 

func (s *UpdateAccessPolicyInput) SetAccessPolicyPermission(v string) *UpdateAccessPolicyInput

SetAccessPolicyPermission sets the AccessPolicyPermission field's value.

func (*UpdateAccessPolicyInput) SetAccessPolicyResource 

func (s *UpdateAccessPolicyInput) SetAccessPolicyResource(v *Resource) *UpdateAccessPolicyInput

SetAccessPolicyResource sets the AccessPolicyResource field's value.

func (*UpdateAccessPolicyInput) SetClientToken 

func (s *UpdateAccessPolicyInput) SetClientToken(v string) *UpdateAccessPolicyInput

SetClientToken sets the ClientToken field's value.

func (UpdateAccessPolicyInput) String 

func (s UpdateAccessPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAccessPolicyInput) Validate 

func (s *UpdateAccessPolicyInput) Validate() error

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

type UpdateAccessPolicyOutput 

type UpdateAccessPolicyOutput struct {
	// contains filtered or unexported fields
}

func (UpdateAccessPolicyOutput) GoString 

func (s UpdateAccessPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateAccessPolicyOutput) String 

func (s UpdateAccessPolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAssetInput 

type UpdateAssetInput struct {

	// A description for the asset.
	AssetDescription *string `locationName:"assetDescription" min:"1" type:"string"`

	// An external ID to assign to the asset. The asset must not already have an
	// external ID. The external ID must be unique within your Amazon Web Services
	// account. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	AssetExternalId *string `locationName:"assetExternalId" min:"2" type:"string"`

	// The ID of the asset to update. This can be either the actual ID in UUID format,
	// or else externalId: followed by the external ID, if it has one. For more
	// information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"uri" locationName:"assetId" min:"13" type:"string" required:"true"`

	// A friendly name for the asset.
	//
	// AssetName is a required field
	AssetName *string `locationName:"assetName" min:"1" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (UpdateAssetInput) GoString 

func (s UpdateAssetInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAssetInput) SetAssetDescription added in v1.44.25 

func (s *UpdateAssetInput) SetAssetDescription(v string) *UpdateAssetInput

SetAssetDescription sets the AssetDescription field's value.

func (*UpdateAssetInput) SetAssetExternalId added in v1.48.2 

func (s *UpdateAssetInput) SetAssetExternalId(v string) *UpdateAssetInput

SetAssetExternalId sets the AssetExternalId field's value.

func (*UpdateAssetInput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*UpdateAssetInput) SetAssetName 

func (s *UpdateAssetInput) SetAssetName(v string) *UpdateAssetInput

SetAssetName sets the AssetName field's value.

func (*UpdateAssetInput) SetClientToken 

func (s *UpdateAssetInput) SetClientToken(v string) *UpdateAssetInput

SetClientToken sets the ClientToken field's value.

func (UpdateAssetInput) String 

func (s UpdateAssetInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAssetInput) Validate 

func (s *UpdateAssetInput) Validate() error

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

type UpdateAssetModelCompositeModelInput added in v1.48.2 

type UpdateAssetModelCompositeModelInput struct {

	// A description for the composite model.
	AssetModelCompositeModelDescription *string `locationName:"assetModelCompositeModelDescription" min:"1" type:"string"`

	// An external ID to assign to the asset model. You can only set the external
	// ID of the asset model if it wasn't set when it was created, or you're setting
	// it to the exact same thing as when it was created.
	AssetModelCompositeModelExternalId *string `locationName:"assetModelCompositeModelExternalId" min:"2" type:"string"`

	// The ID of a composite model on this asset model.
	//
	// AssetModelCompositeModelId is a required field
	AssetModelCompositeModelId *string `location:"uri" locationName:"assetModelCompositeModelId" min:"13" type:"string" required:"true"`

	// A unique, friendly name for the composite model.
	//
	// AssetModelCompositeModelName is a required field
	AssetModelCompositeModelName *string `locationName:"assetModelCompositeModelName" min:"1" type:"string" required:"true"`

	// The property definitions of the composite model. For more information, see
	// <LINK>.
	//
	// You can specify up to 200 properties per composite model. For more information,
	// see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
	// in the IoT SiteWise User Guide.
	AssetModelCompositeModelProperties []*AssetModelProperty `locationName:"assetModelCompositeModelProperties" type:"list"`

	// The ID of the asset model, in UUID format.
	//
	// AssetModelId is a required field
	AssetModelId *string `location:"uri" locationName:"assetModelId" min:"13" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (UpdateAssetModelCompositeModelInput) GoString added in v1.48.2 

func (s UpdateAssetModelCompositeModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAssetModelCompositeModelInput) SetAssetModelCompositeModelDescription added in v1.48.2 

func (s *UpdateAssetModelCompositeModelInput) SetAssetModelCompositeModelDescription(v string) *UpdateAssetModelCompositeModelInput

SetAssetModelCompositeModelDescription sets the AssetModelCompositeModelDescription field's value.

func (*UpdateAssetModelCompositeModelInput) SetAssetModelCompositeModelExternalId added in v1.48.2 

func (s *UpdateAssetModelCompositeModelInput) SetAssetModelCompositeModelExternalId(v string) *UpdateAssetModelCompositeModelInput

SetAssetModelCompositeModelExternalId sets the AssetModelCompositeModelExternalId field's value.

func (*UpdateAssetModelCompositeModelInput) SetAssetModelCompositeModelId added in v1.48.2 

func (s *UpdateAssetModelCompositeModelInput) SetAssetModelCompositeModelId(v string) *UpdateAssetModelCompositeModelInput

SetAssetModelCompositeModelId sets the AssetModelCompositeModelId field's value.

func (*UpdateAssetModelCompositeModelInput) SetAssetModelCompositeModelName added in v1.48.2 

func (s *UpdateAssetModelCompositeModelInput) SetAssetModelCompositeModelName(v string) *UpdateAssetModelCompositeModelInput

SetAssetModelCompositeModelName sets the AssetModelCompositeModelName field's value.

func (*UpdateAssetModelCompositeModelInput) SetAssetModelCompositeModelProperties added in v1.48.2 

func (s *UpdateAssetModelCompositeModelInput) SetAssetModelCompositeModelProperties(v []*AssetModelProperty) *UpdateAssetModelCompositeModelInput

SetAssetModelCompositeModelProperties sets the AssetModelCompositeModelProperties field's value.

func (*UpdateAssetModelCompositeModelInput) SetAssetModelId added in v1.48.2 

func (s *UpdateAssetModelCompositeModelInput) SetAssetModelId(v string) *UpdateAssetModelCompositeModelInput

SetAssetModelId sets the AssetModelId field's value.

func (*UpdateAssetModelCompositeModelInput) SetClientToken added in v1.48.2 

func (s *UpdateAssetModelCompositeModelInput) SetClientToken(v string) *UpdateAssetModelCompositeModelInput

SetClientToken sets the ClientToken field's value.

func (UpdateAssetModelCompositeModelInput) String added in v1.48.2 

func (s UpdateAssetModelCompositeModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAssetModelCompositeModelInput) Validate added in v1.48.2 

func (s *UpdateAssetModelCompositeModelInput) Validate() error

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

type UpdateAssetModelCompositeModelOutput added in v1.48.2 

type UpdateAssetModelCompositeModelOutput struct {

	// The path to the composite model listing the parent composite models.
	//
	// AssetModelCompositeModelPath is a required field
	AssetModelCompositeModelPath []*AssetModelCompositeModelPathSegment `locationName:"assetModelCompositeModelPath" type:"list" required:"true"`

	// Contains current status information for an asset model. For more information,
	// see Asset and model states (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html)
	// in the IoT SiteWise User Guide.
	//
	// AssetModelStatus is a required field
	AssetModelStatus *AssetModelStatus `locationName:"assetModelStatus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAssetModelCompositeModelOutput) GoString added in v1.48.2 

func (s UpdateAssetModelCompositeModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAssetModelCompositeModelOutput) SetAssetModelCompositeModelPath added in v1.48.2 

func (s *UpdateAssetModelCompositeModelOutput) SetAssetModelCompositeModelPath(v []*AssetModelCompositeModelPathSegment) *UpdateAssetModelCompositeModelOutput

SetAssetModelCompositeModelPath sets the AssetModelCompositeModelPath field's value.

func (*UpdateAssetModelCompositeModelOutput) SetAssetModelStatus added in v1.48.2 

func (s *UpdateAssetModelCompositeModelOutput) SetAssetModelStatus(v *AssetModelStatus) *UpdateAssetModelCompositeModelOutput

SetAssetModelStatus sets the AssetModelStatus field's value.

func (UpdateAssetModelCompositeModelOutput) String added in v1.48.2 

func (s UpdateAssetModelCompositeModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAssetModelInput 

type UpdateAssetModelInput struct {

	// The composite models that are part of this asset model. It groups properties
	// (such as attributes, measurements, transforms, and metrics) and child composite
	// models that model parts of your industrial equipment. Each composite model
	// has a type that defines the properties that the composite model supports.
	// Use composite models to define alarms on this asset model.
	//
	// When creating custom composite models, you need to use CreateAssetModelCompositeModel
	// (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html).
	// For more information, see <LINK>.
	AssetModelCompositeModels []*AssetModelCompositeModel `locationName:"assetModelCompositeModels" type:"list"`

	// A description for the asset model.
	AssetModelDescription *string `locationName:"assetModelDescription" min:"1" type:"string"`

	// An external ID to assign to the asset model. The asset model must not already
	// have an external ID. The external ID must be unique within your Amazon Web
	// Services account. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	AssetModelExternalId *string `locationName:"assetModelExternalId" min:"2" type:"string"`

	// The updated hierarchy definitions of the asset model. Each hierarchy specifies
	// an asset model whose assets can be children of any other assets created from
	// this asset model. For more information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html)
	// in the IoT SiteWise User Guide.
	//
	// You can specify up to 10 hierarchies per asset model. For more information,
	// see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
	// in the IoT SiteWise User Guide.
	AssetModelHierarchies []*AssetModelHierarchy `locationName:"assetModelHierarchies" type:"list"`

	// The ID of the asset model to update. This can be either the actual ID in
	// UUID format, or else externalId: followed by the external ID, if it has one.
	// For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetModelId is a required field
	AssetModelId *string `location:"uri" locationName:"assetModelId" min:"13" type:"string" required:"true"`

	// A unique, friendly name for the asset model.
	//
	// AssetModelName is a required field
	AssetModelName *string `locationName:"assetModelName" min:"1" type:"string" required:"true"`

	// The updated property definitions of the asset model. For more information,
	// see Asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html)
	// in the IoT SiteWise User Guide.
	//
	// You can specify up to 200 properties per asset model. For more information,
	// see Quotas (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
	// in the IoT SiteWise User Guide.
	AssetModelProperties []*AssetModelProperty `locationName:"assetModelProperties" type:"list"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (UpdateAssetModelInput) GoString 

func (s UpdateAssetModelInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAssetModelInput) SetAssetModelCompositeModels added in v1.36.7 

func (s *UpdateAssetModelInput) SetAssetModelCompositeModels(v []*AssetModelCompositeModel) *UpdateAssetModelInput

SetAssetModelCompositeModels sets the AssetModelCompositeModels field's value.

func (*UpdateAssetModelInput) SetAssetModelDescription 

func (s *UpdateAssetModelInput) SetAssetModelDescription(v string) *UpdateAssetModelInput

SetAssetModelDescription sets the AssetModelDescription field's value.

func (*UpdateAssetModelInput) SetAssetModelExternalId added in v1.48.2 

func (s *UpdateAssetModelInput) SetAssetModelExternalId(v string) *UpdateAssetModelInput

SetAssetModelExternalId sets the AssetModelExternalId field's value.

func (*UpdateAssetModelInput) SetAssetModelHierarchies 

func (s *UpdateAssetModelInput) SetAssetModelHierarchies(v []*AssetModelHierarchy) *UpdateAssetModelInput

SetAssetModelHierarchies sets the AssetModelHierarchies field's value.

func (*UpdateAssetModelInput) SetAssetModelId 

func (s *UpdateAssetModelInput) SetAssetModelId(v string) *UpdateAssetModelInput

SetAssetModelId sets the AssetModelId field's value.

func (*UpdateAssetModelInput) SetAssetModelName 

func (s *UpdateAssetModelInput) SetAssetModelName(v string) *UpdateAssetModelInput

SetAssetModelName sets the AssetModelName field's value.

func (*UpdateAssetModelInput) SetAssetModelProperties 

func (s *UpdateAssetModelInput) SetAssetModelProperties(v []*AssetModelProperty) *UpdateAssetModelInput

SetAssetModelProperties sets the AssetModelProperties field's value.

func (*UpdateAssetModelInput) SetClientToken 

func (s *UpdateAssetModelInput) SetClientToken(v string) *UpdateAssetModelInput

SetClientToken sets the ClientToken field's value.

func (UpdateAssetModelInput) String 

func (s UpdateAssetModelInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAssetModelInput) Validate 

func (s *UpdateAssetModelInput) Validate() error

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

type UpdateAssetModelOutput 

type UpdateAssetModelOutput struct {

	// The status of the asset model, which contains a state (UPDATING after successfully
	// calling this operation) and any error message.
	//
	// AssetModelStatus is a required field
	AssetModelStatus *AssetModelStatus `locationName:"assetModelStatus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAssetModelOutput) GoString 

func (s UpdateAssetModelOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAssetModelOutput) SetAssetModelStatus 

func (s *UpdateAssetModelOutput) SetAssetModelStatus(v *AssetModelStatus) *UpdateAssetModelOutput

SetAssetModelStatus sets the AssetModelStatus field's value.

func (UpdateAssetModelOutput) String 

func (s UpdateAssetModelOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAssetOutput 

type UpdateAssetOutput struct {

	// The status of the asset, which contains a state (UPDATING after successfully
	// calling this operation) and any error message.
	//
	// AssetStatus is a required field
	AssetStatus *AssetStatus `locationName:"assetStatus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateAssetOutput) GoString 

func (s UpdateAssetOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAssetOutput) SetAssetStatus 

func (s *UpdateAssetOutput) SetAssetStatus(v *AssetStatus) *UpdateAssetOutput

SetAssetStatus sets the AssetStatus field's value.

func (UpdateAssetOutput) String 

func (s UpdateAssetOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAssetPropertyInput 

type UpdateAssetPropertyInput struct {

	// The ID of the asset to be updated. This can be either the actual ID in UUID
	// format, or else externalId: followed by the external ID, if it has one. For
	// more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// AssetId is a required field
	AssetId *string `location:"uri" locationName:"assetId" min:"13" type:"string" required:"true"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The alias that identifies the property, such as an OPC-UA server data stream
	// path (for example, /company/windfarm/3/turbine/7/temperature). For more information,
	// see Mapping industrial data streams to asset properties (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
	// in the IoT SiteWise User Guide.
	//
	// If you omit this parameter, the alias is removed from the property.
	PropertyAlias *string `locationName:"propertyAlias" min:"1" type:"string"`

	// The ID of the asset property to be updated. This can be either the actual
	// ID in UUID format, or else externalId: followed by the external ID, if it
	// has one. For more information, see Referencing objects with external IDs
	// (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
	// in the IoT SiteWise User Guide.
	//
	// PropertyId is a required field
	PropertyId *string `location:"uri" locationName:"propertyId" min:"13" type:"string" required:"true"`

	// The MQTT notification state (enabled or disabled) for this asset property.
	// When the notification state is enabled, IoT SiteWise publishes property value
	// updates to a unique MQTT topic. For more information, see Interacting with
	// other services (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html)
	// in the IoT SiteWise User Guide.
	//
	// If you omit this parameter, the notification state is set to DISABLED.
	PropertyNotificationState *string `locationName:"propertyNotificationState" type:"string" enum:"PropertyNotificationState"`

	// The unit of measure (such as Newtons or RPM) of the asset property. If you
	// don't specify a value for this parameter, the service uses the value of the
	// assetModelProperty in the asset model.
	PropertyUnit *string `locationName:"propertyUnit" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateAssetPropertyInput) GoString 

func (s UpdateAssetPropertyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAssetPropertyInput) SetAssetId 

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

SetAssetId sets the AssetId field's value.

func (*UpdateAssetPropertyInput) SetClientToken 

func (s *UpdateAssetPropertyInput) SetClientToken(v string) *UpdateAssetPropertyInput

SetClientToken sets the ClientToken field's value.

func (*UpdateAssetPropertyInput) SetPropertyAlias 

func (s *UpdateAssetPropertyInput) SetPropertyAlias(v string) *UpdateAssetPropertyInput

SetPropertyAlias sets the PropertyAlias field's value.

func (*UpdateAssetPropertyInput) SetPropertyId 

func (s *UpdateAssetPropertyInput) SetPropertyId(v string) *UpdateAssetPropertyInput

SetPropertyId sets the PropertyId field's value.

func (*UpdateAssetPropertyInput) SetPropertyNotificationState 

func (s *UpdateAssetPropertyInput) SetPropertyNotificationState(v string) *UpdateAssetPropertyInput

SetPropertyNotificationState sets the PropertyNotificationState field's value.

func (*UpdateAssetPropertyInput) SetPropertyUnit added in v1.44.93 

func (s *UpdateAssetPropertyInput) SetPropertyUnit(v string) *UpdateAssetPropertyInput

SetPropertyUnit sets the PropertyUnit field's value.

func (UpdateAssetPropertyInput) String 

func (s UpdateAssetPropertyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAssetPropertyInput) Validate 

func (s *UpdateAssetPropertyInput) Validate() error

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

type UpdateAssetPropertyOutput 

type UpdateAssetPropertyOutput struct {
	// contains filtered or unexported fields
}

func (UpdateAssetPropertyOutput) GoString 

func (s UpdateAssetPropertyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateAssetPropertyOutput) String 

func (s UpdateAssetPropertyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateDashboardInput 

type UpdateDashboardInput struct {

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The new dashboard definition, as specified in a JSON literal. For detailed
	// information, see Creating dashboards (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html)
	// in the IoT SiteWise User Guide.
	//
	// DashboardDefinition is a required field
	DashboardDefinition *string `locationName:"dashboardDefinition" type:"string" required:"true"`

	// A new description for the dashboard.
	DashboardDescription *string `locationName:"dashboardDescription" min:"1" type:"string"`

	// The ID of the dashboard to update.
	//
	// DashboardId is a required field
	DashboardId *string `location:"uri" locationName:"dashboardId" min:"36" type:"string" required:"true"`

	// A new friendly name for the dashboard.
	//
	// DashboardName is a required field
	DashboardName *string `locationName:"dashboardName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateDashboardInput) GoString 

func (s UpdateDashboardInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDashboardInput) SetClientToken 

func (s *UpdateDashboardInput) SetClientToken(v string) *UpdateDashboardInput

SetClientToken sets the ClientToken field's value.

func (*UpdateDashboardInput) SetDashboardDefinition 

func (s *UpdateDashboardInput) SetDashboardDefinition(v string) *UpdateDashboardInput

SetDashboardDefinition sets the DashboardDefinition field's value.

func (*UpdateDashboardInput) SetDashboardDescription 

func (s *UpdateDashboardInput) SetDashboardDescription(v string) *UpdateDashboardInput

SetDashboardDescription sets the DashboardDescription field's value.

func (*UpdateDashboardInput) SetDashboardId 

func (s *UpdateDashboardInput) SetDashboardId(v string) *UpdateDashboardInput

SetDashboardId sets the DashboardId field's value.

func (*UpdateDashboardInput) SetDashboardName 

func (s *UpdateDashboardInput) SetDashboardName(v string) *UpdateDashboardInput

SetDashboardName sets the DashboardName field's value.

func (UpdateDashboardInput) String 

func (s UpdateDashboardInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateDashboardInput) Validate 

func (s *UpdateDashboardInput) Validate() error

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

type UpdateDashboardOutput 

type UpdateDashboardOutput struct {
	// contains filtered or unexported fields
}

func (UpdateDashboardOutput) GoString 

func (s UpdateDashboardOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateDashboardOutput) String 

func (s UpdateDashboardOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGatewayCapabilityConfigurationInput 

type UpdateGatewayCapabilityConfigurationInput struct {

	// The JSON document that defines the configuration for the gateway capability.
	// For more information, see Configuring data sources (CLI) (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html#configure-source-cli)
	// in the IoT SiteWise User Guide.
	//
	// CapabilityConfiguration is a required field
	CapabilityConfiguration *string `locationName:"capabilityConfiguration" min:"1" type:"string" required:"true"`

	// The namespace of the gateway capability configuration to be updated. For
	// example, if you configure OPC-UA sources from the IoT SiteWise console, your
	// OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version,
	// where version is a number such as 1.
	//
	// CapabilityNamespace is a required field
	CapabilityNamespace *string `locationName:"capabilityNamespace" min:"1" type:"string" required:"true"`

	// The ID of the gateway to be updated.
	//
	// GatewayId is a required field
	GatewayId *string `location:"uri" locationName:"gatewayId" min:"36" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGatewayCapabilityConfigurationInput) GoString 

func (s UpdateGatewayCapabilityConfigurationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGatewayCapabilityConfigurationInput) SetCapabilityConfiguration 

func (s *UpdateGatewayCapabilityConfigurationInput) SetCapabilityConfiguration(v string) *UpdateGatewayCapabilityConfigurationInput

SetCapabilityConfiguration sets the CapabilityConfiguration field's value.

func (*UpdateGatewayCapabilityConfigurationInput) SetCapabilityNamespace 

func (s *UpdateGatewayCapabilityConfigurationInput) SetCapabilityNamespace(v string) *UpdateGatewayCapabilityConfigurationInput

SetCapabilityNamespace sets the CapabilityNamespace field's value.

func (*UpdateGatewayCapabilityConfigurationInput) SetGatewayId 

func (s *UpdateGatewayCapabilityConfigurationInput) SetGatewayId(v string) *UpdateGatewayCapabilityConfigurationInput

SetGatewayId sets the GatewayId field's value.

func (UpdateGatewayCapabilityConfigurationInput) String 

func (s UpdateGatewayCapabilityConfigurationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGatewayCapabilityConfigurationInput) Validate 

func (s *UpdateGatewayCapabilityConfigurationInput) Validate() error

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

type UpdateGatewayCapabilityConfigurationOutput 

type UpdateGatewayCapabilityConfigurationOutput struct {

	// The namespace of the gateway capability.
	//
	// CapabilityNamespace is a required field
	CapabilityNamespace *string `locationName:"capabilityNamespace" min:"1" type:"string" required:"true"`

	// The synchronization status of the capability configuration. The sync status
	// can be one of the following:
	//
	//    * IN_SYNC – The gateway is running the capability configuration.
	//
	//    * OUT_OF_SYNC – The gateway hasn't received the capability configuration.
	//
	//    * SYNC_FAILED – The gateway rejected the capability configuration.
	//
	// After you update a capability configuration, its sync status is OUT_OF_SYNC
	// until the gateway receives and applies or rejects the updated configuration.
	//
	// CapabilitySyncStatus is a required field
	CapabilitySyncStatus *string `locationName:"capabilitySyncStatus" type:"string" required:"true" enum:"CapabilitySyncStatus"`
	// contains filtered or unexported fields
}

func (UpdateGatewayCapabilityConfigurationOutput) GoString 

func (s UpdateGatewayCapabilityConfigurationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGatewayCapabilityConfigurationOutput) SetCapabilityNamespace 

func (s *UpdateGatewayCapabilityConfigurationOutput) SetCapabilityNamespace(v string) *UpdateGatewayCapabilityConfigurationOutput

SetCapabilityNamespace sets the CapabilityNamespace field's value.

func (*UpdateGatewayCapabilityConfigurationOutput) SetCapabilitySyncStatus 

func (s *UpdateGatewayCapabilityConfigurationOutput) SetCapabilitySyncStatus(v string) *UpdateGatewayCapabilityConfigurationOutput

SetCapabilitySyncStatus sets the CapabilitySyncStatus field's value.

func (UpdateGatewayCapabilityConfigurationOutput) String 

func (s UpdateGatewayCapabilityConfigurationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGatewayInput 

type UpdateGatewayInput struct {

	// The ID of the gateway to update.
	//
	// GatewayId is a required field
	GatewayId *string `location:"uri" locationName:"gatewayId" min:"36" type:"string" required:"true"`

	// A unique, friendly name for the gateway.
	//
	// GatewayName is a required field
	GatewayName *string `locationName:"gatewayName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGatewayInput) GoString 

func (s UpdateGatewayInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGatewayInput) SetGatewayId 

func (s *UpdateGatewayInput) SetGatewayId(v string) *UpdateGatewayInput

SetGatewayId sets the GatewayId field's value.

func (*UpdateGatewayInput) SetGatewayName 

func (s *UpdateGatewayInput) SetGatewayName(v string) *UpdateGatewayInput

SetGatewayName sets the GatewayName field's value.

func (UpdateGatewayInput) String 

func (s UpdateGatewayInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGatewayInput) Validate 

func (s *UpdateGatewayInput) Validate() error

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

type UpdateGatewayOutput 

type UpdateGatewayOutput struct {
	// contains filtered or unexported fields
}

func (UpdateGatewayOutput) GoString 

func (s UpdateGatewayOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateGatewayOutput) String 

func (s UpdateGatewayOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdatePortalInput 

type UpdatePortalInput struct {

	// Contains the configuration information of an alarm created in an IoT SiteWise
	// Monitor portal. You can use the alarm to monitor an asset property and get
	// notified when the asset property value is outside a specified range. For
	// more information, see Monitoring with alarms (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html)
	// in the IoT SiteWise Application Guide.
	Alarms *Alarms `locationName:"alarms" type:"structure"`

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// The email address that sends alarm notifications.
	NotificationSenderEmail *string `locationName:"notificationSenderEmail" min:"1" type:"string"`

	// The Amazon Web Services administrator's contact email address.
	//
	// PortalContactEmail is a required field
	PortalContactEmail *string `locationName:"portalContactEmail" min:"1" type:"string" required:"true"`

	// A new description for the portal.
	PortalDescription *string `locationName:"portalDescription" min:"1" type:"string"`

	// The ID of the portal to update.
	//
	// PortalId is a required field
	PortalId *string `location:"uri" locationName:"portalId" min:"36" type:"string" required:"true"`

	// Contains an image that is one of the following:
	//
	//    * An image file. Choose this option to upload a new image.
	//
	//    * The ID of an existing image. Choose this option to keep an existing
	//    image.
	PortalLogoImage *Image `locationName:"portalLogoImage" type:"structure"`

	// A new friendly name for the portal.
	//
	// PortalName is a required field
	PortalName *string `locationName:"portalName" min:"1" type:"string" required:"true"`

	// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
	// of a service role that allows the portal's users to access your IoT SiteWise
	// resources on your behalf. For more information, see Using service roles for
	// IoT SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html)
	// in the IoT SiteWise User Guide.
	//
	// RoleArn is a required field
	RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePortalInput) GoString 

func (s UpdatePortalInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePortalInput) SetAlarms added in v1.38.50 

func (s *UpdatePortalInput) SetAlarms(v *Alarms) *UpdatePortalInput

SetAlarms sets the Alarms field's value.

func (*UpdatePortalInput) SetClientToken 

func (s *UpdatePortalInput) SetClientToken(v string) *UpdatePortalInput

SetClientToken sets the ClientToken field's value.

func (*UpdatePortalInput) SetNotificationSenderEmail added in v1.38.50 

func (s *UpdatePortalInput) SetNotificationSenderEmail(v string) *UpdatePortalInput

SetNotificationSenderEmail sets the NotificationSenderEmail field's value.

func (*UpdatePortalInput) SetPortalContactEmail 

func (s *UpdatePortalInput) SetPortalContactEmail(v string) *UpdatePortalInput

SetPortalContactEmail sets the PortalContactEmail field's value.

func (*UpdatePortalInput) SetPortalDescription 

func (s *UpdatePortalInput) SetPortalDescription(v string) *UpdatePortalInput

SetPortalDescription sets the PortalDescription field's value.

func (*UpdatePortalInput) SetPortalId 

func (s *UpdatePortalInput) SetPortalId(v string) *UpdatePortalInput

SetPortalId sets the PortalId field's value.

func (*UpdatePortalInput) SetPortalLogoImage added in v1.31.4 

func (s *UpdatePortalInput) SetPortalLogoImage(v *Image) *UpdatePortalInput

SetPortalLogoImage sets the PortalLogoImage field's value.

func (*UpdatePortalInput) SetPortalName 

func (s *UpdatePortalInput) SetPortalName(v string) *UpdatePortalInput

SetPortalName sets the PortalName field's value.

func (*UpdatePortalInput) SetRoleArn 

func (s *UpdatePortalInput) SetRoleArn(v string) *UpdatePortalInput

SetRoleArn sets the RoleArn field's value.

func (UpdatePortalInput) String 

func (s UpdatePortalInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePortalInput) Validate 

func (s *UpdatePortalInput) Validate() error

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

type UpdatePortalOutput 

type UpdatePortalOutput struct {

	// The status of the portal, which contains a state (UPDATING after successfully
	// calling this operation) and any error message.
	//
	// PortalStatus is a required field
	PortalStatus *PortalStatus `locationName:"portalStatus" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePortalOutput) GoString 

func (s UpdatePortalOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePortalOutput) SetPortalStatus 

func (s *UpdatePortalOutput) SetPortalStatus(v *PortalStatus) *UpdatePortalOutput

SetPortalStatus sets the PortalStatus field's value.

func (UpdatePortalOutput) String 

func (s UpdatePortalOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateProjectInput 

type UpdateProjectInput struct {

	// A unique case-sensitive identifier that you can provide to ensure the idempotency
	// of the request. Don't reuse this client token if a new idempotent request
	// is required.
	ClientToken *string `locationName:"clientToken" min:"36" type:"string" idempotencyToken:"true"`

	// A new description for the project.
	ProjectDescription *string `locationName:"projectDescription" min:"1" type:"string"`

	// The ID of the project to update.
	//
	// ProjectId is a required field
	ProjectId *string `location:"uri" locationName:"projectId" min:"36" type:"string" required:"true"`

	// A new friendly name for the project.
	//
	// ProjectName is a required field
	ProjectName *string `locationName:"projectName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateProjectInput) GoString 

func (s UpdateProjectInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateProjectInput) SetClientToken 

func (s *UpdateProjectInput) SetClientToken(v string) *UpdateProjectInput

SetClientToken sets the ClientToken field's value.

func (*UpdateProjectInput) SetProjectDescription 

func (s *UpdateProjectInput) SetProjectDescription(v string) *UpdateProjectInput

SetProjectDescription sets the ProjectDescription field's value.

func (*UpdateProjectInput) SetProjectId 

func (s *UpdateProjectInput) SetProjectId(v string) *UpdateProjectInput

SetProjectId sets the ProjectId field's value.

func (*UpdateProjectInput) SetProjectName 

func (s *UpdateProjectInput) SetProjectName(v string) *UpdateProjectInput

SetProjectName sets the ProjectName field's value.

func (UpdateProjectInput) String 

func (s UpdateProjectInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateProjectInput) Validate 

func (s *UpdateProjectInput) Validate() error

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

type UpdateProjectOutput 

type UpdateProjectOutput struct {
	// contains filtered or unexported fields
}

func (UpdateProjectOutput) GoString 

func (s UpdateProjectOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateProjectOutput) String 

func (s UpdateProjectOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UserIdentity 

type UserIdentity struct {

	// The IAM Identity Center ID of the user.
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information for a user identity in an access policy.

func (UserIdentity) GoString 

func (s UserIdentity) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserIdentity) SetId 

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

SetId sets the Id field's value.

func (UserIdentity) String 

func (s UserIdentity) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UserIdentity) Validate 

func (s *UserIdentity) Validate() error

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

type ValidationException added in v1.48.2 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The validation failed for this query.

func (*ValidationException) Code added in v1.48.2 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error added in v1.48.2 

func (s *ValidationException) Error() string

func (ValidationException) GoString added in v1.48.2 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message added in v1.48.2 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr added in v1.48.2 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID added in v1.48.2 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode added in v1.48.2 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String added in v1.48.2 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VariableValue 

type VariableValue struct {

	// The ID of the hierarchy to query for the property ID. You can use the hierarchy's
	// name instead of the hierarchy's ID. If the hierarchy has an external ID,
	// you can specify externalId: followed by the external ID. For more information,
	// see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	//
	// You use a hierarchy ID instead of a model ID because you can have several
	// hierarchies using the same model and therefore the same propertyId. For example,
	// you might have separately grouped assets that come from the same asset model.
	// For more information, see Asset hierarchies (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html)
	// in the IoT SiteWise User Guide.
	HierarchyId *string `locationName:"hierarchyId" min:"1" type:"string"`

	// The ID of the property to use as the variable. You can use the property name
	// if it's from the same asset model. If the property has an external ID, you
	// can specify externalId: followed by the external ID. For more information,
	// see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
	// in the IoT SiteWise User Guide.
	PropertyId *string `locationName:"propertyId" min:"1" type:"string"`

	// The path of the property.
	PropertyPath []*AssetModelPropertyPathSegment `locationName:"propertyPath" type:"list"`
	// contains filtered or unexported fields
}

Identifies a property value used in an expression.

func (VariableValue) GoString 

func (s VariableValue) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VariableValue) SetHierarchyId 

func (s *VariableValue) SetHierarchyId(v string) *VariableValue

SetHierarchyId sets the HierarchyId field's value.

func (*VariableValue) SetPropertyId 

func (s *VariableValue) SetPropertyId(v string) *VariableValue

SetPropertyId sets the PropertyId field's value.

func (*VariableValue) SetPropertyPath added in v1.48.2 

func (s *VariableValue) SetPropertyPath(v []*AssetModelPropertyPathSegment) *VariableValue

SetPropertyPath sets the PropertyPath field's value.

func (VariableValue) String 

func (s VariableValue) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VariableValue) Validate 

func (s *VariableValue) Validate() error

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

type Variant 

type Variant struct {

	// Asset property data of type Boolean (true or false).
	BooleanValue *bool `locationName:"booleanValue" type:"boolean"`

	// Asset property data of type double (floating point number).
	DoubleValue *float64 `locationName:"doubleValue" type:"double"`

	// Asset property data of type integer (number that's greater than or equal
	// to zero).
	IntegerValue *int64 `locationName:"integerValue" type:"integer"`

	// Asset property data of type string (sequence of characters).
	StringValue *string `locationName:"stringValue" type:"string"`
	// contains filtered or unexported fields
}

Contains an asset property value (of a single type only).

func (Variant) GoString 

func (s Variant) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Variant) SetBooleanValue 

func (s *Variant) SetBooleanValue(v bool) *Variant

SetBooleanValue sets the BooleanValue field's value.

func (*Variant) SetDoubleValue 

func (s *Variant) SetDoubleValue(v float64) *Variant

SetDoubleValue sets the DoubleValue field's value.

func (*Variant) SetIntegerValue 

func (s *Variant) SetIntegerValue(v int64) *Variant

SetIntegerValue sets the IntegerValue field's value.

func (*Variant) SetStringValue 

func (s *Variant) SetStringValue(v string) *Variant

SetStringValue sets the StringValue field's value.

func (Variant) String 

func (s Variant) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WarmTierRetentionPeriod added in v1.48.2 

type WarmTierRetentionPeriod struct {

	// The number of days the data is stored in the warm tier.
	NumberOfDays *int64 `locationName:"numberOfDays" min:"30" type:"integer"`

	// If set to true, the data is stored indefinitely in the warm tier.
	Unlimited *bool `locationName:"unlimited" type:"boolean"`
	// contains filtered or unexported fields
}

Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.

func (WarmTierRetentionPeriod) GoString added in v1.48.2 

func (s WarmTierRetentionPeriod) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WarmTierRetentionPeriod) SetNumberOfDays added in v1.48.2 

func (s *WarmTierRetentionPeriod) SetNumberOfDays(v int64) *WarmTierRetentionPeriod

SetNumberOfDays sets the NumberOfDays field's value.

func (*WarmTierRetentionPeriod) SetUnlimited added in v1.48.2 

func (s *WarmTierRetentionPeriod) SetUnlimited(v bool) *WarmTierRetentionPeriod

SetUnlimited sets the Unlimited field's value.

func (WarmTierRetentionPeriod) String added in v1.48.2 

func (s WarmTierRetentionPeriod) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WarmTierRetentionPeriod) Validate added in v1.48.2 

func (s *WarmTierRetentionPeriod) Validate() error

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

Source Files

View all Source files

Directories

Path Synopsis
Package iotsitewiseiface provides an interface to enable mocking the AWS IoT SiteWise service client for testing your code.
 Package iotsitewiseiface provides an interface to enable mocking the AWS IoT SiteWise service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.