snowdevicemanagement

package
v1.40.21 Latest Latest
Warning

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

 Go to latest Published: Aug 12, 2021 License: Apache-2.0 Imports: 10 Imported by: 11

Documentation

Overview

Package snowdevicemanagement provides the client and types for making API requests to AWS Snow Device Management.

Amazon Web Services Snow Device Management documentation.

See https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04 for more information on this service.

See snowdevicemanagement package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/snowdevicemanagement/

Using the Client

To contact AWS Snow Device Management with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Snow Device Management client SnowDeviceManagement for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/snowdevicemanagement/#New

Index

Constants

View Source 
const (
	// AttachmentStatusAttaching is a AttachmentStatus enum value
	AttachmentStatusAttaching = "ATTACHING"

	// AttachmentStatusAttached is a AttachmentStatus enum value
	AttachmentStatusAttached = "ATTACHED"

	// AttachmentStatusDetaching is a AttachmentStatus enum value
	AttachmentStatusDetaching = "DETACHING"

	// AttachmentStatusDetached is a AttachmentStatus enum value
	AttachmentStatusDetached = "DETACHED"
)
View Source 
const (
	// ExecutionStateQueued is a ExecutionState enum value
	ExecutionStateQueued = "QUEUED"

	// ExecutionStateInProgress is a ExecutionState enum value
	ExecutionStateInProgress = "IN_PROGRESS"

	// ExecutionStateCanceled is a ExecutionState enum value
	ExecutionStateCanceled = "CANCELED"

	// ExecutionStateFailed is a ExecutionState enum value
	ExecutionStateFailed = "FAILED"

	// ExecutionStateSucceeded is a ExecutionState enum value
	ExecutionStateSucceeded = "SUCCEEDED"

	// ExecutionStateRejected is a ExecutionState enum value
	ExecutionStateRejected = "REJECTED"

	// ExecutionStateTimedOut is a ExecutionState enum value
	ExecutionStateTimedOut = "TIMED_OUT"
)
View Source 
const (
	// InstanceStateNamePending is a InstanceStateName enum value
	InstanceStateNamePending = "PENDING"

	// InstanceStateNameRunning is a InstanceStateName enum value
	InstanceStateNameRunning = "RUNNING"

	// InstanceStateNameShuttingDown is a InstanceStateName enum value
	InstanceStateNameShuttingDown = "SHUTTING_DOWN"

	// InstanceStateNameTerminated is a InstanceStateName enum value
	InstanceStateNameTerminated = "TERMINATED"

	// InstanceStateNameStopping is a InstanceStateName enum value
	InstanceStateNameStopping = "STOPPING"

	// InstanceStateNameStopped is a InstanceStateName enum value
	InstanceStateNameStopped = "STOPPED"
)
View Source 
const (
	// IpAddressAssignmentDhcp is a IpAddressAssignment enum value
	IpAddressAssignmentDhcp = "DHCP"

	// IpAddressAssignmentStatic is a IpAddressAssignment enum value
	IpAddressAssignmentStatic = "STATIC"
)
View Source 
const (
	// PhysicalConnectorTypeRj45 is a PhysicalConnectorType enum value
	PhysicalConnectorTypeRj45 = "RJ45"

	// PhysicalConnectorTypeSfpPlus is a PhysicalConnectorType enum value
	PhysicalConnectorTypeSfpPlus = "SFP_PLUS"

	// PhysicalConnectorTypeQsfp is a PhysicalConnectorType enum value
	PhysicalConnectorTypeQsfp = "QSFP"

	// PhysicalConnectorTypeRj452 is a PhysicalConnectorType enum value
	PhysicalConnectorTypeRj452 = "RJ45_2"

	// PhysicalConnectorTypeWifi is a PhysicalConnectorType enum value
	PhysicalConnectorTypeWifi = "WIFI"
)
View Source 
const (
	// TaskStateInProgress is a TaskState enum value
	TaskStateInProgress = "IN_PROGRESS"

	// TaskStateCanceled is a TaskState enum value
	TaskStateCanceled = "CANCELED"

	// TaskStateCompleted is a TaskState enum value
	TaskStateCompleted = "COMPLETED"
)
View Source 
const (
	// UnlockStateUnlocked is a UnlockState enum value
	UnlockStateUnlocked = "UNLOCKED"

	// UnlockStateLocked is a UnlockState enum value
	UnlockStateLocked = "LOCKED"

	// UnlockStateUnlocking is a UnlockState enum value
	UnlockStateUnlocking = "UNLOCKING"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You don't have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// An unexpected error occurred while processing the request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The request references a resource that doesn't exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The request would cause a service quota to be exceeded.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The input fails to satisfy the constraints specified by an Amazon Web Services
	// service.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Snow Device Management" // Name of service.
	EndpointsID = "snow-device-management" // ID to lookup a service endpoint with.
	ServiceID   = "Snow Device Management" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AttachmentStatus_Values 

func AttachmentStatus_Values() []string

AttachmentStatus_Values returns all elements of the AttachmentStatus enum

func ExecutionState_Values 

func ExecutionState_Values() []string

ExecutionState_Values returns all elements of the ExecutionState enum

func InstanceStateName_Values 

func InstanceStateName_Values() []string

InstanceStateName_Values returns all elements of the InstanceStateName enum

func IpAddressAssignment_Values 

func IpAddressAssignment_Values() []string

IpAddressAssignment_Values returns all elements of the IpAddressAssignment enum

func PhysicalConnectorType_Values 

func PhysicalConnectorType_Values() []string

PhysicalConnectorType_Values returns all elements of the PhysicalConnectorType enum

func TaskState_Values 

func TaskState_Values() []string

TaskState_Values returns all elements of the TaskState enum

func UnlockState_Values 

func UnlockState_Values() []string

UnlockState_Values returns all elements of the UnlockState enum

Types

type AccessDeniedException 

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

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

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

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation

type CancelTaskInput 

type CancelTaskInput struct {

	// The ID of the task that you are attempting to cancel. You can retrieve a
	// task ID by using the ListTasks operation.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelTaskInput) GoString 

func (s CancelTaskInput) GoString() string

GoString returns the string representation

func (*CancelTaskInput) SetTaskId 

func (s *CancelTaskInput) SetTaskId(v string) *CancelTaskInput

SetTaskId sets the TaskId field's value.

func (CancelTaskInput) String 

func (s CancelTaskInput) String() string

String returns the string representation

func (*CancelTaskInput) Validate 

func (s *CancelTaskInput) Validate() error

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

type CancelTaskOutput 

type CancelTaskOutput struct {

	// The ID of the task that you are attempting to cancel.
	TaskId *string `locationName:"taskId" type:"string"`
	// contains filtered or unexported fields
}

func (CancelTaskOutput) GoString 

func (s CancelTaskOutput) GoString() string

GoString returns the string representation

func (*CancelTaskOutput) SetTaskId 

func (s *CancelTaskOutput) SetTaskId(v string) *CancelTaskOutput

SetTaskId sets the TaskId field's value.

func (CancelTaskOutput) String 

func (s CancelTaskOutput) String() string

String returns the string representation

type Capacity 

type Capacity struct {

	// The amount of capacity available for use on the device.
	Available *int64 `locationName:"available" type:"long"`

	// The name of the type of capacity, such as memory.
	Name *string `locationName:"name" type:"string"`

	// The total capacity on the device.
	Total *int64 `locationName:"total" type:"long"`

	// The unit of measure for the type of capacity.
	Unit *string `locationName:"unit" type:"string"`

	// The amount of capacity used on the device.
	Used *int64 `locationName:"used" type:"long"`
	// contains filtered or unexported fields
}

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

func (Capacity) GoString 

func (s Capacity) GoString() string

GoString returns the string representation

func (*Capacity) SetAvailable 

func (s *Capacity) SetAvailable(v int64) *Capacity

SetAvailable sets the Available field's value.

func (*Capacity) SetName 

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

SetName sets the Name field's value.

func (*Capacity) SetTotal 

func (s *Capacity) SetTotal(v int64) *Capacity

SetTotal sets the Total field's value.

func (*Capacity) SetUnit 

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

SetUnit sets the Unit field's value.

func (*Capacity) SetUsed 

func (s *Capacity) SetUsed(v int64) *Capacity

SetUsed sets the Used field's value.

func (Capacity) String 

func (s Capacity) String() string

String returns the string representation

type Command 

type Command struct {

	// Reboots the device.
	Reboot *Reboot `locationName:"reboot" type:"structure"`

	// Unlocks the device.
	Unlock *Unlock `locationName:"unlock" type:"structure"`
	// contains filtered or unexported fields
}

The command given to the device to execute.

func (Command) GoString 

func (s Command) GoString() string

GoString returns the string representation

func (*Command) SetReboot 

func (s *Command) SetReboot(v *Reboot) *Command

SetReboot sets the Reboot field's value.

func (*Command) SetUnlock 

func (s *Command) SetUnlock(v *Unlock) *Command

SetUnlock sets the Unlock field's value.

func (Command) String 

func (s Command) String() string

String returns the string representation

type CpuOptions 

type CpuOptions struct {

	// The number of cores that the CPU can use.
	CoreCount *int64 `locationName:"coreCount" type:"integer"`

	// The number of threads per core in the CPU.
	ThreadsPerCore *int64 `locationName:"threadsPerCore" type:"integer"`
	// contains filtered or unexported fields
}

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

func (CpuOptions) GoString 

func (s CpuOptions) GoString() string

GoString returns the string representation

func (*CpuOptions) SetCoreCount 

func (s *CpuOptions) SetCoreCount(v int64) *CpuOptions

SetCoreCount sets the CoreCount field's value.

func (*CpuOptions) SetThreadsPerCore 

func (s *CpuOptions) SetThreadsPerCore(v int64) *CpuOptions

SetThreadsPerCore sets the ThreadsPerCore field's value.

func (CpuOptions) String 

func (s CpuOptions) String() string

String returns the string representation

type CreateTaskInput 

type CreateTaskInput struct {

	// A token ensuring that the action is called only once with the specified details.
	ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"`

	// The task to be performed. Only one task is executed on a device at a time.
	//
	// Command is a required field
	Command *Command `locationName:"command" type:"structure" required:"true"`

	// A description of the task and its targets.
	Description *string `locationName:"description" min:"1" type:"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 `locationName:"tags" type:"map"`

	// A list of managed device IDs.
	//
	// Targets is a required field
	Targets []*string `locationName:"targets" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateTaskInput) GoString 

func (s CreateTaskInput) GoString() string

GoString returns the string representation

func (*CreateTaskInput) SetClientToken 

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

SetClientToken sets the ClientToken field's value.

func (*CreateTaskInput) SetCommand 

func (s *CreateTaskInput) SetCommand(v *Command) *CreateTaskInput

SetCommand sets the Command field's value.

func (*CreateTaskInput) SetDescription 

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

SetDescription sets the Description field's value.

func (*CreateTaskInput) SetTags 

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

SetTags sets the Tags field's value.

func (*CreateTaskInput) SetTargets 

func (s *CreateTaskInput) SetTargets(v []*string) *CreateTaskInput

SetTargets sets the Targets field's value.

func (CreateTaskInput) String 

func (s CreateTaskInput) String() string

String returns the string representation

func (*CreateTaskInput) Validate 

func (s *CreateTaskInput) Validate() error

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

type CreateTaskOutput 

type CreateTaskOutput struct {

	// The Amazon Resource Name (ARN) of the task that you created.
	TaskArn *string `locationName:"taskArn" type:"string"`

	// The ID of the task that you created.
	TaskId *string `locationName:"taskId" type:"string"`
	// contains filtered or unexported fields
}

func (CreateTaskOutput) GoString 

func (s CreateTaskOutput) GoString() string

GoString returns the string representation

func (*CreateTaskOutput) SetTaskArn 

func (s *CreateTaskOutput) SetTaskArn(v string) *CreateTaskOutput

SetTaskArn sets the TaskArn field's value.

func (*CreateTaskOutput) SetTaskId 

func (s *CreateTaskOutput) SetTaskId(v string) *CreateTaskOutput

SetTaskId sets the TaskId field's value.

func (CreateTaskOutput) String 

func (s CreateTaskOutput) String() string

String returns the string representation

type DescribeDeviceEc2InstancesInput 

type DescribeDeviceEc2InstancesInput struct {

	// A list of instance IDs associated with the managed device.
	//
	// InstanceIds is a required field
	InstanceIds []*string `locationName:"instanceIds" type:"list" required:"true"`

	// The ID of the managed device.
	//
	// ManagedDeviceId is a required field
	ManagedDeviceId *string `location:"uri" locationName:"managedDeviceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDeviceEc2InstancesInput) GoString 

func (s DescribeDeviceEc2InstancesInput) GoString() string

GoString returns the string representation

func (*DescribeDeviceEc2InstancesInput) SetInstanceIds 

func (s *DescribeDeviceEc2InstancesInput) SetInstanceIds(v []*string) *DescribeDeviceEc2InstancesInput

SetInstanceIds sets the InstanceIds field's value.

func (*DescribeDeviceEc2InstancesInput) SetManagedDeviceId 

func (s *DescribeDeviceEc2InstancesInput) SetManagedDeviceId(v string) *DescribeDeviceEc2InstancesInput

SetManagedDeviceId sets the ManagedDeviceId field's value.

func (DescribeDeviceEc2InstancesInput) String 

func (s DescribeDeviceEc2InstancesInput) String() string

String returns the string representation

func (*DescribeDeviceEc2InstancesInput) Validate 

func (s *DescribeDeviceEc2InstancesInput) Validate() error

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

type DescribeDeviceEc2InstancesOutput 

type DescribeDeviceEc2InstancesOutput struct {

	// A list of structures containing information about each instance.
	Instances []*InstanceSummary `locationName:"instances" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeDeviceEc2InstancesOutput) GoString 

func (s DescribeDeviceEc2InstancesOutput) GoString() string

GoString returns the string representation

func (*DescribeDeviceEc2InstancesOutput) SetInstances 

func (s *DescribeDeviceEc2InstancesOutput) SetInstances(v []*InstanceSummary) *DescribeDeviceEc2InstancesOutput

SetInstances sets the Instances field's value.

func (DescribeDeviceEc2InstancesOutput) String 

func (s DescribeDeviceEc2InstancesOutput) String() string

String returns the string representation

type DescribeDeviceInput 

type DescribeDeviceInput struct {

	// The ID of the device that you are checking the information of.
	//
	// ManagedDeviceId is a required field
	ManagedDeviceId *string `location:"uri" locationName:"managedDeviceId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeDeviceInput) GoString 

func (s DescribeDeviceInput) GoString() string

GoString returns the string representation

func (*DescribeDeviceInput) SetManagedDeviceId 

func (s *DescribeDeviceInput) SetManagedDeviceId(v string) *DescribeDeviceInput

SetManagedDeviceId sets the ManagedDeviceId field's value.

func (DescribeDeviceInput) String 

func (s DescribeDeviceInput) String() string

String returns the string representation

func (*DescribeDeviceInput) Validate 

func (s *DescribeDeviceInput) Validate() error

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

type DescribeDeviceOutput 

type DescribeDeviceOutput struct {

	// The ID of the job used when ordering the device.
	AssociatedWithJob *string `locationName:"associatedWithJob" type:"string"`

	// The hardware specifications of the device.
	DeviceCapacities []*Capacity `locationName:"deviceCapacities" type:"list"`

	// The current state of the device.
	DeviceState *string `locationName:"deviceState" type:"string" enum:"UnlockState"`

	// The type of Amazon Web Services Snow Family device.
	DeviceType *string `locationName:"deviceType" type:"string"`

	// When the device last contacted the Amazon Web Services Cloud. Indicates that
	// the device is online.
	LastReachedOutAt *time.Time `locationName:"lastReachedOutAt" type:"timestamp"`

	// When the device last pushed an update to the Amazon Web Services Cloud. Indicates
	// when the device cache was refreshed.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// The Amazon Resource Name (ARN) of the device.
	ManagedDeviceArn *string `locationName:"managedDeviceArn" type:"string"`

	// The ID of the device that you checked the information for.
	ManagedDeviceId *string `locationName:"managedDeviceId" min:"1" type:"string"`

	// The network interfaces available on the device.
	PhysicalNetworkInterfaces []*PhysicalNetworkInterface `locationName:"physicalNetworkInterfaces" type:"list"`

	// The software installed on the device.
	Software *SoftwareInformation `locationName:"software" type:"structure"`

	// 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 `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (DescribeDeviceOutput) GoString 

func (s DescribeDeviceOutput) GoString() string

GoString returns the string representation

func (*DescribeDeviceOutput) SetAssociatedWithJob 

func (s *DescribeDeviceOutput) SetAssociatedWithJob(v string) *DescribeDeviceOutput

SetAssociatedWithJob sets the AssociatedWithJob field's value.

func (*DescribeDeviceOutput) SetDeviceCapacities 

func (s *DescribeDeviceOutput) SetDeviceCapacities(v []*Capacity) *DescribeDeviceOutput

SetDeviceCapacities sets the DeviceCapacities field's value.

func (*DescribeDeviceOutput) SetDeviceState 

func (s *DescribeDeviceOutput) SetDeviceState(v string) *DescribeDeviceOutput

SetDeviceState sets the DeviceState field's value.

func (*DescribeDeviceOutput) SetDeviceType 

func (s *DescribeDeviceOutput) SetDeviceType(v string) *DescribeDeviceOutput

SetDeviceType sets the DeviceType field's value.

func (*DescribeDeviceOutput) SetLastReachedOutAt 

func (s *DescribeDeviceOutput) SetLastReachedOutAt(v time.Time) *DescribeDeviceOutput

SetLastReachedOutAt sets the LastReachedOutAt field's value.

func (*DescribeDeviceOutput) SetLastUpdatedAt 

func (s *DescribeDeviceOutput) SetLastUpdatedAt(v time.Time) *DescribeDeviceOutput

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*DescribeDeviceOutput) SetManagedDeviceArn 

func (s *DescribeDeviceOutput) SetManagedDeviceArn(v string) *DescribeDeviceOutput

SetManagedDeviceArn sets the ManagedDeviceArn field's value.

func (*DescribeDeviceOutput) SetManagedDeviceId 

func (s *DescribeDeviceOutput) SetManagedDeviceId(v string) *DescribeDeviceOutput

SetManagedDeviceId sets the ManagedDeviceId field's value.

func (*DescribeDeviceOutput) SetPhysicalNetworkInterfaces 

func (s *DescribeDeviceOutput) SetPhysicalNetworkInterfaces(v []*PhysicalNetworkInterface) *DescribeDeviceOutput

SetPhysicalNetworkInterfaces sets the PhysicalNetworkInterfaces field's value.

func (*DescribeDeviceOutput) SetSoftware 

func (s *DescribeDeviceOutput) SetSoftware(v *SoftwareInformation) *DescribeDeviceOutput

SetSoftware sets the Software field's value.

func (*DescribeDeviceOutput) SetTags 

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

SetTags sets the Tags field's value.

func (DescribeDeviceOutput) String 

func (s DescribeDeviceOutput) String() string

String returns the string representation

type DescribeExecutionInput 

type DescribeExecutionInput struct {

	// The ID of the managed device.
	//
	// ManagedDeviceId is a required field
	ManagedDeviceId *string `location:"uri" locationName:"managedDeviceId" min:"1" type:"string" required:"true"`

	// The ID of the task that the action is describing.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeExecutionInput) GoString 

func (s DescribeExecutionInput) GoString() string

GoString returns the string representation

func (*DescribeExecutionInput) SetManagedDeviceId 

func (s *DescribeExecutionInput) SetManagedDeviceId(v string) *DescribeExecutionInput

SetManagedDeviceId sets the ManagedDeviceId field's value.

func (*DescribeExecutionInput) SetTaskId 

func (s *DescribeExecutionInput) SetTaskId(v string) *DescribeExecutionInput

SetTaskId sets the TaskId field's value.

func (DescribeExecutionInput) String 

func (s DescribeExecutionInput) String() string

String returns the string representation

func (*DescribeExecutionInput) Validate 

func (s *DescribeExecutionInput) Validate() error

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

type DescribeExecutionOutput 

type DescribeExecutionOutput struct {

	// The ID of the execution.
	ExecutionId *string `locationName:"executionId" min:"1" type:"string"`

	// When the status of the execution was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// The ID of the managed device that the task is being executed on.
	ManagedDeviceId *string `locationName:"managedDeviceId" min:"1" type:"string"`

	// When the execution began.
	StartedAt *time.Time `locationName:"startedAt" type:"timestamp"`

	// The current state of the execution.
	State *string `locationName:"state" type:"string" enum:"ExecutionState"`

	// The ID of the task being executed on the device.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeExecutionOutput) GoString 

func (s DescribeExecutionOutput) GoString() string

GoString returns the string representation

func (*DescribeExecutionOutput) SetExecutionId 

func (s *DescribeExecutionOutput) SetExecutionId(v string) *DescribeExecutionOutput

SetExecutionId sets the ExecutionId field's value.

func (*DescribeExecutionOutput) SetLastUpdatedAt 

func (s *DescribeExecutionOutput) SetLastUpdatedAt(v time.Time) *DescribeExecutionOutput

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*DescribeExecutionOutput) SetManagedDeviceId 

func (s *DescribeExecutionOutput) SetManagedDeviceId(v string) *DescribeExecutionOutput

SetManagedDeviceId sets the ManagedDeviceId field's value.

func (*DescribeExecutionOutput) SetStartedAt 

func (s *DescribeExecutionOutput) SetStartedAt(v time.Time) *DescribeExecutionOutput

SetStartedAt sets the StartedAt field's value.

func (*DescribeExecutionOutput) SetState 

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

SetState sets the State field's value.

func (*DescribeExecutionOutput) SetTaskId 

func (s *DescribeExecutionOutput) SetTaskId(v string) *DescribeExecutionOutput

SetTaskId sets the TaskId field's value.

func (DescribeExecutionOutput) String 

func (s DescribeExecutionOutput) String() string

String returns the string representation

type DescribeTaskInput 

type DescribeTaskInput struct {

	// The ID of the task to be described.
	//
	// TaskId is a required field
	TaskId *string `location:"uri" locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeTaskInput) GoString 

func (s DescribeTaskInput) GoString() string

GoString returns the string representation

func (*DescribeTaskInput) SetTaskId 

func (s *DescribeTaskInput) SetTaskId(v string) *DescribeTaskInput

SetTaskId sets the TaskId field's value.

func (DescribeTaskInput) String 

func (s DescribeTaskInput) String() string

String returns the string representation

func (*DescribeTaskInput) Validate 

func (s *DescribeTaskInput) Validate() error

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

type DescribeTaskOutput 

type DescribeTaskOutput struct {

	// When the task was completed.
	CompletedAt *time.Time `locationName:"completedAt" type:"timestamp"`

	// When the CreateTask operation was called.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The description provided of the task and managed devices.
	Description *string `locationName:"description" min:"1" type:"string"`

	// When the state of the task was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`

	// The current state of the task.
	State *string `locationName:"state" type:"string" enum:"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 `locationName:"tags" type:"map"`

	// The managed devices that the task was sent to.
	Targets []*string `locationName:"targets" min:"1" type:"list"`

	// The Amazon Resource Name (ARN) of the task.
	TaskArn *string `locationName:"taskArn" type:"string"`

	// The ID of the task.
	TaskId *string `locationName:"taskId" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeTaskOutput) GoString 

func (s DescribeTaskOutput) GoString() string

GoString returns the string representation

func (*DescribeTaskOutput) SetCompletedAt 

func (s *DescribeTaskOutput) SetCompletedAt(v time.Time) *DescribeTaskOutput

SetCompletedAt sets the CompletedAt field's value.

func (*DescribeTaskOutput) SetCreatedAt 

func (s *DescribeTaskOutput) SetCreatedAt(v time.Time) *DescribeTaskOutput

SetCreatedAt sets the CreatedAt field's value.

func (*DescribeTaskOutput) SetDescription 

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

SetDescription sets the Description field's value.

func (*DescribeTaskOutput) SetLastUpdatedAt 

func (s *DescribeTaskOutput) SetLastUpdatedAt(v time.Time) *DescribeTaskOutput

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (*DescribeTaskOutput) SetState 

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

SetState sets the State field's value.

func (*DescribeTaskOutput) SetTags 

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

SetTags sets the Tags field's value.

func (*DescribeTaskOutput) SetTargets 

func (s *DescribeTaskOutput) SetTargets(v []*string) *DescribeTaskOutput

SetTargets sets the Targets field's value.

func (*DescribeTaskOutput) SetTaskArn 

func (s *DescribeTaskOutput) SetTaskArn(v string) *DescribeTaskOutput

SetTaskArn sets the TaskArn field's value.

func (*DescribeTaskOutput) SetTaskId 

func (s *DescribeTaskOutput) SetTaskId(v string) *DescribeTaskOutput

SetTaskId sets the TaskId field's value.

func (DescribeTaskOutput) String 

func (s DescribeTaskOutput) String() string

String returns the string representation

type DeviceSummary 

type DeviceSummary struct {

	// The ID of the job used to order the device.
	AssociatedWithJob *string `locationName:"associatedWithJob" type:"string"`

	// The Amazon Resource Name (ARN) of the device.
	ManagedDeviceArn *string `locationName:"managedDeviceArn" type:"string"`

	// The ID of the device.
	ManagedDeviceId *string `locationName:"managedDeviceId" min:"1" type:"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 `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

Identifying information about the device.

func (DeviceSummary) GoString 

func (s DeviceSummary) GoString() string

GoString returns the string representation

func (*DeviceSummary) SetAssociatedWithJob 

func (s *DeviceSummary) SetAssociatedWithJob(v string) *DeviceSummary

SetAssociatedWithJob sets the AssociatedWithJob field's value.

func (*DeviceSummary) SetManagedDeviceArn 

func (s *DeviceSummary) SetManagedDeviceArn(v string) *DeviceSummary

SetManagedDeviceArn sets the ManagedDeviceArn field's value.

func (*DeviceSummary) SetManagedDeviceId 

func (s *DeviceSummary) SetManagedDeviceId(v string) *DeviceSummary

SetManagedDeviceId sets the ManagedDeviceId field's value.

func (*DeviceSummary) SetTags 

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

SetTags sets the Tags field's value.

func (DeviceSummary) String 

func (s DeviceSummary) String() string

String returns the string representation

type EbsInstanceBlockDevice 

type EbsInstanceBlockDevice struct {

	// When the attachment was initiated.
	AttachTime *time.Time `locationName:"attachTime" type:"timestamp"`

	// A value that indicates whether the volume is deleted on instance termination.
	DeleteOnTermination *bool `locationName:"deleteOnTermination" type:"boolean"`

	// The attachment state.
	Status *string `locationName:"status" type:"string" enum:"AttachmentStatus"`

	// The ID of the Amazon EBS volume.
	VolumeId *string `locationName:"volumeId" type:"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.

func (EbsInstanceBlockDevice) GoString 

func (s EbsInstanceBlockDevice) GoString() string

GoString returns the string representation

func (*EbsInstanceBlockDevice) SetAttachTime 

func (s *EbsInstanceBlockDevice) SetAttachTime(v time.Time) *EbsInstanceBlockDevice

SetAttachTime sets the AttachTime field's value.

func (*EbsInstanceBlockDevice) SetDeleteOnTermination 

func (s *EbsInstanceBlockDevice) SetDeleteOnTermination(v bool) *EbsInstanceBlockDevice

SetDeleteOnTermination sets the DeleteOnTermination field's value.

func (*EbsInstanceBlockDevice) SetStatus 

func (s *EbsInstanceBlockDevice) SetStatus(v string) *EbsInstanceBlockDevice

SetStatus sets the Status field's value.

func (*EbsInstanceBlockDevice) SetVolumeId 

func (s *EbsInstanceBlockDevice) SetVolumeId(v string) *EbsInstanceBlockDevice

SetVolumeId sets the VolumeId field's value.

func (EbsInstanceBlockDevice) String 

func (s EbsInstanceBlockDevice) String() string

String returns the string representation

type ExecutionSummary 

type ExecutionSummary struct {

	// The ID of the execution.
	ExecutionId *string `locationName:"executionId" min:"1" type:"string"`

	// The ID of the managed device that the task is being executed on.
	ManagedDeviceId *string `locationName:"managedDeviceId" min:"1" type:"string"`

	// The state of the execution.
	State *string `locationName:"state" type:"string" enum:"ExecutionState"`

	// The ID of the task.
	TaskId *string `locationName:"taskId" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The summary of a task execution on a specified device.

func (ExecutionSummary) GoString 

func (s ExecutionSummary) GoString() string

GoString returns the string representation

func (*ExecutionSummary) SetExecutionId 

func (s *ExecutionSummary) SetExecutionId(v string) *ExecutionSummary

SetExecutionId sets the ExecutionId field's value.

func (*ExecutionSummary) SetManagedDeviceId 

func (s *ExecutionSummary) SetManagedDeviceId(v string) *ExecutionSummary

SetManagedDeviceId sets the ManagedDeviceId field's value.

func (*ExecutionSummary) SetState 

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

SetState sets the State field's value.

func (*ExecutionSummary) SetTaskId 

func (s *ExecutionSummary) SetTaskId(v string) *ExecutionSummary

SetTaskId sets the TaskId field's value.

func (ExecutionSummary) String 

func (s ExecutionSummary) String() string

String returns the string representation

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 *int64 `locationName:"amiLaunchIndex" type:"integer"`

	// Any block device mapping entries for the instance.
	BlockDeviceMappings []*InstanceBlockDeviceMapping `locationName:"blockDeviceMappings" type:"list"`

	// The CPU options for the instance.
	CpuOptions *CpuOptions `locationName:"cpuOptions" type:"structure"`

	// When the instance was created.
	CreatedAt *time.Time `locationName:"createdAt" type:"timestamp"`

	// The ID of the AMI used to launch the instance.
	ImageId *string `locationName:"imageId" type:"string"`

	// The ID of the instance.
	InstanceId *string `locationName:"instanceId" type:"string"`

	// The instance type.
	InstanceType *string `locationName:"instanceType" type:"string"`

	// The private IPv4 address assigned to the instance.
	PrivateIpAddress *string `locationName:"privateIpAddress" type:"string"`

	// The public IPv4 address assigned to the instance.
	PublicIpAddress *string `locationName:"publicIpAddress" type:"string"`

	// The device name of the root device volume (for example, /dev/sda1).
	RootDeviceName *string `locationName:"rootDeviceName" type:"string"`

	// The security groups for the instance.
	SecurityGroups []*SecurityGroupIdentifier `locationName:"securityGroups" type:"list"`

	// The description of the current state of an instance.
	State *InstanceState `locationName:"state" type:"structure"`

	// When the instance was last updated.
	UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

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

func (Instance) GoString 

func (s Instance) GoString() string

GoString returns the string representation

func (*Instance) SetAmiLaunchIndex 

func (s *Instance) SetAmiLaunchIndex(v int64) *Instance

SetAmiLaunchIndex sets the AmiLaunchIndex field's value.

func (*Instance) SetBlockDeviceMappings 

func (s *Instance) SetBlockDeviceMappings(v []*InstanceBlockDeviceMapping) *Instance

SetBlockDeviceMappings sets the BlockDeviceMappings field's value.

func (*Instance) SetCpuOptions 

func (s *Instance) SetCpuOptions(v *CpuOptions) *Instance

SetCpuOptions sets the CpuOptions field's value.

func (*Instance) SetCreatedAt 

func (s *Instance) SetCreatedAt(v time.Time) *Instance

SetCreatedAt sets the CreatedAt field's value.

func (*Instance) SetImageId 

func (s *Instance) SetImageId(v string) *Instance

SetImageId sets the ImageId field's value.

func (*Instance) SetInstanceId 

func (s *Instance) SetInstanceId(v string) *Instance

SetInstanceId sets the InstanceId field's value.

func (*Instance) SetInstanceType 

func (s *Instance) SetInstanceType(v string) *Instance

SetInstanceType sets the InstanceType field's value.

func (*Instance) SetPrivateIpAddress 

func (s *Instance) SetPrivateIpAddress(v string) *Instance

SetPrivateIpAddress sets the PrivateIpAddress field's value.

func (*Instance) SetPublicIpAddress 

func (s *Instance) SetPublicIpAddress(v string) *Instance

SetPublicIpAddress sets the PublicIpAddress field's value.

func (*Instance) SetRootDeviceName 

func (s *Instance) SetRootDeviceName(v string) *Instance

SetRootDeviceName sets the RootDeviceName field's value.

func (*Instance) SetSecurityGroups 

func (s *Instance) SetSecurityGroups(v []*SecurityGroupIdentifier) *Instance

SetSecurityGroups sets the SecurityGroups field's value.

func (*Instance) SetState 

func (s *Instance) SetState(v *InstanceState) *Instance

SetState sets the State field's value.

func (*Instance) SetUpdatedAt 

func (s *Instance) SetUpdatedAt(v time.Time) *Instance

SetUpdatedAt sets the UpdatedAt field's value.

func (Instance) String 

func (s Instance) String() string

String returns the string representation

type InstanceBlockDeviceMapping 

type InstanceBlockDeviceMapping struct {

	// The block device name.
	DeviceName *string `locationName:"deviceName" type:"string"`

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

The description of a block device mapping.

func (InstanceBlockDeviceMapping) GoString 

func (s InstanceBlockDeviceMapping) GoString() string

GoString returns the string representation

func (*InstanceBlockDeviceMapping) SetDeviceName 

func (s *InstanceBlockDeviceMapping) SetDeviceName(v string) *InstanceBlockDeviceMapping

SetDeviceName sets the DeviceName field's value.

func (*InstanceBlockDeviceMapping) SetEbs 

func (s *InstanceBlockDeviceMapping) SetEbs(v *EbsInstanceBlockDevice) *InstanceBlockDeviceMapping

SetEbs sets the Ebs field's value.

func (InstanceBlockDeviceMapping) String 

func (s InstanceBlockDeviceMapping) String() string

String returns the string representation

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 *int64 `locationName:"code" type:"integer"`

	// The current state of the instance.
	Name *string `locationName:"name" type:"string" enum:"InstanceStateName"`
	// contains filtered or unexported fields
}

The description of the current state of an instance.

func (InstanceState) GoString 

func (s InstanceState) GoString() string

GoString returns the string representation

func (*InstanceState) SetCode 

func (s *InstanceState) SetCode(v int64) *InstanceState

SetCode sets the Code field's value.

func (*InstanceState) SetName 

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

SetName sets the Name field's value.

func (InstanceState) String 

func (s InstanceState) String() string

String returns the string representation

type InstanceSummary 

type InstanceSummary struct {

	// A structure containing details about the instance.
	Instance *Instance `locationName:"instance" type:"structure"`

	// When the instance summary was last updated.
	LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp"`
	// contains filtered or unexported fields
}

The details about the instance.

func (InstanceSummary) GoString 

func (s InstanceSummary) GoString() string

GoString returns the string representation

func (*InstanceSummary) SetInstance 

func (s *InstanceSummary) SetInstance(v *Instance) *InstanceSummary

SetInstance sets the Instance field's value.

func (*InstanceSummary) SetLastUpdatedAt 

func (s *InstanceSummary) SetLastUpdatedAt(v time.Time) *InstanceSummary

SetLastUpdatedAt sets the LastUpdatedAt field's value.

func (InstanceSummary) String 

func (s InstanceSummary) String() string

String returns the string representation

type InternalServerException 

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

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

An unexpected error occurred while processing the request.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation

type ListDeviceResourcesInput 

type ListDeviceResourcesInput struct {

	// The ID of the managed device that you are listing the resources of.
	//
	// ManagedDeviceId is a required field
	ManagedDeviceId *string `location:"uri" locationName:"managedDeviceId" min:"1" type:"string" required:"true"`

	// The maximum number of resources per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A pagination token to continue to the next page of results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// A structure used to filter the results by type of resource.
	Type *string `location:"querystring" locationName:"type" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDeviceResourcesInput) GoString 

func (s ListDeviceResourcesInput) GoString() string

GoString returns the string representation

func (*ListDeviceResourcesInput) SetManagedDeviceId 

func (s *ListDeviceResourcesInput) SetManagedDeviceId(v string) *ListDeviceResourcesInput

SetManagedDeviceId sets the ManagedDeviceId field's value.

func (*ListDeviceResourcesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDeviceResourcesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListDeviceResourcesInput) SetType 

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

SetType sets the Type field's value.

func (ListDeviceResourcesInput) String 

func (s ListDeviceResourcesInput) String() string

String returns the string representation

func (*ListDeviceResourcesInput) Validate 

func (s *ListDeviceResourcesInput) Validate() error

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

type ListDeviceResourcesOutput 

type ListDeviceResourcesOutput struct {

	// A pagination token to continue to the next page of results.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A structure defining the resource's type, Amazon Resource Name (ARN), and
	// ID.
	Resources []*ResourceSummary `locationName:"resources" type:"list"`
	// contains filtered or unexported fields
}

func (ListDeviceResourcesOutput) GoString 

func (s ListDeviceResourcesOutput) GoString() string

GoString returns the string representation

func (*ListDeviceResourcesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListDeviceResourcesOutput) SetResources 

func (s *ListDeviceResourcesOutput) SetResources(v []*ResourceSummary) *ListDeviceResourcesOutput

SetResources sets the Resources field's value.

func (ListDeviceResourcesOutput) String 

func (s ListDeviceResourcesOutput) String() string

String returns the string representation

type ListDevicesInput 

type ListDevicesInput struct {

	// The ID of the job used to order the device.
	JobId *string `location:"querystring" locationName:"jobId" min:"1" type:"string"`

	// The maximum number of devices to list per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A pagination token to continue to the next page of results.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDevicesInput) GoString 

func (s ListDevicesInput) GoString() string

GoString returns the string representation

func (*ListDevicesInput) SetJobId 

func (s *ListDevicesInput) SetJobId(v string) *ListDevicesInput

SetJobId sets the JobId field's value.

func (*ListDevicesInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListDevicesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDevicesInput) String 

func (s ListDevicesInput) String() string

String returns the string representation

func (*ListDevicesInput) Validate 

func (s *ListDevicesInput) Validate() error

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

type ListDevicesOutput 

type ListDevicesOutput struct {

	// A list of device structures that contain information about the device.
	Devices []*DeviceSummary `locationName:"devices" type:"list"`

	// A pagination token to continue to the next page of devices.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListDevicesOutput) GoString 

func (s ListDevicesOutput) GoString() string

GoString returns the string representation

func (*ListDevicesOutput) SetDevices 

func (s *ListDevicesOutput) SetDevices(v []*DeviceSummary) *ListDevicesOutput

SetDevices sets the Devices field's value.

func (*ListDevicesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListDevicesOutput) String 

func (s ListDevicesOutput) String() string

String returns the string representation

type ListExecutionsInput 

type ListExecutionsInput struct {

	// The maximum number of tasks to list per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A pagination token to continue to the next page of tasks.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// A structure used to filter the tasks by their current state.
	State *string `location:"querystring" locationName:"state" type:"string" enum:"ExecutionState"`

	// The ID of the task.
	//
	// TaskId is a required field
	TaskId *string `location:"querystring" locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListExecutionsInput) GoString 

func (s ListExecutionsInput) GoString() string

GoString returns the string representation

func (*ListExecutionsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListExecutionsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListExecutionsInput) SetState 

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

SetState sets the State field's value.

func (*ListExecutionsInput) SetTaskId 

func (s *ListExecutionsInput) SetTaskId(v string) *ListExecutionsInput

SetTaskId sets the TaskId field's value.

func (ListExecutionsInput) String 

func (s ListExecutionsInput) String() string

String returns the string representation

func (*ListExecutionsInput) Validate 

func (s *ListExecutionsInput) Validate() error

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

type ListExecutionsOutput 

type ListExecutionsOutput struct {

	// A list of executions. Each execution contains the task ID, the device that
	// the task is executing on, the execution ID, and the status of the execution.
	Executions []*ExecutionSummary `locationName:"executions" type:"list"`

	// A pagination token to continue to the next page of executions.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListExecutionsOutput) GoString 

func (s ListExecutionsOutput) GoString() string

GoString returns the string representation

func (*ListExecutionsOutput) SetExecutions 

func (s *ListExecutionsOutput) SetExecutions(v []*ExecutionSummary) *ListExecutionsOutput

SetExecutions sets the Executions field's value.

func (*ListExecutionsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListExecutionsOutput) String 

func (s ListExecutionsOutput) String() string

String returns the string representation

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the device or task.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of tags for the device or task.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTags 

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

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTasksInput 

type ListTasksInput struct {

	// The maximum number of tasks per page.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A pagination token to continue to the next page of tasks.
	NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"`

	// A structure used to filter the list of tasks.
	State *string `location:"querystring" locationName:"state" type:"string" enum:"TaskState"`
	// contains filtered or unexported fields
}

func (ListTasksInput) GoString 

func (s ListTasksInput) GoString() string

GoString returns the string representation

func (*ListTasksInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListTasksInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListTasksInput) SetState 

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

SetState sets the State field's value.

func (ListTasksInput) String 

func (s ListTasksInput) String() string

String returns the string representation

func (*ListTasksInput) Validate 

func (s *ListTasksInput) Validate() error

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

type ListTasksOutput 

type ListTasksOutput struct {

	// A pagination token to continue to the next page of tasks.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A list of task structures containing details about each task.
	Tasks []*TaskSummary `locationName:"tasks" type:"list"`
	// contains filtered or unexported fields
}

func (ListTasksOutput) GoString 

func (s ListTasksOutput) GoString() string

GoString returns the string representation

func (*ListTasksOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListTasksOutput) SetTasks 

func (s *ListTasksOutput) SetTasks(v []*TaskSummary) *ListTasksOutput

SetTasks sets the Tasks field's value.

func (ListTasksOutput) String 

func (s ListTasksOutput) String() string

String returns the string representation

type PhysicalNetworkInterface 

type PhysicalNetworkInterface struct {

	// The default gateway of the device.
	DefaultGateway *string `locationName:"defaultGateway" type:"string"`

	// The IP address of the device.
	IpAddress *string `locationName:"ipAddress" type:"string"`

	// A value that describes whether the IP address is dynamic or persistent.
	IpAddressAssignment *string `locationName:"ipAddressAssignment" type:"string" enum:"IpAddressAssignment"`

	// The MAC address of the device.
	MacAddress *string `locationName:"macAddress" type:"string"`

	// The netmask used to divide the IP address into subnets.
	Netmask *string `locationName:"netmask" type:"string"`

	// The physical connector type.
	PhysicalConnectorType *string `locationName:"physicalConnectorType" type:"string" enum:"PhysicalConnectorType"`

	// The physical network interface ID.
	PhysicalNetworkInterfaceId *string `locationName:"physicalNetworkInterfaceId" type:"string"`
	// contains filtered or unexported fields
}

The details about the physical network interface for the device.

func (PhysicalNetworkInterface) GoString 

func (s PhysicalNetworkInterface) GoString() string

GoString returns the string representation

func (*PhysicalNetworkInterface) SetDefaultGateway 

func (s *PhysicalNetworkInterface) SetDefaultGateway(v string) *PhysicalNetworkInterface

SetDefaultGateway sets the DefaultGateway field's value.

func (*PhysicalNetworkInterface) SetIpAddress 

func (s *PhysicalNetworkInterface) SetIpAddress(v string) *PhysicalNetworkInterface

SetIpAddress sets the IpAddress field's value.

func (*PhysicalNetworkInterface) SetIpAddressAssignment 

func (s *PhysicalNetworkInterface) SetIpAddressAssignment(v string) *PhysicalNetworkInterface

SetIpAddressAssignment sets the IpAddressAssignment field's value.

func (*PhysicalNetworkInterface) SetMacAddress 

func (s *PhysicalNetworkInterface) SetMacAddress(v string) *PhysicalNetworkInterface

SetMacAddress sets the MacAddress field's value.

func (*PhysicalNetworkInterface) SetNetmask 

func (s *PhysicalNetworkInterface) SetNetmask(v string) *PhysicalNetworkInterface

SetNetmask sets the Netmask field's value.

func (*PhysicalNetworkInterface) SetPhysicalConnectorType 

func (s *PhysicalNetworkInterface) SetPhysicalConnectorType(v string) *PhysicalNetworkInterface

SetPhysicalConnectorType sets the PhysicalConnectorType field's value.

func (*PhysicalNetworkInterface) SetPhysicalNetworkInterfaceId 

func (s *PhysicalNetworkInterface) SetPhysicalNetworkInterfaceId(v string) *PhysicalNetworkInterface

SetPhysicalNetworkInterfaceId sets the PhysicalNetworkInterfaceId field's value.

func (PhysicalNetworkInterface) String 

func (s PhysicalNetworkInterface) String() string

String returns the string representation

type Reboot 

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

A structure used to reboot the device.

func (Reboot) GoString 

func (s Reboot) GoString() string

GoString returns the string representation

func (Reboot) String 

func (s Reboot) String() string

String returns the string representation

type ResourceNotFoundException 

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

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

The request references a resource that doesn't exist.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation

type ResourceSummary 

type ResourceSummary struct {

	// The Amazon Resource Name (ARN) of the resource.
	Arn *string `locationName:"arn" type:"string"`

	// The ID of the resource.
	Id *string `locationName:"id" type:"string"`

	// The resource type.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A summary of a resource available on the device.

func (ResourceSummary) GoString 

func (s ResourceSummary) GoString() string

GoString returns the string representation

func (*ResourceSummary) SetArn 

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

SetArn sets the Arn field's value.

func (*ResourceSummary) SetId 

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

SetId sets the Id field's value.

func (*ResourceSummary) SetResourceType 

func (s *ResourceSummary) SetResourceType(v string) *ResourceSummary

SetResourceType sets the ResourceType field's value.

func (ResourceSummary) String 

func (s ResourceSummary) String() string

String returns the string representation

type SecurityGroupIdentifier 

type SecurityGroupIdentifier struct {

	// The security group ID.
	GroupId *string `locationName:"groupId" type:"string"`

	// The security group name.
	GroupName *string `locationName:"groupName" type:"string"`
	// contains filtered or unexported fields
}

Information about the device's security group.

func (SecurityGroupIdentifier) GoString 

func (s SecurityGroupIdentifier) GoString() string

GoString returns the string representation

func (*SecurityGroupIdentifier) SetGroupId 

func (s *SecurityGroupIdentifier) SetGroupId(v string) *SecurityGroupIdentifier

SetGroupId sets the GroupId field's value.

func (*SecurityGroupIdentifier) SetGroupName 

func (s *SecurityGroupIdentifier) SetGroupName(v string) *SecurityGroupIdentifier

SetGroupName sets the GroupName field's value.

func (SecurityGroupIdentifier) String 

func (s SecurityGroupIdentifier) String() string

String returns the string representation

type ServiceQuotaExceededException 

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

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

The request would cause a service quota to be exceeded.

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation

type SnowDeviceManagement 

type SnowDeviceManagement struct {
	*client.Client
}

SnowDeviceManagement provides the API operation methods for making requests to AWS Snow Device Management. See this package's package overview docs for details on the service.

SnowDeviceManagement methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *SnowDeviceManagement

New creates a new instance of the SnowDeviceManagement client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a SnowDeviceManagement client from just a session.
svc := snowdevicemanagement.New(mySession)

// Create a SnowDeviceManagement client with additional configuration
svc := snowdevicemanagement.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*SnowDeviceManagement) CancelTask 

func (c *SnowDeviceManagement) CancelTask(input *CancelTaskInput) (*CancelTaskOutput, error)

CancelTask API operation for AWS Snow Device Management.

Sends a cancel request for a specified task. You can cancel a task only if it's still in a QUEUED state. Tasks that are already running can't be cancelled.

A task might still run if it's processed from the queue before the CancelTask operation changes the task's state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation CancelTask for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • InternalServerException An unexpected error occurred while processing the request.

  • ResourceNotFoundException The request references a resource that doesn't exist.

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

  • AccessDeniedException You don't have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/CancelTask

func (*SnowDeviceManagement) CancelTaskRequest 

func (c *SnowDeviceManagement) CancelTaskRequest(input *CancelTaskInput) (req *request.Request, output *CancelTaskOutput)

CancelTaskRequest generates a "aws/request.Request" representing the client's request for the CancelTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelTask for more information on using the CancelTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CancelTaskRequest method.
req, resp := client.CancelTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/CancelTask

func (*SnowDeviceManagement) CancelTaskWithContext 

func (c *SnowDeviceManagement) CancelTaskWithContext(ctx aws.Context, input *CancelTaskInput, opts ...request.Option) (*CancelTaskOutput, error)

CancelTaskWithContext is the same as CancelTask with the addition of the ability to pass a context and additional request options.

See CancelTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) CreateTask 

func (c *SnowDeviceManagement) CreateTask(input *CreateTaskInput) (*CreateTaskOutput, error)

CreateTask API operation for AWS Snow Device Management.

Instructs one or more devices to start a task, such as unlocking or rebooting.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation CreateTask for usage and error information.

Returned Error Types:

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

  • ThrottlingException The request was denied due to request throttling.

  • InternalServerException An unexpected error occurred while processing the request.

  • ResourceNotFoundException The request references a resource that doesn't exist.

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

  • AccessDeniedException You don't have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/CreateTask

func (*SnowDeviceManagement) CreateTaskRequest 

func (c *SnowDeviceManagement) CreateTaskRequest(input *CreateTaskInput) (req *request.Request, output *CreateTaskOutput)

CreateTaskRequest generates a "aws/request.Request" representing the client's request for the CreateTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTask for more information on using the CreateTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateTaskRequest method.
req, resp := client.CreateTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/CreateTask

func (*SnowDeviceManagement) CreateTaskWithContext 

func (c *SnowDeviceManagement) CreateTaskWithContext(ctx aws.Context, input *CreateTaskInput, opts ...request.Option) (*CreateTaskOutput, error)

CreateTaskWithContext is the same as CreateTask with the addition of the ability to pass a context and additional request options.

See CreateTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) DescribeDevice 

func (c *SnowDeviceManagement) DescribeDevice(input *DescribeDeviceInput) (*DescribeDeviceOutput, error)

DescribeDevice API operation for AWS Snow Device Management.

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation DescribeDevice for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • InternalServerException An unexpected error occurred while processing the request.

  • ResourceNotFoundException The request references a resource that doesn't exist.

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

  • AccessDeniedException You don't have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeDevice

func (*SnowDeviceManagement) DescribeDeviceEc2Instances 

func (c *SnowDeviceManagement) DescribeDeviceEc2Instances(input *DescribeDeviceEc2InstancesInput) (*DescribeDeviceEc2InstancesOutput, error)

DescribeDeviceEc2Instances API operation for AWS Snow Device Management.

Checks the current state of the Amazon EC2 instances. The output is similar to describeDevice, but the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the available fields.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation DescribeDeviceEc2Instances for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • InternalServerException An unexpected error occurred while processing the request.

  • ResourceNotFoundException The request references a resource that doesn't exist.

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

  • AccessDeniedException You don't have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeDeviceEc2Instances

func (*SnowDeviceManagement) DescribeDeviceEc2InstancesRequest 

func (c *SnowDeviceManagement) DescribeDeviceEc2InstancesRequest(input *DescribeDeviceEc2InstancesInput) (req *request.Request, output *DescribeDeviceEc2InstancesOutput)

DescribeDeviceEc2InstancesRequest generates a "aws/request.Request" representing the client's request for the DescribeDeviceEc2Instances operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDeviceEc2Instances for more information on using the DescribeDeviceEc2Instances API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeDeviceEc2InstancesRequest method.
req, resp := client.DescribeDeviceEc2InstancesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeDeviceEc2Instances

func (*SnowDeviceManagement) DescribeDeviceEc2InstancesWithContext 

func (c *SnowDeviceManagement) DescribeDeviceEc2InstancesWithContext(ctx aws.Context, input *DescribeDeviceEc2InstancesInput, opts ...request.Option) (*DescribeDeviceEc2InstancesOutput, error)

DescribeDeviceEc2InstancesWithContext is the same as DescribeDeviceEc2Instances with the addition of the ability to pass a context and additional request options.

See DescribeDeviceEc2Instances for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) DescribeDeviceRequest 

func (c *SnowDeviceManagement) DescribeDeviceRequest(input *DescribeDeviceInput) (req *request.Request, output *DescribeDeviceOutput)

DescribeDeviceRequest generates a "aws/request.Request" representing the client's request for the DescribeDevice operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeDevice for more information on using the DescribeDevice API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeDeviceRequest method.
req, resp := client.DescribeDeviceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeDevice

func (*SnowDeviceManagement) DescribeDeviceWithContext 

func (c *SnowDeviceManagement) DescribeDeviceWithContext(ctx aws.Context, input *DescribeDeviceInput, opts ...request.Option) (*DescribeDeviceOutput, error)

DescribeDeviceWithContext is the same as DescribeDevice with the addition of the ability to pass a context and additional request options.

See DescribeDevice for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) DescribeExecution 

func (c *SnowDeviceManagement) DescribeExecution(input *DescribeExecutionInput) (*DescribeExecutionOutput, error)

DescribeExecution API operation for AWS Snow Device Management.

Checks the status of a remote task running on one or more target devices.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation DescribeExecution for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • InternalServerException An unexpected error occurred while processing the request.

  • ResourceNotFoundException The request references a resource that doesn't exist.

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

  • AccessDeniedException You don't have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeExecution

func (*SnowDeviceManagement) DescribeExecutionRequest 

func (c *SnowDeviceManagement) DescribeExecutionRequest(input *DescribeExecutionInput) (req *request.Request, output *DescribeExecutionOutput)

DescribeExecutionRequest generates a "aws/request.Request" representing the client's request for the DescribeExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeExecution for more information on using the DescribeExecution API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeExecutionRequest method.
req, resp := client.DescribeExecutionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeExecution

func (*SnowDeviceManagement) DescribeExecutionWithContext 

func (c *SnowDeviceManagement) DescribeExecutionWithContext(ctx aws.Context, input *DescribeExecutionInput, opts ...request.Option) (*DescribeExecutionOutput, error)

DescribeExecutionWithContext is the same as DescribeExecution with the addition of the ability to pass a context and additional request options.

See DescribeExecution for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) DescribeTask 

func (c *SnowDeviceManagement) DescribeTask(input *DescribeTaskInput) (*DescribeTaskOutput, error)

DescribeTask API operation for AWS Snow Device Management.

Checks the metadata for a given task on a device.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation DescribeTask for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • InternalServerException An unexpected error occurred while processing the request.

  • ResourceNotFoundException The request references a resource that doesn't exist.

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

  • AccessDeniedException You don't have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeTask

func (*SnowDeviceManagement) DescribeTaskRequest 

func (c *SnowDeviceManagement) DescribeTaskRequest(input *DescribeTaskInput) (req *request.Request, output *DescribeTaskOutput)

DescribeTaskRequest generates a "aws/request.Request" representing the client's request for the DescribeTask operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeTask for more information on using the DescribeTask API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeTaskRequest method.
req, resp := client.DescribeTaskRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/DescribeTask

func (*SnowDeviceManagement) DescribeTaskWithContext 

func (c *SnowDeviceManagement) DescribeTaskWithContext(ctx aws.Context, input *DescribeTaskInput, opts ...request.Option) (*DescribeTaskOutput, error)

DescribeTaskWithContext is the same as DescribeTask with the addition of the ability to pass a context and additional request options.

See DescribeTask for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) ListDeviceResources 

