types

package
v1.15.0 Latest Latest
Warning

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

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

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You don't have sufficient permission to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type Actuator 

type Actuator struct {

	// The specified data type of the actuator.
	//
	// This member is required.
	DataType NodeDataType

	// The fully qualified name of the actuator. For example, the fully qualified name
	// of an actuator might be Vehicle.Front.Left.Door.Lock .
	//
	// This member is required.
	FullyQualifiedName *string

	// A list of possible values an actuator can take.
	AllowedValues []string

	// A specified value for the actuator.
	//
	// Deprecated: assignedValue is no longer in use
	AssignedValue *string

	// A comment in addition to the description.
	Comment *string

	// The deprecation message for the node or the branch that was moved or deleted.
	DeprecationMessage *string

	// A brief description of the actuator.
	Description *string

	// The specified possible maximum value of an actuator.
	Max *float64

	// The specified possible minimum value of an actuator.
	Min *float64

	// The fully qualified name of the struct node for the actuator if the data type
	// of the actuator is Struct or StructArray . For example, the struct fully
	// qualified name of an actuator might be Vehicle.Door.LockStruct .
	StructFullyQualifiedName *string

	// The scientific unit for the actuator.
	Unit *string
	// contains filtered or unexported fields
}

A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.

Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.

type Attribute 

type Attribute struct {

	// The specified data type of the attribute.
	//
	// This member is required.
	DataType NodeDataType

	// The fully qualified name of the attribute. For example, the fully qualified
	// name of an attribute might be Vehicle.Body.Engine.Type .
	//
	// This member is required.
	FullyQualifiedName *string

	// A list of possible values an attribute can be assigned.
	AllowedValues []string

	// A specified value for the attribute.
	//
	// Deprecated: assignedValue is no longer in use
	AssignedValue *string

	// A comment in addition to the description.
	Comment *string

	// The default value of the attribute.
	DefaultValue *string

	// The deprecation message for the node or the branch that was moved or deleted.
	DeprecationMessage *string

	// A brief description of the attribute.
	Description *string

	// The specified possible maximum value of the attribute.
	Max *float64

	// The specified possible minimum value of the attribute.
	Min *float64

	// The scientific unit for the attribute.
	Unit *string
	// contains filtered or unexported fields
}

A signal that represents static information about the vehicle, such as engine type or manufacturing date.

type Branch 

type Branch struct {

	// The fully qualified name of the branch. For example, the fully qualified name
	// of a branch might be Vehicle.Body.Engine .
	//
	// This member is required.
	FullyQualifiedName *string

	// A comment in addition to the description.
	Comment *string

	// The deprecation message for the node or the branch that was moved or deleted.
	DeprecationMessage *string

	// A brief description of the branch.
	Description *string
	// contains filtered or unexported fields
}

A group of signals that are defined in a hierarchical structure.

type CampaignStatus 

type CampaignStatus string
const (
	CampaignStatusCreating           CampaignStatus = "CREATING"
	CampaignStatusWaitingForApproval CampaignStatus = "WAITING_FOR_APPROVAL"
	CampaignStatusRunning            CampaignStatus = "RUNNING"
	CampaignStatusSuspended          CampaignStatus = "SUSPENDED"
)

Enum values for CampaignStatus

func (CampaignStatus) Values 

func (CampaignStatus) Values() []CampaignStatus

Values returns all known values for CampaignStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CampaignSummary 

type CampaignSummary struct {

	// The time the campaign was created.
	//
	// This member is required.
	CreationTime *time.Time

	// The last time the campaign was modified.
	//
	// This member is required.
	LastModificationTime *time.Time

	// The Amazon Resource Name (ARN) of a campaign.
	Arn *string

	// The description of the campaign.
	Description *string

	// The name of a campaign.
	Name *string

	// The ARN of the signal catalog associated with the campaign.
	SignalCatalogArn *string

	// The state of a campaign. The status can be one of the following:
	//
	//   - CREATING - Amazon Web Services IoT FleetWise is processing your request to
	//   create the campaign.
	//
	//   - WAITING_FOR_APPROVAL - After a campaign is created, it enters the
	//   WAITING_FOR_APPROVAL state. To allow Amazon Web Services IoT FleetWise to
	//   deploy the campaign to the target vehicle or fleet, use the API operation to
	//   approve the campaign.
	//
	//   - RUNNING - The campaign is active.
	//
	//   - SUSPENDED - The campaign is suspended. To resume the campaign, use the API
	//   operation.
	Status CampaignStatus

	// The ARN of a vehicle or fleet to which the campaign is deployed.
	TargetArn *string
	// contains filtered or unexported fields
}

Information about a campaign.

You can use the API operation to return this information about multiple created campaigns.

type CanDbcDefinition 

type CanDbcDefinition struct {

	// A list of DBC files. You can upload only one DBC file for each network
	// interface and specify up to five (inclusive) files in the list. The DBC file can
	// be a maximum size of 200 MB.
	//
	// This member is required.
	CanDbcFiles [][]byte

	// Contains information about a network interface.
	//
	// This member is required.
	NetworkInterface *string

	// Pairs every signal specified in your vehicle model with a signal decoder.
	SignalsMap map[string]string
	// contains filtered or unexported fields
}

Configurations used to create a decoder manifest.

type CanInterface 

type CanInterface struct {

	// The unique name of the interface.
	//
	// This member is required.
	Name *string

	// The name of the communication protocol for the interface.
	ProtocolName *string

	// The version of the communication protocol for the interface.
	ProtocolVersion *string
	// contains filtered or unexported fields
}

A single controller area network (CAN) device interface.

type CanSignal 

type CanSignal struct {

	// A multiplier used to decode the CAN message.
	//
	// This member is required.
	Factor *float64

	// Whether the byte ordering of a CAN message is big-endian.
	//
	// This member is required.
	IsBigEndian bool

	// Whether the message data is specified as a signed value.
	//
	// This member is required.
	IsSigned bool

	// How many bytes of data are in the message.
	//
	// This member is required.
	Length int32

	// The ID of the message.
	//
	// This member is required.
	MessageId int32

	// The offset used to calculate the signal value. Combined with factor, the
	// calculation is value = raw_value * factor + offset .
	//
	// This member is required.
	Offset *float64

	// Indicates the beginning of the CAN signal. This should always be the least
	// significant bit (LSB).
	//
	// This value might be different from the value in a DBC file. For little endian
	// signals, startBit is the same value as in the DBC file. For big endian signals
	// in a DBC file, the start bit is the most significant bit (MSB). You will have to
	// calculate the LSB instead and pass it as the startBit .
	//
	// This member is required.
	StartBit int32

	// The name of the signal.
	Name *string
	// contains filtered or unexported fields
}

Information about a single controller area network (CAN) signal and the messages it receives and transmits.

type CloudWatchLogDeliveryOptions 

type CloudWatchLogDeliveryOptions struct {

	// The type of log to send data to Amazon CloudWatch Logs.
	//
	// This member is required.
	LogType LogType

	// The Amazon CloudWatch Logs group the operation sends data to.
	LogGroupName *string
	// contains filtered or unexported fields
}

The log delivery option to send data to Amazon CloudWatch Logs.

type CollectionScheme 

type CollectionScheme interface {
	// contains filtered or unexported methods
}

Specifies what data to collect and how often or when to collect it.

The following types satisfy this interface: 

CollectionSchemeMemberConditionBasedCollectionScheme
CollectionSchemeMemberTimeBasedCollectionScheme
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/iotfleetwise/types"
)

