types

package
v1.22.8 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 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
}

The requestor does not have permission to access the target action or resource.

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

type AlternateSoftwareMetadata struct {

	// The appliance software version.
	Version *string
	// contains filtered or unexported fields
}

Details about a beta appliance software update.

type ApplicationInstance 

type ApplicationInstance struct {

	// The application instance's ID.
	ApplicationInstanceId *string

	// The application instance's ARN.
	Arn *string

	// When the application instance was created.
	CreatedTime *time.Time

	// The device's ID.
	DefaultRuntimeContextDevice *string

	// The device's name.
	DefaultRuntimeContextDeviceName *string

	// The application instance's description.
	Description *string

	// The application instance's health status.
	HealthStatus ApplicationInstanceHealthStatus

	// The application instance's name.
	Name *string

	// The application's state.
	RuntimeContextStates []ReportedRuntimeContextState

	// The application instance's status.
	Status ApplicationInstanceStatus

	// The application instance's status description.
	StatusDescription *string

	// The application instance's tags.
	Tags map[string]string
	// contains filtered or unexported fields
}

An application instance on a device.

type ApplicationInstanceHealthStatus 

type ApplicationInstanceHealthStatus string
const (
	ApplicationInstanceHealthStatusRunning      ApplicationInstanceHealthStatus = "RUNNING"
	ApplicationInstanceHealthStatusError        ApplicationInstanceHealthStatus = "ERROR"
	ApplicationInstanceHealthStatusNotAvailable ApplicationInstanceHealthStatus = "NOT_AVAILABLE"
)

Enum values for ApplicationInstanceHealthStatus

func (ApplicationInstanceHealthStatus) Values 

func (ApplicationInstanceHealthStatus) Values() []ApplicationInstanceHealthStatus

Values returns all known values for ApplicationInstanceHealthStatus. 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 ApplicationInstanceStatus 

type ApplicationInstanceStatus string
const (
	ApplicationInstanceStatusDeploymentPending    ApplicationInstanceStatus = "DEPLOYMENT_PENDING"
	ApplicationInstanceStatusDeploymentRequested  ApplicationInstanceStatus = "DEPLOYMENT_REQUESTED"
	ApplicationInstanceStatusDeploymentInProgress ApplicationInstanceStatus = "DEPLOYMENT_IN_PROGRESS"
	ApplicationInstanceStatusDeploymentError      ApplicationInstanceStatus = "DEPLOYMENT_ERROR"
	ApplicationInstanceStatusDeploymentSucceeded  ApplicationInstanceStatus = "DEPLOYMENT_SUCCEEDED"
	ApplicationInstanceStatusRemovalPending       ApplicationInstanceStatus = "REMOVAL_PENDING"
	ApplicationInstanceStatusRemovalRequested     ApplicationInstanceStatus = "REMOVAL_REQUESTED"
	ApplicationInstanceStatusRemovalInProgress    ApplicationInstanceStatus = "REMOVAL_IN_PROGRESS"
	ApplicationInstanceStatusRemovalFailed        ApplicationInstanceStatus = "REMOVAL_FAILED"
	ApplicationInstanceStatusRemovalSucceeded     ApplicationInstanceStatus = "REMOVAL_SUCCEEDED"
	ApplicationInstanceStatusDeploymentFailed     ApplicationInstanceStatus = "DEPLOYMENT_FAILED"
)

Enum values for ApplicationInstanceStatus

func (ApplicationInstanceStatus) Values 

func (ApplicationInstanceStatus) Values() []ApplicationInstanceStatus

Values returns all known values for ApplicationInstanceStatus. 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 ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId     *string
	ResourceType   *string
	ErrorId        *string
	ErrorArguments []ConflictExceptionErrorArgument
	// contains filtered or unexported fields
}

The target resource is in use.

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 ConflictExceptionErrorArgument 