func (c *SnowDeviceManagement) ListDeviceResources(input *ListDeviceResourcesInput) (*ListDeviceResourcesOutput, error)

ListDeviceResources API operation for AWS Snow Device Management.

Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation ListDeviceResources for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • InternalServerException An unexpected error occurred while processing the request.

  • ResourceNotFoundException The request references a resource that doesn't exist.

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

  • AccessDeniedException You don't have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListDeviceResources

func (*SnowDeviceManagement) ListDeviceResourcesPages 

func (c *SnowDeviceManagement) ListDeviceResourcesPages(input *ListDeviceResourcesInput, fn func(*ListDeviceResourcesOutput, bool) bool) error

ListDeviceResourcesPages iterates over the pages of a ListDeviceResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDeviceResources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDeviceResources operation.
pageNum := 0
err := client.ListDeviceResourcesPages(params,
    func(page *snowdevicemanagement.ListDeviceResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SnowDeviceManagement) ListDeviceResourcesPagesWithContext 

func (c *SnowDeviceManagement) ListDeviceResourcesPagesWithContext(ctx aws.Context, input *ListDeviceResourcesInput, fn func(*ListDeviceResourcesOutput, bool) bool, opts ...request.Option) error

ListDeviceResourcesPagesWithContext same as ListDeviceResourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) ListDeviceResourcesRequest 

