types

package
v1.9.5 Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2023 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 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 AttachmentStatus 

type AttachmentStatus string
const (
	AttachmentStatusAttaching AttachmentStatus = "ATTACHING"
	AttachmentStatusAttached  AttachmentStatus = "ATTACHED"
	AttachmentStatusDetaching AttachmentStatus = "DETACHING"
	AttachmentStatusDetached  AttachmentStatus = "DETACHED"
)

Enum values for AttachmentStatus

func (AttachmentStatus) Values 

func (AttachmentStatus) Values() []AttachmentStatus

Values returns all known values for AttachmentStatus. 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 Capacity 

type Capacity struct {

	// The amount of capacity available for use on the device.
	Available *int64

	// The name of the type of capacity, such as memory.
	Name *string

	// The total capacity on the device.
	Total *int64

	// The unit of measure for the type of capacity.
	Unit *string

	// The amount of capacity used on the device.
	Used *int64
	// contains filtered or unexported fields
}

The physical capacity of the Amazon Web Services Snow Family device.

type Command 

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

The command given to the device to execute.

The following types satisfy this interface: 

CommandMemberReboot
CommandMemberUnlock
Example (OutputUsage) 
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

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

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

	case *types.CommandMemberUnlock:
		_ = v.Value // Value is types.Unlock

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

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

	}
}

var _ *types.Reboot
var _ *types.Unlock

Output:

type CommandMemberReboot 

type CommandMemberReboot struct {
	Value Reboot
	// contains filtered or unexported fields
}

Reboots the device.

type CommandMemberUnlock 

type CommandMemberUnlock struct {
	Value Unlock
	// contains filtered or unexported fields
}

Unlocks the device.

type CpuOptions 

type CpuOptions struct {

	// The number of cores that the CPU can use.
	CoreCount *int32

	// The number of threads per core in the CPU.
	ThreadsPerCore *int32
	// contains filtered or unexported fields
}

The options for how a device's CPU is configured.

type DeviceSummary 

type DeviceSummary struct {

	// The ID of the job used to order the device.
	AssociatedWithJob *string

	// The Amazon Resource Name (ARN) of the device.
	ManagedDeviceArn *string

	// The ID of the device.
	ManagedDeviceId *string

	// Optional metadata that you assign to a resource. You can use tags to categorize
	// a resource in different ways, such as by purpose, owner, or environment.
	Tags map[string]string
	// contains filtered or unexported fields
}

Identifying information about the device.

type EbsInstanceBlockDevice 

type EbsInstanceBlockDevice struct {

	// When the attachment was initiated.
	AttachTime *time.Time

	// A value that indicates whether the volume is deleted on instance termination.
	DeleteOnTermination *bool

	// The attachment state.
	Status AttachmentStatus

	// The ID of the Amazon EBS volume.
	VolumeId *string
	// contains filtered or unexported fields
}

Describes a parameter used to set up an Amazon Elastic Block Store (Amazon EBS) volume in a block device mapping.

type ExecutionState 

type ExecutionState string
const (
	ExecutionStateQueued     ExecutionState = "QUEUED"
	ExecutionStateInProgress ExecutionState = "IN_PROGRESS"
	ExecutionStateCanceled   ExecutionState = "CANCELED"
	ExecutionStateFailed     ExecutionState = "FAILED"
	ExecutionStateSucceeded  ExecutionState = "SUCCEEDED"
	ExecutionStateRejected   ExecutionState = "REJECTED"
	ExecutionStateTimedOut   ExecutionState = "TIMED_OUT"
)

Enum values for ExecutionState

func (ExecutionState) Values 

func (ExecutionState) Values() []ExecutionState

Values returns all known values for ExecutionState. 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 ExecutionSummary 

type ExecutionSummary struct {

	// The ID of the execution.
	ExecutionId *string

	// The ID of the managed device that the task is being executed on.
	ManagedDeviceId *string

	// The state of the execution.
	State ExecutionState

	// The ID of the task.
	TaskId *string
	// contains filtered or unexported fields
}

The summary of a task execution on a specified device.

type Instance 