type ConflictExceptionErrorArgument struct {

	// The error argument's name.
	//
	// This member is required.
	Name *string

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

A conflict exception error argument.

type ConnectionType 

type ConnectionType string
const (
	ConnectionTypeStaticIp ConnectionType = "STATIC_IP"
	ConnectionTypeDhcp     ConnectionType = "DHCP"
)

Enum values for ConnectionType

func (ConnectionType) Values 

func (ConnectionType) Values() []ConnectionType

Values returns all known values for ConnectionType. 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 DesiredState added in v1.9.0 

type DesiredState string
const (
	DesiredStateRunning DesiredState = "RUNNING"
	DesiredStateStopped DesiredState = "STOPPED"
	DesiredStateRemoved DesiredState = "REMOVED"
)

Enum values for DesiredState

func (DesiredState) Values added in v1.9.0 

func (DesiredState) Values() []DesiredState

Values returns all known values for DesiredState. 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 Device 

type Device struct {

	// The device's maker.
	Brand DeviceBrand

	// When the device was created.
	CreatedTime *time.Time

	// A device's current software.
	CurrentSoftware *string

	// A description for the device.
	Description *string

	// A device's aggregated status. Including the device's connection status,
	// provisioning status, and lease status.
	DeviceAggregatedStatus DeviceAggregatedStatus

	// The device's ID.
	DeviceId *string

	// When the device was updated.
	LastUpdatedTime *time.Time

	// A device's latest job. Includes the target image version, and the update job
	// status.
	LatestDeviceJob *LatestDeviceJob

	// The device's lease expiration time.
	LeaseExpirationTime *time.Time

	// The device's name.
	Name *string

	// The device's provisioning status.
	ProvisioningStatus DeviceStatus

	// The device's tags.
	Tags map[string]string

	// The device's type.
	Type DeviceType
	// contains filtered or unexported fields
}

A device.

type DeviceAggregatedStatus added in v1.8.0 

type DeviceAggregatedStatus string
const (
	DeviceAggregatedStatusError                DeviceAggregatedStatus = "ERROR"
	DeviceAggregatedStatusAwaitingProvisioning DeviceAggregatedStatus = "AWAITING_PROVISIONING"
	DeviceAggregatedStatusPending              DeviceAggregatedStatus = "PENDING"
	DeviceAggregatedStatusFailed               DeviceAggregatedStatus = "FAILED"
	DeviceAggregatedStatusDeleting             DeviceAggregatedStatus = "DELETING"
	DeviceAggregatedStatusOnline               DeviceAggregatedStatus = "ONLINE"
	DeviceAggregatedStatusOffline              DeviceAggregatedStatus = "OFFLINE"
	DeviceAggregatedStatusLeaseExpired         DeviceAggregatedStatus = "LEASE_EXPIRED"
	DeviceAggregatedStatusUpdateNeeded         DeviceAggregatedStatus = "UPDATE_NEEDED"
	DeviceAggregatedStatusRebooting            DeviceAggregatedStatus = "REBOOTING"
)

Enum values for DeviceAggregatedStatus

func (DeviceAggregatedStatus) Values added in v1.8.0 

func (DeviceAggregatedStatus) Values() []DeviceAggregatedStatus

Values returns all known values for DeviceAggregatedStatus. 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 DeviceBrand added in v1.7.0 

type DeviceBrand string
const (
	DeviceBrandAwsPanorama DeviceBrand = "AWS_PANORAMA"
	DeviceBrandLenovo      DeviceBrand = "LENOVO"
)

Enum values for DeviceBrand

func (DeviceBrand) Values added in v1.7.0 

func (DeviceBrand) Values() []DeviceBrand

Values returns all known values for DeviceBrand. 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 DeviceConnectionStatus 

type DeviceConnectionStatus string
const (
	DeviceConnectionStatusOnline              DeviceConnectionStatus = "ONLINE"
	DeviceConnectionStatusOffline             DeviceConnectionStatus = "OFFLINE"
	DeviceConnectionStatusAwaitingCredentials DeviceConnectionStatus = "AWAITING_CREDENTIALS"
	DeviceConnectionStatusNotAvailable        DeviceConnectionStatus = "NOT_AVAILABLE"
	DeviceConnectionStatusError               DeviceConnectionStatus = "ERROR"
)

Enum values for DeviceConnectionStatus

func (DeviceConnectionStatus) Values 

func (DeviceConnectionStatus) Values() []DeviceConnectionStatus

Values returns all known values for DeviceConnectionStatus. 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 DeviceJob 

type DeviceJob struct {

	// When the job was created.
	CreatedTime *time.Time

	// The ID of the target device.
	DeviceId *string

	// The name of the target device
	DeviceName *string

	// The job's ID.
	JobId *string

	// The job's type.
	JobType JobType
	// contains filtered or unexported fields
}

A job that runs on a device.

type DeviceJobConfig 

type DeviceJobConfig struct {

	// A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.
	OTAJobConfig *OTAJobConfig
	// contains filtered or unexported fields
}

A job's configuration.

type DeviceReportedStatus added in v1.9.0 

type DeviceReportedStatus string
const (
	DeviceReportedStatusStopping          DeviceReportedStatus = "STOPPING"
	DeviceReportedStatusStopped           DeviceReportedStatus = "STOPPED"
	DeviceReportedStatusStopError         DeviceReportedStatus = "STOP_ERROR"
	DeviceReportedStatusRemovalFailed     DeviceReportedStatus = "REMOVAL_FAILED"
	DeviceReportedStatusRemovalInProgress DeviceReportedStatus = "REMOVAL_IN_PROGRESS"
	DeviceReportedStatusStarting          DeviceReportedStatus = "STARTING"
	DeviceReportedStatusRunning           DeviceReportedStatus = "RUNNING"
	DeviceReportedStatusInstallError      DeviceReportedStatus = "INSTALL_ERROR"
	DeviceReportedStatusLaunched          DeviceReportedStatus = "LAUNCHED"
	DeviceReportedStatusLaunchError       DeviceReportedStatus = "LAUNCH_ERROR"
	DeviceReportedStatusInstallInProgress DeviceReportedStatus = "INSTALL_IN_PROGRESS"
)

Enum values for DeviceReportedStatus

func (DeviceReportedStatus) Values added in v1.9.0 

func (DeviceReportedStatus) Values() []DeviceReportedStatus

Values returns all known values for DeviceReportedStatus. 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 DeviceStatus 

type DeviceStatus string
const (
	DeviceStatusAwaitingProvisioning DeviceStatus = "AWAITING_PROVISIONING"
	DeviceStatusPending              DeviceStatus = "PENDING"
	DeviceStatusSucceeded            DeviceStatus = "SUCCEEDED"
	DeviceStatusFailed               DeviceStatus = "FAILED"
	DeviceStatusError                DeviceStatus = "ERROR"
	DeviceStatusDeleting             DeviceStatus = "DELETING"
)

Enum values for DeviceStatus

func (DeviceStatus) Values 

func (DeviceStatus) Values() []DeviceStatus

Values returns all known values for DeviceStatus. 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 DeviceType 

type DeviceType string
const (
	DeviceTypePanoramaApplianceDeveloperKit DeviceType = "PANORAMA_APPLIANCE_DEVELOPER_KIT"
	DeviceTypePanoramaAppliance             DeviceType = "PANORAMA_APPLIANCE"
)

Enum values for DeviceType

func (DeviceType) Values 

func (DeviceType) Values() []DeviceType

Values returns all known values for DeviceType. 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 EthernetPayload 

type EthernetPayload struct {

	// How the device gets an IP address.
	//
	// This member is required.
	ConnectionType ConnectionType

	// Network configuration for a static IP connection.
	StaticIpConnectionInfo *StaticIpConnectionInfo
	// contains filtered or unexported fields
}

A device's network configuration.

type EthernetStatus 

type EthernetStatus struct {

	// The device's connection status.
	ConnectionStatus NetworkConnectionStatus

	// The device's physical address.
	HwAddress *string

	// The device's IP address.
	IpAddress *string
	// contains filtered or unexported fields
}

A device's Ethernet status.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds int32
	// contains filtered or unexported fields
}