func (c *SnowDeviceManagement) ListDeviceResourcesRequest(input *ListDeviceResourcesInput) (req *request.Request, output *ListDeviceResourcesOutput)

ListDeviceResourcesRequest generates a "aws/request.Request" representing the client's request for the ListDeviceResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDeviceResources for more information on using the ListDeviceResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDeviceResourcesRequest method.
req, resp := client.ListDeviceResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListDeviceResources

func (*SnowDeviceManagement) ListDeviceResourcesWithContext 

func (c *SnowDeviceManagement) ListDeviceResourcesWithContext(ctx aws.Context, input *ListDeviceResourcesInput, opts ...request.Option) (*ListDeviceResourcesOutput, error)

ListDeviceResourcesWithContext is the same as ListDeviceResources with the addition of the ability to pass a context and additional request options.

See ListDeviceResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) ListDevices 

func (c *SnowDeviceManagement) ListDevices(input *ListDevicesInput) (*ListDevicesOutput, error)

ListDevices API operation for AWS Snow Device Management.

Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation ListDevices for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • InternalServerException An unexpected error occurred while processing the request.

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

  • AccessDeniedException You don't have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListDevices

func (*SnowDeviceManagement) ListDevicesPages 

func (c *SnowDeviceManagement) ListDevicesPages(input *ListDevicesInput, fn func(*ListDevicesOutput, bool) bool) error