func main() {
	var union types.CollectionScheme
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.CollectionSchemeMemberConditionBasedCollectionScheme:
		_ = v.Value // Value is types.ConditionBasedCollectionScheme

	case *types.CollectionSchemeMemberTimeBasedCollectionScheme:
		_ = v.Value // Value is types.TimeBasedCollectionScheme

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type CollectionSchemeMemberConditionBasedCollectionScheme 

type CollectionSchemeMemberConditionBasedCollectionScheme struct {
	Value ConditionBasedCollectionScheme
	// contains filtered or unexported fields
}

Information about a collection scheme that uses a simple logical expression to recognize what data to collect.

type CollectionSchemeMemberTimeBasedCollectionScheme 

type CollectionSchemeMemberTimeBasedCollectionScheme struct {
	Value TimeBasedCollectionScheme
	// contains filtered or unexported fields
}

Information about a collection scheme that uses a time period to decide how often to collect data.

type Compression 

type Compression string
const (
	CompressionOff    Compression = "OFF"
	CompressionSnappy Compression = "SNAPPY"
)

Enum values for Compression

func (Compression) Values 

func (Compression) Values() []Compression

Values returns all known values for Compression. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ConditionBasedCollectionScheme 

type ConditionBasedCollectionScheme struct {

	// The logical expression used to recognize what data to collect. For example,
	// $variable.`Vehicle.OutsideAirTemperature` >= 105.0 .
	//
	// This member is required.
	Expression *string

	// Specifies the version of the conditional expression language.
	ConditionLanguageVersion *int32

	// The minimum duration of time between two triggering events to collect data, in
	// milliseconds.
	//
	// If a signal changes often, you might want to collect data at a slower rate.
	MinimumTriggerIntervalMs *int64

	// Whether to collect data for all triggering events ( ALWAYS ). Specify (
	// RISING_EDGE ), or specify only when the condition first evaluates to false. For
	// example, triggering on "AirbagDeployed"; Users aren't interested on triggering
	// when the airbag is already exploded; they only care about the change from not
	// deployed => deployed.
	TriggerMode TriggerMode
	// contains filtered or unexported fields
}

Information about a collection scheme that uses a simple logical expression to recognize what data to collect.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	Resource     *string
	ResourceType *string
	// contains filtered or unexported fields
}

The 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 (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type CreateVehicleError 

type CreateVehicleError struct {

	// An HTTP error code.
	Code *string

	// A description of the HTTP error.
	Message *string

	// The ID of the vehicle with the error.
	VehicleName *string
	// contains filtered or unexported fields
}

An HTTP error resulting from creating a vehicle.

type CreateVehicleRequestItem 

type CreateVehicleRequestItem struct {

	// The Amazon Resource Name (ARN) of a decoder manifest associated with the
	// vehicle to create.
	//
	// This member is required.
	DecoderManifestArn *string

	// The ARN of the vehicle model (model manifest) to create the vehicle from.
	//
	// This member is required.
	ModelManifestArn *string

	// The unique ID of the vehicle to create.
	//
	// This member is required.
	VehicleName *string

	// An option to create a new Amazon Web Services IoT thing when creating a
	// vehicle, or to validate an existing thing as a vehicle.
	AssociationBehavior VehicleAssociationBehavior

	// Static information about a vehicle in a key-value pair. For example: "engine
	// Type" : "v6"
	Attributes map[string]string

	// Metadata which can be used to manage the vehicle.
	Tags []Tag
	// contains filtered or unexported fields
}

Information about the vehicle to create.

type CreateVehicleResponseItem 

type CreateVehicleResponseItem struct {

	// The ARN of the created vehicle.
	Arn *string

	// The ARN of a created or validated Amazon Web Services IoT thing.
	ThingArn *string

	// The unique ID of the vehicle to create.
	VehicleName *string
	// contains filtered or unexported fields
}

Information about a created vehicle.

type CustomProperty added in v1.9.0 

type CustomProperty struct {

	// The data type for the custom property.
	//
	// This member is required.
	DataType NodeDataType

	// The fully qualified name of the custom property. For example, the fully
	// qualified name of a custom property might be
	// ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS .
	//
	// This member is required.
	FullyQualifiedName *string

	// A comment in addition to the description.
	Comment *string

	// Indicates whether the property is binary data.
	DataEncoding NodeDataEncoding

	// The deprecation message for the node or the branch that was moved or deleted.
	DeprecationMessage *string

	// A brief description of the custom property.
	Description *string

	// The fully qualified name of the struct node for the custom property if the data
	// type of the custom property is Struct or StructArray .
	StructFullyQualifiedName *string
	// contains filtered or unexported fields
}

Represents a member of the complex data structure. The data type of the property can be either primitive or another struct .

type CustomStruct added in v1.9.0 

type CustomStruct struct {

	// The fully qualified name of the custom structure. For example, the fully
	// qualified name of a custom structure might be
	// ComplexDataTypes.VehicleDataTypes.SVMCamera .
	//
	// This member is required.
	FullyQualifiedName *string

	// A comment in addition to the description.
	Comment *string

	// The deprecation message for the node or the branch that was moved or deleted.
	DeprecationMessage *string

	// A brief description of the custom structure.
	Description *string
	// contains filtered or unexported fields
}

The custom structure represents a complex or higher-order data structure.

type DataDestinationConfig added in v1.4.0 

type DataDestinationConfig interface {
	// contains filtered or unexported methods
}

The destination where the Amazon Web Services IoT FleetWise campaign sends data. You can send data to be stored in Amazon S3 or Amazon Timestream.

The following types satisfy this interface: 

DataDestinationConfigMemberS3Config
DataDestinationConfigMemberTimestreamConfig
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/iotfleetwise/types"
)