An internal error occurred.

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 Job 

type Job struct {

	// The target device's ID.
	DeviceId *string

	// The job's ID.
	JobId *string
	// contains filtered or unexported fields
}

A job for a device.

type JobResourceTags 

type JobResourceTags struct {

	// The job's type.
	//
	// This member is required.
	ResourceType JobResourceType

	// The job's tags.
	//
	// This member is required.
	Tags map[string]string
	// contains filtered or unexported fields
}

Tags for a job.

type JobResourceType 

type JobResourceType string
const (
	JobResourceTypePackage JobResourceType = "PACKAGE"
)

Enum values for JobResourceType

func (JobResourceType) Values 

func (JobResourceType) Values() []JobResourceType

Values returns all known values for JobResourceType. 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 JobType 

type JobType string
const (
	JobTypeOta    JobType = "OTA"
	JobTypeReboot JobType = "REBOOT"
)

Enum values for JobType

func (JobType) Values 

func (JobType) Values() []JobType

Values returns all known values for JobType. 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 LatestDeviceJob added in v1.8.0 

type LatestDeviceJob struct {

	// The target version of the device software.
	ImageVersion *string

	// The job's type.
	JobType JobType

	// Status of the latest device job.
	Status UpdateProgress
	// contains filtered or unexported fields
}