ListDevicesPages iterates over the pages of a ListDevices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDevices method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListDevices operation.
pageNum := 0
err := client.ListDevicesPages(params,
    func(page *snowdevicemanagement.ListDevicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SnowDeviceManagement) ListDevicesPagesWithContext 

func (c *SnowDeviceManagement) ListDevicesPagesWithContext(ctx aws.Context, input *ListDevicesInput, fn func(*ListDevicesOutput, bool) bool, opts ...request.Option) error

ListDevicesPagesWithContext same as ListDevicesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) ListDevicesRequest 

func (c *SnowDeviceManagement) ListDevicesRequest(input *ListDevicesInput) (req *request.Request, output *ListDevicesOutput)

ListDevicesRequest generates a "aws/request.Request" representing the client's request for the ListDevices operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDevices for more information on using the ListDevices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListDevicesRequest method.
req, resp := client.ListDevicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListDevices

func (*SnowDeviceManagement) ListDevicesWithContext 

func (c *SnowDeviceManagement) ListDevicesWithContext(ctx aws.Context, input *ListDevicesInput, opts ...request.Option) (*ListDevicesOutput, error)

ListDevicesWithContext is the same as ListDevices with the addition of the ability to pass a context and additional request options.

See ListDevices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) ListExecutions 