func main() {
	var union types.DataDestinationConfig
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.DataDestinationConfigMemberS3Config:
		_ = v.Value // Value is types.S3Config

	case *types.DataDestinationConfigMemberTimestreamConfig:
		_ = v.Value // Value is types.TimestreamConfig

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type DataDestinationConfigMemberS3Config added in v1.4.0 

type DataDestinationConfigMemberS3Config struct {
	Value S3Config
	// contains filtered or unexported fields
}

The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.

type DataDestinationConfigMemberTimestreamConfig added in v1.4.0 

type DataDestinationConfigMemberTimestreamConfig struct {
	Value TimestreamConfig
	// contains filtered or unexported fields
}

The Amazon Timestream table where the campaign sends data.

type DataFormat added in v1.4.0 

type DataFormat string
const (
	DataFormatJson    DataFormat = "JSON"
	DataFormatParquet DataFormat = "PARQUET"
)

Enum values for DataFormat

func (DataFormat) Values added in v1.4.0 

func (DataFormat) Values() []DataFormat

Values returns all known values for DataFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DecoderManifestSummary 

type DecoderManifestSummary struct {

	// The time the decoder manifest was created in seconds since epoch (January 1,
	// 1970 at midnight UTC time).
	//
	// This member is required.
	CreationTime *time.Time

	// The time the decoder manifest was last updated in seconds since epoch (January
	// 1, 1970 at midnight UTC time).
	//
	// This member is required.
	LastModificationTime *time.Time

	// The ARN of a vehicle model (model manifest) associated with the decoder
	// manifest.
	Arn *string

	// A brief description of the decoder manifest.
	Description *string

	// The detailed message for the decoder manifest. When a decoder manifest is in an
	// INVALID status, the message contains detailed reason and help information.
	Message *string

	// The ARN of a vehicle model (model manifest) associated with the decoder
	// manifest.
	ModelManifestArn *string

	// The name of the decoder manifest.
	Name *string

	// The state of the decoder manifest. If the status is ACTIVE , the decoder
	// manifest can't be edited. If the status is marked DRAFT , you can edit the
	// decoder manifest.
	Status ManifestStatus
	// contains filtered or unexported fields
}

Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests.

type DecoderManifestValidationException 

type DecoderManifestValidationException struct {
	Message *string

	ErrorCodeOverride *string

	InvalidSignals           []InvalidSignalDecoder
	InvalidNetworkInterfaces []InvalidNetworkInterface
	// contains filtered or unexported fields
}

The request couldn't be completed because it contains signal decoders with one or more validation errors.

func (*DecoderManifestValidationException) Error 

func (e *DecoderManifestValidationException) Error() string

func (*DecoderManifestValidationException) ErrorCode 

func (e *DecoderManifestValidationException) ErrorCode() string

func (*DecoderManifestValidationException) ErrorFault 

func (e *DecoderManifestValidationException) ErrorFault() smithy.ErrorFault

func (*DecoderManifestValidationException) ErrorMessage 

func (e *DecoderManifestValidationException) ErrorMessage() string

type DiagnosticsMode 

type DiagnosticsMode string
const (
	DiagnosticsModeOff            DiagnosticsMode = "OFF"
	DiagnosticsModeSendActiveDtcs DiagnosticsMode = "SEND_ACTIVE_DTCS"
)

Enum values for DiagnosticsMode

func (DiagnosticsMode) Values 

func (DiagnosticsMode) Values() []DiagnosticsMode

Values returns all known values for DiagnosticsMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EncryptionStatus added in v1.6.0 

type EncryptionStatus string
const (
	EncryptionStatusPending EncryptionStatus = "PENDING"
	EncryptionStatusSuccess EncryptionStatus = "SUCCESS"
	EncryptionStatusFailure EncryptionStatus = "FAILURE"
)

Enum values for EncryptionStatus

func (EncryptionStatus) Values added in v1.6.0 

func (EncryptionStatus) Values() []EncryptionStatus

Values returns all known values for EncryptionStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type EncryptionType added in v1.6.0 

type EncryptionType string
const (
	EncryptionTypeKmsBasedEncryption         EncryptionType = "KMS_BASED_ENCRYPTION"
	EncryptionTypeFleetwiseDefaultEncryption EncryptionType = "FLEETWISE_DEFAULT_ENCRYPTION"
)

Enum values for EncryptionType

func (EncryptionType) Values added in v1.6.0 

func (EncryptionType) Values() []EncryptionType

Values returns all known values for EncryptionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type FleetSummary 

type FleetSummary struct {

	// The Amazon Resource Name (ARN) of the fleet.
	//
	// This member is required.
	Arn *string

	// The time the fleet was created, in seconds since epoch (January 1, 1970 at
	// midnight UTC time).
	//
	// This member is required.
	CreationTime *time.Time

	// The unique ID of the fleet.
	//
	// This member is required.
	Id *string

	// The ARN of the signal catalog associated with the fleet.
	//
	// This member is required.
	SignalCatalogArn *string

	// A brief description of the fleet.
	Description *string

	// The time the fleet was last updated in seconds since epoch (January 1, 1970 at
	// midnight UTC time).
	LastModificationTime *time.Time
	// contains filtered or unexported fields
}

Information about a fleet.

You can use the API operation to return this information about multiple fleets.

type FormattedVss 

type FormattedVss interface {
	// contains filtered or unexported methods
}

Vehicle Signal Specification (VSS) is a precise language used to describe and model signals in vehicle networks. The JSON file collects signal specificiations in a VSS format.

The following types satisfy this interface: 

FormattedVssMemberVssJson
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/iotfleetwise/types"
)

func main() {
	var union types.FormattedVss
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.FormattedVssMemberVssJson:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type FormattedVssMemberVssJson 

type FormattedVssMemberVssJson struct {
	Value string
	// contains filtered or unexported fields
}

Provides the VSS in JSON format.

type IamRegistrationResponse 

type IamRegistrationResponse struct {

	// The status of registering your IAM resource. The status can be one of
	// REGISTRATION_SUCCESS , REGISTRATION_PENDING , REGISTRATION_FAILURE .
	//
	// This member is required.
	RegistrationStatus RegistrationStatus

	// The Amazon Resource Name (ARN) of the IAM role to register.
	//
	// This member is required.
	RoleArn *string

	// A message associated with a registration error.
	ErrorMessage *string
	// contains filtered or unexported fields
}

Information about registering an Identity and Access Management (IAM) resource so Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to Amazon Timestream.

type IamResources 

type IamResources struct {

	// The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web
	// Services IoT FleetWise to send data to Amazon Timestream. For example,
	// arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN .
	//
	// This member is required.
	RoleArn *string
	// contains filtered or unexported fields
}

The IAM resource that enables Amazon Web Services IoT FleetWise edge agent software to send data to Amazon Timestream.

For more information, see IAM roles in the Identity and Access Management User Guide.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

The request couldn't be completed because the server temporarily failed.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type InvalidNetworkInterface 

type InvalidNetworkInterface struct {

	// The ID of the interface that isn't valid.
	InterfaceId *string

	// A message about why the interface isn't valid.
	Reason NetworkInterfaceFailureReason
	// contains filtered or unexported fields
}

A reason a vehicle network interface isn't valid.

type InvalidNodeException 

type InvalidNodeException struct {
	Message *string

	ErrorCodeOverride *string

	InvalidNodes []Node
	Reason       *string
	// contains filtered or unexported fields
}

The specified node type doesn't match the expected node type for a node. You can specify the node type as branch, sensor, actuator, or attribute.

func (*InvalidNodeException) Error 

func (e *InvalidNodeException) Error() string

func (*InvalidNodeException) ErrorCode 

func (e *InvalidNodeException) ErrorCode() string

func (*InvalidNodeException) ErrorFault 

func (e *InvalidNodeException) ErrorFault() smithy.ErrorFault

func (*InvalidNodeException) ErrorMessage 

func (e *InvalidNodeException) ErrorMessage() string

type InvalidSignal 

type InvalidSignal struct {

	// The name of the signal that isn't valid.
	Name *string

	// A message about why the signal isn't valid.
	Reason *string
	// contains filtered or unexported fields
}

A reason that a signal isn't valid.

type InvalidSignalDecoder 

type InvalidSignalDecoder struct {

	// The possible cause for the invalid signal decoder.
	Hint *string

	// The name of a signal decoder that isn't valid.
	Name *string

	// A message about why the signal decoder isn't valid.
	Reason SignalDecoderFailureReason
	// contains filtered or unexported fields
}

A reason that a signal decoder isn't valid.

type InvalidSignalsException 

type InvalidSignalsException struct {
	Message *string

	ErrorCodeOverride *string

	InvalidSignals []InvalidSignal
	// contains filtered or unexported fields
}

The request couldn't be completed because it contains signals that aren't valid.

func (*InvalidSignalsException) Error 

func (e *InvalidSignalsException) Error() string

func (*InvalidSignalsException) ErrorCode 

func (e *InvalidSignalsException) ErrorCode() string

func (*InvalidSignalsException) ErrorFault 

func (e *InvalidSignalsException) ErrorFault() smithy.ErrorFault

func (*InvalidSignalsException) ErrorMessage 

func (e *InvalidSignalsException) ErrorMessage() string

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

A service quota was exceeded.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type LogType 

type LogType string
const (
	LogTypeOff   LogType = "OFF"
	LogTypeError LogType = "ERROR"
)

Enum values for LogType

func (LogType) Values 

func (LogType) Values() []LogType

Values returns all known values for LogType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ManifestStatus 

type ManifestStatus string
const (
	ManifestStatusActive     ManifestStatus = "ACTIVE"
	ManifestStatusDraft      ManifestStatus = "DRAFT"
	ManifestStatusInvalid    ManifestStatus = "INVALID"
	ManifestStatusValidating ManifestStatus = "VALIDATING"
)

Enum values for ManifestStatus

func (ManifestStatus) Values 

func (ManifestStatus) Values() []ManifestStatus

Values returns all known values for ManifestStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type MessageSignal added in v1.9.0 

type MessageSignal struct {

	// The structured message for the message signal. It can be defined with either a
	// primitiveMessageDefinition , structuredMessageListDefinition , or
	// structuredMessageDefinition recursively.
	//
	// This member is required.
	StructuredMessage StructuredMessage

	// The topic name for the message signal. It corresponds to topics in ROS 2.
	//
	// This member is required.
	TopicName *string
	// contains filtered or unexported fields
}

The decoding information for a specific message which support higher order data types.

type ModelManifestSummary 

type ModelManifestSummary struct {

	// The time the vehicle model was created, in seconds since epoch (January 1, 1970
	// at midnight UTC time).
	//
	// This member is required.
	CreationTime *time.Time

	// The time the vehicle model was last updated, in seconds since epoch (January 1,
	// 1970 at midnight UTC time).
	//
	// This member is required.
	LastModificationTime *time.Time

	// The Amazon Resource Name (ARN) of the vehicle model.
	Arn *string

	// A brief description of the vehicle model.
	Description *string

	// The name of the vehicle model.
	Name *string

	// The ARN of the signal catalog associated with the vehicle model.
	SignalCatalogArn *string

	// The state of the vehicle model. If the status is ACTIVE , the vehicle model
	// can't be edited. If the status is DRAFT , you can edit the vehicle model.
	Status ManifestStatus
	// contains filtered or unexported fields
}

Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models.

type NetworkFileDefinition 

type NetworkFileDefinition interface {
	// contains filtered or unexported methods
}

Specifications for defining a vehicle network.

The following types satisfy this interface: 

NetworkFileDefinitionMemberCanDbc
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/iotfleetwise/types"
)