Returns information about the latest device job.

type ListDevicesSortBy added in v1.8.0 

type ListDevicesSortBy string
const (
	ListDevicesSortByDeviceId               ListDevicesSortBy = "DEVICE_ID"
	ListDevicesSortByCreatedTime            ListDevicesSortBy = "CREATED_TIME"
	ListDevicesSortByName                   ListDevicesSortBy = "NAME"
	ListDevicesSortByDeviceAggregatedStatus ListDevicesSortBy = "DEVICE_AGGREGATED_STATUS"
)

Enum values for ListDevicesSortBy

func (ListDevicesSortBy) Values added in v1.8.0 

func (ListDevicesSortBy) Values() []ListDevicesSortBy

Values returns all known values for ListDevicesSortBy. 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 ManifestOverridesPayload 

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

Parameter overrides for an application instance. This is a JSON document that has a single key ( PayloadData ) where the value is an escaped string representation of the overrides document.

The following types satisfy this interface: 

ManifestOverridesPayloadMemberPayloadData
Example (OutputUsage) 
package main

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

func main() {
	var union types.ManifestOverridesPayload
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ManifestOverridesPayloadMemberPayloadData:
		_ = 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 ManifestOverridesPayloadMemberPayloadData 

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

The overrides document.

type ManifestPayload 

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

A application verion's manifest file. This is a JSON document that has a single key ( PayloadData ) where the value is an escaped string representation of the application manifest ( graph.json ). This file is located in the graphs folder in your application source.

The following types satisfy this interface: 

ManifestPayloadMemberPayloadData
Example (OutputUsage) 
package main

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

func main() {
	var union types.ManifestPayload
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ManifestPayloadMemberPayloadData:
		_ = 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 ManifestPayloadMemberPayloadData 

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

The application manifest.

type NetworkConnectionStatus 

type NetworkConnectionStatus string
const (
	NetworkConnectionStatusConnected    NetworkConnectionStatus = "CONNECTED"
	NetworkConnectionStatusNotConnected NetworkConnectionStatus = "NOT_CONNECTED"
	NetworkConnectionStatusConnecting   NetworkConnectionStatus = "CONNECTING"
)

Enum values for NetworkConnectionStatus

func (NetworkConnectionStatus) Values 

func (NetworkConnectionStatus) Values() []NetworkConnectionStatus

Values returns all known values for NetworkConnectionStatus. 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 NetworkPayload 

type NetworkPayload struct {

	// Settings for Ethernet port 0.
	Ethernet0 *EthernetPayload

	// Settings for Ethernet port 1.
	Ethernet1 *EthernetPayload

	// Network time protocol (NTP) server settings.
	Ntp *NtpPayload
	// contains filtered or unexported fields
}

The network configuration for a device.

type NetworkStatus 

type NetworkStatus struct {

	// The status of Ethernet port 0.
	Ethernet0Status *EthernetStatus

	// The status of Ethernet port 1.
	Ethernet1Status *EthernetStatus

	// When the network status changed.
	LastUpdatedTime *time.Time

	// Details about a network time protocol (NTP) server connection.
	NtpStatus *NtpStatus
	// contains filtered or unexported fields
}

The network status of a device.

type Node 

type Node struct {

	// The node's category.
	//
	// This member is required.
	Category NodeCategory

	// When the node was created.
	//
	// This member is required.
	CreatedTime *time.Time

	// The node's name.
	//
	// This member is required.
	Name *string

	// The node's ID.
	//
	// This member is required.
	NodeId *string

	// The node's package ID.
	//
	// This member is required.
	PackageId *string

	// The node's package name.
	//
	// This member is required.
	PackageName *string

	// The node's package version.
	//
	// This member is required.
	PackageVersion *string

	// The node's patch version.
	//
	// This member is required.
	PatchVersion *string

	// The node's description.
	Description *string

	// The account ID of the node's owner.
	OwnerAccount *string

	// The node's ARN.
	PackageArn *string
	// contains filtered or unexported fields
}

An application node that represents a camera stream, a model, code, or output.

type NodeCategory 

type NodeCategory string
const (
	NodeCategoryBusinessLogic NodeCategory = "BUSINESS_LOGIC"
	NodeCategoryMlModel       NodeCategory = "ML_MODEL"
	NodeCategoryMediaSource   NodeCategory = "MEDIA_SOURCE"
	NodeCategoryMediaSink     NodeCategory = "MEDIA_SINK"
)

Enum values for NodeCategory

func (NodeCategory) Values 

func (NodeCategory) Values() []NodeCategory

Values returns all known values for NodeCategory. 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 NodeFromTemplateJob 

type NodeFromTemplateJob struct {

	// When the job was created.
	CreatedTime *time.Time

	// The job's ID.
	JobId *string

	// The node's name.
	NodeName *string

	// The job's status.
	Status NodeFromTemplateJobStatus

	// The job's status message.
	StatusMessage *string

	// The job's template type.
	TemplateType TemplateType
	// contains filtered or unexported fields
}

A job to create a camera stream node.

type NodeFromTemplateJobStatus 

type NodeFromTemplateJobStatus string
const (
	NodeFromTemplateJobStatusPending   NodeFromTemplateJobStatus = "PENDING"
	NodeFromTemplateJobStatusSucceeded NodeFromTemplateJobStatus = "SUCCEEDED"
	NodeFromTemplateJobStatusFailed    NodeFromTemplateJobStatus = "FAILED"
)

Enum values for NodeFromTemplateJobStatus

func (NodeFromTemplateJobStatus) Values 

func (NodeFromTemplateJobStatus) Values() []NodeFromTemplateJobStatus

Values returns all known values for NodeFromTemplateJobStatus. 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 NodeInputPort 

type NodeInputPort struct {

	// The input port's default value.
	DefaultValue *string

	// The input port's description.
	Description *string

	// The input port's max connections.
	MaxConnections int32

	// The input port's name.
	Name *string

	// The input port's type.
	Type PortType
	// contains filtered or unexported fields
}

A node input port.

type NodeInstance 

type NodeInstance struct {

	// The instance's current status.
	//
	// This member is required.
	CurrentStatus NodeInstanceStatus

	// The instance's ID.
	//
	// This member is required.
	NodeInstanceId *string

	// The node's ID.
	NodeId *string

	// The instance's name.
	NodeName *string

	// The instance's package name.
	PackageName *string

	// The instance's package patch version.
	PackagePatchVersion *string

	// The instance's package version.
	PackageVersion *string
	// contains filtered or unexported fields
}

A node instance.

type NodeInstanceStatus 

type NodeInstanceStatus string
const (
	NodeInstanceStatusRunning      NodeInstanceStatus = "RUNNING"
	NodeInstanceStatusError        NodeInstanceStatus = "ERROR"
	NodeInstanceStatusNotAvailable NodeInstanceStatus = "NOT_AVAILABLE"
	NodeInstanceStatusPaused       NodeInstanceStatus = "PAUSED"
)

Enum values for NodeInstanceStatus

func (NodeInstanceStatus) Values 

func (NodeInstanceStatus) Values() []NodeInstanceStatus

Values returns all known values for NodeInstanceStatus. 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 NodeInterface 

type NodeInterface struct {

	// The node interface's inputs.
	//
	// This member is required.
	Inputs []NodeInputPort

	// The node interface's outputs.
	//
	// This member is required.
	Outputs []NodeOutputPort
	// contains filtered or unexported fields
}

A node interface.

type NodeOutputPort 

type NodeOutputPort struct {

	// The output port's description.
	Description *string

	// The output port's name.
	Name *string

	// The output port's type.
	Type PortType
	// contains filtered or unexported fields
}

A node output port.

type NodeSignal added in v1.9.0 

type NodeSignal struct {

	// The camera node's name, from the application manifest.
	//
	// This member is required.
	NodeInstanceId *string

	// The signal value.
	//
	// This member is required.
	Signal NodeSignalValue
	// contains filtered or unexported fields
}

A signal to a camera node to start or stop processing video.

type NodeSignalValue added in v1.9.0 

type NodeSignalValue string
const (
	NodeSignalValuePause  NodeSignalValue = "PAUSE"
	NodeSignalValueResume NodeSignalValue = "RESUME"
)

Enum values for NodeSignalValue

func (NodeSignalValue) Values added in v1.9.0 

func (NodeSignalValue) Values() []NodeSignalValue

Values returns all known values for NodeSignalValue. 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 NtpPayload added in v1.6.0 

type NtpPayload struct {

	// NTP servers to use, in order of preference.
	//
	// This member is required.
	NtpServers []string
	// contains filtered or unexported fields
}

Network time protocol (NTP) server settings. Use this option to connect to local NTP servers instead of pool.ntp.org .

type NtpStatus added in v1.6.0 

type NtpStatus struct {

	// The connection's status.
	ConnectionStatus NetworkConnectionStatus

	// The IP address of the server.
	IpAddress *string

	// The domain name of the server.
	NtpServerName *string
	// contains filtered or unexported fields
}

Details about an NTP server connection.

type OTAJobConfig 

type OTAJobConfig struct {

	// The target version of the device software.
	//
	// This member is required.
	ImageVersion *string

	// Whether to apply the update if it is a major version change.
	AllowMajorVersionUpdate bool
	// contains filtered or unexported fields
}

An over-the-air update (OTA) job configuration.

type OutPutS3Location 

type OutPutS3Location struct {

	// The object's bucket.
	//
	// This member is required.
	BucketName *string

	// The object's key.
	//
	// This member is required.
	ObjectKey *string
	// contains filtered or unexported fields
}

The location of an output object in Amazon S3.

type PackageImportJob 

type PackageImportJob struct {

	// When the job was created.
	CreatedTime *time.Time

	// The job's ID.
	JobId *string

	// The job's type.
	JobType PackageImportJobType

	// When the job was updated.
	LastUpdatedTime *time.Time

	// The job's status.
	Status PackageImportJobStatus

	// The job's status message.
	StatusMessage *string
	// contains filtered or unexported fields
}

A job to import a package version.

type PackageImportJobInputConfig 

type PackageImportJobInputConfig struct {

	// The package version's input configuration.
	PackageVersionInputConfig *PackageVersionInputConfig
	// contains filtered or unexported fields
}

A configuration for a package import job.

type PackageImportJobOutput 

type PackageImportJobOutput struct {

	// The package's output location.
	//
	// This member is required.
	OutputS3Location *OutPutS3Location

	// The package's ID.
	//
	// This member is required.
	PackageId *string

	// The package's version.
	//
	// This member is required.
	PackageVersion *string

	// The package's patch version.
	//
	// This member is required.
	PatchVersion *string
	// contains filtered or unexported fields
}

Results of a package import job.

type PackageImportJobOutputConfig 

type PackageImportJobOutputConfig struct {

	// The package version's output configuration.
	PackageVersionOutputConfig *PackageVersionOutputConfig
	// contains filtered or unexported fields
}

An output configuration for a package import job.

type PackageImportJobStatus 

type PackageImportJobStatus string
const (
	PackageImportJobStatusPending   PackageImportJobStatus = "PENDING"
	PackageImportJobStatusSucceeded PackageImportJobStatus = "SUCCEEDED"
	PackageImportJobStatusFailed    PackageImportJobStatus = "FAILED"
)

Enum values for PackageImportJobStatus

func (PackageImportJobStatus) Values 

func (PackageImportJobStatus) Values() []PackageImportJobStatus

Values returns all known values for PackageImportJobStatus. 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 PackageImportJobType 

type PackageImportJobType string
const (
	PackageImportJobTypeNodePackageVersion            PackageImportJobType = "NODE_PACKAGE_VERSION"
	PackageImportJobTypeMarketplaceNodePackageVersion PackageImportJobType = "MARKETPLACE_NODE_PACKAGE_VERSION"
)

Enum values for PackageImportJobType

func (PackageImportJobType) Values 

func (PackageImportJobType) Values() []PackageImportJobType

Values returns all known values for PackageImportJobType. 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 PackageListItem 

type PackageListItem struct {

	// The package's ARN.
	Arn *string

	// When the package was created.
	CreatedTime *time.Time

	// The package's ID.
	PackageId *string

	// The package's name.
	PackageName *string

	// The package's tags.
	Tags map[string]string
	// contains filtered or unexported fields
}

A package summary.

type PackageObject 

type PackageObject struct {

	// The object's name.
	//
	// This member is required.
	Name *string

	// The object's package version.
	//
	// This member is required.
	PackageVersion *string

	// The object's patch version.
	//
	// This member is required.
	PatchVersion *string
	// contains filtered or unexported fields
}

A package object.

type PackageVersionInputConfig 

type PackageVersionInputConfig struct {

	// A location in Amazon S3.
	//
	// This member is required.
	S3Location *S3Location
	// contains filtered or unexported fields
}

A package version input configuration.

type PackageVersionOutputConfig 

type PackageVersionOutputConfig struct {

	// The output's package name.
	//
	// This member is required.
	PackageName *string

	// The output's package version.
	//
	// This member is required.
	PackageVersion *string

	// Indicates that the version is recommended for all users.
	MarkLatest bool
	// contains filtered or unexported fields
}

A package version output configuration.

type PackageVersionStatus 

type PackageVersionStatus string
const (
	PackageVersionStatusRegisterPending   PackageVersionStatus = "REGISTER_PENDING"
	PackageVersionStatusRegisterCompleted PackageVersionStatus = "REGISTER_COMPLETED"
	PackageVersionStatusFailed            PackageVersionStatus = "FAILED"
	PackageVersionStatusDeleting          PackageVersionStatus = "DELETING"
)

Enum values for PackageVersionStatus

func (PackageVersionStatus) Values 

func (PackageVersionStatus) Values() []PackageVersionStatus

Values returns all known values for PackageVersionStatus. 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 PortType 

type PortType string
const (
	PortTypeBoolean PortType = "BOOLEAN"
	PortTypeString  PortType = "STRING"
	PortTypeInt32   PortType = "INT32"
	PortTypeFloat32 PortType = "FLOAT32"
	PortTypeMedia   PortType = "MEDIA"
)

Enum values for PortType

func (PortType) Values 

func (PortType) Values() []PortType

Values returns all known values for PortType. 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 ReportedRuntimeContextState added in v1.9.0 

type ReportedRuntimeContextState struct {

	// The application's desired state.
	//
	// This member is required.
	DesiredState DesiredState

	// The application's reported status.
	//
	// This member is required.
	DeviceReportedStatus DeviceReportedStatus

	// When the device reported the application's state.
	//
	// This member is required.
	DeviceReportedTime *time.Time

	// The device's name.
	//
	// This member is required.
	RuntimeContextName *string
	// contains filtered or unexported fields
}

An application instance's state.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

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

The target resource was not 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 S3Location 

type S3Location struct {

	// A bucket name.
	//
	// This member is required.
	BucketName *string

	// An object key.
	//
	// This member is required.
	ObjectKey *string

	// The bucket's Region.
	Region *string
	// contains filtered or unexported fields
}

A location in Amazon S3.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

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

The request would cause a limit to be exceeded.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

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

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SortOrder added in v1.8.0 

type SortOrder string
const (
	SortOrderAscending  SortOrder = "ASCENDING"
	SortOrderDescending SortOrder = "DESCENDING"
)

Enum values for SortOrder

func (SortOrder) Values added in v1.8.0 

func (SortOrder) Values() []SortOrder

Values returns all known values for SortOrder. 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 StaticIpConnectionInfo 

type StaticIpConnectionInfo struct {

	// The connection's default gateway.
	//
	// This member is required.
	DefaultGateway *string

	// The connection's DNS address.
	//
	// This member is required.
	Dns []string

	// The connection's IP address.
	//
	// This member is required.
	IpAddress *string

	// The connection's DNS mask.
	//
	// This member is required.
	Mask *string
	// contains filtered or unexported fields
}

A static IP configuration.

type StatusFilter 

type StatusFilter string
const (
	StatusFilterDeploymentSucceeded  StatusFilter = "DEPLOYMENT_SUCCEEDED"
	StatusFilterDeploymentError      StatusFilter = "DEPLOYMENT_ERROR"
	StatusFilterRemovalSucceeded     StatusFilter = "REMOVAL_SUCCEEDED"
	StatusFilterRemovalFailed        StatusFilter = "REMOVAL_FAILED"
	StatusFilterProcessingDeployment StatusFilter = "PROCESSING_DEPLOYMENT"
	StatusFilterProcessingRemoval    StatusFilter = "PROCESSING_REMOVAL"
	StatusFilterDeploymentFailed     StatusFilter = "DEPLOYMENT_FAILED"
)

Enum values for StatusFilter

func (StatusFilter) Values 

func (StatusFilter) Values() []StatusFilter

Values returns all known values for StatusFilter. 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 StorageLocation 

type StorageLocation struct {

	// The location's binary prefix.
	//
	// This member is required.
	BinaryPrefixLocation *string

	// The location's bucket.
	//
	// This member is required.
	Bucket *string

	// The location's generated prefix.
	//
	// This member is required.
	GeneratedPrefixLocation *string

	// The location's manifest prefix.
	//
	// This member is required.
	ManifestPrefixLocation *string

	// The location's repo prefix.
	//
	// This member is required.
	RepoPrefixLocation *string
	// contains filtered or unexported fields
}

A storage location.

type TemplateType 

type TemplateType string
const (
	TemplateTypeRtspCameraStream TemplateType = "RTSP_CAMERA_STREAM"
)

Enum values for TemplateType

func (TemplateType) Values 

func (TemplateType) Values() []TemplateType

Values returns all known values for TemplateType. 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 UpdateProgress 

type UpdateProgress string
const (
	UpdateProgressPending     UpdateProgress = "PENDING"
	UpdateProgressInProgress  UpdateProgress = "IN_PROGRESS"
	UpdateProgressVerifying   UpdateProgress = "VERIFYING"
	UpdateProgressRebooting   UpdateProgress = "REBOOTING"
	UpdateProgressDownloading UpdateProgress = "DOWNLOADING"
	UpdateProgressCompleted   UpdateProgress = "COMPLETED"
	UpdateProgressFailed      UpdateProgress = "FAILED"
)

Enum values for UpdateProgress

func (UpdateProgress) Values 

func (UpdateProgress) Values() []UpdateProgress

Values returns all known values for UpdateProgress. 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 ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason         ValidationExceptionReason
	ErrorId        *string
	ErrorArguments []ValidationExceptionErrorArgument
	Fields         []ValidationExceptionField
	// contains filtered or unexported fields
}

The request contains an invalid parameter value.

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 ValidationExceptionErrorArgument 

type ValidationExceptionErrorArgument struct {

	// The argument's name.
	//
	// This member is required.
	Name *string

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

A validation exception error argument.

type ValidationExceptionField 

type ValidationExceptionField struct {

	// The field's message.
	//
	// This member is required.
	Message *string

	// The field's name.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

A validation exception field.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UNKNOWN_OPERATION"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "CANNOT_PARSE"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	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.

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.