func (c *SnowDeviceManagement) ListExecutions(input *ListExecutionsInput) (*ListExecutionsOutput, error)

ListExecutions API operation for AWS Snow Device Management.

Returns the status of tasks for one or more target devices.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation ListExecutions for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • InternalServerException An unexpected error occurred while processing the request.

  • ResourceNotFoundException The request references a resource that doesn't exist.

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

  • AccessDeniedException You don't have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListExecutions

func (*SnowDeviceManagement) ListExecutionsPages 

func (c *SnowDeviceManagement) ListExecutionsPages(input *ListExecutionsInput, fn func(*ListExecutionsOutput, bool) bool) error

ListExecutionsPages iterates over the pages of a ListExecutions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListExecutions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListExecutions operation.
pageNum := 0
err := client.ListExecutionsPages(params,
    func(page *snowdevicemanagement.ListExecutionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SnowDeviceManagement) ListExecutionsPagesWithContext 

func (c *SnowDeviceManagement) ListExecutionsPagesWithContext(ctx aws.Context, input *ListExecutionsInput, fn func(*ListExecutionsOutput, bool) bool, opts ...request.Option) error

ListExecutionsPagesWithContext same as ListExecutionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) ListExecutionsRequest 

func (c *SnowDeviceManagement) ListExecutionsRequest(input *ListExecutionsInput) (req *request.Request, output *ListExecutionsOutput)

