Documentation ¶
Overview ¶
Package workspaces provides a client for Amazon WorkSpaces.
Index ¶
- Constants
- type ComputeType
- type CreateTagsInput
- type CreateTagsOutput
- type CreateWorkspacesInput
- type CreateWorkspacesOutput
- type DefaultWorkspaceCreationProperties
- func (s DefaultWorkspaceCreationProperties) GoString() string
- func (s *DefaultWorkspaceCreationProperties) SetCustomSecurityGroupId(v string) *DefaultWorkspaceCreationProperties
- func (s *DefaultWorkspaceCreationProperties) SetDefaultOu(v string) *DefaultWorkspaceCreationProperties
- func (s *DefaultWorkspaceCreationProperties) SetEnableInternetAccess(v bool) *DefaultWorkspaceCreationProperties
- func (s *DefaultWorkspaceCreationProperties) SetEnableWorkDocs(v bool) *DefaultWorkspaceCreationProperties
- func (s *DefaultWorkspaceCreationProperties) SetUserEnabledAsLocalAdministrator(v bool) *DefaultWorkspaceCreationProperties
- func (s DefaultWorkspaceCreationProperties) String() string
- type DeleteTagsInput
- type DeleteTagsOutput
- type DescribeTagsInput
- type DescribeTagsOutput
- type DescribeWorkspaceBundlesInput
- func (s DescribeWorkspaceBundlesInput) GoString() string
- func (s *DescribeWorkspaceBundlesInput) SetBundleIds(v []*string) *DescribeWorkspaceBundlesInput
- func (s *DescribeWorkspaceBundlesInput) SetNextToken(v string) *DescribeWorkspaceBundlesInput
- func (s *DescribeWorkspaceBundlesInput) SetOwner(v string) *DescribeWorkspaceBundlesInput
- func (s DescribeWorkspaceBundlesInput) String() string
- func (s *DescribeWorkspaceBundlesInput) Validate() error
- type DescribeWorkspaceBundlesOutput
- func (s DescribeWorkspaceBundlesOutput) GoString() string
- func (s *DescribeWorkspaceBundlesOutput) SetBundles(v []*WorkspaceBundle) *DescribeWorkspaceBundlesOutput
- func (s *DescribeWorkspaceBundlesOutput) SetNextToken(v string) *DescribeWorkspaceBundlesOutput
- func (s DescribeWorkspaceBundlesOutput) String() string
- type DescribeWorkspaceDirectoriesInput
- func (s DescribeWorkspaceDirectoriesInput) GoString() string
- func (s *DescribeWorkspaceDirectoriesInput) SetDirectoryIds(v []*string) *DescribeWorkspaceDirectoriesInput
- func (s *DescribeWorkspaceDirectoriesInput) SetNextToken(v string) *DescribeWorkspaceDirectoriesInput
- func (s DescribeWorkspaceDirectoriesInput) String() string
- func (s *DescribeWorkspaceDirectoriesInput) Validate() error
- type DescribeWorkspaceDirectoriesOutput
- func (s DescribeWorkspaceDirectoriesOutput) GoString() string
- func (s *DescribeWorkspaceDirectoriesOutput) SetDirectories(v []*WorkspaceDirectory) *DescribeWorkspaceDirectoriesOutput
- func (s *DescribeWorkspaceDirectoriesOutput) SetNextToken(v string) *DescribeWorkspaceDirectoriesOutput
- func (s DescribeWorkspaceDirectoriesOutput) String() string
- type DescribeWorkspacesConnectionStatusInput
- func (s DescribeWorkspacesConnectionStatusInput) GoString() string
- func (s *DescribeWorkspacesConnectionStatusInput) SetNextToken(v string) *DescribeWorkspacesConnectionStatusInput
- func (s *DescribeWorkspacesConnectionStatusInput) SetWorkspaceIds(v []*string) *DescribeWorkspacesConnectionStatusInput
- func (s DescribeWorkspacesConnectionStatusInput) String() string
- func (s *DescribeWorkspacesConnectionStatusInput) Validate() error
- type DescribeWorkspacesConnectionStatusOutput
- func (s DescribeWorkspacesConnectionStatusOutput) GoString() string
- func (s *DescribeWorkspacesConnectionStatusOutput) SetNextToken(v string) *DescribeWorkspacesConnectionStatusOutput
- func (s *DescribeWorkspacesConnectionStatusOutput) SetWorkspacesConnectionStatus(v []*WorkspaceConnectionStatus) *DescribeWorkspacesConnectionStatusOutput
- func (s DescribeWorkspacesConnectionStatusOutput) String() string
- type DescribeWorkspacesInput
- func (s DescribeWorkspacesInput) GoString() string
- func (s *DescribeWorkspacesInput) SetBundleId(v string) *DescribeWorkspacesInput
- func (s *DescribeWorkspacesInput) SetDirectoryId(v string) *DescribeWorkspacesInput
- func (s *DescribeWorkspacesInput) SetLimit(v int64) *DescribeWorkspacesInput
- func (s *DescribeWorkspacesInput) SetNextToken(v string) *DescribeWorkspacesInput
- func (s *DescribeWorkspacesInput) SetUserName(v string) *DescribeWorkspacesInput
- func (s *DescribeWorkspacesInput) SetWorkspaceIds(v []*string) *DescribeWorkspacesInput
- func (s DescribeWorkspacesInput) String() string
- func (s *DescribeWorkspacesInput) Validate() error
- type DescribeWorkspacesOutput
- type FailedCreateWorkspaceRequest
- func (s FailedCreateWorkspaceRequest) GoString() string
- func (s *FailedCreateWorkspaceRequest) SetErrorCode(v string) *FailedCreateWorkspaceRequest
- func (s *FailedCreateWorkspaceRequest) SetErrorMessage(v string) *FailedCreateWorkspaceRequest
- func (s *FailedCreateWorkspaceRequest) SetWorkspaceRequest(v *WorkspaceRequest) *FailedCreateWorkspaceRequest
- func (s FailedCreateWorkspaceRequest) String() string
- type FailedWorkspaceChangeRequest
- func (s FailedWorkspaceChangeRequest) GoString() string
- func (s *FailedWorkspaceChangeRequest) SetErrorCode(v string) *FailedWorkspaceChangeRequest
- func (s *FailedWorkspaceChangeRequest) SetErrorMessage(v string) *FailedWorkspaceChangeRequest
- func (s *FailedWorkspaceChangeRequest) SetWorkspaceId(v string) *FailedWorkspaceChangeRequest
- func (s FailedWorkspaceChangeRequest) String() string
- type ModifyWorkspacePropertiesInput
- func (s ModifyWorkspacePropertiesInput) GoString() string
- func (s *ModifyWorkspacePropertiesInput) SetWorkspaceId(v string) *ModifyWorkspacePropertiesInput
- func (s *ModifyWorkspacePropertiesInput) SetWorkspaceProperties(v *WorkspaceProperties) *ModifyWorkspacePropertiesInput
- func (s ModifyWorkspacePropertiesInput) String() string
- func (s *ModifyWorkspacePropertiesInput) Validate() error
- type ModifyWorkspacePropertiesOutput
- type RebootRequest
- type RebootWorkspacesInput
- type RebootWorkspacesOutput
- type RebuildRequest
- type RebuildWorkspacesInput
- type RebuildWorkspacesOutput
- type StartRequest
- type StartWorkspacesInput
- type StartWorkspacesOutput
- type StopRequest
- type StopWorkspacesInput
- type StopWorkspacesOutput
- type Tag
- type TerminateRequest
- type TerminateWorkspacesInput
- type TerminateWorkspacesOutput
- type UserStorage
- type WorkSpaces
- func (c *WorkSpaces) CreateTags(input *CreateTagsInput) (*CreateTagsOutput, error)
- func (c *WorkSpaces) CreateTagsRequest(input *CreateTagsInput) (req *request.Request, output *CreateTagsOutput)
- func (c *WorkSpaces) CreateTagsWithContext(ctx aws.Context, input *CreateTagsInput, opts ...request.Option) (*CreateTagsOutput, error)
- func (c *WorkSpaces) CreateWorkspaces(input *CreateWorkspacesInput) (*CreateWorkspacesOutput, error)
- func (c *WorkSpaces) CreateWorkspacesRequest(input *CreateWorkspacesInput) (req *request.Request, output *CreateWorkspacesOutput)
- func (c *WorkSpaces) CreateWorkspacesWithContext(ctx aws.Context, input *CreateWorkspacesInput, opts ...request.Option) (*CreateWorkspacesOutput, error)
- func (c *WorkSpaces) DeleteTags(input *DeleteTagsInput) (*DeleteTagsOutput, error)
- func (c *WorkSpaces) DeleteTagsRequest(input *DeleteTagsInput) (req *request.Request, output *DeleteTagsOutput)
- func (c *WorkSpaces) DeleteTagsWithContext(ctx aws.Context, input *DeleteTagsInput, opts ...request.Option) (*DeleteTagsOutput, error)
- func (c *WorkSpaces) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error)
- func (c *WorkSpaces) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput)
- func (c *WorkSpaces) DescribeTagsWithContext(ctx aws.Context, input *DescribeTagsInput, opts ...request.Option) (*DescribeTagsOutput, error)
- func (c *WorkSpaces) DescribeWorkspaceBundles(input *DescribeWorkspaceBundlesInput) (*DescribeWorkspaceBundlesOutput, error)
- func (c *WorkSpaces) DescribeWorkspaceBundlesPages(input *DescribeWorkspaceBundlesInput, ...) error
- func (c *WorkSpaces) DescribeWorkspaceBundlesPagesWithContext(ctx aws.Context, input *DescribeWorkspaceBundlesInput, ...) error
- func (c *WorkSpaces) DescribeWorkspaceBundlesRequest(input *DescribeWorkspaceBundlesInput) (req *request.Request, output *DescribeWorkspaceBundlesOutput)
- func (c *WorkSpaces) DescribeWorkspaceBundlesWithContext(ctx aws.Context, input *DescribeWorkspaceBundlesInput, opts ...request.Option) (*DescribeWorkspaceBundlesOutput, error)
- func (c *WorkSpaces) DescribeWorkspaceDirectories(input *DescribeWorkspaceDirectoriesInput) (*DescribeWorkspaceDirectoriesOutput, error)
- func (c *WorkSpaces) DescribeWorkspaceDirectoriesPages(input *DescribeWorkspaceDirectoriesInput, ...) error
- func (c *WorkSpaces) DescribeWorkspaceDirectoriesPagesWithContext(ctx aws.Context, input *DescribeWorkspaceDirectoriesInput, ...) error
- func (c *WorkSpaces) DescribeWorkspaceDirectoriesRequest(input *DescribeWorkspaceDirectoriesInput) (req *request.Request, output *DescribeWorkspaceDirectoriesOutput)
- func (c *WorkSpaces) DescribeWorkspaceDirectoriesWithContext(ctx aws.Context, input *DescribeWorkspaceDirectoriesInput, ...) (*DescribeWorkspaceDirectoriesOutput, error)
- func (c *WorkSpaces) DescribeWorkspaces(input *DescribeWorkspacesInput) (*DescribeWorkspacesOutput, error)
- func (c *WorkSpaces) DescribeWorkspacesConnectionStatus(input *DescribeWorkspacesConnectionStatusInput) (*DescribeWorkspacesConnectionStatusOutput, error)
- func (c *WorkSpaces) DescribeWorkspacesConnectionStatusRequest(input *DescribeWorkspacesConnectionStatusInput) (req *request.Request, output *DescribeWorkspacesConnectionStatusOutput)
- func (c *WorkSpaces) DescribeWorkspacesConnectionStatusWithContext(ctx aws.Context, input *DescribeWorkspacesConnectionStatusInput, ...) (*DescribeWorkspacesConnectionStatusOutput, error)
- func (c *WorkSpaces) DescribeWorkspacesPages(input *DescribeWorkspacesInput, fn func(*DescribeWorkspacesOutput, bool) bool) error
- func (c *WorkSpaces) DescribeWorkspacesPagesWithContext(ctx aws.Context, input *DescribeWorkspacesInput, ...) error
- func (c *WorkSpaces) DescribeWorkspacesRequest(input *DescribeWorkspacesInput) (req *request.Request, output *DescribeWorkspacesOutput)
- func (c *WorkSpaces) DescribeWorkspacesWithContext(ctx aws.Context, input *DescribeWorkspacesInput, opts ...request.Option) (*DescribeWorkspacesOutput, error)
- func (c *WorkSpaces) ModifyWorkspaceProperties(input *ModifyWorkspacePropertiesInput) (*ModifyWorkspacePropertiesOutput, error)
- func (c *WorkSpaces) ModifyWorkspacePropertiesRequest(input *ModifyWorkspacePropertiesInput) (req *request.Request, output *ModifyWorkspacePropertiesOutput)
- func (c *WorkSpaces) ModifyWorkspacePropertiesWithContext(ctx aws.Context, input *ModifyWorkspacePropertiesInput, opts ...request.Option) (*ModifyWorkspacePropertiesOutput, error)
- func (c *WorkSpaces) RebootWorkspaces(input *RebootWorkspacesInput) (*RebootWorkspacesOutput, error)
- func (c *WorkSpaces) RebootWorkspacesRequest(input *RebootWorkspacesInput) (req *request.Request, output *RebootWorkspacesOutput)
- func (c *WorkSpaces) RebootWorkspacesWithContext(ctx aws.Context, input *RebootWorkspacesInput, opts ...request.Option) (*RebootWorkspacesOutput, error)
- func (c *WorkSpaces) RebuildWorkspaces(input *RebuildWorkspacesInput) (*RebuildWorkspacesOutput, error)
- func (c *WorkSpaces) RebuildWorkspacesRequest(input *RebuildWorkspacesInput) (req *request.Request, output *RebuildWorkspacesOutput)
- func (c *WorkSpaces) RebuildWorkspacesWithContext(ctx aws.Context, input *RebuildWorkspacesInput, opts ...request.Option) (*RebuildWorkspacesOutput, error)
- func (c *WorkSpaces) StartWorkspaces(input *StartWorkspacesInput) (*StartWorkspacesOutput, error)
- func (c *WorkSpaces) StartWorkspacesRequest(input *StartWorkspacesInput) (req *request.Request, output *StartWorkspacesOutput)
- func (c *WorkSpaces) StartWorkspacesWithContext(ctx aws.Context, input *StartWorkspacesInput, opts ...request.Option) (*StartWorkspacesOutput, error)
- func (c *WorkSpaces) StopWorkspaces(input *StopWorkspacesInput) (*StopWorkspacesOutput, error)
- func (c *WorkSpaces) StopWorkspacesRequest(input *StopWorkspacesInput) (req *request.Request, output *StopWorkspacesOutput)
- func (c *WorkSpaces) StopWorkspacesWithContext(ctx aws.Context, input *StopWorkspacesInput, opts ...request.Option) (*StopWorkspacesOutput, error)
- func (c *WorkSpaces) TerminateWorkspaces(input *TerminateWorkspacesInput) (*TerminateWorkspacesOutput, error)
- func (c *WorkSpaces) TerminateWorkspacesRequest(input *TerminateWorkspacesInput) (req *request.Request, output *TerminateWorkspacesOutput)
- func (c *WorkSpaces) TerminateWorkspacesWithContext(ctx aws.Context, input *TerminateWorkspacesInput, opts ...request.Option) (*TerminateWorkspacesOutput, error)
- type Workspace
- func (s Workspace) GoString() string
- func (s *Workspace) SetBundleId(v string) *Workspace
- func (s *Workspace) SetComputerName(v string) *Workspace
- func (s *Workspace) SetDirectoryId(v string) *Workspace
- func (s *Workspace) SetErrorCode(v string) *Workspace
- func (s *Workspace) SetErrorMessage(v string) *Workspace
- func (s *Workspace) SetIpAddress(v string) *Workspace
- func (s *Workspace) SetRootVolumeEncryptionEnabled(v bool) *Workspace
- func (s *Workspace) SetState(v string) *Workspace
- func (s *Workspace) SetSubnetId(v string) *Workspace
- func (s *Workspace) SetUserName(v string) *Workspace
- func (s *Workspace) SetUserVolumeEncryptionEnabled(v bool) *Workspace
- func (s *Workspace) SetVolumeEncryptionKey(v string) *Workspace
- func (s *Workspace) SetWorkspaceId(v string) *Workspace
- func (s *Workspace) SetWorkspaceProperties(v *WorkspaceProperties) *Workspace
- func (s Workspace) String() string
- type WorkspaceBundle
- func (s WorkspaceBundle) GoString() string
- func (s *WorkspaceBundle) SetBundleId(v string) *WorkspaceBundle
- func (s *WorkspaceBundle) SetComputeType(v *ComputeType) *WorkspaceBundle
- func (s *WorkspaceBundle) SetDescription(v string) *WorkspaceBundle
- func (s *WorkspaceBundle) SetName(v string) *WorkspaceBundle
- func (s *WorkspaceBundle) SetOwner(v string) *WorkspaceBundle
- func (s *WorkspaceBundle) SetUserStorage(v *UserStorage) *WorkspaceBundle
- func (s WorkspaceBundle) String() string
- type WorkspaceConnectionStatus
- func (s WorkspaceConnectionStatus) GoString() string
- func (s *WorkspaceConnectionStatus) SetConnectionState(v string) *WorkspaceConnectionStatus
- func (s *WorkspaceConnectionStatus) SetConnectionStateCheckTimestamp(v time.Time) *WorkspaceConnectionStatus
- func (s *WorkspaceConnectionStatus) SetLastKnownUserConnectionTimestamp(v time.Time) *WorkspaceConnectionStatus
- func (s *WorkspaceConnectionStatus) SetWorkspaceId(v string) *WorkspaceConnectionStatus
- func (s WorkspaceConnectionStatus) String() string
- type WorkspaceDirectory
- func (s WorkspaceDirectory) GoString() string
- func (s *WorkspaceDirectory) SetAlias(v string) *WorkspaceDirectory
- func (s *WorkspaceDirectory) SetCustomerUserName(v string) *WorkspaceDirectory
- func (s *WorkspaceDirectory) SetDirectoryId(v string) *WorkspaceDirectory
- func (s *WorkspaceDirectory) SetDirectoryName(v string) *WorkspaceDirectory
- func (s *WorkspaceDirectory) SetDirectoryType(v string) *WorkspaceDirectory
- func (s *WorkspaceDirectory) SetDnsIpAddresses(v []*string) *WorkspaceDirectory
- func (s *WorkspaceDirectory) SetIamRoleId(v string) *WorkspaceDirectory
- func (s *WorkspaceDirectory) SetRegistrationCode(v string) *WorkspaceDirectory
- func (s *WorkspaceDirectory) SetState(v string) *WorkspaceDirectory
- func (s *WorkspaceDirectory) SetSubnetIds(v []*string) *WorkspaceDirectory
- func (s *WorkspaceDirectory) SetWorkspaceCreationProperties(v *DefaultWorkspaceCreationProperties) *WorkspaceDirectory
- func (s *WorkspaceDirectory) SetWorkspaceSecurityGroupId(v string) *WorkspaceDirectory
- func (s WorkspaceDirectory) String() string
- type WorkspaceProperties
- type WorkspaceRequest
- func (s WorkspaceRequest) GoString() string
- func (s *WorkspaceRequest) SetBundleId(v string) *WorkspaceRequest
- func (s *WorkspaceRequest) SetDirectoryId(v string) *WorkspaceRequest
- func (s *WorkspaceRequest) SetRootVolumeEncryptionEnabled(v bool) *WorkspaceRequest
- func (s *WorkspaceRequest) SetTags(v []*Tag) *WorkspaceRequest
- func (s *WorkspaceRequest) SetUserName(v string) *WorkspaceRequest
- func (s *WorkspaceRequest) SetUserVolumeEncryptionEnabled(v bool) *WorkspaceRequest
- func (s *WorkspaceRequest) SetVolumeEncryptionKey(v string) *WorkspaceRequest
- func (s *WorkspaceRequest) SetWorkspaceProperties(v *WorkspaceProperties) *WorkspaceRequest
- func (s WorkspaceRequest) String() string
- func (s *WorkspaceRequest) Validate() error
Examples ¶
- WorkSpaces.CreateTags
- WorkSpaces.CreateWorkspaces
- WorkSpaces.DeleteTags
- WorkSpaces.DescribeTags
- WorkSpaces.DescribeWorkspaceBundles
- WorkSpaces.DescribeWorkspaceDirectories
- WorkSpaces.DescribeWorkspaces
- WorkSpaces.DescribeWorkspacesConnectionStatus
- WorkSpaces.ModifyWorkspaceProperties
- WorkSpaces.RebootWorkspaces
- WorkSpaces.RebuildWorkspaces
- WorkSpaces.StartWorkspaces
- WorkSpaces.StopWorkspaces
- WorkSpaces.TerminateWorkspaces
Constants ¶
const ( // ComputeValue is a Compute enum value ComputeValue = "VALUE" // ComputeStandard is a Compute enum value ComputeStandard = "STANDARD" // ComputePerformance is a Compute enum value ComputePerformance = "PERFORMANCE" )
const ( // ConnectionStateConnected is a ConnectionState enum value ConnectionStateConnected = "CONNECTED" // ConnectionStateDisconnected is a ConnectionState enum value ConnectionStateDisconnected = "DISCONNECTED" // ConnectionStateUnknown is a ConnectionState enum value ConnectionStateUnknown = "UNKNOWN" )
const ( // RunningModeAutoStop is a RunningMode enum value RunningModeAutoStop = "AUTO_STOP" // RunningModeAlwaysOn is a RunningMode enum value RunningModeAlwaysOn = "ALWAYS_ON" )
const ( // WorkspaceDirectoryStateRegistering is a WorkspaceDirectoryState enum value WorkspaceDirectoryStateRegistering = "REGISTERING" // WorkspaceDirectoryStateRegistered is a WorkspaceDirectoryState enum value WorkspaceDirectoryStateRegistered = "REGISTERED" // WorkspaceDirectoryStateDeregistering is a WorkspaceDirectoryState enum value WorkspaceDirectoryStateDeregistering = "DEREGISTERING" // WorkspaceDirectoryStateDeregistered is a WorkspaceDirectoryState enum value WorkspaceDirectoryStateDeregistered = "DEREGISTERED" // WorkspaceDirectoryStateError is a WorkspaceDirectoryState enum value WorkspaceDirectoryStateError = "ERROR" )
const ( // WorkspaceDirectoryTypeSimpleAd is a WorkspaceDirectoryType enum value WorkspaceDirectoryTypeSimpleAd = "SIMPLE_AD" // WorkspaceDirectoryTypeAdConnector is a WorkspaceDirectoryType enum value WorkspaceDirectoryTypeAdConnector = "AD_CONNECTOR" )
const ( // WorkspaceStatePending is a WorkspaceState enum value WorkspaceStatePending = "PENDING" // WorkspaceStateAvailable is a WorkspaceState enum value WorkspaceStateAvailable = "AVAILABLE" // WorkspaceStateImpaired is a WorkspaceState enum value WorkspaceStateImpaired = "IMPAIRED" // WorkspaceStateUnhealthy is a WorkspaceState enum value WorkspaceStateUnhealthy = "UNHEALTHY" // WorkspaceStateRebooting is a WorkspaceState enum value WorkspaceStateRebooting = "REBOOTING" // WorkspaceStateStarting is a WorkspaceState enum value WorkspaceStateStarting = "STARTING" // WorkspaceStateRebuilding is a WorkspaceState enum value WorkspaceStateRebuilding = "REBUILDING" // WorkspaceStateMaintenance is a WorkspaceState enum value WorkspaceStateMaintenance = "MAINTENANCE" // WorkspaceStateTerminating is a WorkspaceState enum value WorkspaceStateTerminating = "TERMINATING" // WorkspaceStateTerminated is a WorkspaceState enum value WorkspaceStateTerminated = "TERMINATED" // WorkspaceStateSuspended is a WorkspaceState enum value WorkspaceStateSuspended = "SUSPENDED" // WorkspaceStateStopping is a WorkspaceState enum value WorkspaceStateStopping = "STOPPING" // WorkspaceStateStopped is a WorkspaceState enum value WorkspaceStateStopped = "STOPPED" // WorkspaceStateError is a WorkspaceState enum value WorkspaceStateError = "ERROR" )
const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeInvalidParameterValuesException for service response error code // "InvalidParameterValuesException". // // One or more parameter values are not valid. ErrCodeInvalidParameterValuesException = "InvalidParameterValuesException" // ErrCodeInvalidResourceStateException for service response error code // "InvalidResourceStateException". // // The specified WorkSpace has an invalid state for this operation. ErrCodeInvalidResourceStateException = "InvalidResourceStateException" // ErrCodeOperationInProgressException for service response error code // "OperationInProgressException". // // The properties of this WorkSpace are currently being modified. Try again // in a moment. ErrCodeOperationInProgressException = "OperationInProgressException" // ErrCodeResourceLimitExceededException for service response error code // "ResourceLimitExceededException". // // Your resource limits have been exceeded. ErrCodeResourceLimitExceededException = "ResourceLimitExceededException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // The resource could not be found. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // "ResourceUnavailableException". // // The specified resource is not available. ErrCodeResourceUnavailableException = "ResourceUnavailableException" // ErrCodeUnsupportedWorkspaceConfigurationException for service response error code // "UnsupportedWorkspaceConfigurationException". // // The WorkSpace does not have the supported configuration for this operation. // For more information, see the Amazon WorkSpaces Administration Guide (http://docs.aws.amazon.com/workspaces/latest/adminguide). ErrCodeUnsupportedWorkspaceConfigurationException = "UnsupportedWorkspaceConfigurationException" )
const ( ServiceName = "workspaces" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ComputeType ¶
type ComputeType struct { // The name of the compute type for the bundle. Name *string `type:"string" enum:"Compute"` // contains filtered or unexported fields }
Contains information about the compute type of a WorkSpace bundle. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ComputeType
func (ComputeType) GoString ¶
func (s ComputeType) GoString() string
GoString returns the string representation
func (*ComputeType) SetName ¶
func (s *ComputeType) SetName(v string) *ComputeType
SetName sets the Name field's value.
func (ComputeType) String ¶
func (s ComputeType) String() string
String returns the string representation
type CreateTagsInput ¶
type CreateTagsInput struct { // The resource ID of the request. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // The tags of the request. // // Tags is a required field Tags []*Tag `type:"list" required:"true"` // contains filtered or unexported fields }
The request of the CreateTags operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTagsRequest
func (CreateTagsInput) GoString ¶
func (s CreateTagsInput) GoString() string
GoString returns the string representation
func (*CreateTagsInput) SetResourceId ¶
func (s *CreateTagsInput) SetResourceId(v string) *CreateTagsInput
SetResourceId sets the ResourceId field's value.
func (*CreateTagsInput) SetTags ¶
func (s *CreateTagsInput) SetTags(v []*Tag) *CreateTagsInput
SetTags sets the Tags field's value.
func (CreateTagsInput) String ¶
func (s CreateTagsInput) String() string
String returns the string representation
func (*CreateTagsInput) Validate ¶
func (s *CreateTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateTagsOutput ¶
type CreateTagsOutput struct {
// contains filtered or unexported fields
}
The result of the CreateTags operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTagsResult
func (CreateTagsOutput) GoString ¶
func (s CreateTagsOutput) GoString() string
GoString returns the string representation
func (CreateTagsOutput) String ¶
func (s CreateTagsOutput) String() string
String returns the string representation
type CreateWorkspacesInput ¶
type CreateWorkspacesInput struct { // An array of structures that specify the WorkSpaces to create. // // Workspaces is a required field Workspaces []*WorkspaceRequest `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the CreateWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspacesRequest
func (CreateWorkspacesInput) GoString ¶
func (s CreateWorkspacesInput) GoString() string
GoString returns the string representation
func (*CreateWorkspacesInput) SetWorkspaces ¶
func (s *CreateWorkspacesInput) SetWorkspaces(v []*WorkspaceRequest) *CreateWorkspacesInput
SetWorkspaces sets the Workspaces field's value.
func (CreateWorkspacesInput) String ¶
func (s CreateWorkspacesInput) String() string
String returns the string representation
func (*CreateWorkspacesInput) Validate ¶
func (s *CreateWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateWorkspacesOutput ¶
type CreateWorkspacesOutput struct { // An array of structures that represent the WorkSpaces that could not be created. FailedRequests []*FailedCreateWorkspaceRequest `type:"list"` // An array of structures that represent the WorkSpaces that were created. // // Because this operation is asynchronous, the identifier in WorkspaceId is // not immediately available. If you immediately call DescribeWorkspaces with // this identifier, no information will be returned. PendingRequests []*Workspace `type:"list"` // contains filtered or unexported fields }
Contains the result of the CreateWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspacesResult
func (CreateWorkspacesOutput) GoString ¶
func (s CreateWorkspacesOutput) GoString() string
GoString returns the string representation
func (*CreateWorkspacesOutput) SetFailedRequests ¶
func (s *CreateWorkspacesOutput) SetFailedRequests(v []*FailedCreateWorkspaceRequest) *CreateWorkspacesOutput
SetFailedRequests sets the FailedRequests field's value.
func (*CreateWorkspacesOutput) SetPendingRequests ¶
func (s *CreateWorkspacesOutput) SetPendingRequests(v []*Workspace) *CreateWorkspacesOutput
SetPendingRequests sets the PendingRequests field's value.
func (CreateWorkspacesOutput) String ¶
func (s CreateWorkspacesOutput) String() string
String returns the string representation
type DefaultWorkspaceCreationProperties ¶
type DefaultWorkspaceCreationProperties struct { // The identifier of any custom security groups that are applied to the WorkSpaces // when they are created. CustomSecurityGroupId *string `type:"string"` // The organizational unit (OU) in the directory that the WorkSpace machine // accounts are placed in. DefaultOu *string `type:"string"` // A public IP address will be attached to all WorkSpaces that are created or // rebuilt. EnableInternetAccess *bool `type:"boolean"` // Specifies if the directory is enabled for Amazon WorkDocs. EnableWorkDocs *bool `type:"boolean"` // The WorkSpace user is an administrator on the WorkSpace. UserEnabledAsLocalAdministrator *bool `type:"boolean"` // contains filtered or unexported fields }
Contains default WorkSpace creation information. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DefaultWorkspaceCreationProperties
func (DefaultWorkspaceCreationProperties) GoString ¶
func (s DefaultWorkspaceCreationProperties) GoString() string
GoString returns the string representation
func (*DefaultWorkspaceCreationProperties) SetCustomSecurityGroupId ¶
func (s *DefaultWorkspaceCreationProperties) SetCustomSecurityGroupId(v string) *DefaultWorkspaceCreationProperties
SetCustomSecurityGroupId sets the CustomSecurityGroupId field's value.
func (*DefaultWorkspaceCreationProperties) SetDefaultOu ¶
func (s *DefaultWorkspaceCreationProperties) SetDefaultOu(v string) *DefaultWorkspaceCreationProperties
SetDefaultOu sets the DefaultOu field's value.
func (*DefaultWorkspaceCreationProperties) SetEnableInternetAccess ¶
func (s *DefaultWorkspaceCreationProperties) SetEnableInternetAccess(v bool) *DefaultWorkspaceCreationProperties
SetEnableInternetAccess sets the EnableInternetAccess field's value.
func (*DefaultWorkspaceCreationProperties) SetEnableWorkDocs ¶
func (s *DefaultWorkspaceCreationProperties) SetEnableWorkDocs(v bool) *DefaultWorkspaceCreationProperties
SetEnableWorkDocs sets the EnableWorkDocs field's value.
func (*DefaultWorkspaceCreationProperties) SetUserEnabledAsLocalAdministrator ¶
func (s *DefaultWorkspaceCreationProperties) SetUserEnabledAsLocalAdministrator(v bool) *DefaultWorkspaceCreationProperties
SetUserEnabledAsLocalAdministrator sets the UserEnabledAsLocalAdministrator field's value.
func (DefaultWorkspaceCreationProperties) String ¶
func (s DefaultWorkspaceCreationProperties) String() string
String returns the string representation
type DeleteTagsInput ¶
type DeleteTagsInput struct { // The resource ID of the request. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // The tag keys of the request. // // TagKeys is a required field TagKeys []*string `type:"list" required:"true"` // contains filtered or unexported fields }
The request of the DeleteTags operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTagsRequest
func (DeleteTagsInput) GoString ¶
func (s DeleteTagsInput) GoString() string
GoString returns the string representation
func (*DeleteTagsInput) SetResourceId ¶
func (s *DeleteTagsInput) SetResourceId(v string) *DeleteTagsInput
SetResourceId sets the ResourceId field's value.
func (*DeleteTagsInput) SetTagKeys ¶
func (s *DeleteTagsInput) SetTagKeys(v []*string) *DeleteTagsInput
SetTagKeys sets the TagKeys field's value.
func (DeleteTagsInput) String ¶
func (s DeleteTagsInput) String() string
String returns the string representation
func (*DeleteTagsInput) Validate ¶
func (s *DeleteTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteTagsOutput ¶
type DeleteTagsOutput struct {
// contains filtered or unexported fields
}
The result of the DeleteTags operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTagsResult
func (DeleteTagsOutput) GoString ¶
func (s DeleteTagsOutput) GoString() string
GoString returns the string representation
func (DeleteTagsOutput) String ¶
func (s DeleteTagsOutput) String() string
String returns the string representation
type DescribeTagsInput ¶
type DescribeTagsInput struct { // The resource ID of the request. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The request of the DescribeTags operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTagsRequest
func (DescribeTagsInput) GoString ¶
func (s DescribeTagsInput) GoString() string
GoString returns the string representation
func (*DescribeTagsInput) SetResourceId ¶
func (s *DescribeTagsInput) SetResourceId(v string) *DescribeTagsInput
SetResourceId sets the ResourceId field's value.
func (DescribeTagsInput) String ¶
func (s DescribeTagsInput) String() string
String returns the string representation
func (*DescribeTagsInput) Validate ¶
func (s *DescribeTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTagsOutput ¶
type DescribeTagsOutput struct { // The list of tags. TagList []*Tag `type:"list"` // contains filtered or unexported fields }
The result of the DescribeTags operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTagsResult
func (DescribeTagsOutput) GoString ¶
func (s DescribeTagsOutput) GoString() string
GoString returns the string representation
func (*DescribeTagsOutput) SetTagList ¶
func (s *DescribeTagsOutput) SetTagList(v []*Tag) *DescribeTagsOutput
SetTagList sets the TagList field's value.
func (DescribeTagsOutput) String ¶
func (s DescribeTagsOutput) String() string
String returns the string representation
type DescribeWorkspaceBundlesInput ¶
type DescribeWorkspaceBundlesInput struct { // An array of strings that contains the identifiers of the bundles to retrieve. // This parameter cannot be combined with any other filter parameter. BundleIds []*string `min:"1" type:"list"` // The NextToken value from a previous call to this operation. Pass null if // this is the first call. NextToken *string `min:"1" type:"string"` // The owner of the bundles to retrieve. This parameter cannot be combined with // any other filter parameter. // // This contains one of the following values: // // * null- Retrieves the bundles that belong to the account making the call. // // * AMAZON- Retrieves the bundles that are provided by AWS. Owner *string `type:"string"` // contains filtered or unexported fields }
Contains the inputs for the DescribeWorkspaceBundles operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundlesRequest
func (DescribeWorkspaceBundlesInput) GoString ¶
func (s DescribeWorkspaceBundlesInput) GoString() string
GoString returns the string representation
func (*DescribeWorkspaceBundlesInput) SetBundleIds ¶
func (s *DescribeWorkspaceBundlesInput) SetBundleIds(v []*string) *DescribeWorkspaceBundlesInput
SetBundleIds sets the BundleIds field's value.
func (*DescribeWorkspaceBundlesInput) SetNextToken ¶
func (s *DescribeWorkspaceBundlesInput) SetNextToken(v string) *DescribeWorkspaceBundlesInput
SetNextToken sets the NextToken field's value.
func (*DescribeWorkspaceBundlesInput) SetOwner ¶
func (s *DescribeWorkspaceBundlesInput) SetOwner(v string) *DescribeWorkspaceBundlesInput
SetOwner sets the Owner field's value.
func (DescribeWorkspaceBundlesInput) String ¶
func (s DescribeWorkspaceBundlesInput) String() string
String returns the string representation
func (*DescribeWorkspaceBundlesInput) Validate ¶
func (s *DescribeWorkspaceBundlesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeWorkspaceBundlesOutput ¶
type DescribeWorkspaceBundlesOutput struct { // An array of structures that contain information about the bundles. Bundles []*WorkspaceBundle `type:"list"` // If not null, more results are available. Pass this value for the NextToken // parameter in a subsequent call to this operation to retrieve the next set // of items. This token is valid for one day and must be used within that time // frame. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains the results of the DescribeWorkspaceBundles operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundlesResult
func (DescribeWorkspaceBundlesOutput) GoString ¶
func (s DescribeWorkspaceBundlesOutput) GoString() string
GoString returns the string representation
func (*DescribeWorkspaceBundlesOutput) SetBundles ¶
func (s *DescribeWorkspaceBundlesOutput) SetBundles(v []*WorkspaceBundle) *DescribeWorkspaceBundlesOutput
SetBundles sets the Bundles field's value.
func (*DescribeWorkspaceBundlesOutput) SetNextToken ¶
func (s *DescribeWorkspaceBundlesOutput) SetNextToken(v string) *DescribeWorkspaceBundlesOutput
SetNextToken sets the NextToken field's value.
func (DescribeWorkspaceBundlesOutput) String ¶
func (s DescribeWorkspaceBundlesOutput) String() string
String returns the string representation
type DescribeWorkspaceDirectoriesInput ¶
type DescribeWorkspaceDirectoriesInput struct { // An array of strings that contains the directory identifiers to retrieve information // for. If this member is null, all directories are retrieved. DirectoryIds []*string `min:"1" type:"list"` // The NextToken value from a previous call to this operation. Pass null if // this is the first call. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains the inputs for the DescribeWorkspaceDirectories operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectoriesRequest
func (DescribeWorkspaceDirectoriesInput) GoString ¶
func (s DescribeWorkspaceDirectoriesInput) GoString() string
GoString returns the string representation
func (*DescribeWorkspaceDirectoriesInput) SetDirectoryIds ¶
func (s *DescribeWorkspaceDirectoriesInput) SetDirectoryIds(v []*string) *DescribeWorkspaceDirectoriesInput
SetDirectoryIds sets the DirectoryIds field's value.
func (*DescribeWorkspaceDirectoriesInput) SetNextToken ¶
func (s *DescribeWorkspaceDirectoriesInput) SetNextToken(v string) *DescribeWorkspaceDirectoriesInput
SetNextToken sets the NextToken field's value.
func (DescribeWorkspaceDirectoriesInput) String ¶
func (s DescribeWorkspaceDirectoriesInput) String() string
String returns the string representation
func (*DescribeWorkspaceDirectoriesInput) Validate ¶
func (s *DescribeWorkspaceDirectoriesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeWorkspaceDirectoriesOutput ¶
type DescribeWorkspaceDirectoriesOutput struct { // An array of structures that contain information about the directories. Directories []*WorkspaceDirectory `type:"list"` // If not null, more results are available. Pass this value for the NextToken // parameter in a subsequent call to this operation to retrieve the next set // of items. This token is valid for one day and must be used within that time // frame. NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains the results of the DescribeWorkspaceDirectories operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectoriesResult
func (DescribeWorkspaceDirectoriesOutput) GoString ¶
func (s DescribeWorkspaceDirectoriesOutput) GoString() string
GoString returns the string representation
func (*DescribeWorkspaceDirectoriesOutput) SetDirectories ¶
func (s *DescribeWorkspaceDirectoriesOutput) SetDirectories(v []*WorkspaceDirectory) *DescribeWorkspaceDirectoriesOutput
SetDirectories sets the Directories field's value.
func (*DescribeWorkspaceDirectoriesOutput) SetNextToken ¶
func (s *DescribeWorkspaceDirectoriesOutput) SetNextToken(v string) *DescribeWorkspaceDirectoriesOutput
SetNextToken sets the NextToken field's value.
func (DescribeWorkspaceDirectoriesOutput) String ¶
func (s DescribeWorkspaceDirectoriesOutput) String() string
String returns the string representation
type DescribeWorkspacesConnectionStatusInput ¶
type DescribeWorkspacesConnectionStatusInput struct { // The next token of the request. NextToken *string `min:"1" type:"string"` // An array of strings that contain the identifiers of the WorkSpaces. WorkspaceIds []*string `min:"1" type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatusRequest
func (DescribeWorkspacesConnectionStatusInput) GoString ¶
func (s DescribeWorkspacesConnectionStatusInput) GoString() string
GoString returns the string representation
func (*DescribeWorkspacesConnectionStatusInput) SetNextToken ¶
func (s *DescribeWorkspacesConnectionStatusInput) SetNextToken(v string) *DescribeWorkspacesConnectionStatusInput
SetNextToken sets the NextToken field's value.
func (*DescribeWorkspacesConnectionStatusInput) SetWorkspaceIds ¶
func (s *DescribeWorkspacesConnectionStatusInput) SetWorkspaceIds(v []*string) *DescribeWorkspacesConnectionStatusInput
SetWorkspaceIds sets the WorkspaceIds field's value.
func (DescribeWorkspacesConnectionStatusInput) String ¶
func (s DescribeWorkspacesConnectionStatusInput) String() string
String returns the string representation
func (*DescribeWorkspacesConnectionStatusInput) Validate ¶
func (s *DescribeWorkspacesConnectionStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeWorkspacesConnectionStatusOutput ¶
type DescribeWorkspacesConnectionStatusOutput struct { // The next token of the result. NextToken *string `min:"1" type:"string"` // The connection status of the WorkSpace. WorkspacesConnectionStatus []*WorkspaceConnectionStatus `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatusResult
func (DescribeWorkspacesConnectionStatusOutput) GoString ¶
func (s DescribeWorkspacesConnectionStatusOutput) GoString() string
GoString returns the string representation
func (*DescribeWorkspacesConnectionStatusOutput) SetNextToken ¶
func (s *DescribeWorkspacesConnectionStatusOutput) SetNextToken(v string) *DescribeWorkspacesConnectionStatusOutput
SetNextToken sets the NextToken field's value.
func (*DescribeWorkspacesConnectionStatusOutput) SetWorkspacesConnectionStatus ¶
func (s *DescribeWorkspacesConnectionStatusOutput) SetWorkspacesConnectionStatus(v []*WorkspaceConnectionStatus) *DescribeWorkspacesConnectionStatusOutput
SetWorkspacesConnectionStatus sets the WorkspacesConnectionStatus field's value.
func (DescribeWorkspacesConnectionStatusOutput) String ¶
func (s DescribeWorkspacesConnectionStatusOutput) String() string
String returns the string representation
type DescribeWorkspacesInput ¶
type DescribeWorkspacesInput struct { // The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that // are created from this bundle will be retrieved. This parameter cannot be // combined with any other filter parameter. BundleId *string `type:"string"` // Specifies the directory identifier to which to limit the WorkSpaces. Optionally, // you can specify a specific directory user with the UserName parameter. This // parameter cannot be combined with any other filter parameter. DirectoryId *string `type:"string"` // The maximum number of items to return. Limit *int64 `min:"1" type:"integer"` // The NextToken value from a previous call to this operation. Pass null if // this is the first call. NextToken *string `min:"1" type:"string"` // Used with the DirectoryId parameter to specify the directory user for whom // to obtain the WorkSpace. UserName *string `min:"1" type:"string"` // An array of strings that contain the identifiers of the WorkSpaces for which // to retrieve information. This parameter cannot be combined with any other // filter parameter. // // Because the CreateWorkspaces operation is asynchronous, the identifier it // returns is not immediately available. If you immediately call DescribeWorkspaces // with this identifier, no information is returned. WorkspaceIds []*string `min:"1" type:"list"` // contains filtered or unexported fields }
Contains the inputs for the DescribeWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesRequest
func (DescribeWorkspacesInput) GoString ¶
func (s DescribeWorkspacesInput) GoString() string
GoString returns the string representation
func (*DescribeWorkspacesInput) SetBundleId ¶
func (s *DescribeWorkspacesInput) SetBundleId(v string) *DescribeWorkspacesInput
SetBundleId sets the BundleId field's value.
func (*DescribeWorkspacesInput) SetDirectoryId ¶
func (s *DescribeWorkspacesInput) SetDirectoryId(v string) *DescribeWorkspacesInput
SetDirectoryId sets the DirectoryId field's value.
func (*DescribeWorkspacesInput) SetLimit ¶
func (s *DescribeWorkspacesInput) SetLimit(v int64) *DescribeWorkspacesInput
SetLimit sets the Limit field's value.
func (*DescribeWorkspacesInput) SetNextToken ¶
func (s *DescribeWorkspacesInput) SetNextToken(v string) *DescribeWorkspacesInput
SetNextToken sets the NextToken field's value.
func (*DescribeWorkspacesInput) SetUserName ¶
func (s *DescribeWorkspacesInput) SetUserName(v string) *DescribeWorkspacesInput
SetUserName sets the UserName field's value.
func (*DescribeWorkspacesInput) SetWorkspaceIds ¶
func (s *DescribeWorkspacesInput) SetWorkspaceIds(v []*string) *DescribeWorkspacesInput
SetWorkspaceIds sets the WorkspaceIds field's value.
func (DescribeWorkspacesInput) String ¶
func (s DescribeWorkspacesInput) String() string
String returns the string representation
func (*DescribeWorkspacesInput) Validate ¶
func (s *DescribeWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeWorkspacesOutput ¶
type DescribeWorkspacesOutput struct { // If not null, more results are available. Pass this value for the NextToken // parameter in a subsequent call to this operation to retrieve the next set // of items. This token is valid for one day and must be used within that time // frame. NextToken *string `min:"1" type:"string"` // An array of structures that contain the information about the WorkSpaces. // // Because the CreateWorkspaces operation is asynchronous, some of this information // may be incomplete for a newly-created WorkSpace. Workspaces []*Workspace `type:"list"` // contains filtered or unexported fields }
Contains the results for the DescribeWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesResult
func (DescribeWorkspacesOutput) GoString ¶
func (s DescribeWorkspacesOutput) GoString() string
GoString returns the string representation
func (*DescribeWorkspacesOutput) SetNextToken ¶
func (s *DescribeWorkspacesOutput) SetNextToken(v string) *DescribeWorkspacesOutput
SetNextToken sets the NextToken field's value.
func (*DescribeWorkspacesOutput) SetWorkspaces ¶
func (s *DescribeWorkspacesOutput) SetWorkspaces(v []*Workspace) *DescribeWorkspacesOutput
SetWorkspaces sets the Workspaces field's value.
func (DescribeWorkspacesOutput) String ¶
func (s DescribeWorkspacesOutput) String() string
String returns the string representation
type FailedCreateWorkspaceRequest ¶
type FailedCreateWorkspaceRequest struct { // The error code. ErrorCode *string `type:"string"` // The textual error message. ErrorMessage *string `type:"string"` // A FailedCreateWorkspaceRequest$WorkspaceRequest object that contains the // information about the WorkSpace that could not be created. WorkspaceRequest *WorkspaceRequest `type:"structure"` // contains filtered or unexported fields }
Contains information about a WorkSpace that could not be created. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/FailedCreateWorkspaceRequest
func (FailedCreateWorkspaceRequest) GoString ¶
func (s FailedCreateWorkspaceRequest) GoString() string
GoString returns the string representation
func (*FailedCreateWorkspaceRequest) SetErrorCode ¶
func (s *FailedCreateWorkspaceRequest) SetErrorCode(v string) *FailedCreateWorkspaceRequest
SetErrorCode sets the ErrorCode field's value.
func (*FailedCreateWorkspaceRequest) SetErrorMessage ¶
func (s *FailedCreateWorkspaceRequest) SetErrorMessage(v string) *FailedCreateWorkspaceRequest
SetErrorMessage sets the ErrorMessage field's value.
func (*FailedCreateWorkspaceRequest) SetWorkspaceRequest ¶
func (s *FailedCreateWorkspaceRequest) SetWorkspaceRequest(v *WorkspaceRequest) *FailedCreateWorkspaceRequest
SetWorkspaceRequest sets the WorkspaceRequest field's value.
func (FailedCreateWorkspaceRequest) String ¶
func (s FailedCreateWorkspaceRequest) String() string
String returns the string representation
type FailedWorkspaceChangeRequest ¶
type FailedWorkspaceChangeRequest struct { // The error code. ErrorCode *string `type:"string"` // The textual error message. ErrorMessage *string `type:"string"` // The identifier of the WorkSpace. WorkspaceId *string `type:"string"` // contains filtered or unexported fields }
Contains information about a WorkSpace that could not be rebooted (RebootWorkspaces), rebuilt (RebuildWorkspaces), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces). Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/FailedWorkspaceChangeRequest
func (FailedWorkspaceChangeRequest) GoString ¶
func (s FailedWorkspaceChangeRequest) GoString() string
GoString returns the string representation
func (*FailedWorkspaceChangeRequest) SetErrorCode ¶
func (s *FailedWorkspaceChangeRequest) SetErrorCode(v string) *FailedWorkspaceChangeRequest
SetErrorCode sets the ErrorCode field's value.
func (*FailedWorkspaceChangeRequest) SetErrorMessage ¶
func (s *FailedWorkspaceChangeRequest) SetErrorMessage(v string) *FailedWorkspaceChangeRequest
SetErrorMessage sets the ErrorMessage field's value.
func (*FailedWorkspaceChangeRequest) SetWorkspaceId ¶
func (s *FailedWorkspaceChangeRequest) SetWorkspaceId(v string) *FailedWorkspaceChangeRequest
SetWorkspaceId sets the WorkspaceId field's value.
func (FailedWorkspaceChangeRequest) String ¶
func (s FailedWorkspaceChangeRequest) String() string
String returns the string representation
type ModifyWorkspacePropertiesInput ¶
type ModifyWorkspacePropertiesInput struct { // The ID of the WorkSpace. // // WorkspaceId is a required field WorkspaceId *string `type:"string" required:"true"` // The WorkSpace properties of the request. // // WorkspaceProperties is a required field WorkspaceProperties *WorkspaceProperties `type:"structure" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspacePropertiesRequest
func (ModifyWorkspacePropertiesInput) GoString ¶
func (s ModifyWorkspacePropertiesInput) GoString() string
GoString returns the string representation
func (*ModifyWorkspacePropertiesInput) SetWorkspaceId ¶
func (s *ModifyWorkspacePropertiesInput) SetWorkspaceId(v string) *ModifyWorkspacePropertiesInput
SetWorkspaceId sets the WorkspaceId field's value.
func (*ModifyWorkspacePropertiesInput) SetWorkspaceProperties ¶
func (s *ModifyWorkspacePropertiesInput) SetWorkspaceProperties(v *WorkspaceProperties) *ModifyWorkspacePropertiesInput
SetWorkspaceProperties sets the WorkspaceProperties field's value.
func (ModifyWorkspacePropertiesInput) String ¶
func (s ModifyWorkspacePropertiesInput) String() string
String returns the string representation
func (*ModifyWorkspacePropertiesInput) Validate ¶
func (s *ModifyWorkspacePropertiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ModifyWorkspacePropertiesOutput ¶
type ModifyWorkspacePropertiesOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspacePropertiesResult
func (ModifyWorkspacePropertiesOutput) GoString ¶
func (s ModifyWorkspacePropertiesOutput) GoString() string
GoString returns the string representation
func (ModifyWorkspacePropertiesOutput) String ¶
func (s ModifyWorkspacePropertiesOutput) String() string
String returns the string representation
type RebootRequest ¶
type RebootRequest struct { // The identifier of the WorkSpace to reboot. // // WorkspaceId is a required field WorkspaceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains information used with the RebootWorkspaces operation to reboot a WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootRequest
func (RebootRequest) GoString ¶
func (s RebootRequest) GoString() string
GoString returns the string representation
func (*RebootRequest) SetWorkspaceId ¶
func (s *RebootRequest) SetWorkspaceId(v string) *RebootRequest
SetWorkspaceId sets the WorkspaceId field's value.
func (RebootRequest) String ¶
func (s RebootRequest) String() string
String returns the string representation
func (*RebootRequest) Validate ¶
func (s *RebootRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RebootWorkspacesInput ¶
type RebootWorkspacesInput struct { // An array of structures that specify the WorkSpaces to reboot. // // RebootWorkspaceRequests is a required field RebootWorkspaceRequests []*RebootRequest `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the RebootWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspacesRequest
func (RebootWorkspacesInput) GoString ¶
func (s RebootWorkspacesInput) GoString() string
GoString returns the string representation
func (*RebootWorkspacesInput) SetRebootWorkspaceRequests ¶
func (s *RebootWorkspacesInput) SetRebootWorkspaceRequests(v []*RebootRequest) *RebootWorkspacesInput
SetRebootWorkspaceRequests sets the RebootWorkspaceRequests field's value.
func (RebootWorkspacesInput) String ¶
func (s RebootWorkspacesInput) String() string
String returns the string representation
func (*RebootWorkspacesInput) Validate ¶
func (s *RebootWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RebootWorkspacesOutput ¶
type RebootWorkspacesOutput struct { // An array of structures representing any WorkSpaces that could not be rebooted. FailedRequests []*FailedWorkspaceChangeRequest `type:"list"` // contains filtered or unexported fields }
Contains the results of the RebootWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspacesResult
func (RebootWorkspacesOutput) GoString ¶
func (s RebootWorkspacesOutput) GoString() string
GoString returns the string representation
func (*RebootWorkspacesOutput) SetFailedRequests ¶
func (s *RebootWorkspacesOutput) SetFailedRequests(v []*FailedWorkspaceChangeRequest) *RebootWorkspacesOutput
SetFailedRequests sets the FailedRequests field's value.
func (RebootWorkspacesOutput) String ¶
func (s RebootWorkspacesOutput) String() string
String returns the string representation
type RebuildRequest ¶
type RebuildRequest struct { // The identifier of the WorkSpace to rebuild. // // WorkspaceId is a required field WorkspaceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains information used with the RebuildWorkspaces operation to rebuild a WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildRequest
func (RebuildRequest) GoString ¶
func (s RebuildRequest) GoString() string
GoString returns the string representation
func (*RebuildRequest) SetWorkspaceId ¶
func (s *RebuildRequest) SetWorkspaceId(v string) *RebuildRequest
SetWorkspaceId sets the WorkspaceId field's value.
func (RebuildRequest) String ¶
func (s RebuildRequest) String() string
String returns the string representation
func (*RebuildRequest) Validate ¶
func (s *RebuildRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RebuildWorkspacesInput ¶
type RebuildWorkspacesInput struct { // An array of structures that specify the WorkSpaces to rebuild. // // RebuildWorkspaceRequests is a required field RebuildWorkspaceRequests []*RebuildRequest `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the RebuildWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspacesRequest
func (RebuildWorkspacesInput) GoString ¶
func (s RebuildWorkspacesInput) GoString() string
GoString returns the string representation
func (*RebuildWorkspacesInput) SetRebuildWorkspaceRequests ¶
func (s *RebuildWorkspacesInput) SetRebuildWorkspaceRequests(v []*RebuildRequest) *RebuildWorkspacesInput
SetRebuildWorkspaceRequests sets the RebuildWorkspaceRequests field's value.
func (RebuildWorkspacesInput) String ¶
func (s RebuildWorkspacesInput) String() string
String returns the string representation
func (*RebuildWorkspacesInput) Validate ¶
func (s *RebuildWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RebuildWorkspacesOutput ¶
type RebuildWorkspacesOutput struct { // An array of structures representing any WorkSpaces that could not be rebuilt. FailedRequests []*FailedWorkspaceChangeRequest `type:"list"` // contains filtered or unexported fields }
Contains the results of the RebuildWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspacesResult
func (RebuildWorkspacesOutput) GoString ¶
func (s RebuildWorkspacesOutput) GoString() string
GoString returns the string representation
func (*RebuildWorkspacesOutput) SetFailedRequests ¶
func (s *RebuildWorkspacesOutput) SetFailedRequests(v []*FailedWorkspaceChangeRequest) *RebuildWorkspacesOutput
SetFailedRequests sets the FailedRequests field's value.
func (RebuildWorkspacesOutput) String ¶
func (s RebuildWorkspacesOutput) String() string
String returns the string representation
type StartRequest ¶
type StartRequest struct { // The ID of the WorkSpace. WorkspaceId *string `type:"string"` // contains filtered or unexported fields }
Describes the start request. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartRequest
func (StartRequest) GoString ¶
func (s StartRequest) GoString() string
GoString returns the string representation
func (*StartRequest) SetWorkspaceId ¶
func (s *StartRequest) SetWorkspaceId(v string) *StartRequest
SetWorkspaceId sets the WorkspaceId field's value.
func (StartRequest) String ¶
func (s StartRequest) String() string
String returns the string representation
type StartWorkspacesInput ¶
type StartWorkspacesInput struct { // The requests. // // StartWorkspaceRequests is a required field StartWorkspaceRequests []*StartRequest `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspacesRequest
func (StartWorkspacesInput) GoString ¶
func (s StartWorkspacesInput) GoString() string
GoString returns the string representation
func (*StartWorkspacesInput) SetStartWorkspaceRequests ¶
func (s *StartWorkspacesInput) SetStartWorkspaceRequests(v []*StartRequest) *StartWorkspacesInput
SetStartWorkspaceRequests sets the StartWorkspaceRequests field's value.
func (StartWorkspacesInput) String ¶
func (s StartWorkspacesInput) String() string
String returns the string representation
func (*StartWorkspacesInput) Validate ¶
func (s *StartWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartWorkspacesOutput ¶
type StartWorkspacesOutput struct { // The failed requests. FailedRequests []*FailedWorkspaceChangeRequest `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspacesResult
func (StartWorkspacesOutput) GoString ¶
func (s StartWorkspacesOutput) GoString() string
GoString returns the string representation
func (*StartWorkspacesOutput) SetFailedRequests ¶
func (s *StartWorkspacesOutput) SetFailedRequests(v []*FailedWorkspaceChangeRequest) *StartWorkspacesOutput
SetFailedRequests sets the FailedRequests field's value.
func (StartWorkspacesOutput) String ¶
func (s StartWorkspacesOutput) String() string
String returns the string representation
type StopRequest ¶
type StopRequest struct { // The ID of the WorkSpace. WorkspaceId *string `type:"string"` // contains filtered or unexported fields }
Describes the stop request. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopRequest
func (StopRequest) GoString ¶
func (s StopRequest) GoString() string
GoString returns the string representation
func (*StopRequest) SetWorkspaceId ¶
func (s *StopRequest) SetWorkspaceId(v string) *StopRequest
SetWorkspaceId sets the WorkspaceId field's value.
func (StopRequest) String ¶
func (s StopRequest) String() string
String returns the string representation
type StopWorkspacesInput ¶
type StopWorkspacesInput struct { // The requests. // // StopWorkspaceRequests is a required field StopWorkspaceRequests []*StopRequest `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspacesRequest
func (StopWorkspacesInput) GoString ¶
func (s StopWorkspacesInput) GoString() string
GoString returns the string representation
func (*StopWorkspacesInput) SetStopWorkspaceRequests ¶
func (s *StopWorkspacesInput) SetStopWorkspaceRequests(v []*StopRequest) *StopWorkspacesInput
SetStopWorkspaceRequests sets the StopWorkspaceRequests field's value.
func (StopWorkspacesInput) String ¶
func (s StopWorkspacesInput) String() string
String returns the string representation
func (*StopWorkspacesInput) Validate ¶
func (s *StopWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopWorkspacesOutput ¶
type StopWorkspacesOutput struct { // The failed requests. FailedRequests []*FailedWorkspaceChangeRequest `type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspacesResult
func (StopWorkspacesOutput) GoString ¶
func (s StopWorkspacesOutput) GoString() string
GoString returns the string representation
func (*StopWorkspacesOutput) SetFailedRequests ¶
func (s *StopWorkspacesOutput) SetFailedRequests(v []*FailedWorkspaceChangeRequest) *StopWorkspacesOutput
SetFailedRequests sets the FailedRequests field's value.
func (StopWorkspacesOutput) String ¶
func (s StopWorkspacesOutput) String() string
String returns the string representation
type Tag ¶
type Tag struct { // The key of the tag. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // The value of the tag. Value *string `type:"string"` // contains filtered or unexported fields }
Describes the tag of the WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/Tag
type TerminateRequest ¶
type TerminateRequest struct { // The identifier of the WorkSpace to terminate. // // WorkspaceId is a required field WorkspaceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains information used with the TerminateWorkspaces operation to terminate a WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateRequest
func (TerminateRequest) GoString ¶
func (s TerminateRequest) GoString() string
GoString returns the string representation
func (*TerminateRequest) SetWorkspaceId ¶
func (s *TerminateRequest) SetWorkspaceId(v string) *TerminateRequest
SetWorkspaceId sets the WorkspaceId field's value.
func (TerminateRequest) String ¶
func (s TerminateRequest) String() string
String returns the string representation
func (*TerminateRequest) Validate ¶
func (s *TerminateRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TerminateWorkspacesInput ¶
type TerminateWorkspacesInput struct { // An array of structures that specify the WorkSpaces to terminate. // // TerminateWorkspaceRequests is a required field TerminateWorkspaceRequests []*TerminateRequest `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the TerminateWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspacesRequest
func (TerminateWorkspacesInput) GoString ¶
func (s TerminateWorkspacesInput) GoString() string
GoString returns the string representation
func (*TerminateWorkspacesInput) SetTerminateWorkspaceRequests ¶
func (s *TerminateWorkspacesInput) SetTerminateWorkspaceRequests(v []*TerminateRequest) *TerminateWorkspacesInput
SetTerminateWorkspaceRequests sets the TerminateWorkspaceRequests field's value.
func (TerminateWorkspacesInput) String ¶
func (s TerminateWorkspacesInput) String() string
String returns the string representation
func (*TerminateWorkspacesInput) Validate ¶
func (s *TerminateWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TerminateWorkspacesOutput ¶
type TerminateWorkspacesOutput struct { // An array of structures representing any WorkSpaces that could not be terminated. FailedRequests []*FailedWorkspaceChangeRequest `type:"list"` // contains filtered or unexported fields }
Contains the results of the TerminateWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspacesResult
func (TerminateWorkspacesOutput) GoString ¶
func (s TerminateWorkspacesOutput) GoString() string
GoString returns the string representation
func (*TerminateWorkspacesOutput) SetFailedRequests ¶
func (s *TerminateWorkspacesOutput) SetFailedRequests(v []*FailedWorkspaceChangeRequest) *TerminateWorkspacesOutput
SetFailedRequests sets the FailedRequests field's value.
func (TerminateWorkspacesOutput) String ¶
func (s TerminateWorkspacesOutput) String() string
String returns the string representation
type UserStorage ¶
type UserStorage struct { // The amount of user storage for the bundle. Capacity *string `min:"1" type:"string"` // contains filtered or unexported fields }
Contains information about the user storage for a WorkSpace bundle. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UserStorage
func (UserStorage) GoString ¶
func (s UserStorage) GoString() string
GoString returns the string representation
func (*UserStorage) SetCapacity ¶
func (s *UserStorage) SetCapacity(v string) *UserStorage
SetCapacity sets the Capacity field's value.
func (UserStorage) String ¶
func (s UserStorage) String() string
String returns the string representation
type WorkSpaces ¶
This reference provides detailed information about the Amazon WorkSpaces operations. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *WorkSpaces
New creates a new instance of the WorkSpaces 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:
// Create a WorkSpaces client from just a session. svc := workspaces.New(mySession) // Create a WorkSpaces client with additional configuration svc := workspaces.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*WorkSpaces) CreateTags ¶
func (c *WorkSpaces) CreateTags(input *CreateTagsInput) (*CreateTagsOutput, error)
CreateTags API operation for Amazon WorkSpaces.
Creates tags for a WorkSpace.
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 Amazon WorkSpaces's API operation CreateTags for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" The resource could not be found.
ErrCodeInvalidParameterValuesException "InvalidParameterValuesException" One or more parameter values are not valid.
ErrCodeResourceLimitExceededException "ResourceLimitExceededException" Your resource limits have been exceeded.
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTags
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.CreateTagsInput{ ResourceId: aws.String("NonEmptyString"), // Required Tags: []*workspaces.Tag{ // Required { // Required Key: aws.String("TagKey"), // Required Value: aws.String("TagValue"), }, // More values... }, } resp, err := svc.CreateTags(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) CreateTagsRequest ¶
func (c *WorkSpaces) CreateTagsRequest(input *CreateTagsInput) (req *request.Request, output *CreateTagsOutput)
CreateTagsRequest generates a "aws/request.Request" representing the client's request for the CreateTags operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateTags for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateTags method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateTagsRequest method. req, resp := client.CreateTagsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTags
func (*WorkSpaces) CreateTagsWithContext ¶
func (c *WorkSpaces) CreateTagsWithContext(ctx aws.Context, input *CreateTagsInput, opts ...request.Option) (*CreateTagsOutput, error)
CreateTagsWithContext is the same as CreateTags with the addition of the ability to pass a context and additional request options.
See CreateTags 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 (*WorkSpaces) CreateWorkspaces ¶
func (c *WorkSpaces) CreateWorkspaces(input *CreateWorkspacesInput) (*CreateWorkspacesOutput, error)
CreateWorkspaces API operation for Amazon WorkSpaces.
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
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 Amazon WorkSpaces's API operation CreateWorkspaces for usage and error information.
Returned Error Codes:
ErrCodeResourceLimitExceededException "ResourceLimitExceededException" Your resource limits have been exceeded.
ErrCodeInvalidParameterValuesException "InvalidParameterValuesException" One or more parameter values are not valid.
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaces
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.CreateWorkspacesInput{ Workspaces: []*workspaces.WorkspaceRequest{ // Required { // Required BundleId: aws.String("BundleId"), // Required DirectoryId: aws.String("DirectoryId"), // Required UserName: aws.String("UserName"), // Required RootVolumeEncryptionEnabled: aws.Bool(true), Tags: []*workspaces.Tag{ { // Required Key: aws.String("TagKey"), // Required Value: aws.String("TagValue"), }, // More values... }, UserVolumeEncryptionEnabled: aws.Bool(true), VolumeEncryptionKey: aws.String("VolumeEncryptionKey"), WorkspaceProperties: &workspaces.WorkspaceProperties{ RunningMode: aws.String("RunningMode"), RunningModeAutoStopTimeoutInMinutes: aws.Int64(1), }, }, // More values... }, } resp, err := svc.CreateWorkspaces(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) CreateWorkspacesRequest ¶
func (c *WorkSpaces) CreateWorkspacesRequest(input *CreateWorkspacesInput) (req *request.Request, output *CreateWorkspacesOutput)
CreateWorkspacesRequest generates a "aws/request.Request" representing the client's request for the CreateWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateWorkspaces for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateWorkspaces method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateWorkspacesRequest method. req, resp := client.CreateWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaces
func (*WorkSpaces) CreateWorkspacesWithContext ¶
func (c *WorkSpaces) CreateWorkspacesWithContext(ctx aws.Context, input *CreateWorkspacesInput, opts ...request.Option) (*CreateWorkspacesOutput, error)
CreateWorkspacesWithContext is the same as CreateWorkspaces with the addition of the ability to pass a context and additional request options.
See CreateWorkspaces 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 (*WorkSpaces) DeleteTags ¶
func (c *WorkSpaces) DeleteTags(input *DeleteTagsInput) (*DeleteTagsOutput, error)
DeleteTags API operation for Amazon WorkSpaces.
Deletes tags from a WorkSpace.
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 Amazon WorkSpaces's API operation DeleteTags for usage and error information.
Returned Error Codes:
ErrCodeResourceNotFoundException "ResourceNotFoundException" The resource could not be found.
ErrCodeInvalidParameterValuesException "InvalidParameterValuesException" One or more parameter values are not valid.
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTags
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.DeleteTagsInput{ ResourceId: aws.String("NonEmptyString"), // Required TagKeys: []*string{ // Required aws.String("NonEmptyString"), // Required // More values... }, } resp, err := svc.DeleteTags(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) DeleteTagsRequest ¶
func (c *WorkSpaces) DeleteTagsRequest(input *DeleteTagsInput) (req *request.Request, output *DeleteTagsOutput)
DeleteTagsRequest generates a "aws/request.Request" representing the client's request for the DeleteTags operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteTags for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteTags method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteTagsRequest method. req, resp := client.DeleteTagsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTags
func (*WorkSpaces) DeleteTagsWithContext ¶
func (c *WorkSpaces) DeleteTagsWithContext(ctx aws.Context, input *DeleteTagsInput, opts ...request.Option) (*DeleteTagsOutput, error)
DeleteTagsWithContext is the same as DeleteTags with the addition of the ability to pass a context and additional request options.
See DeleteTags 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 (*WorkSpaces) DescribeTags ¶
func (c *WorkSpaces) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error)
DescribeTags API operation for Amazon WorkSpaces.
Describes tags for a WorkSpace.
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 Amazon WorkSpaces's API operation DescribeTags for usage and error information.
Returned Error Codes:
- ErrCodeResourceNotFoundException "ResourceNotFoundException" The resource could not be found.
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTags
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.DescribeTagsInput{ ResourceId: aws.String("NonEmptyString"), // Required } resp, err := svc.DescribeTags(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) DescribeTagsRequest ¶
func (c *WorkSpaces) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput)
DescribeTagsRequest generates a "aws/request.Request" representing the client's request for the DescribeTags operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeTags for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeTags method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeTagsRequest method. req, resp := client.DescribeTagsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTags
func (*WorkSpaces) DescribeTagsWithContext ¶
func (c *WorkSpaces) DescribeTagsWithContext(ctx aws.Context, input *DescribeTagsInput, opts ...request.Option) (*DescribeTagsOutput, error)
DescribeTagsWithContext is the same as DescribeTags with the addition of the ability to pass a context and additional request options.
See DescribeTags 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 (*WorkSpaces) DescribeWorkspaceBundles ¶
func (c *WorkSpaces) DescribeWorkspaceBundles(input *DescribeWorkspaceBundlesInput) (*DescribeWorkspaceBundlesOutput, error)
DescribeWorkspaceBundles API operation for Amazon WorkSpaces.
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.
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 Amazon WorkSpaces's API operation DescribeWorkspaceBundles for usage and error information.
Returned Error Codes:
- ErrCodeInvalidParameterValuesException "InvalidParameterValuesException" One or more parameter values are not valid.
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundles
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.DescribeWorkspaceBundlesInput{ BundleIds: []*string{ aws.String("BundleId"), // Required // More values... }, NextToken: aws.String("PaginationToken"), Owner: aws.String("BundleOwner"), } resp, err := svc.DescribeWorkspaceBundles(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) DescribeWorkspaceBundlesPages ¶
func (c *WorkSpaces) DescribeWorkspaceBundlesPages(input *DescribeWorkspaceBundlesInput, fn func(*DescribeWorkspaceBundlesOutput, bool) bool) error
DescribeWorkspaceBundlesPages iterates over the pages of a DescribeWorkspaceBundles operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeWorkspaceBundles 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 DescribeWorkspaceBundles operation. pageNum := 0 err := client.DescribeWorkspaceBundlesPages(params, func(page *DescribeWorkspaceBundlesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*WorkSpaces) DescribeWorkspaceBundlesPagesWithContext ¶
func (c *WorkSpaces) DescribeWorkspaceBundlesPagesWithContext(ctx aws.Context, input *DescribeWorkspaceBundlesInput, fn func(*DescribeWorkspaceBundlesOutput, bool) bool, opts ...request.Option) error
DescribeWorkspaceBundlesPagesWithContext same as DescribeWorkspaceBundlesPages 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 (*WorkSpaces) DescribeWorkspaceBundlesRequest ¶
func (c *WorkSpaces) DescribeWorkspaceBundlesRequest(input *DescribeWorkspaceBundlesInput) (req *request.Request, output *DescribeWorkspaceBundlesOutput)
DescribeWorkspaceBundlesRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaceBundles operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeWorkspaceBundles for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeWorkspaceBundles method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeWorkspaceBundlesRequest method. req, resp := client.DescribeWorkspaceBundlesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundles
func (*WorkSpaces) DescribeWorkspaceBundlesWithContext ¶
func (c *WorkSpaces) DescribeWorkspaceBundlesWithContext(ctx aws.Context, input *DescribeWorkspaceBundlesInput, opts ...request.Option) (*DescribeWorkspaceBundlesOutput, error)
DescribeWorkspaceBundlesWithContext is the same as DescribeWorkspaceBundles with the addition of the ability to pass a context and additional request options.
See DescribeWorkspaceBundles 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 (*WorkSpaces) DescribeWorkspaceDirectories ¶
func (c *WorkSpaces) DescribeWorkspaceDirectories(input *DescribeWorkspaceDirectoriesInput) (*DescribeWorkspaceDirectoriesOutput, error)
DescribeWorkspaceDirectories API operation for Amazon WorkSpaces.
Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.
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 Amazon WorkSpaces's API operation DescribeWorkspaceDirectories for usage and error information.
Returned Error Codes:
- ErrCodeInvalidParameterValuesException "InvalidParameterValuesException" One or more parameter values are not valid.
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.DescribeWorkspaceDirectoriesInput{ DirectoryIds: []*string{ aws.String("DirectoryId"), // Required // More values... }, NextToken: aws.String("PaginationToken"), } resp, err := svc.DescribeWorkspaceDirectories(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) DescribeWorkspaceDirectoriesPages ¶
func (c *WorkSpaces) DescribeWorkspaceDirectoriesPages(input *DescribeWorkspaceDirectoriesInput, fn func(*DescribeWorkspaceDirectoriesOutput, bool) bool) error
DescribeWorkspaceDirectoriesPages iterates over the pages of a DescribeWorkspaceDirectories operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeWorkspaceDirectories 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 DescribeWorkspaceDirectories operation. pageNum := 0 err := client.DescribeWorkspaceDirectoriesPages(params, func(page *DescribeWorkspaceDirectoriesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*WorkSpaces) DescribeWorkspaceDirectoriesPagesWithContext ¶
func (c *WorkSpaces) DescribeWorkspaceDirectoriesPagesWithContext(ctx aws.Context, input *DescribeWorkspaceDirectoriesInput, fn func(*DescribeWorkspaceDirectoriesOutput, bool) bool, opts ...request.Option) error
DescribeWorkspaceDirectoriesPagesWithContext same as DescribeWorkspaceDirectoriesPages 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 (*WorkSpaces) DescribeWorkspaceDirectoriesRequest ¶
func (c *WorkSpaces) DescribeWorkspaceDirectoriesRequest(input *DescribeWorkspaceDirectoriesInput) (req *request.Request, output *DescribeWorkspaceDirectoriesOutput)
DescribeWorkspaceDirectoriesRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaceDirectories operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeWorkspaceDirectories for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeWorkspaceDirectories method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeWorkspaceDirectoriesRequest method. req, resp := client.DescribeWorkspaceDirectoriesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories
func (*WorkSpaces) DescribeWorkspaceDirectoriesWithContext ¶
func (c *WorkSpaces) DescribeWorkspaceDirectoriesWithContext(ctx aws.Context, input *DescribeWorkspaceDirectoriesInput, opts ...request.Option) (*DescribeWorkspaceDirectoriesOutput, error)
DescribeWorkspaceDirectoriesWithContext is the same as DescribeWorkspaceDirectories with the addition of the ability to pass a context and additional request options.
See DescribeWorkspaceDirectories 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 (*WorkSpaces) DescribeWorkspaces ¶
func (c *WorkSpaces) DescribeWorkspaces(input *DescribeWorkspacesInput) (*DescribeWorkspacesOutput, error)
DescribeWorkspaces API operation for Amazon WorkSpaces.
Obtains information about the specified WorkSpaces.
Only one of the filter parameters, such as BundleId, DirectoryId, or WorkspaceIds, can be specified at a time.
This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.
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 Amazon WorkSpaces's API operation DescribeWorkspaces for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterValuesException "InvalidParameterValuesException" One or more parameter values are not valid.
ErrCodeResourceUnavailableException "ResourceUnavailableException" The specified resource is not available.
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaces
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.DescribeWorkspacesInput{ BundleId: aws.String("BundleId"), DirectoryId: aws.String("DirectoryId"), Limit: aws.Int64(1), NextToken: aws.String("PaginationToken"), UserName: aws.String("UserName"), WorkspaceIds: []*string{ aws.String("WorkspaceId"), // Required // More values... }, } resp, err := svc.DescribeWorkspaces(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) DescribeWorkspacesConnectionStatus ¶
func (c *WorkSpaces) DescribeWorkspacesConnectionStatus(input *DescribeWorkspacesConnectionStatusInput) (*DescribeWorkspacesConnectionStatusOutput, error)
DescribeWorkspacesConnectionStatus API operation for Amazon WorkSpaces.
Describes the connection status of a specified WorkSpace.
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 Amazon WorkSpaces's API operation DescribeWorkspacesConnectionStatus for usage and error information.
Returned Error Codes:
- ErrCodeInvalidParameterValuesException "InvalidParameterValuesException" One or more parameter values are not valid.
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.DescribeWorkspacesConnectionStatusInput{ NextToken: aws.String("PaginationToken"), WorkspaceIds: []*string{ aws.String("WorkspaceId"), // Required // More values... }, } resp, err := svc.DescribeWorkspacesConnectionStatus(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) DescribeWorkspacesConnectionStatusRequest ¶
func (c *WorkSpaces) DescribeWorkspacesConnectionStatusRequest(input *DescribeWorkspacesConnectionStatusInput) (req *request.Request, output *DescribeWorkspacesConnectionStatusOutput)
DescribeWorkspacesConnectionStatusRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspacesConnectionStatus operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeWorkspacesConnectionStatus for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeWorkspacesConnectionStatus method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeWorkspacesConnectionStatusRequest method. req, resp := client.DescribeWorkspacesConnectionStatusRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus
func (*WorkSpaces) DescribeWorkspacesConnectionStatusWithContext ¶
func (c *WorkSpaces) DescribeWorkspacesConnectionStatusWithContext(ctx aws.Context, input *DescribeWorkspacesConnectionStatusInput, opts ...request.Option) (*DescribeWorkspacesConnectionStatusOutput, error)
DescribeWorkspacesConnectionStatusWithContext is the same as DescribeWorkspacesConnectionStatus with the addition of the ability to pass a context and additional request options.
See DescribeWorkspacesConnectionStatus 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 (*WorkSpaces) DescribeWorkspacesPages ¶
func (c *WorkSpaces) DescribeWorkspacesPages(input *DescribeWorkspacesInput, fn func(*DescribeWorkspacesOutput, bool) bool) error
DescribeWorkspacesPages iterates over the pages of a DescribeWorkspaces operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeWorkspaces 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 DescribeWorkspaces operation. pageNum := 0 err := client.DescribeWorkspacesPages(params, func(page *DescribeWorkspacesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*WorkSpaces) DescribeWorkspacesPagesWithContext ¶
func (c *WorkSpaces) DescribeWorkspacesPagesWithContext(ctx aws.Context, input *DescribeWorkspacesInput, fn func(*DescribeWorkspacesOutput, bool) bool, opts ...request.Option) error
DescribeWorkspacesPagesWithContext same as DescribeWorkspacesPages 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 (*WorkSpaces) DescribeWorkspacesRequest ¶
func (c *WorkSpaces) DescribeWorkspacesRequest(input *DescribeWorkspacesInput) (req *request.Request, output *DescribeWorkspacesOutput)
DescribeWorkspacesRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeWorkspaces for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeWorkspaces method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeWorkspacesRequest method. req, resp := client.DescribeWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaces
func (*WorkSpaces) DescribeWorkspacesWithContext ¶
func (c *WorkSpaces) DescribeWorkspacesWithContext(ctx aws.Context, input *DescribeWorkspacesInput, opts ...request.Option) (*DescribeWorkspacesOutput, error)
DescribeWorkspacesWithContext is the same as DescribeWorkspaces with the addition of the ability to pass a context and additional request options.
See DescribeWorkspaces 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 (*WorkSpaces) ModifyWorkspaceProperties ¶
func (c *WorkSpaces) ModifyWorkspaceProperties(input *ModifyWorkspacePropertiesInput) (*ModifyWorkspacePropertiesOutput, error)
ModifyWorkspaceProperties API operation for Amazon WorkSpaces.
Modifies the WorkSpace properties, including the RunningMode and AutoStop time.
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 Amazon WorkSpaces's API operation ModifyWorkspaceProperties for usage and error information.
Returned Error Codes:
ErrCodeInvalidParameterValuesException "InvalidParameterValuesException" One or more parameter values are not valid.
ErrCodeInvalidResourceStateException "InvalidResourceStateException" The specified WorkSpace has an invalid state for this operation.
ErrCodeOperationInProgressException "OperationInProgressException" The properties of this WorkSpace are currently being modified. Try again in a moment.
ErrCodeUnsupportedWorkspaceConfigurationException "UnsupportedWorkspaceConfigurationException" The WorkSpace does not have the supported configuration for this operation. For more information, see the Amazon WorkSpaces Administration Guide (http://docs.aws.amazon.com/workspaces/latest/adminguide).
ErrCodeResourceNotFoundException "ResourceNotFoundException" The resource could not be found.
ErrCodeAccessDeniedException "AccessDeniedException"
ErrCodeResourceUnavailableException "ResourceUnavailableException" The specified resource is not available.
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceProperties
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.ModifyWorkspacePropertiesInput{ WorkspaceId: aws.String("WorkspaceId"), // Required WorkspaceProperties: &workspaces.WorkspaceProperties{ // Required RunningMode: aws.String("RunningMode"), RunningModeAutoStopTimeoutInMinutes: aws.Int64(1), }, } resp, err := svc.ModifyWorkspaceProperties(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) ModifyWorkspacePropertiesRequest ¶
func (c *WorkSpaces) ModifyWorkspacePropertiesRequest(input *ModifyWorkspacePropertiesInput) (req *request.Request, output *ModifyWorkspacePropertiesOutput)
ModifyWorkspacePropertiesRequest generates a "aws/request.Request" representing the client's request for the ModifyWorkspaceProperties operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See ModifyWorkspaceProperties for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ModifyWorkspaceProperties method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ModifyWorkspacePropertiesRequest method. req, resp := client.ModifyWorkspacePropertiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceProperties
func (*WorkSpaces) ModifyWorkspacePropertiesWithContext ¶
func (c *WorkSpaces) ModifyWorkspacePropertiesWithContext(ctx aws.Context, input *ModifyWorkspacePropertiesInput, opts ...request.Option) (*ModifyWorkspacePropertiesOutput, error)
ModifyWorkspacePropertiesWithContext is the same as ModifyWorkspaceProperties with the addition of the ability to pass a context and additional request options.
See ModifyWorkspaceProperties 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 (*WorkSpaces) RebootWorkspaces ¶
func (c *WorkSpaces) RebootWorkspaces(input *RebootWorkspacesInput) (*RebootWorkspacesOutput, error)
RebootWorkspaces API operation for Amazon WorkSpaces.
Reboots the specified WorkSpaces.
To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE, IMPAIRED, or INOPERABLE.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
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 Amazon WorkSpaces's API operation RebootWorkspaces for usage and error information. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspaces
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.RebootWorkspacesInput{ RebootWorkspaceRequests: []*workspaces.RebootRequest{ // Required { // Required WorkspaceId: aws.String("WorkspaceId"), // Required }, // More values... }, } resp, err := svc.RebootWorkspaces(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) RebootWorkspacesRequest ¶
func (c *WorkSpaces) RebootWorkspacesRequest(input *RebootWorkspacesInput) (req *request.Request, output *RebootWorkspacesOutput)
RebootWorkspacesRequest generates a "aws/request.Request" representing the client's request for the RebootWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See RebootWorkspaces for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RebootWorkspaces method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the RebootWorkspacesRequest method. req, resp := client.RebootWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspaces
func (*WorkSpaces) RebootWorkspacesWithContext ¶
func (c *WorkSpaces) RebootWorkspacesWithContext(ctx aws.Context, input *RebootWorkspacesInput, opts ...request.Option) (*RebootWorkspacesOutput, error)
RebootWorkspacesWithContext is the same as RebootWorkspaces with the addition of the ability to pass a context and additional request options.
See RebootWorkspaces 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 (*WorkSpaces) RebuildWorkspaces ¶
func (c *WorkSpaces) RebuildWorkspaces(input *RebuildWorkspacesInput) (*RebuildWorkspacesOutput, error)
RebuildWorkspaces API operation for Amazon WorkSpaces.
Rebuilds the specified WorkSpaces.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur:
The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.
The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.
To be able to rebuild a WorkSpace, the WorkSpace must have a State of AVAILABLE or ERROR.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
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 Amazon WorkSpaces's API operation RebuildWorkspaces for usage and error information. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspaces
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.RebuildWorkspacesInput{ RebuildWorkspaceRequests: []*workspaces.RebuildRequest{ // Required { // Required WorkspaceId: aws.String("WorkspaceId"), // Required }, // More values... }, } resp, err := svc.RebuildWorkspaces(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) RebuildWorkspacesRequest ¶
func (c *WorkSpaces) RebuildWorkspacesRequest(input *RebuildWorkspacesInput) (req *request.Request, output *RebuildWorkspacesOutput)
RebuildWorkspacesRequest generates a "aws/request.Request" representing the client's request for the RebuildWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See RebuildWorkspaces for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RebuildWorkspaces method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the RebuildWorkspacesRequest method. req, resp := client.RebuildWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspaces
func (*WorkSpaces) RebuildWorkspacesWithContext ¶
func (c *WorkSpaces) RebuildWorkspacesWithContext(ctx aws.Context, input *RebuildWorkspacesInput, opts ...request.Option) (*RebuildWorkspacesOutput, error)
RebuildWorkspacesWithContext is the same as RebuildWorkspaces with the addition of the ability to pass a context and additional request options.
See RebuildWorkspaces 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 (*WorkSpaces) StartWorkspaces ¶
func (c *WorkSpaces) StartWorkspaces(input *StartWorkspacesInput) (*StartWorkspacesOutput, error)
StartWorkspaces API operation for Amazon WorkSpaces.
Starts the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to “STOPPED.”
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 Amazon WorkSpaces's API operation StartWorkspaces for usage and error information. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspaces
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.StartWorkspacesInput{ StartWorkspaceRequests: []*workspaces.StartRequest{ // Required { // Required WorkspaceId: aws.String("WorkspaceId"), }, // More values... }, } resp, err := svc.StartWorkspaces(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) StartWorkspacesRequest ¶
func (c *WorkSpaces) StartWorkspacesRequest(input *StartWorkspacesInput) (req *request.Request, output *StartWorkspacesOutput)
StartWorkspacesRequest generates a "aws/request.Request" representing the client's request for the StartWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See StartWorkspaces for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StartWorkspaces method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the StartWorkspacesRequest method. req, resp := client.StartWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspaces
func (*WorkSpaces) StartWorkspacesWithContext ¶
func (c *WorkSpaces) StartWorkspacesWithContext(ctx aws.Context, input *StartWorkspacesInput, opts ...request.Option) (*StartWorkspacesOutput, error)
StartWorkspacesWithContext is the same as StartWorkspaces with the addition of the ability to pass a context and additional request options.
See StartWorkspaces 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 (*WorkSpaces) StopWorkspaces ¶
func (c *WorkSpaces) StopWorkspaces(input *StopWorkspacesInput) (*StopWorkspacesOutput, error)
StopWorkspaces API operation for Amazon WorkSpaces.
Stops the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
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 Amazon WorkSpaces's API operation StopWorkspaces for usage and error information. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspaces
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.StopWorkspacesInput{ StopWorkspaceRequests: []*workspaces.StopRequest{ // Required { // Required WorkspaceId: aws.String("WorkspaceId"), }, // More values... }, } resp, err := svc.StopWorkspaces(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) StopWorkspacesRequest ¶
func (c *WorkSpaces) StopWorkspacesRequest(input *StopWorkspacesInput) (req *request.Request, output *StopWorkspacesOutput)
StopWorkspacesRequest generates a "aws/request.Request" representing the client's request for the StopWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See StopWorkspaces for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StopWorkspaces method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the StopWorkspacesRequest method. req, resp := client.StopWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspaces
func (*WorkSpaces) StopWorkspacesWithContext ¶
func (c *WorkSpaces) StopWorkspacesWithContext(ctx aws.Context, input *StopWorkspacesInput, opts ...request.Option) (*StopWorkspacesOutput, error)
StopWorkspacesWithContext is the same as StopWorkspaces with the addition of the ability to pass a context and additional request options.
See StopWorkspaces 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 (*WorkSpaces) TerminateWorkspaces ¶
func (c *WorkSpaces) TerminateWorkspaces(input *TerminateWorkspacesInput) (*TerminateWorkspacesOutput, error)
TerminateWorkspaces API operation for Amazon WorkSpaces.
Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.
You can terminate a WorkSpace that is in any state except SUSPENDED.
This operation is asynchronous and returns before the WorkSpaces have been completely terminated.
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 Amazon WorkSpaces's API operation TerminateWorkspaces for usage and error information. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspaces
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/workspaces" ) func main() { sess := session.Must(session.NewSession()) svc := workspaces.New(sess) params := &workspaces.TerminateWorkspacesInput{ TerminateWorkspaceRequests: []*workspaces.TerminateRequest{ // Required { // Required WorkspaceId: aws.String("WorkspaceId"), // Required }, // More values... }, } resp, err := svc.TerminateWorkspaces(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*WorkSpaces) TerminateWorkspacesRequest ¶
func (c *WorkSpaces) TerminateWorkspacesRequest(input *TerminateWorkspacesInput) (req *request.Request, output *TerminateWorkspacesOutput)
TerminateWorkspacesRequest generates a "aws/request.Request" representing the client's request for the TerminateWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See TerminateWorkspaces for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the TerminateWorkspaces method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the TerminateWorkspacesRequest method. req, resp := client.TerminateWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspaces
func (*WorkSpaces) TerminateWorkspacesWithContext ¶
func (c *WorkSpaces) TerminateWorkspacesWithContext(ctx aws.Context, input *TerminateWorkspacesInput, opts ...request.Option) (*TerminateWorkspacesOutput, error)
TerminateWorkspacesWithContext is the same as TerminateWorkspaces with the addition of the ability to pass a context and additional request options.
See TerminateWorkspaces 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 Workspace ¶
type Workspace struct { // The identifier of the bundle that the WorkSpace was created from. BundleId *string `type:"string"` // The name of the WorkSpace as seen by the operating system. ComputerName *string `type:"string"` // The identifier of the AWS Directory Service directory that the WorkSpace // belongs to. DirectoryId *string `type:"string"` // If the WorkSpace could not be created, this contains the error code. ErrorCode *string `type:"string"` // If the WorkSpace could not be created, this contains a textual error message // that describes the failure. ErrorMessage *string `type:"string"` // The IP address of the WorkSpace. IpAddress *string `type:"string"` // Specifies whether the data stored on the root volume, or C: drive, is encrypted. RootVolumeEncryptionEnabled *bool `type:"boolean"` // The operational state of the WorkSpace. State *string `type:"string" enum:"WorkspaceState"` // The identifier of the subnet that the WorkSpace is in. SubnetId *string `type:"string"` // The user that the WorkSpace is assigned to. UserName *string `min:"1" type:"string"` // Specifies whether the data stored on the user volume, or D: drive, is encrypted. UserVolumeEncryptionEnabled *bool `type:"boolean"` // The KMS key used to encrypt data stored on your WorkSpace. VolumeEncryptionKey *string `type:"string"` // The identifier of the WorkSpace. WorkspaceId *string `type:"string"` // Describes the properties of a WorkSpace. WorkspaceProperties *WorkspaceProperties `type:"structure"` // contains filtered or unexported fields }
Contains information about a WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/Workspace
func (*Workspace) SetBundleId ¶
SetBundleId sets the BundleId field's value.
func (*Workspace) SetComputerName ¶
SetComputerName sets the ComputerName field's value.
func (*Workspace) SetDirectoryId ¶
SetDirectoryId sets the DirectoryId field's value.
func (*Workspace) SetErrorCode ¶
SetErrorCode sets the ErrorCode field's value.
func (*Workspace) SetErrorMessage ¶
SetErrorMessage sets the ErrorMessage field's value.
func (*Workspace) SetIpAddress ¶
SetIpAddress sets the IpAddress field's value.
func (*Workspace) SetRootVolumeEncryptionEnabled ¶
SetRootVolumeEncryptionEnabled sets the RootVolumeEncryptionEnabled field's value.
func (*Workspace) SetSubnetId ¶
SetSubnetId sets the SubnetId field's value.
func (*Workspace) SetUserName ¶
SetUserName sets the UserName field's value.
func (*Workspace) SetUserVolumeEncryptionEnabled ¶
SetUserVolumeEncryptionEnabled sets the UserVolumeEncryptionEnabled field's value.
func (*Workspace) SetVolumeEncryptionKey ¶
SetVolumeEncryptionKey sets the VolumeEncryptionKey field's value.
func (*Workspace) SetWorkspaceId ¶
SetWorkspaceId sets the WorkspaceId field's value.
func (*Workspace) SetWorkspaceProperties ¶
func (s *Workspace) SetWorkspaceProperties(v *WorkspaceProperties) *Workspace
SetWorkspaceProperties sets the WorkspaceProperties field's value.
type WorkspaceBundle ¶
type WorkspaceBundle struct { // The bundle identifier. BundleId *string `type:"string"` // A ComputeType object that specifies the compute type for the bundle. ComputeType *ComputeType `type:"structure"` // The bundle description. Description *string `type:"string"` // The name of the bundle. Name *string `min:"1" type:"string"` // The owner of the bundle. This contains the owner's account identifier, or // AMAZON if the bundle is provided by AWS. Owner *string `type:"string"` // A UserStorage object that specifies the amount of user storage that the bundle // contains. UserStorage *UserStorage `type:"structure"` // contains filtered or unexported fields }
Contains information about a WorkSpace bundle. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceBundle
func (WorkspaceBundle) GoString ¶
func (s WorkspaceBundle) GoString() string
GoString returns the string representation
func (*WorkspaceBundle) SetBundleId ¶
func (s *WorkspaceBundle) SetBundleId(v string) *WorkspaceBundle
SetBundleId sets the BundleId field's value.
func (*WorkspaceBundle) SetComputeType ¶
func (s *WorkspaceBundle) SetComputeType(v *ComputeType) *WorkspaceBundle
SetComputeType sets the ComputeType field's value.
func (*WorkspaceBundle) SetDescription ¶
func (s *WorkspaceBundle) SetDescription(v string) *WorkspaceBundle
SetDescription sets the Description field's value.
func (*WorkspaceBundle) SetName ¶
func (s *WorkspaceBundle) SetName(v string) *WorkspaceBundle
SetName sets the Name field's value.
func (*WorkspaceBundle) SetOwner ¶
func (s *WorkspaceBundle) SetOwner(v string) *WorkspaceBundle
SetOwner sets the Owner field's value.
func (*WorkspaceBundle) SetUserStorage ¶
func (s *WorkspaceBundle) SetUserStorage(v *UserStorage) *WorkspaceBundle
SetUserStorage sets the UserStorage field's value.
func (WorkspaceBundle) String ¶
func (s WorkspaceBundle) String() string
String returns the string representation
type WorkspaceConnectionStatus ¶
type WorkspaceConnectionStatus struct { // The connection state of the WorkSpace. Returns UNKOWN if the WorkSpace is // in a Stopped state. ConnectionState *string `type:"string" enum:"ConnectionState"` // The timestamp of the connection state check. ConnectionStateCheckTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"` // The timestamp of the last known user connection. LastKnownUserConnectionTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"` // The ID of the WorkSpace. WorkspaceId *string `type:"string"` // contains filtered or unexported fields }
Describes the connection status of a WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceConnectionStatus
func (WorkspaceConnectionStatus) GoString ¶
func (s WorkspaceConnectionStatus) GoString() string
GoString returns the string representation
func (*WorkspaceConnectionStatus) SetConnectionState ¶
func (s *WorkspaceConnectionStatus) SetConnectionState(v string) *WorkspaceConnectionStatus
SetConnectionState sets the ConnectionState field's value.
func (*WorkspaceConnectionStatus) SetConnectionStateCheckTimestamp ¶
func (s *WorkspaceConnectionStatus) SetConnectionStateCheckTimestamp(v time.Time) *WorkspaceConnectionStatus
SetConnectionStateCheckTimestamp sets the ConnectionStateCheckTimestamp field's value.
func (*WorkspaceConnectionStatus) SetLastKnownUserConnectionTimestamp ¶
func (s *WorkspaceConnectionStatus) SetLastKnownUserConnectionTimestamp(v time.Time) *WorkspaceConnectionStatus
SetLastKnownUserConnectionTimestamp sets the LastKnownUserConnectionTimestamp field's value.
func (*WorkspaceConnectionStatus) SetWorkspaceId ¶
func (s *WorkspaceConnectionStatus) SetWorkspaceId(v string) *WorkspaceConnectionStatus
SetWorkspaceId sets the WorkspaceId field's value.
func (WorkspaceConnectionStatus) String ¶
func (s WorkspaceConnectionStatus) String() string
String returns the string representation
type WorkspaceDirectory ¶
type WorkspaceDirectory struct { // The directory alias. Alias *string `type:"string"` // The user name for the service account. CustomerUserName *string `min:"1" type:"string"` // The directory identifier. DirectoryId *string `type:"string"` // The name of the directory. DirectoryName *string `type:"string"` // The directory type. DirectoryType *string `type:"string" enum:"WorkspaceDirectoryType"` // An array of strings that contains the IP addresses of the DNS servers for // the directory. DnsIpAddresses []*string `type:"list"` // The identifier of the IAM role. This is the role that allows Amazon WorkSpaces // to make calls to other services, such as Amazon EC2, on your behalf. IamRoleId *string `type:"string"` // The registration code for the directory. This is the code that users enter // in their Amazon WorkSpaces client application to connect to the directory. RegistrationCode *string `min:"1" type:"string"` // The state of the directory's registration with Amazon WorkSpaces State *string `type:"string" enum:"WorkspaceDirectoryState"` // An array of strings that contains the identifiers of the subnets used with // the directory. SubnetIds []*string `type:"list"` // A structure that specifies the default creation properties for all WorkSpaces // in the directory. WorkspaceCreationProperties *DefaultWorkspaceCreationProperties `type:"structure"` // The identifier of the security group that is assigned to new WorkSpaces. WorkspaceSecurityGroupId *string `type:"string"` // contains filtered or unexported fields }
Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceDirectory
func (WorkspaceDirectory) GoString ¶
func (s WorkspaceDirectory) GoString() string
GoString returns the string representation
func (*WorkspaceDirectory) SetAlias ¶
func (s *WorkspaceDirectory) SetAlias(v string) *WorkspaceDirectory
SetAlias sets the Alias field's value.
func (*WorkspaceDirectory) SetCustomerUserName ¶
func (s *WorkspaceDirectory) SetCustomerUserName(v string) *WorkspaceDirectory
SetCustomerUserName sets the CustomerUserName field's value.
func (*WorkspaceDirectory) SetDirectoryId ¶
func (s *WorkspaceDirectory) SetDirectoryId(v string) *WorkspaceDirectory
SetDirectoryId sets the DirectoryId field's value.
func (*WorkspaceDirectory) SetDirectoryName ¶
func (s *WorkspaceDirectory) SetDirectoryName(v string) *WorkspaceDirectory
SetDirectoryName sets the DirectoryName field's value.
func (*WorkspaceDirectory) SetDirectoryType ¶
func (s *WorkspaceDirectory) SetDirectoryType(v string) *WorkspaceDirectory
SetDirectoryType sets the DirectoryType field's value.
func (*WorkspaceDirectory) SetDnsIpAddresses ¶
func (s *WorkspaceDirectory) SetDnsIpAddresses(v []*string) *WorkspaceDirectory
SetDnsIpAddresses sets the DnsIpAddresses field's value.
func (*WorkspaceDirectory) SetIamRoleId ¶
func (s *WorkspaceDirectory) SetIamRoleId(v string) *WorkspaceDirectory
SetIamRoleId sets the IamRoleId field's value.
func (*WorkspaceDirectory) SetRegistrationCode ¶
func (s *WorkspaceDirectory) SetRegistrationCode(v string) *WorkspaceDirectory
SetRegistrationCode sets the RegistrationCode field's value.
func (*WorkspaceDirectory) SetState ¶
func (s *WorkspaceDirectory) SetState(v string) *WorkspaceDirectory
SetState sets the State field's value.
func (*WorkspaceDirectory) SetSubnetIds ¶
func (s *WorkspaceDirectory) SetSubnetIds(v []*string) *WorkspaceDirectory
SetSubnetIds sets the SubnetIds field's value.
func (*WorkspaceDirectory) SetWorkspaceCreationProperties ¶
func (s *WorkspaceDirectory) SetWorkspaceCreationProperties(v *DefaultWorkspaceCreationProperties) *WorkspaceDirectory
SetWorkspaceCreationProperties sets the WorkspaceCreationProperties field's value.
func (*WorkspaceDirectory) SetWorkspaceSecurityGroupId ¶
func (s *WorkspaceDirectory) SetWorkspaceSecurityGroupId(v string) *WorkspaceDirectory
SetWorkspaceSecurityGroupId sets the WorkspaceSecurityGroupId field's value.
func (WorkspaceDirectory) String ¶
func (s WorkspaceDirectory) String() string
String returns the string representation
type WorkspaceProperties ¶
type WorkspaceProperties struct { // The running mode of the WorkSpace. AlwaysOn WorkSpaces are billed monthly. // AutoStop WorkSpaces are billed by the hour and stopped when no longer being // used in order to save on costs. RunningMode *string `type:"string" enum:"RunningMode"` // The time after a user logs off when WorkSpaces are automatically stopped. // Configured in 60 minute intervals. RunningModeAutoStopTimeoutInMinutes *int64 `type:"integer"` // contains filtered or unexported fields }
Describes the properties of a WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceProperties
func (WorkspaceProperties) GoString ¶
func (s WorkspaceProperties) GoString() string
GoString returns the string representation
func (*WorkspaceProperties) SetRunningMode ¶
func (s *WorkspaceProperties) SetRunningMode(v string) *WorkspaceProperties
SetRunningMode sets the RunningMode field's value.
func (*WorkspaceProperties) SetRunningModeAutoStopTimeoutInMinutes ¶
func (s *WorkspaceProperties) SetRunningModeAutoStopTimeoutInMinutes(v int64) *WorkspaceProperties
SetRunningModeAutoStopTimeoutInMinutes sets the RunningModeAutoStopTimeoutInMinutes field's value.
func (WorkspaceProperties) String ¶
func (s WorkspaceProperties) String() string
String returns the string representation
type WorkspaceRequest ¶
type WorkspaceRequest struct { // The identifier of the bundle to create the WorkSpace from. You can use the // DescribeWorkspaceBundles operation to obtain a list of the bundles that are // available. // // BundleId is a required field BundleId *string `type:"string" required:"true"` // The identifier of the AWS Directory Service directory to create the WorkSpace // in. You can use the DescribeWorkspaceDirectories operation to obtain a list // of the directories that are available. // // DirectoryId is a required field DirectoryId *string `type:"string" required:"true"` // Specifies whether the data stored on the root volume, or C: drive, is encrypted. RootVolumeEncryptionEnabled *bool `type:"boolean"` // The tags of the WorkSpace request. Tags []*Tag `type:"list"` // The username that the WorkSpace is assigned to. This username must exist // in the AWS Directory Service directory specified by the DirectoryId member. // // UserName is a required field UserName *string `min:"1" type:"string" required:"true"` // Specifies whether the data stored on the user volume, or D: drive, is encrypted. UserVolumeEncryptionEnabled *bool `type:"boolean"` // The KMS key used to encrypt data stored on your WorkSpace. VolumeEncryptionKey *string `type:"string"` // Describes the properties of a WorkSpace. WorkspaceProperties *WorkspaceProperties `type:"structure"` // contains filtered or unexported fields }
Contains information about a WorkSpace creation request. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceRequest
func (WorkspaceRequest) GoString ¶
func (s WorkspaceRequest) GoString() string
GoString returns the string representation
func (*WorkspaceRequest) SetBundleId ¶
func (s *WorkspaceRequest) SetBundleId(v string) *WorkspaceRequest
SetBundleId sets the BundleId field's value.
func (*WorkspaceRequest) SetDirectoryId ¶
func (s *WorkspaceRequest) SetDirectoryId(v string) *WorkspaceRequest
SetDirectoryId sets the DirectoryId field's value.
func (*WorkspaceRequest) SetRootVolumeEncryptionEnabled ¶
func (s *WorkspaceRequest) SetRootVolumeEncryptionEnabled(v bool) *WorkspaceRequest
SetRootVolumeEncryptionEnabled sets the RootVolumeEncryptionEnabled field's value.
func (*WorkspaceRequest) SetTags ¶
func (s *WorkspaceRequest) SetTags(v []*Tag) *WorkspaceRequest
SetTags sets the Tags field's value.
func (*WorkspaceRequest) SetUserName ¶
func (s *WorkspaceRequest) SetUserName(v string) *WorkspaceRequest
SetUserName sets the UserName field's value.
func (*WorkspaceRequest) SetUserVolumeEncryptionEnabled ¶
func (s *WorkspaceRequest) SetUserVolumeEncryptionEnabled(v bool) *WorkspaceRequest
SetUserVolumeEncryptionEnabled sets the UserVolumeEncryptionEnabled field's value.
func (*WorkspaceRequest) SetVolumeEncryptionKey ¶
func (s *WorkspaceRequest) SetVolumeEncryptionKey(v string) *WorkspaceRequest
SetVolumeEncryptionKey sets the VolumeEncryptionKey field's value.
func (*WorkspaceRequest) SetWorkspaceProperties ¶
func (s *WorkspaceRequest) SetWorkspaceProperties(v *WorkspaceProperties) *WorkspaceRequest
SetWorkspaceProperties sets the WorkspaceProperties field's value.
func (WorkspaceRequest) String ¶
func (s WorkspaceRequest) String() string
String returns the string representation
func (*WorkspaceRequest) Validate ¶
func (s *WorkspaceRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
Directories ¶
Path | Synopsis |
---|---|
Package workspacesiface provides an interface to enable mocking the Amazon WorkSpaces service client for testing your code.
|
Package workspacesiface provides an interface to enable mocking the Amazon WorkSpaces service client for testing your code. |