type Instance struct {

	// The Amazon Machine Image (AMI) launch index, which you can use to find this
	// instance in the launch group.
	AmiLaunchIndex *int32

	// Any block device mapping entries for the instance.
	BlockDeviceMappings []InstanceBlockDeviceMapping

	// The CPU options for the instance.
	CpuOptions *CpuOptions

	// When the instance was created.
	CreatedAt *time.Time

	// The ID of the AMI used to launch the instance.
	ImageId *string

	// The ID of the instance.
	InstanceId *string

	// The instance type.
	InstanceType *string

	// The private IPv4 address assigned to the instance.
	PrivateIpAddress *string

	// The public IPv4 address assigned to the instance.
	PublicIpAddress *string

	// The device name of the root device volume (for example, /dev/sda1).
	RootDeviceName *string

	// The security groups for the instance.
	SecurityGroups []SecurityGroupIdentifier

	// The description of the current state of an instance.
	State *InstanceState

	// When the instance was last updated.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

The description of an instance. Currently, Amazon EC2 instances are the only supported instance type.

type InstanceBlockDeviceMapping 

type InstanceBlockDeviceMapping struct {

	// The block device name.
	DeviceName *string

	// The parameters used to automatically set up Amazon Elastic Block Store (Amazon
	// EBS) volumes when the instance is launched.
	Ebs *EbsInstanceBlockDevice
	// contains filtered or unexported fields
}

The description of a block device mapping.

type InstanceState 

type InstanceState struct {

	// The state of the instance as a 16-bit unsigned integer. The high byte is all of
	// the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and
	// 65,535. These numerical values are used for internal purposes and should be
	// ignored. The low byte is all of the bits between 2^0 and (2^8)-1, which equals
	// decimal values between 0 and 255. The valid values for the instance state code
	// are all in the range of the low byte. These values are:
	//
	// * 0 : pending
	//
	// * 16 :
	// running
	//
	// * 32 : shutting-down
	//
	// * 48 : terminated
	//
	// * 64 : stopping
	//
	// * 80 :
	// stopped
	//
	// You can ignore the high byte value by zeroing out all of the bits above
	// 2^8 or 256 in decimal.
	Code *int32

	// The current state of the instance.
	Name InstanceStateName
	// contains filtered or unexported fields
}

The description of the current state of an instance.

type InstanceStateName 

type InstanceStateName string
const (
	InstanceStateNamePending      InstanceStateName = "PENDING"
	InstanceStateNameRunning      InstanceStateName = "RUNNING"
	InstanceStateNameShuttingDown InstanceStateName = "SHUTTING_DOWN"
	InstanceStateNameTerminated   InstanceStateName = "TERMINATED"
	InstanceStateNameStopping     InstanceStateName = "STOPPING"
	InstanceStateNameStopped      InstanceStateName = "STOPPED"
)

Enum values for InstanceStateName

func (InstanceStateName) Values 

func (InstanceStateName) Values() []InstanceStateName

Values returns all known values for InstanceStateName. 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 InstanceSummary 

type InstanceSummary struct {

	// A structure containing details about the instance.
	Instance *Instance

	// When the instance summary was last updated.
	LastUpdatedAt *time.Time
	// contains filtered or unexported fields
}

The details about the instance.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An unexpected error occurred while processing the request.

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 IpAddressAssignment 

type IpAddressAssignment string
const (
	IpAddressAssignmentDhcp   IpAddressAssignment = "DHCP"
	IpAddressAssignmentStatic IpAddressAssignment = "STATIC"
)

Enum values for IpAddressAssignment

func (IpAddressAssignment) Values 

func (IpAddressAssignment) Values() []IpAddressAssignment

Values returns all known values for IpAddressAssignment. 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 PhysicalConnectorType 

type PhysicalConnectorType string
const (
	PhysicalConnectorTypeRj45    PhysicalConnectorType = "RJ45"
	PhysicalConnectorTypeSfpPlus PhysicalConnectorType = "SFP_PLUS"
	PhysicalConnectorTypeQsfp    PhysicalConnectorType = "QSFP"
	PhysicalConnectorTypeRj452   PhysicalConnectorType = "RJ45_2"
	PhysicalConnectorTypeWifi    PhysicalConnectorType = "WIFI"
)

Enum values for PhysicalConnectorType

func (PhysicalConnectorType) Values 

func (PhysicalConnectorType) Values() []PhysicalConnectorType

Values returns all known values for PhysicalConnectorType. 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 PhysicalNetworkInterface 

type PhysicalNetworkInterface struct {

	// The default gateway of the device.
	DefaultGateway *string

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

	// A value that describes whether the IP address is dynamic or persistent.
	IpAddressAssignment IpAddressAssignment

	// The MAC address of the device.
	MacAddress *string

	// The netmask used to divide the IP address into subnets.
	Netmask *string

	// The physical connector type.
	PhysicalConnectorType PhysicalConnectorType

	// The physical network interface ID.
	PhysicalNetworkInterfaceId *string
	// contains filtered or unexported fields
}

The details about the physical network interface for the device.

type Reboot 

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

A structure used to reboot the device.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request references a resource that 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 ResourceSummary 

type ResourceSummary struct {

	// The resource type.
	//
	// This member is required.
	ResourceType *string

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

	// The ID of the resource.
	Id *string
	// contains filtered or unexported fields
}

A summary of a resource available on the device.

type SecurityGroupIdentifier 

type SecurityGroupIdentifier struct {

	// The security group ID.
	GroupId *string

	// The security group name.
	GroupName *string
	// contains filtered or unexported fields
}

Information about the device's security group.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request would cause a service quota 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 SoftwareInformation 

type SoftwareInformation struct {

	// The state of the software that is installed or that is being installed on the
	// device.
	InstallState *string

	// The version of the software currently installed on the device.
	InstalledVersion *string

	// The version of the software being installed on the device.
	InstallingVersion *string
	// contains filtered or unexported fields
}

Information about the software on the device.

type TaskState 

type TaskState string
const (
	TaskStateInProgress TaskState = "IN_PROGRESS"
	TaskStateCanceled   TaskState = "CANCELED"
	TaskStateCompleted  TaskState = "COMPLETED"
)

Enum values for TaskState

func (TaskState) Values 

func (TaskState) Values() []TaskState

Values returns all known values for TaskState. 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 TaskSummary 

type TaskSummary struct {

	// The task ID.
	//
	// This member is required.
	TaskId *string

	// The state of the task assigned to one or many devices.
	State TaskState

	// Optional metadata that you assign to a resource. You can use tags to categorize
	// a resource in different ways, such as by purpose, owner, or environment.
	Tags map[string]string

	// The Amazon Resource Name (ARN) of the task.
	TaskArn *string
	// contains filtered or unexported fields
}

Information about the task assigned to one or many devices.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was denied due to request 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 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 Unlock 

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

A structure used to unlock a device.

type UnlockState 

type UnlockState string
const (
	UnlockStateUnlocked  UnlockState = "UNLOCKED"
	UnlockStateLocked    UnlockState = "LOCKED"
	UnlockStateUnlocking UnlockState = "UNLOCKING"
)

Enum values for UnlockState

func (UnlockState) Values 

func (UnlockState) Values() []UnlockState

Values returns all known values for UnlockState. 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
	// 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

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.