ListExecutionsRequest generates a "aws/request.Request" representing the client's request for the ListExecutions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListExecutions for more information on using the ListExecutions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListExecutionsRequest method.
req, resp := client.ListExecutionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListExecutions

func (*SnowDeviceManagement) ListExecutionsWithContext 

func (c *SnowDeviceManagement) ListExecutionsWithContext(ctx aws.Context, input *ListExecutionsInput, opts ...request.Option) (*ListExecutionsOutput, error)

ListExecutionsWithContext is the same as ListExecutions with the addition of the ability to pass a context and additional request options.

See ListExecutions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) ListTagsForResource 

func (c *SnowDeviceManagement) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Snow Device Management.

Returns a list of tags for a managed device or task.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error occurred while processing the request.

  • ResourceNotFoundException The request references a resource that doesn't exist.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListTagsForResource

func (*SnowDeviceManagement) ListTagsForResourceRequest 

func (c *SnowDeviceManagement) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListTagsForResource

func (*SnowDeviceManagement) ListTagsForResourceWithContext 

func (c *SnowDeviceManagement) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) ListTasks 

func (c *SnowDeviceManagement) ListTasks(input *ListTasksInput) (*ListTasksOutput, error)

ListTasks API operation for AWS Snow Device Management.

Returns a list of tasks that can be filtered by state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation ListTasks for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied due to request throttling.

  • InternalServerException An unexpected error occurred while processing the request.

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

  • AccessDeniedException You don't have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListTasks

func (*SnowDeviceManagement) ListTasksPages 

func (c *SnowDeviceManagement) ListTasksPages(input *ListTasksInput, fn func(*ListTasksOutput, bool) bool) error

ListTasksPages iterates over the pages of a ListTasks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTasks method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTasks operation.
pageNum := 0
err := client.ListTasksPages(params,
    func(page *snowdevicemanagement.ListTasksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*SnowDeviceManagement) ListTasksPagesWithContext 

func (c *SnowDeviceManagement) ListTasksPagesWithContext(ctx aws.Context, input *ListTasksInput, fn func(*ListTasksOutput, bool) bool, opts ...request.Option) error

ListTasksPagesWithContext same as ListTasksPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) ListTasksRequest 

func (c *SnowDeviceManagement) ListTasksRequest(input *ListTasksInput) (req *request.Request, output *ListTasksOutput)

ListTasksRequest generates a "aws/request.Request" representing the client's request for the ListTasks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTasks for more information on using the ListTasks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTasksRequest method.
req, resp := client.ListTasksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/ListTasks

func (*SnowDeviceManagement) ListTasksWithContext 

func (c *SnowDeviceManagement) ListTasksWithContext(ctx aws.Context, input *ListTasksInput, opts ...request.Option) (*ListTasksOutput, error)