func main() {
	var union types.NetworkFileDefinition
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.NetworkFileDefinitionMemberCanDbc:
		_ = v.Value // Value is types.CanDbcDefinition

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type NetworkFileDefinitionMemberCanDbc 

type NetworkFileDefinitionMemberCanDbc struct {
	Value CanDbcDefinition
	// contains filtered or unexported fields
}

Information, including CAN DBC files, about the configurations used to create a decoder manifest.

type NetworkInterface 

type NetworkInterface struct {

	// The ID of the network interface.
	//
	// This member is required.
	InterfaceId *string

	// The network protocol for the vehicle. For example, CAN_SIGNAL specifies a
	// protocol that defines how data is communicated between electronic control units
	// (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data
	// is communicated between ECUs.
	//
	// This member is required.
	Type NetworkInterfaceType

	// Information about a network interface specified by the Controller Area Network
	// (CAN) protocol.
	CanInterface *CanInterface

	// Information about a network interface specified by the On-board diagnostic
	// (OBD) II protocol.
	ObdInterface *ObdInterface

	// The vehicle middleware defined as a type of network interface. Examples of
	// vehicle middleware include ROS2 and SOME/IP .
	VehicleMiddleware *VehicleMiddleware
	// contains filtered or unexported fields
}

Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node.

To return this information about all the network interfaces specified in a decoder manifest, use the API operation.

type NetworkInterfaceFailureReason 

type NetworkInterfaceFailureReason string
const (
	NetworkInterfaceFailureReasonDuplicateInterface                            NetworkInterfaceFailureReason = "DUPLICATE_NETWORK_INTERFACE"
	NetworkInterfaceFailureReasonConflictingNetworkInterface                   NetworkInterfaceFailureReason = "CONFLICTING_NETWORK_INTERFACE"
	NetworkInterfaceFailureReasonNetworkInterfaceToAddAlreadyExists            NetworkInterfaceFailureReason = "NETWORK_INTERFACE_TO_ADD_ALREADY_EXISTS"
	NetworkInterfaceFailureReasonCanNetworkInterfaceInfoIsNull                 NetworkInterfaceFailureReason = "CAN_NETWORK_INTERFACE_INFO_IS_NULL"
	NetworkInterfaceFailureReasonObdNetworkInterfaceInfoIsNull                 NetworkInterfaceFailureReason = "OBD_NETWORK_INTERFACE_INFO_IS_NULL"
	NetworkInterfaceFailureReasonNetworkInterfaceToRemoveAssociatedWithSignals NetworkInterfaceFailureReason = "NETWORK_INTERFACE_TO_REMOVE_ASSOCIATED_WITH_SIGNALS"
	NetworkInterfaceFailureReasonVehicleMiddlewareNetworkInterfaceInfoIsNull   NetworkInterfaceFailureReason = "VEHICLE_MIDDLEWARE_NETWORK_INTERFACE_INFO_IS_NULL"
)

Enum values for NetworkInterfaceFailureReason

func (NetworkInterfaceFailureReason) Values 

func (NetworkInterfaceFailureReason) Values() []NetworkInterfaceFailureReason

Values returns all known values for NetworkInterfaceFailureReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NetworkInterfaceType 

type NetworkInterfaceType string
const (
	NetworkInterfaceTypeCanInterface      NetworkInterfaceType = "CAN_INTERFACE"
	NetworkInterfaceTypeObdInterface      NetworkInterfaceType = "OBD_INTERFACE"
	NetworkInterfaceTypeVehicleMiddleware NetworkInterfaceType = "VEHICLE_MIDDLEWARE"
)

Enum values for NetworkInterfaceType

func (NetworkInterfaceType) Values 

func (NetworkInterfaceType) Values() []NetworkInterfaceType

Values returns all known values for NetworkInterfaceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Node 

type Node interface {
	// contains filtered or unexported methods
}

A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.

The following types satisfy this interface: 

NodeMemberActuator
NodeMemberAttribute
NodeMemberBranch
NodeMemberProperty
NodeMemberSensor
NodeMemberStruct
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/iotfleetwise/types"
)

