types

package
v1.8.2 Latest Latest
Warning

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

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

User does not have sufficient access 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 CartesianCoordinates 

type CartesianCoordinates struct {

	// X coordinate.
	//
	// This member is required.
	X *float64

	// Y coordinate.
	//
	// This member is required.
	Y *float64

	// Z coordinate.
	Z *float64
	// contains filtered or unexported fields
}

Cartesian coordinates in 3D space relative to the RoboRunner origin.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception thrown if a resource in a create request already exists.

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 Destination 

type Destination struct {

	// Destination ARN.
	//
	// This member is required.
	Arn *string

	// Timestamp at which the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// Filters access by the destination's identifier
	//
	// This member is required.
	Id *string

	// Human friendly name of the resource.
	//
	// This member is required.
	Name *string

	// Site ARN.
	//
	// This member is required.
	Site *string

	// State of the destination.
	//
	// This member is required.
	State DestinationState

	// Timestamp at which the resource was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// JSON document containing additional fixed properties regarding the destination
	AdditionalFixedProperties *string
	// contains filtered or unexported fields
}

Area within a facility where work can be performed.

type DestinationState 

type DestinationState string
const (
	DestinationStateEnabled        DestinationState = "ENABLED"
	DestinationStateDisabled       DestinationState = "DISABLED"
	DestinationStateDecommissioned DestinationState = "DECOMMISSIONED"
)

Enum values for DestinationState

func (DestinationState) Values 

func (DestinationState) Values() []DestinationState

Values returns all known values for DestinationState. 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 InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception thrown if something goes wrong within the service.

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 Orientation 

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

Worker orientation measured in units clockwise from north.

The following types satisfy this interface: 

OrientationMemberDegrees
Example (OutputUsage) 
package main

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

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

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

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

	}
}

Output:

type OrientationMemberDegrees 

type OrientationMemberDegrees struct {
	Value float64
	// contains filtered or unexported fields
}

Degrees, limited on [0, 360)

type PositionCoordinates 

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

Supported coordinates for worker position.

The following types satisfy this interface: 

PositionCoordinatesMemberCartesianCoordinates
Example (OutputUsage) 
package main

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

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

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

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

	}
}

Output:

type PositionCoordinatesMemberCartesianCoordinates 

type PositionCoordinatesMemberCartesianCoordinates struct {
	Value CartesianCoordinates
	// contains filtered or unexported fields
}

Cartesian coordinates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception thrown if a resource referenced in the request doesn't exist.

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 ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception thrown if the user's AWS account has reached a service limit and the operation cannot proceed.

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 Site 

type Site struct {

	// Site ARN.
	//
	// This member is required.
	Arn *string

	// A valid ISO 3166-1 alpha-2 code for the country in which the site resides.
	// e.g., US.
	//
	// This member is required.
	CountryCode *string

	// Timestamp at which the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The name of the site. Mutable after creation and unique within a given account.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Facility containing destinations, workers, activities, and tasks.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception thrown if the api has been called too quickly be the client.

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

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Exception thrown if an invalid parameter is provided to an API.

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 VendorProperties 

type VendorProperties struct {

	// The worker ID defined by the vendor FMS.
	//
	// This member is required.
	VendorWorkerId *string

	// JSON blob containing unstructured vendor properties that are fixed and won't
	// change during regular operation.
	VendorAdditionalFixedProperties *string

	// JSON blob containing unstructured vendor properties that are transient and may
	// change during regular operation.
	VendorAdditionalTransientProperties *string

	// The worker IP address defined by the vendor FMS.
	VendorWorkerIpAddress *string
	// contains filtered or unexported fields
}

Properties of the worker that are provided by the vendor FMS.

type Worker 

type Worker struct {

	// Full ARN of the worker.
	//
	// This member is required.
	Arn *string

	// Timestamp at which the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// Full ARN of the worker fleet.
	//
	// This member is required.
	Fleet *string

	// Filters access by the workers identifier
	//
	// This member is required.
	Id *string

	// Human friendly name of the resource.
	//
	// This member is required.
	Name *string

	// Site ARN.
	//
	// This member is required.
	Site *string

	// Timestamp at which the resource was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// JSON blob containing unstructured worker properties that are fixed and won't
	// change during regular operation.
	AdditionalFixedProperties *string

	// JSON blob containing unstructured worker properties that are transient and may
	// change during regular operation.
	AdditionalTransientProperties *string

	// Worker orientation measured in units clockwise from north.
	Orientation Orientation

	// Supported coordinates for worker position.
	Position PositionCoordinates

	// Properties of the worker that are provided by the vendor FMS.
	VendorProperties *VendorProperties
	// contains filtered or unexported fields
}

A unit capable of performing tasks.

type WorkerFleet 

type WorkerFleet struct {

	// Full ARN of the worker fleet.
	//
	// This member is required.
	Arn *string

	// Timestamp at which the resource was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// Filters access by the worker fleet's identifier
	//
	// This member is required.
	Id *string

	// Human friendly name of the resource.
	//
	// This member is required.
	Name *string

	// Site ARN.
	//
	// This member is required.
	Site *string

	// Timestamp at which the resource was last updated.
	//
	// This member is required.
	UpdatedAt *time.Time

	// JSON blob containing additional fixed properties regarding the worker fleet
	AdditionalFixedProperties *string
	// contains filtered or unexported fields
}

A collection of workers organized within a facility.

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.