ListTasksWithContext is the same as ListTasks with the addition of the ability to pass a context and additional request options.

See ListTasks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) TagResource 

func (c *SnowDeviceManagement) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Snow Device Management.

Adds or replaces tags on a device or task.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation TagResource for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error occurred while processing the request.

  • ResourceNotFoundException The request references a resource that doesn't exist.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/TagResource

func (*SnowDeviceManagement) TagResourceRequest 

func (c *SnowDeviceManagement) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/TagResource

func (*SnowDeviceManagement) TagResourceWithContext 

func (c *SnowDeviceManagement) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*SnowDeviceManagement) UntagResource 

func (c *SnowDeviceManagement) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Snow Device Management.

Removes a tag from a device or task.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Snow Device Management's API operation UntagResource for usage and error information.

Returned Error Types:

  • InternalServerException An unexpected error occurred while processing the request.

  • ResourceNotFoundException The request references a resource that doesn't exist.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/UntagResource

func (*SnowDeviceManagement) UntagResourceRequest 

func (c *SnowDeviceManagement) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/snow-device-management-2021-08-04/UntagResource

func (*SnowDeviceManagement) UntagResourceWithContext 

func (c *SnowDeviceManagement) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type SoftwareInformation 

type SoftwareInformation struct {

	// The state of the software that is installed or that is being installed on
	// the device.
	InstallState *string `locationName:"installState" type:"string"`

	// The version of the software currently installed on the device.
	InstalledVersion *string `locationName:"installedVersion" type:"string"`

	// The version of the software being installed on the device.
	InstallingVersion *string `locationName:"installingVersion" type:"string"`
	// contains filtered or unexported fields
}

Information about the software on the device.

func (SoftwareInformation) GoString 

func (s SoftwareInformation) GoString() string

GoString returns the string representation

func (*SoftwareInformation) SetInstallState 

func (s *SoftwareInformation) SetInstallState(v string) *SoftwareInformation

SetInstallState sets the InstallState field's value.

func (*SoftwareInformation) SetInstalledVersion 

func (s *SoftwareInformation) SetInstalledVersion(v string) *SoftwareInformation

SetInstalledVersion sets the InstalledVersion field's value.

func (*SoftwareInformation) SetInstallingVersion 

func (s *SoftwareInformation) SetInstallingVersion(v string) *SoftwareInformation

SetInstallingVersion sets the InstallingVersion field's value.

func (SoftwareInformation) String 

func (s SoftwareInformation) String() string

String returns the string representation

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the device or task.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// 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 is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

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

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

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

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TaskSummary 

type TaskSummary struct {

	// The state of the task assigned to one or many devices.
	State *string `locationName:"state" type:"string" enum:"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 `locationName:"tags" type:"map"`

	// The Amazon Resource Name (ARN) of the task.
	TaskArn *string `locationName:"taskArn" type:"string"`

	// The task ID.
	//
	// TaskId is a required field
	TaskId *string `locationName:"taskId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information about the task assigned to one or many devices.

func (TaskSummary) GoString 

func (s TaskSummary) GoString() string

GoString returns the string representation

func (*TaskSummary) SetState 

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

SetState sets the State field's value.

func (*TaskSummary) SetTags 

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

SetTags sets the Tags field's value.

func (*TaskSummary) SetTaskArn 

func (s *TaskSummary) SetTaskArn(v string) *TaskSummary

SetTaskArn sets the TaskArn field's value.

func (*TaskSummary) SetTaskId 

func (s *TaskSummary) SetTaskId(v string) *TaskSummary

SetTaskId sets the TaskId field's value.

func (TaskSummary) String 

func (s TaskSummary) String() string

String returns the string representation

type ThrottlingException 

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

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

The request was denied due to request throttling.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

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

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation

type Unlock 

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

A structure used to unlock a device.

func (Unlock) GoString 

func (s Unlock) GoString() string

GoString returns the string representation

func (Unlock) String 

func (s Unlock) String() string

String returns the string representation

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the device or task.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// 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.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

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

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type ValidationException 

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

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

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

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package snowdevicemanagementiface provides an interface to enable mocking the AWS Snow Device Management service client for testing your code.
 Package snowdevicemanagementiface provides an interface to enable mocking the AWS Snow Device Management service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.