func main() {
	var union types.Node
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.NodeMemberActuator:
		_ = v.Value // Value is types.Actuator

	case *types.NodeMemberAttribute:
		_ = v.Value // Value is types.Attribute

	case *types.NodeMemberBranch:
		_ = v.Value // Value is types.Branch

	case *types.NodeMemberProperty:
		_ = v.Value // Value is types.CustomProperty

	case *types.NodeMemberSensor:
		_ = v.Value // Value is types.Sensor

	case *types.NodeMemberStruct:
		_ = v.Value // Value is types.CustomStruct

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type NodeCounts 

type NodeCounts struct {

	// The total number of nodes in a vehicle network that represent actuators.
	TotalActuators int32

	// The total number of nodes in a vehicle network that represent attributes.
	TotalAttributes int32

	// The total number of nodes in a vehicle network that represent branches.
	TotalBranches int32

	// The total number of nodes in a vehicle network.
	TotalNodes int32

	// The total properties for the node.
	TotalProperties int32

	// The total number of nodes in a vehicle network that represent sensors.
	TotalSensors int32

	// The total structure for the node.
	TotalStructs int32
	// contains filtered or unexported fields
}

Information about the number of nodes and node types in a vehicle network.

type NodeDataEncoding added in v1.9.0 

type NodeDataEncoding string
const (
	NodeDataEncodingBinary NodeDataEncoding = "BINARY"
	NodeDataEncodingTyped  NodeDataEncoding = "TYPED"
)

Enum values for NodeDataEncoding

func (NodeDataEncoding) Values added in v1.9.0 

func (NodeDataEncoding) Values() []NodeDataEncoding

Values returns all known values for NodeDataEncoding. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NodeDataType 

type NodeDataType string
const (
	NodeDataTypeInt8               NodeDataType = "INT8"
	NodeDataTypeUint8              NodeDataType = "UINT8"
	NodeDataTypeInt16              NodeDataType = "INT16"
	NodeDataTypeUint16             NodeDataType = "UINT16"
	NodeDataTypeInt32              NodeDataType = "INT32"
	NodeDataTypeUint32             NodeDataType = "UINT32"
	NodeDataTypeInt64              NodeDataType = "INT64"
	NodeDataTypeUint64             NodeDataType = "UINT64"
	NodeDataTypeBoolean            NodeDataType = "BOOLEAN"
	NodeDataTypeFloat              NodeDataType = "FLOAT"
	NodeDataTypeDouble             NodeDataType = "DOUBLE"
	NodeDataTypeString             NodeDataType = "STRING"
	NodeDataTypeUnixTimestamp      NodeDataType = "UNIX_TIMESTAMP"
	NodeDataTypeInt8Array          NodeDataType = "INT8_ARRAY"
	NodeDataTypeUint8Array         NodeDataType = "UINT8_ARRAY"
	NodeDataTypeInt16Array         NodeDataType = "INT16_ARRAY"
	NodeDataTypeUint16Array        NodeDataType = "UINT16_ARRAY"
	NodeDataTypeInt32Array         NodeDataType = "INT32_ARRAY"
	NodeDataTypeUint32Array        NodeDataType = "UINT32_ARRAY"
	NodeDataTypeInt64Array         NodeDataType = "INT64_ARRAY"
	NodeDataTypeUint64Array        NodeDataType = "UINT64_ARRAY"
	NodeDataTypeBooleanArray       NodeDataType = "BOOLEAN_ARRAY"
	NodeDataTypeFloatArray         NodeDataType = "FLOAT_ARRAY"
	NodeDataTypeDoubleArray        NodeDataType = "DOUBLE_ARRAY"
	NodeDataTypeStringArray        NodeDataType = "STRING_ARRAY"
	NodeDataTypeUnixTimestampArray NodeDataType = "UNIX_TIMESTAMP_ARRAY"
	NodeDataTypeUnknown            NodeDataType = "UNKNOWN"
	NodeDataTypeStruct             NodeDataType = "STRUCT"
	NodeDataTypeStructArray        NodeDataType = "STRUCT_ARRAY"
)

Enum values for NodeDataType

func (NodeDataType) Values 

func (NodeDataType) Values() []NodeDataType

Values returns all known values for NodeDataType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NodeMemberActuator 

type NodeMemberActuator struct {
	Value Actuator
	// contains filtered or unexported fields
}

Information about a node specified as an actuator.

An actuator is a digital representation of a vehicle device.

type NodeMemberAttribute 

type NodeMemberAttribute struct {
	Value Attribute
	// contains filtered or unexported fields
}

Information about a node specified as an attribute.

An attribute represents static information about a vehicle.

type NodeMemberBranch 

type NodeMemberBranch struct {
	Value Branch
	// contains filtered or unexported fields
}

Information about a node specified as a branch.

A group of signals that are defined in a hierarchical structure.

type NodeMemberProperty added in v1.9.0 

type NodeMemberProperty struct {
	Value CustomProperty
	// contains filtered or unexported fields
}

Represents a member of the complex data structure. The datatype of the property can be either primitive or another struct .

type NodeMemberSensor 

type NodeMemberSensor struct {
	Value Sensor
	// contains filtered or unexported fields
}

An input component that reports the environmental condition of a vehicle.

You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

type NodeMemberStruct added in v1.9.0 

type NodeMemberStruct struct {
	Value CustomStruct
	// contains filtered or unexported fields
}

Represents a complex or higher-order data structure.

type ObdInterface 

type ObdInterface struct {

	// The name of the interface.
	//
	// This member is required.
	Name *string

	// The ID of the message requesting vehicle data.
	//
	// This member is required.
	RequestMessageId int32

	// The maximum number message requests per diagnostic trouble code per second.
	DtcRequestIntervalSeconds int32

	// Whether the vehicle has a transmission control module (TCM).
	HasTransmissionEcu bool

	// The standard OBD II PID.
	ObdStandard *string

	// The maximum number message requests per second.
	PidRequestIntervalSeconds int32

	// Whether to use extended IDs in the message.
	UseExtendedIds bool
	// contains filtered or unexported fields
}

A network interface that specifies the On-board diagnostic (OBD) II network protocol.

type ObdSignal 

type ObdSignal struct {

	// The length of a message.
	//
	// This member is required.
	ByteLength *int32

	// The offset used to calculate the signal value. Combined with scaling, the
	// calculation is value = raw_value * scaling + offset .
	//
	// This member is required.
	Offset *float64

	// The diagnostic code used to request data from a vehicle for this signal.
	//
	// This member is required.
	Pid int32

	// The length of the requested data.
	//
	// This member is required.
	PidResponseLength *int32

	// A multiplier used to decode the message.
	//
	// This member is required.
	Scaling *float64

	// The mode of operation (diagnostic service) in a message.
	//
	// This member is required.
	ServiceMode int32

	// Indicates the beginning of the message.
	//
	// This member is required.
	StartByte int32

	// The number of bits to mask in a message.
	BitMaskLength *int32

	// The number of positions to shift bits in the message.
	BitRightShift int32
	// contains filtered or unexported fields
}

Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.

type PrimitiveMessageDefinition added in v1.9.0 

type PrimitiveMessageDefinition interface {
	// contains filtered or unexported methods
}

Represents a primitive type node of the complex data structure.

The following types satisfy this interface: 

PrimitiveMessageDefinitionMemberRos2PrimitiveMessageDefinition
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/iotfleetwise/types"
)

