func AttachmentStatus_Values() []string
AttachmentStatus_Values returns all elements of the AttachmentStatus enum
func ExecutionState_Values() []string
ExecutionState_Values returns all elements of the ExecutionState enum
func InstanceStateName_Values() []string
InstanceStateName_Values returns all elements of the InstanceStateName enum
func IpAddressAssignment_Values() []string
IpAddressAssignment_Values returns all elements of the IpAddressAssignment enum
func PhysicalConnectorType_Values() []string
PhysicalConnectorType_Values returns all elements of the PhysicalConnectorType enum
func TaskState_Values() []string
TaskState_Values returns all elements of the TaskState enum
func UnlockState_Values() []string
UnlockState_Values returns all elements of the UnlockState enum
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 (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (s *AccessDeniedException) Error() string
func (s AccessDeniedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s AccessDeniedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s CancelTaskInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelTaskInput) SetTaskId(v string) *CancelTaskInput
SetTaskId sets the TaskId field's value.
func (s CancelTaskInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s CancelTaskOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CancelTaskOutput) SetTaskId(v string) *CancelTaskOutput
SetTaskId sets the TaskId field's value.
func (s CancelTaskOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s Capacity) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Capacity) SetAvailable(v int64) *Capacity
SetAvailable sets the Available field's value.
func (s *Capacity) SetName(v string) *Capacity
SetName sets the Name field's value.
func (s *Capacity) SetTotal(v int64) *Capacity
SetTotal sets the Total field's value.
func (s *Capacity) SetUnit(v string) *Capacity
SetUnit sets the Unit field's value.
func (s *Capacity) SetUsed(v int64) *Capacity
SetUsed sets the Used field's value.
func (s Capacity) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s Command) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Command) SetReboot(v *Reboot) *Command
SetReboot sets the Reboot field's value.
func (s *Command) SetUnlock(v *Unlock) *Command
SetUnlock sets the Unlock field's value.
func (s Command) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s CpuOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CpuOptions) SetCoreCount(v int64) *CpuOptions
SetCoreCount sets the CoreCount field's value.
func (s *CpuOptions) SetThreadsPerCore(v int64) *CpuOptions
SetThreadsPerCore sets the ThreadsPerCore field's value.
func (s CpuOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s CreateTaskInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateTaskInput) SetClientToken(v string) *CreateTaskInput
SetClientToken sets the ClientToken field's value.
func (s *CreateTaskInput) SetCommand(v *Command) *CreateTaskInput
SetCommand sets the Command field's value.
func (s *CreateTaskInput) SetDescription(v string) *CreateTaskInput
SetDescription sets the Description field's value.
func (s *CreateTaskInput) SetTags(v map[string]*string) *CreateTaskInput
SetTags sets the Tags field's value.
func (s *CreateTaskInput) SetTargets(v []*string) *CreateTaskInput
SetTargets sets the Targets field's value.
func (s CreateTaskInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s CreateTaskOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateTaskOutput) SetTaskArn(v string) *CreateTaskOutput
SetTaskArn sets the TaskArn field's value.
func (s *CreateTaskOutput) SetTaskId(v string) *CreateTaskOutput
SetTaskId sets the TaskId field's value.
func (s CreateTaskOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s DescribeDeviceEc2InstancesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDeviceEc2InstancesInput) SetInstanceIds(v []*string) *DescribeDeviceEc2InstancesInput
SetInstanceIds sets the InstanceIds field's value.
func (s *DescribeDeviceEc2InstancesInput) SetManagedDeviceId(v string) *DescribeDeviceEc2InstancesInput
SetManagedDeviceId sets the ManagedDeviceId field's value.
func (s DescribeDeviceEc2InstancesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDeviceEc2InstancesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeDeviceEc2InstancesOutput struct {
// A list of structures containing information about each instance.
Instances []*InstanceSummary `locationName:"instances" type:"list"`
// contains filtered or unexported fields
}
func (s DescribeDeviceEc2InstancesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDeviceEc2InstancesOutput) SetInstances(v []*InstanceSummary) *DescribeDeviceEc2InstancesOutput
SetInstances sets the Instances field's value.
func (s DescribeDeviceEc2InstancesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s DescribeDeviceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDeviceInput) SetManagedDeviceId(v string) *DescribeDeviceInput
SetManagedDeviceId sets the ManagedDeviceId field's value.
func (s DescribeDeviceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDeviceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s DescribeDeviceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeDeviceOutput) SetAssociatedWithJob(v string) *DescribeDeviceOutput
SetAssociatedWithJob sets the AssociatedWithJob field's value.
func (s *DescribeDeviceOutput) SetDeviceCapacities(v []*Capacity) *DescribeDeviceOutput
SetDeviceCapacities sets the DeviceCapacities field's value.
func (s *DescribeDeviceOutput) SetDeviceState(v string) *DescribeDeviceOutput
SetDeviceState sets the DeviceState field's value.
func (s *DescribeDeviceOutput) SetDeviceType(v string) *DescribeDeviceOutput
SetDeviceType sets the DeviceType field's value.
func (s *DescribeDeviceOutput) SetLastReachedOutAt(v time.Time) *DescribeDeviceOutput
SetLastReachedOutAt sets the LastReachedOutAt field's value.
func (s *DescribeDeviceOutput) SetLastUpdatedAt(v time.Time) *DescribeDeviceOutput
SetLastUpdatedAt sets the LastUpdatedAt field's value.
func (s *DescribeDeviceOutput) SetManagedDeviceArn(v string) *DescribeDeviceOutput
SetManagedDeviceArn sets the ManagedDeviceArn field's value.
func (s *DescribeDeviceOutput) SetManagedDeviceId(v string) *DescribeDeviceOutput
SetManagedDeviceId sets the ManagedDeviceId field's value.
func (s *DescribeDeviceOutput) SetPhysicalNetworkInterfaces(v []*PhysicalNetworkInterface) *DescribeDeviceOutput
SetPhysicalNetworkInterfaces sets the PhysicalNetworkInterfaces field's value.
func (s *DescribeDeviceOutput) SetSoftware(v *SoftwareInformation) *DescribeDeviceOutput
SetSoftware sets the Software field's value.
func (s *DescribeDeviceOutput) SetTags(v map[string]*string) *DescribeDeviceOutput
SetTags sets the Tags field's value.
func (s DescribeDeviceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s DescribeExecutionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeExecutionInput) SetManagedDeviceId(v string) *DescribeExecutionInput
SetManagedDeviceId sets the ManagedDeviceId field's value.
func (s *DescribeExecutionInput) SetTaskId(v string) *DescribeExecutionInput
SetTaskId sets the TaskId field's value.
func (s DescribeExecutionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s DescribeExecutionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeExecutionOutput) SetExecutionId(v string) *DescribeExecutionOutput
SetExecutionId sets the ExecutionId field's value.
func (s *DescribeExecutionOutput) SetLastUpdatedAt(v time.Time) *DescribeExecutionOutput
SetLastUpdatedAt sets the LastUpdatedAt field's value.
func (s *DescribeExecutionOutput) SetManagedDeviceId(v string) *DescribeExecutionOutput
SetManagedDeviceId sets the ManagedDeviceId field's value.
func (s *DescribeExecutionOutput) SetStartedAt(v time.Time) *DescribeExecutionOutput
SetStartedAt sets the StartedAt field's value.
func (s *DescribeExecutionOutput) SetState(v string) *DescribeExecutionOutput
SetState sets the State field's value.
func (s *DescribeExecutionOutput) SetTaskId(v string) *DescribeExecutionOutput
SetTaskId sets the TaskId field's value.
func (s DescribeExecutionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s DescribeTaskInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeTaskInput) SetTaskId(v string) *DescribeTaskInput
SetTaskId sets the TaskId field's value.
func (s DescribeTaskInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s DescribeTaskOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeTaskOutput) SetCompletedAt(v time.Time) *DescribeTaskOutput
SetCompletedAt sets the CompletedAt field's value.
func (s *DescribeTaskOutput) SetCreatedAt(v time.Time) *DescribeTaskOutput
SetCreatedAt sets the CreatedAt field's value.
func (s *DescribeTaskOutput) SetDescription(v string) *DescribeTaskOutput
SetDescription sets the Description field's value.
func (s *DescribeTaskOutput) SetLastUpdatedAt(v time.Time) *DescribeTaskOutput
SetLastUpdatedAt sets the LastUpdatedAt field's value.
func (s *DescribeTaskOutput) SetState(v string) *DescribeTaskOutput
SetState sets the State field's value.
func (s *DescribeTaskOutput) SetTags(v map[string]*string) *DescribeTaskOutput
SetTags sets the Tags field's value.
func (s *DescribeTaskOutput) SetTargets(v []*string) *DescribeTaskOutput
SetTargets sets the Targets field's value.
func (s *DescribeTaskOutput) SetTaskArn(v string) *DescribeTaskOutput
SetTaskArn sets the TaskArn field's value.
func (s *DescribeTaskOutput) SetTaskId(v string) *DescribeTaskOutput
SetTaskId sets the TaskId field's value.
func (s DescribeTaskOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s DeviceSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeviceSummary) SetAssociatedWithJob(v string) *DeviceSummary
SetAssociatedWithJob sets the AssociatedWithJob field's value.
func (s *DeviceSummary) SetManagedDeviceArn(v string) *DeviceSummary
SetManagedDeviceArn sets the ManagedDeviceArn field's value.
func (s *DeviceSummary) SetManagedDeviceId(v string) *DeviceSummary
SetManagedDeviceId sets the ManagedDeviceId field's value.
func (s *DeviceSummary) SetTags(v map[string]*string) *DeviceSummary
SetTags sets the Tags field's value.
func (s DeviceSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s EbsInstanceBlockDevice) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *EbsInstanceBlockDevice) SetAttachTime(v time.Time) *EbsInstanceBlockDevice
SetAttachTime sets the AttachTime field's value.
func (s *EbsInstanceBlockDevice) SetDeleteOnTermination(v bool) *EbsInstanceBlockDevice
SetDeleteOnTermination sets the DeleteOnTermination field's value.
func (s *EbsInstanceBlockDevice) SetStatus(v string) *EbsInstanceBlockDevice
SetStatus sets the Status field's value.
func (s *EbsInstanceBlockDevice) SetVolumeId(v string) *EbsInstanceBlockDevice
SetVolumeId sets the VolumeId field's value.
func (s EbsInstanceBlockDevice) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s ExecutionSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ExecutionSummary) SetExecutionId(v string) *ExecutionSummary
SetExecutionId sets the ExecutionId field's value.
func (s *ExecutionSummary) SetManagedDeviceId(v string) *ExecutionSummary
SetManagedDeviceId sets the ManagedDeviceId field's value.
func (s *ExecutionSummary) SetState(v string) *ExecutionSummary
SetState sets the State field's value.
func (s *ExecutionSummary) SetTaskId(v string) *ExecutionSummary
SetTaskId sets the TaskId field's value.
func (s ExecutionSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s Instance) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Instance) SetAmiLaunchIndex(v int64) *Instance
SetAmiLaunchIndex sets the AmiLaunchIndex field's value.
func (s *Instance) SetBlockDeviceMappings(v []*InstanceBlockDeviceMapping) *Instance
SetBlockDeviceMappings sets the BlockDeviceMappings field's value.
func (s *Instance) SetCpuOptions(v *CpuOptions) *Instance
SetCpuOptions sets the CpuOptions field's value.
func (s *Instance) SetCreatedAt(v time.Time) *Instance
SetCreatedAt sets the CreatedAt field's value.
func (s *Instance) SetImageId(v string) *Instance
SetImageId sets the ImageId field's value.
func (s *Instance) SetInstanceId(v string) *Instance
SetInstanceId sets the InstanceId field's value.
func (s *Instance) SetInstanceType(v string) *Instance
SetInstanceType sets the InstanceType field's value.
func (s *Instance) SetPrivateIpAddress(v string) *Instance
SetPrivateIpAddress sets the PrivateIpAddress field's value.
func (s *Instance) SetPublicIpAddress(v string) *Instance
SetPublicIpAddress sets the PublicIpAddress field's value.
func (s *Instance) SetRootDeviceName(v string) *Instance
SetRootDeviceName sets the RootDeviceName field's value.
func (s *Instance) SetSecurityGroups(v []*SecurityGroupIdentifier) *Instance
SetSecurityGroups sets the SecurityGroups field's value.
func (s *Instance) SetState(v *InstanceState) *Instance
SetState sets the State field's value.
func (s *Instance) SetUpdatedAt(v time.Time) *Instance
SetUpdatedAt sets the UpdatedAt field's value.
func (s Instance) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s InstanceBlockDeviceMapping) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InstanceBlockDeviceMapping) SetDeviceName(v string) *InstanceBlockDeviceMapping
SetDeviceName sets the DeviceName field's value.
func (s *InstanceBlockDeviceMapping) SetEbs(v *EbsInstanceBlockDevice) *InstanceBlockDeviceMapping
SetEbs sets the Ebs field's value.
func (s InstanceBlockDeviceMapping) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s InstanceState) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InstanceState) SetCode(v int64) *InstanceState
SetCode sets the Code field's value.
func (s *InstanceState) SetName(v string) *InstanceState
SetName sets the Name field's value.
func (s InstanceState) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s InstanceSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InstanceSummary) SetInstance(v *Instance) *InstanceSummary
SetInstance sets the Instance field's value.
func (s *InstanceSummary) SetLastUpdatedAt(v time.Time) *InstanceSummary
SetLastUpdatedAt sets the LastUpdatedAt field's value.
func (s InstanceSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s *InternalServerException) Code() string
Code returns the exception type name.
func (s *InternalServerException) Error() string
func (s InternalServerException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InternalServerException) Message() string
Message returns the exception's message.
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InternalServerException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s ListDeviceResourcesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDeviceResourcesInput) SetManagedDeviceId(v string) *ListDeviceResourcesInput
SetManagedDeviceId sets the ManagedDeviceId field's value.
func (s *ListDeviceResourcesInput) SetMaxResults(v int64) *ListDeviceResourcesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListDeviceResourcesInput) SetNextToken(v string) *ListDeviceResourcesInput
SetNextToken sets the NextToken field's value.
func (s *ListDeviceResourcesInput) SetType(v string) *ListDeviceResourcesInput
SetType sets the Type field's value.
func (s ListDeviceResourcesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDeviceResourcesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s ListDeviceResourcesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDeviceResourcesOutput) SetNextToken(v string) *ListDeviceResourcesOutput
SetNextToken sets the NextToken field's value.
func (s *ListDeviceResourcesOutput) SetResources(v []*ResourceSummary) *ListDeviceResourcesOutput
SetResources sets the Resources field's value.
func (s ListDeviceResourcesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s ListDevicesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDevicesInput) SetJobId(v string) *ListDevicesInput
SetJobId sets the JobId field's value.
func (s *ListDevicesInput) SetMaxResults(v int64) *ListDevicesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListDevicesInput) SetNextToken(v string) *ListDevicesInput
SetNextToken sets the NextToken field's value.
func (s ListDevicesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDevicesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s ListDevicesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListDevicesOutput) SetDevices(v []*DeviceSummary) *ListDevicesOutput
SetDevices sets the Devices field's value.
func (s *ListDevicesOutput) SetNextToken(v string) *ListDevicesOutput
SetNextToken sets the NextToken field's value.
func (s ListDevicesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s ListExecutionsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListExecutionsInput) SetMaxResults(v int64) *ListExecutionsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListExecutionsInput) SetNextToken(v string) *ListExecutionsInput
SetNextToken sets the NextToken field's value.
func (s *ListExecutionsInput) SetState(v string) *ListExecutionsInput
SetState sets the State field's value.
func (s *ListExecutionsInput) SetTaskId(v string) *ListExecutionsInput
SetTaskId sets the TaskId field's value.
func (s ListExecutionsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListExecutionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s ListExecutionsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListExecutionsOutput) SetExecutions(v []*ExecutionSummary) *ListExecutionsOutput
SetExecutions sets the Executions field's value.
func (s *ListExecutionsOutput) SetNextToken(v string) *ListExecutionsOutput
SetNextToken sets the NextToken field's value.
func (s ListExecutionsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s ListTagsForResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s ListTagsForResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s ListTagsForResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
func (s ListTagsForResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s ListTasksInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTasksInput) SetMaxResults(v int64) *ListTasksInput
SetMaxResults sets the MaxResults field's value.
func (s *ListTasksInput) SetNextToken(v string) *ListTasksInput
SetNextToken sets the NextToken field's value.
func (s *ListTasksInput) SetState(v string) *ListTasksInput
SetState sets the State field's value.
func (s ListTasksInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTasksInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s ListTasksOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTasksOutput) SetNextToken(v string) *ListTasksOutput
SetNextToken sets the NextToken field's value.
func (s *ListTasksOutput) SetTasks(v []*TaskSummary) *ListTasksOutput
SetTasks sets the Tasks field's value.
func (s ListTasksOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s PhysicalNetworkInterface) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PhysicalNetworkInterface) SetDefaultGateway(v string) *PhysicalNetworkInterface
SetDefaultGateway sets the DefaultGateway field's value.
func (s *PhysicalNetworkInterface) SetIpAddress(v string) *PhysicalNetworkInterface
SetIpAddress sets the IpAddress field's value.
func (s *PhysicalNetworkInterface) SetIpAddressAssignment(v string) *PhysicalNetworkInterface
SetIpAddressAssignment sets the IpAddressAssignment field's value.
func (s *PhysicalNetworkInterface) SetMacAddress(v string) *PhysicalNetworkInterface
SetMacAddress sets the MacAddress field's value.
func (s *PhysicalNetworkInterface) SetNetmask(v string) *PhysicalNetworkInterface
SetNetmask sets the Netmask field's value.
func (s *PhysicalNetworkInterface) SetPhysicalConnectorType(v string) *PhysicalNetworkInterface
SetPhysicalConnectorType sets the PhysicalConnectorType field's value.
func (s *PhysicalNetworkInterface) SetPhysicalNetworkInterfaceId(v string) *PhysicalNetworkInterface
SetPhysicalNetworkInterfaceId sets the PhysicalNetworkInterfaceId field's value.
func (s PhysicalNetworkInterface) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Reboot struct {
// contains filtered or unexported fields
}
A structure used to reboot the device.
func (s Reboot) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s Reboot) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s ResourceSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ResourceSummary) SetArn(v string) *ResourceSummary
SetArn sets the Arn field's value.
func (s *ResourceSummary) SetId(v string) *ResourceSummary
SetId sets the Id field's value.
func (s *ResourceSummary) SetResourceType(v string) *ResourceSummary
SetResourceType sets the ResourceType field's value.
func (s ResourceSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s SecurityGroupIdentifier) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SecurityGroupIdentifier) SetGroupId(v string) *SecurityGroupIdentifier
SetGroupId sets the GroupId field's value.
func (s *SecurityGroupIdentifier) SetGroupName(v string) *SecurityGroupIdentifier
SetGroupName sets the GroupName field's value.
func (s SecurityGroupIdentifier) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s *ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (s *ServiceQuotaExceededException) Error() string
func (s ServiceQuotaExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (s *ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ServiceQuotaExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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(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 (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.
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)
}
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 (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.
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)
}
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 (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.
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.
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)
}
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 (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)
}
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 (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.
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)
}
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 (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.
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)
}
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 (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.
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 (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 (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)
}
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 (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.
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 (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 (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)
}
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 (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.
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 (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 (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)
}
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 (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.
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)
}
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 (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.
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 (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 (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)
}
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 (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.
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)
}
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 (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.
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)
}
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 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 (s SoftwareInformation) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *SoftwareInformation) SetInstallState(v string) *SoftwareInformation
SetInstallState sets the InstallState field's value.
func (s *SoftwareInformation) SetInstalledVersion(v string) *SoftwareInformation
SetInstalledVersion sets the InstalledVersion field's value.
func (s *SoftwareInformation) SetInstallingVersion(v string) *SoftwareInformation
SetInstallingVersion sets the InstallingVersion field's value.
func (s SoftwareInformation) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s TagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput
SetTags sets the Tags field's value.
func (s TagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (s TagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s TagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s TaskSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TaskSummary) SetState(v string) *TaskSummary
SetState sets the State field's value.
func (s *TaskSummary) SetTags(v map[string]*string) *TaskSummary
SetTags sets the Tags field's value.
func (s *TaskSummary) SetTaskArn(v string) *TaskSummary
SetTaskArn sets the TaskArn field's value.
func (s *TaskSummary) SetTaskId(v string) *TaskSummary
SetTaskId sets the TaskId field's value.
func (s TaskSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
func (s ThrottlingException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ThrottlingException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Unlock struct {
// contains filtered or unexported fields
}
A structure used to unlock a device.
func (s Unlock) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s Unlock) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s UntagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput
SetTagKeys sets the TagKeys field's value.
func (s UntagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (s UntagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UntagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
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 (s *ValidationException) Code() string
Code returns the exception type name.
func (s *ValidationException) Error() string
func (s ValidationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ValidationException) Message() string
Message returns the exception's message.
func (s *ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s ValidationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".