func main() {
	var union types.PrimitiveMessageDefinition
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.PrimitiveMessageDefinitionMemberRos2PrimitiveMessageDefinition:
		_ = v.Value // Value is types.ROS2PrimitiveMessageDefinition

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type PrimitiveMessageDefinitionMemberRos2PrimitiveMessageDefinition added in v1.9.0 

type PrimitiveMessageDefinitionMemberRos2PrimitiveMessageDefinition struct {
	Value ROS2PrimitiveMessageDefinition
	// contains filtered or unexported fields
}

Information about a PrimitiveMessage using a ROS 2 compliant primitive type message of the complex data structure.

type ROS2PrimitiveMessageDefinition added in v1.9.0 

type ROS2PrimitiveMessageDefinition struct {

	// The primitive type (integer, floating point, boolean, etc.) for the ROS 2
	// primitive message definition.
	//
	// This member is required.
	PrimitiveType ROS2PrimitiveType

	// The offset used to calculate the signal value. Combined with scaling, the
	// calculation is value = raw_value * scaling + offset .
	Offset *float64

	// A multiplier used to decode the message.
	Scaling *float64

	// An optional attribute specifying the upper bound for STRING and WSTRING .
	UpperBound *int64
	// contains filtered or unexported fields
}

Represents a ROS 2 compliant primitive type message of the complex data structure.

type ROS2PrimitiveType added in v1.9.0 

type ROS2PrimitiveType string
const (
	ROS2PrimitiveTypeBool    ROS2PrimitiveType = "BOOL"
	ROS2PrimitiveTypeByte    ROS2PrimitiveType = "BYTE"
	ROS2PrimitiveTypeChar    ROS2PrimitiveType = "CHAR"
	ROS2PrimitiveTypeFloat32 ROS2PrimitiveType = "FLOAT32"
	ROS2PrimitiveTypeFloat64 ROS2PrimitiveType = "FLOAT64"
	ROS2PrimitiveTypeInt8    ROS2PrimitiveType = "INT8"
	ROS2PrimitiveTypeUint8   ROS2PrimitiveType = "UINT8"
	ROS2PrimitiveTypeInt16   ROS2PrimitiveType = "INT16"
	ROS2PrimitiveTypeUint16  ROS2PrimitiveType = "UINT16"
	ROS2PrimitiveTypeInt32   ROS2PrimitiveType = "INT32"
	ROS2PrimitiveTypeUint32  ROS2PrimitiveType = "UINT32"
	ROS2PrimitiveTypeInt64   ROS2PrimitiveType = "INT64"
	ROS2PrimitiveTypeUint64  ROS2PrimitiveType = "UINT64"
	ROS2PrimitiveTypeString  ROS2PrimitiveType = "STRING"
	ROS2PrimitiveTypeWstring ROS2PrimitiveType = "WSTRING"
)

Enum values for ROS2PrimitiveType

func (ROS2PrimitiveType) Values added in v1.9.0 

func (ROS2PrimitiveType) Values() []ROS2PrimitiveType

Values returns all known values for ROS2PrimitiveType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RegistrationStatus 

type RegistrationStatus string
const (
	RegistrationStatusRegistrationPending RegistrationStatus = "REGISTRATION_PENDING"
	RegistrationStatusRegistrationSuccess RegistrationStatus = "REGISTRATION_SUCCESS"
	RegistrationStatusRegistrationFailure RegistrationStatus = "REGISTRATION_FAILURE"
)

Enum values for RegistrationStatus

func (RegistrationStatus) Values 

func (RegistrationStatus) Values() []RegistrationStatus

Values returns all known values for RegistrationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The resource wasn't found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type S3Config added in v1.4.0 

type S3Config struct {

	// The Amazon Resource Name (ARN) of the Amazon S3 bucket.
	//
	// This member is required.
	BucketArn *string

	// Specify the format that files are saved in the Amazon S3 bucket. You can save
	// files in an Apache Parquet or JSON format.
	//
	//   - Parquet - Store data in a columnar storage file format. Parquet is optimal
	//   for fast data retrieval and can reduce costs. This option is selected by
	//   default.
	//
	//   - JSON - Store data in a standard text-based JSON file format.
	DataFormat DataFormat

	// (Optional) Enter an S3 bucket prefix. The prefix is the string of characters
	// after the bucket name and before the object name. You can use the prefix to
	// organize data stored in Amazon S3 buckets. For more information, see [Organizing objects using prefixes]in the
	// Amazon Simple Storage Service User Guide.
	//
	// By default, Amazon Web Services IoT FleetWise sets the prefix
	// processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to
	// Amazon S3. You can enter a prefix to append it to this default prefix. For
	// example, if you enter the prefix vehicles , the prefix will be
	// vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/ .
	//
	// [Organizing objects using prefixes]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html
	Prefix *string

	// By default, stored data is compressed as a .gzip file. Compressed files have a
	// reduced file size, which can optimize the cost of data storage.
	StorageCompressionFormat StorageCompressionFormat
	// contains filtered or unexported fields
}

The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data. Amazon S3 is an object storage service that stores data as objects within buckets. For more information, see Creating, configuring, and working with Amazon S3 bucketsin the Amazon Simple Storage Service User Guide.

type Sensor 

type Sensor struct {

	// The specified data type of the sensor.
	//
	// This member is required.
	DataType NodeDataType

	// The fully qualified name of the sensor. For example, the fully qualified name
	// of a sensor might be Vehicle.Body.Engine.Battery .
	//
	// This member is required.
	FullyQualifiedName *string

	// A list of possible values a sensor can take.
	AllowedValues []string

	// A comment in addition to the description.
	Comment *string

	// The deprecation message for the node or the branch that was moved or deleted.
	DeprecationMessage *string

	// A brief description of a sensor.
	Description *string

	// The specified possible maximum value of the sensor.
	Max *float64

	// The specified possible minimum value of the sensor.
	Min *float64

	// The fully qualified name of the struct node for a sensor if the data type of
	// the actuator is Struct or StructArray . For example, the struct fully qualified
	// name of a sensor might be Vehicle.ADAS.CameraStruct .
	StructFullyQualifiedName *string

	// The scientific unit of measurement for data collected by the sensor.
	Unit *string
	// contains filtered or unexported fields
}

An input component that reports the environmental condition of a vehicle.

You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

type SignalCatalogSummary 

type SignalCatalogSummary struct {

	// The Amazon Resource Name (ARN) of the signal catalog.
	Arn *string

	// The time the signal catalog was created in seconds since epoch (January 1, 1970
	// at midnight UTC time).
	CreationTime *time.Time

	// The time the signal catalog was last updated in seconds since epoch (January 1,
	// 1970 at midnight UTC time).
	LastModificationTime *time.Time

	// The name of the signal catalog.
	Name *string
	// contains filtered or unexported fields
}

Information about a collection of standardized signals, which can be attributes, branches, sensors, or actuators.

type SignalDecoder 

type SignalDecoder struct {

	// The fully qualified name of a signal decoder as defined in a vehicle model.
	//
	// This member is required.
	FullyQualifiedName *string

	// The ID of a network interface that specifies what network protocol a vehicle
	// follows.
	//
	// This member is required.
	InterfaceId *string

	// The network protocol for the vehicle. For example, CAN_SIGNAL specifies a
	// protocol that defines how data is communicated between electronic control units
	// (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data
	// is communicated between ECUs.
	//
	// This member is required.
	Type SignalDecoderType

	// Information about signal decoder using the Controller Area Network (CAN)
	// protocol.
	CanSignal *CanSignal

	// The decoding information for a specific message which supports higher order
	// data types.
	MessageSignal *MessageSignal

	// Information about signal decoder using the On-board diagnostic (OBD) II
	// protocol.
	ObdSignal *ObdSignal
	// contains filtered or unexported fields
}

Information about a signal decoder.

type SignalDecoderFailureReason 

type SignalDecoderFailureReason string
const (
	SignalDecoderFailureReasonDuplicateSignal                                       SignalDecoderFailureReason = "DUPLICATE_SIGNAL"
	SignalDecoderFailureReasonConflictingSignal                                     SignalDecoderFailureReason = "CONFLICTING_SIGNAL"
	SignalDecoderFailureReasonSignalToAddAlreadyExists                              SignalDecoderFailureReason = "SIGNAL_TO_ADD_ALREADY_EXISTS"
	SignalDecoderFailureReasonSignalNotAssociatedWithNetworkInterface               SignalDecoderFailureReason = "SIGNAL_NOT_ASSOCIATED_WITH_NETWORK_INTERFACE"
	SignalDecoderFailureReasonNetworkInterfaceTypeIncompatibleWithSignalDecoderType SignalDecoderFailureReason = "NETWORK_INTERFACE_TYPE_INCOMPATIBLE_WITH_SIGNAL_DECODER_TYPE"
	SignalDecoderFailureReasonSignalNotInModel                                      SignalDecoderFailureReason = "SIGNAL_NOT_IN_MODEL"
	SignalDecoderFailureReasonCanSignalInfoIsNull                                   SignalDecoderFailureReason = "CAN_SIGNAL_INFO_IS_NULL"
	SignalDecoderFailureReasonObdSignalInfoIsNull                                   SignalDecoderFailureReason = "OBD_SIGNAL_INFO_IS_NULL"
	SignalDecoderFailureReasonNoDecoderInfoForSignalInModel                         SignalDecoderFailureReason = "NO_DECODER_INFO_FOR_SIGNAL_IN_MODEL"
	SignalDecoderFailureReasonMessageSignalInfoIsNull                               SignalDecoderFailureReason = "MESSAGE_SIGNAL_INFO_IS_NULL"
	SignalDecoderFailureReasonSignalDecoderTypeIncompatibleWithMessageSignalType    SignalDecoderFailureReason = "SIGNAL_DECODER_TYPE_INCOMPATIBLE_WITH_MESSAGE_SIGNAL_TYPE"
	SignalDecoderFailureReasonStructSizeMismatch                                    SignalDecoderFailureReason = "STRUCT_SIZE_MISMATCH"
	SignalDecoderFailureReasonNoSignalInCatalogForDecoderSignal                     SignalDecoderFailureReason = "NO_SIGNAL_IN_CATALOG_FOR_DECODER_SIGNAL"
	SignalDecoderFailureReasonSignalDecoderIncompatibleWithSignalCatalog            SignalDecoderFailureReason = "SIGNAL_DECODER_INCOMPATIBLE_WITH_SIGNAL_CATALOG"
	SignalDecoderFailureReasonEmptyMessageSignal                                    SignalDecoderFailureReason = "EMPTY_MESSAGE_SIGNAL"
)

Enum values for SignalDecoderFailureReason

func (SignalDecoderFailureReason) Values 

func (SignalDecoderFailureReason) Values() []SignalDecoderFailureReason

Values returns all known values for SignalDecoderFailureReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SignalDecoderType 

type SignalDecoderType string
const (
	SignalDecoderTypeCanSignal     SignalDecoderType = "CAN_SIGNAL"
	SignalDecoderTypeObdSignal     SignalDecoderType = "OBD_SIGNAL"
	SignalDecoderTypeMessageSignal SignalDecoderType = "MESSAGE_SIGNAL"
)

Enum values for SignalDecoderType

func (SignalDecoderType) Values 

func (SignalDecoderType) Values() []SignalDecoderType

Values returns all known values for SignalDecoderType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SignalInformation 

type SignalInformation struct {

	// The name of the signal.
	//
	// This member is required.
	Name *string

	// The maximum number of samples to collect.
	MaxSampleCount *int64

	// The minimum duration of time (in milliseconds) between two triggering events to
	// collect data.
	//
	// If a signal changes often, you might want to collect data at a slower rate.
	MinimumSamplingIntervalMs *int64
	// contains filtered or unexported fields
}

Information about a signal.

type SignalNodeType added in v1.12.0 

type SignalNodeType string
const (
	SignalNodeTypeSensor         SignalNodeType = "SENSOR"
	SignalNodeTypeActuator       SignalNodeType = "ACTUATOR"
	SignalNodeTypeAttribute      SignalNodeType = "ATTRIBUTE"
	SignalNodeTypeBranch         SignalNodeType = "BRANCH"
	SignalNodeTypeCustomStruct   SignalNodeType = "CUSTOM_STRUCT"
	SignalNodeTypeCustomProperty SignalNodeType = "CUSTOM_PROPERTY"
)

Enum values for SignalNodeType

func (SignalNodeType) Values added in v1.12.0 

func (SignalNodeType) Values() []SignalNodeType

Values returns all known values for SignalNodeType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SpoolingMode 

type SpoolingMode string
const (
	SpoolingModeOff    SpoolingMode = "OFF"
	SpoolingModeToDisk SpoolingMode = "TO_DISK"
)

Enum values for SpoolingMode

func (SpoolingMode) Values 

func (SpoolingMode) Values() []SpoolingMode

Values returns all known values for SpoolingMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StorageCompressionFormat added in v1.4.0 

type StorageCompressionFormat string
const (
	StorageCompressionFormatNone StorageCompressionFormat = "NONE"
	StorageCompressionFormatGzip StorageCompressionFormat = "GZIP"
)

Enum values for StorageCompressionFormat

func (StorageCompressionFormat) Values added in v1.4.0 

func (StorageCompressionFormat) Values() []StorageCompressionFormat

Values returns all known values for StorageCompressionFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StructuredMessage added in v1.9.0 

type StructuredMessage interface {
	// contains filtered or unexported methods
}

The structured message for the message signal. It can be defined with either a primitiveMessageDefinition , structuredMessageListDefinition , or structuredMessageDefinition recursively.

The following types satisfy this interface: 

StructuredMessageMemberPrimitiveMessageDefinition
StructuredMessageMemberStructuredMessageDefinition
StructuredMessageMemberStructuredMessageListDefinition
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/iotfleetwise/types"
)

func main() {
	var union types.StructuredMessage
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.StructuredMessageMemberPrimitiveMessageDefinition:
		_ = v.Value // Value is types.PrimitiveMessageDefinition

	case *types.StructuredMessageMemberStructuredMessageDefinition:
		_ = v.Value // Value is []types.StructuredMessageFieldNameAndDataTypePair

	case *types.StructuredMessageMemberStructuredMessageListDefinition:
		_ = v.Value // Value is types.StructuredMessageListDefinition

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type StructuredMessageFieldNameAndDataTypePair added in v1.9.0 

type StructuredMessageFieldNameAndDataTypePair struct {

	// The data type.
	//
	// This member is required.
	DataType StructuredMessage

	// The field name of the structured message. It determines how a data value is
	// referenced in the target language.
	//
	// This member is required.
	FieldName *string
	// contains filtered or unexported fields
}

Represents a StructureMessageName to DataType map element.

type StructuredMessageListDefinition added in v1.9.0 

type StructuredMessageListDefinition struct {

	// The type of list of the structured message list definition.
	//
	// This member is required.
	ListType StructuredMessageListType

	// The member type of the structured message list definition.
	//
	// This member is required.
	MemberType StructuredMessage

	// The name of the structured message list definition.
	//
	// This member is required.
	Name *string

	// The capacity of the structured message list definition when the list type is
	// FIXED_CAPACITY or DYNAMIC_BOUNDED_CAPACITY .
	Capacity int32
	// contains filtered or unexported fields
}

Represents a list type node of the complex data structure.

type StructuredMessageListType added in v1.9.0 

type StructuredMessageListType string
const (
	StructuredMessageListTypeFixedCapacity            StructuredMessageListType = "FIXED_CAPACITY"
	StructuredMessageListTypeDynamicUnboundedCapacity StructuredMessageListType = "DYNAMIC_UNBOUNDED_CAPACITY"
	StructuredMessageListTypeDynamicBoundedCapacity   StructuredMessageListType = "DYNAMIC_BOUNDED_CAPACITY"
)

Enum values for StructuredMessageListType

func (StructuredMessageListType) Values added in v1.9.0 

func (StructuredMessageListType) Values() []StructuredMessageListType

Values returns all known values for StructuredMessageListType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type StructuredMessageMemberPrimitiveMessageDefinition added in v1.9.0 

type StructuredMessageMemberPrimitiveMessageDefinition struct {
	Value PrimitiveMessageDefinition
	// contains filtered or unexported fields
}

Represents a primitive type node of the complex data structure.

type StructuredMessageMemberStructuredMessageDefinition added in v1.9.0 

type StructuredMessageMemberStructuredMessageDefinition struct {
	Value []StructuredMessageFieldNameAndDataTypePair
	// contains filtered or unexported fields
}

Represents a struct type node of the complex data structure.

type StructuredMessageMemberStructuredMessageListDefinition added in v1.9.0 

type StructuredMessageMemberStructuredMessageListDefinition struct {
	Value StructuredMessageListDefinition
	// contains filtered or unexported fields
}

Represents a list type node of the complex data structure.

type Tag 

type Tag struct {

	// The tag's key.
	//
	// This member is required.
	Key *string

	// The tag's value.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

A set of key/value pairs that are used to manage the resource.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	QuotaCode         *string
	ServiceCode       *string
	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

The request couldn't be completed due to throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type TimeBasedCollectionScheme 

type TimeBasedCollectionScheme struct {

	// The time period (in milliseconds) to decide how often to collect data. For
	// example, if the time period is 60000 , the Edge Agent software collects data
	// once every minute.
	//
	// This member is required.
	PeriodMs *int64
	// contains filtered or unexported fields
}

Information about a collection scheme that uses a time period to decide how often to collect data.

type TimestreamConfig added in v1.4.0 

type TimestreamConfig struct {

	// The Amazon Resource Name (ARN) of the task execution role that grants Amazon
	// Web Services IoT FleetWise permission to deliver data to the Amazon Timestream
	// table.
	//
	// This member is required.
	ExecutionRoleArn *string

	// The Amazon Resource Name (ARN) of the Amazon Timestream table.
	//
	// This member is required.
	TimestreamTableArn *string
	// contains filtered or unexported fields
}

The Amazon Timestream table where the Amazon Web Services IoT FleetWise campaign sends data. Timestream stores and organizes data to optimize query processing time and to reduce storage costs. For more information, see Data modelingin the Amazon Timestream Developer Guide.

type TimestreamRegistrationResponse 

type TimestreamRegistrationResponse struct {

	// The status of registering your Amazon Timestream resources. The status can be
	// one of REGISTRATION_SUCCESS , REGISTRATION_PENDING , REGISTRATION_FAILURE .
	//
	// This member is required.
	RegistrationStatus RegistrationStatus

	// The name of the Timestream database.
	//
	// This member is required.
	TimestreamDatabaseName *string

	// The name of the Timestream database table.
	//
	// This member is required.
	TimestreamTableName *string

	// A message associated with a registration error.
	ErrorMessage *string

	// The Amazon Resource Name (ARN) of the Timestream database.
	TimestreamDatabaseArn *string

	// The ARN of the Timestream database table.
	TimestreamTableArn *string
	// contains filtered or unexported fields
}

Information about the registered Amazon Timestream resources or errors, if any.

type TimestreamResources 

type TimestreamResources struct {

	// The name of the registered Amazon Timestream database.
	//
	// This member is required.
	TimestreamDatabaseName *string

	// The name of the registered Amazon Timestream database table.
	//
	// This member is required.
	TimestreamTableName *string
	// contains filtered or unexported fields
}

The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.

type TriggerMode 

type TriggerMode string
const (
	TriggerModeAlways     TriggerMode = "ALWAYS"
	TriggerModeRisingEdge TriggerMode = "RISING_EDGE"
)

Enum values for TriggerMode

func (TriggerMode) Values 

func (TriggerMode) Values() []TriggerMode

Values returns all known values for TriggerMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UpdateCampaignAction 

type UpdateCampaignAction string
const (
	UpdateCampaignActionApprove UpdateCampaignAction = "APPROVE"
	UpdateCampaignActionSuspend UpdateCampaignAction = "SUSPEND"
	UpdateCampaignActionResume  UpdateCampaignAction = "RESUME"
	UpdateCampaignActionUpdate  UpdateCampaignAction = "UPDATE"
)

Enum values for UpdateCampaignAction

func (UpdateCampaignAction) Values 

func (UpdateCampaignAction) Values() []UpdateCampaignAction

Values returns all known values for UpdateCampaignAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UpdateMode 

type UpdateMode string
const (
	UpdateModeOverwrite UpdateMode = "Overwrite"
	UpdateModeMerge     UpdateMode = "Merge"
)

Enum values for UpdateMode

func (UpdateMode) Values 

func (UpdateMode) Values() []UpdateMode

Values returns all known values for UpdateMode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UpdateVehicleError 

type UpdateVehicleError struct {

	// The relevant HTTP error code (400+).
	Code int32

	// A message associated with the error.
	Message *string

	// The ID of the vehicle with the error.
	VehicleName *string
	// contains filtered or unexported fields
}

An HTTP error resulting from updating the description for a vehicle.

type UpdateVehicleRequestItem 

type UpdateVehicleRequestItem struct {

	// The unique ID of the vehicle to update.
	//
	// This member is required.
	VehicleName *string

	// The method the specified attributes will update the existing attributes on the
	// vehicle. Use Overwite to replace the vehicle attributes with the specified
	// attributes. Or use Merge to combine all attributes.
	//
	// This is required if attributes are present in the input.
	AttributeUpdateMode UpdateMode

	// Static information about a vehicle in a key-value pair. For example:
	//
	// "engineType" : "1.3 L R2"
	Attributes map[string]string

	// The ARN of the signal decoder manifest associated with the vehicle to update.
	DecoderManifestArn *string

	// The ARN of the vehicle model (model manifest) associated with the vehicle to
	// update.
	ModelManifestArn *string
	// contains filtered or unexported fields
}

Information about the vehicle to update.

type UpdateVehicleResponseItem 

type UpdateVehicleResponseItem struct {

	// The Amazon Resource Name (ARN) of the updated vehicle.
	Arn *string

	// The unique ID of the updated vehicle.
	VehicleName *string
	// contains filtered or unexported fields
}

Information about the updated vehicle.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason    ValidationExceptionReason
	FieldList []ValidationExceptionField
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by an Amazon Web Services service.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField 

type ValidationExceptionField struct {

	// A message about the validation error.
	//
	// This member is required.
	Message *string

	// The name of the parameter field with the validation error.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

A validation error due to mismatch between the expected data type, length, or pattern of the parameter and the input.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "unknownOperation"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "cannotParse"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "fieldValidationFailed"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "other"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VehicleAssociationBehavior 

type VehicleAssociationBehavior string
const (
	VehicleAssociationBehaviorCreateIotThing         VehicleAssociationBehavior = "CreateIotThing"
	VehicleAssociationBehaviorValidateIotThingExists VehicleAssociationBehavior = "ValidateIotThingExists"
)

Enum values for VehicleAssociationBehavior

func (VehicleAssociationBehavior) Values 

func (VehicleAssociationBehavior) Values() []VehicleAssociationBehavior

Values returns all known values for VehicleAssociationBehavior. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VehicleMiddleware added in v1.9.0 

type VehicleMiddleware struct {

	// The name of the vehicle middleware.
	//
	// This member is required.
	Name *string

	// The protocol name of the vehicle middleware.
	//
	// This member is required.
	ProtocolName VehicleMiddlewareProtocol
	// contains filtered or unexported fields
}

The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP .

type VehicleMiddlewareProtocol added in v1.9.0 

type VehicleMiddlewareProtocol string
const (
	VehicleMiddlewareProtocolRos2 VehicleMiddlewareProtocol = "ROS_2"
)

Enum values for VehicleMiddlewareProtocol

func (VehicleMiddlewareProtocol) Values added in v1.9.0 

func (VehicleMiddlewareProtocol) Values() []VehicleMiddlewareProtocol

Values returns all known values for VehicleMiddlewareProtocol. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VehicleState 

type VehicleState string
const (
	VehicleStateCreated   VehicleState = "CREATED"
	VehicleStateReady     VehicleState = "READY"
	VehicleStateHealthy   VehicleState = "HEALTHY"
	VehicleStateSuspended VehicleState = "SUSPENDED"
	VehicleStateDeleting  VehicleState = "DELETING"
)

Enum values for VehicleState

func (VehicleState) Values 

func (VehicleState) Values() []VehicleState

Values returns all known values for VehicleState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VehicleStatus 

type VehicleStatus struct {

	// The name of a campaign.
	CampaignName *string

	// The state of a vehicle, which can be one of the following:
	//
	//   - CREATED - Amazon Web Services IoT FleetWise sucessfully created the vehicle.
	//
	//   - READY - The vehicle is ready to receive a campaign deployment.
	//
	//   - HEALTHY - A campaign deployment was delivered to the vehicle.
	//
	//   - SUSPENDED - A campaign associated with the vehicle was suspended and data
	//   collection was paused.
	//
	//   - DELETING - Amazon Web Services IoT FleetWise is removing a campaign from the
	//   vehicle.
	Status VehicleState

	// The unique ID of the vehicle.
	VehicleName *string
	// contains filtered or unexported fields
}

Information about the state of a vehicle and how it relates to the status of a campaign.

type VehicleSummary 

type VehicleSummary struct {

	// The Amazon Resource Name (ARN) of the vehicle.
	//
	// This member is required.
	Arn *string

	// The time the vehicle was created in seconds since epoch (January 1, 1970 at
	// midnight UTC time).
	//
	// This member is required.
	CreationTime *time.Time

	// The ARN of a decoder manifest associated with the vehicle.
	//
	// This member is required.
	DecoderManifestArn *string

	// The time the vehicle was last updated in seconds since epoch (January 1, 1970
	// at midnight UTC time).
	//
	// This member is required.
	LastModificationTime *time.Time

	// The ARN of a vehicle model (model manifest) associated with the vehicle.
	//
	// This member is required.
	ModelManifestArn *string

	// The unique ID of the vehicle.
	//
	// This member is required.
	VehicleName *string

	// Static information about a vehicle in a key-value pair. For example:
	//
	// "engineType" : "1.3 L R2"
	Attributes map[string]string
	// contains filtered or unexported fields
}

Information about a vehicle.

To return this information about vehicles in your account, you can use the API operation.

Source Files

View all Source files

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.