Documentation
¶
Overview ¶
Package workspaces provides the client and types for making API requests to Amazon WorkSpaces.
Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows desktops for your users.
See https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08 for more information on this service.
See workspaces package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/workspaces/
Using the Client ¶
To contact Amazon WorkSpaces with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon WorkSpaces client WorkSpaces for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/workspaces/#New
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 ModificationState
- 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 RootStorage
- 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) SetModificationStates(v []*ModificationState) *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) SetRootStorage(v *RootStorage) *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
- func (s WorkspaceProperties) GoString() string
- func (s *WorkspaceProperties) SetComputeTypeName(v string) *WorkspaceProperties
- func (s *WorkspaceProperties) SetRootVolumeSizeGib(v int64) *WorkspaceProperties
- func (s *WorkspaceProperties) SetRunningMode(v string) *WorkspaceProperties
- func (s *WorkspaceProperties) SetRunningModeAutoStopTimeoutInMinutes(v int64) *WorkspaceProperties
- func (s *WorkspaceProperties) SetUserVolumeSizeGib(v int64) *WorkspaceProperties
- func (s WorkspaceProperties) String() string
- 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
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" // ComputePower is a Compute enum value ComputePower = "POWER" // ComputeGraphics is a Compute enum value ComputeGraphics = "GRAPHICS" )
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 ( // ModificationResourceEnumRootVolume is a ModificationResourceEnum enum value ModificationResourceEnumRootVolume = "ROOT_VOLUME" // ModificationResourceEnumUserVolume is a ModificationResourceEnum enum value ModificationResourceEnumUserVolume = "USER_VOLUME" // ModificationResourceEnumComputeType is a ModificationResourceEnum enum value ModificationResourceEnumComputeType = "COMPUTE_TYPE" )
const ( // ModificationStateEnumUpdateInitiated is a ModificationStateEnum enum value ModificationStateEnumUpdateInitiated = "UPDATE_INITIATED" // ModificationStateEnumUpdateInProgress is a ModificationStateEnum enum value ModificationStateEnumUpdateInProgress = "UPDATE_IN_PROGRESS" )
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" // WorkspaceStateUpdating is a WorkspaceState enum value WorkspaceStateUpdating = "UPDATING" // 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". // // The user is not authorized to access a resource. 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 state of the WorkSpace is not valid 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 configuration of this WorkSpace is not supported 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 compute type. Name *string `type:"string" enum:"Compute"` // contains filtered or unexported fields }
Information about the compute type.
func (ComputeType) GoString ¶
func (s ComputeType) GoString() string
GoString returns the string representation
func (*ComputeType) SetName ¶ added in v1.6.16
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 ¶ added in v1.3.0
type CreateTagsInput struct { // The ID of the resource. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // The tags. Each resource can have a maximum of 50 tags. // // Tags is a required field Tags []*Tag `type:"list" required:"true"` // contains filtered or unexported fields }
func (CreateTagsInput) GoString ¶ added in v1.3.0
func (s CreateTagsInput) GoString() string
GoString returns the string representation
func (*CreateTagsInput) SetResourceId ¶ added in v1.6.16
func (s *CreateTagsInput) SetResourceId(v string) *CreateTagsInput
SetResourceId sets the ResourceId field's value.
func (*CreateTagsInput) SetTags ¶ added in v1.6.16
func (s *CreateTagsInput) SetTags(v []*Tag) *CreateTagsInput
SetTags sets the Tags field's value.
func (CreateTagsInput) String ¶ added in v1.3.0
func (s CreateTagsInput) String() string
String returns the string representation
func (*CreateTagsInput) Validate ¶ added in v1.3.0
func (s *CreateTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateTagsOutput ¶ added in v1.3.0
type CreateTagsOutput struct {
// contains filtered or unexported fields
}
func (CreateTagsOutput) GoString ¶ added in v1.3.0
func (s CreateTagsOutput) GoString() string
GoString returns the string representation
func (CreateTagsOutput) String ¶ added in v1.3.0
func (s CreateTagsOutput) String() string
String returns the string representation
type CreateWorkspacesInput ¶
type CreateWorkspacesInput struct { // Information about the WorkSpaces to create. // // Workspaces is a required field Workspaces []*WorkspaceRequest `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (CreateWorkspacesInput) GoString ¶
func (s CreateWorkspacesInput) GoString() string
GoString returns the string representation
func (*CreateWorkspacesInput) SetWorkspaces ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *CreateWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateWorkspacesOutput ¶
type CreateWorkspacesOutput struct { // Information about the WorkSpaces that could not be created. FailedRequests []*FailedCreateWorkspaceRequest `type:"list"` // Information about the WorkSpaces that were created. // // Because this operation is asynchronous, the identifier returned is not immediately // available for use with other operations. For example, if you call DescribeWorkspaces // before the WorkSpace is created, the information returned can be incomplete. PendingRequests []*Workspace `type:"list"` // contains filtered or unexported fields }
func (CreateWorkspacesOutput) GoString ¶
func (s CreateWorkspacesOutput) GoString() string
GoString returns the string representation
func (*CreateWorkspacesOutput) SetFailedRequests ¶ added in v1.6.16
func (s *CreateWorkspacesOutput) SetFailedRequests(v []*FailedCreateWorkspaceRequest) *CreateWorkspacesOutput
SetFailedRequests sets the FailedRequests field's value.
func (*CreateWorkspacesOutput) SetPendingRequests ¶ added in v1.6.16
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 security groups to apply to WorkSpaces when they are // created. CustomSecurityGroupId *string `type:"string"` // The organizational unit (OU) in the directory for the WorkSpace machine accounts. DefaultOu *string `type:"string"` // The public IP address to attach to all WorkSpaces that are created or rebuilt. EnableInternetAccess *bool `type:"boolean"` // Indicates whether the directory is enabled for Amazon WorkDocs. EnableWorkDocs *bool `type:"boolean"` // Indicates whether the WorkSpace user is an administrator on the WorkSpace. UserEnabledAsLocalAdministrator *bool `type:"boolean"` // contains filtered or unexported fields }
Information about defaults used to create a WorkSpace.
func (DefaultWorkspaceCreationProperties) GoString ¶
func (s DefaultWorkspaceCreationProperties) GoString() string
GoString returns the string representation
func (*DefaultWorkspaceCreationProperties) SetCustomSecurityGroupId ¶ added in v1.6.16
func (s *DefaultWorkspaceCreationProperties) SetCustomSecurityGroupId(v string) *DefaultWorkspaceCreationProperties
SetCustomSecurityGroupId sets the CustomSecurityGroupId field's value.
func (*DefaultWorkspaceCreationProperties) SetDefaultOu ¶ added in v1.6.16
func (s *DefaultWorkspaceCreationProperties) SetDefaultOu(v string) *DefaultWorkspaceCreationProperties
SetDefaultOu sets the DefaultOu field's value.
func (*DefaultWorkspaceCreationProperties) SetEnableInternetAccess ¶ added in v1.6.16
func (s *DefaultWorkspaceCreationProperties) SetEnableInternetAccess(v bool) *DefaultWorkspaceCreationProperties
SetEnableInternetAccess sets the EnableInternetAccess field's value.
func (*DefaultWorkspaceCreationProperties) SetEnableWorkDocs ¶ added in v1.6.16
func (s *DefaultWorkspaceCreationProperties) SetEnableWorkDocs(v bool) *DefaultWorkspaceCreationProperties
SetEnableWorkDocs sets the EnableWorkDocs field's value.
func (*DefaultWorkspaceCreationProperties) SetUserEnabledAsLocalAdministrator ¶ added in v1.6.16
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 ¶ added in v1.3.0
type DeleteTagsInput struct { // The ID of the resource. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // The tag keys. // // TagKeys is a required field TagKeys []*string `type:"list" required:"true"` // contains filtered or unexported fields }
func (DeleteTagsInput) GoString ¶ added in v1.3.0
func (s DeleteTagsInput) GoString() string
GoString returns the string representation
func (*DeleteTagsInput) SetResourceId ¶ added in v1.6.16
func (s *DeleteTagsInput) SetResourceId(v string) *DeleteTagsInput
SetResourceId sets the ResourceId field's value.
func (*DeleteTagsInput) SetTagKeys ¶ added in v1.6.16
func (s *DeleteTagsInput) SetTagKeys(v []*string) *DeleteTagsInput
SetTagKeys sets the TagKeys field's value.
func (DeleteTagsInput) String ¶ added in v1.3.0
func (s DeleteTagsInput) String() string
String returns the string representation
func (*DeleteTagsInput) Validate ¶ added in v1.3.0
func (s *DeleteTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteTagsOutput ¶ added in v1.3.0
type DeleteTagsOutput struct {
// contains filtered or unexported fields
}
func (DeleteTagsOutput) GoString ¶ added in v1.3.0
func (s DeleteTagsOutput) GoString() string
GoString returns the string representation
func (DeleteTagsOutput) String ¶ added in v1.3.0
func (s DeleteTagsOutput) String() string
String returns the string representation
type DescribeTagsInput ¶ added in v1.3.0
type DescribeTagsInput struct { // The ID of the resource. // // ResourceId is a required field ResourceId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeTagsInput) GoString ¶ added in v1.3.0
func (s DescribeTagsInput) GoString() string
GoString returns the string representation
func (*DescribeTagsInput) SetResourceId ¶ added in v1.6.16
func (s *DescribeTagsInput) SetResourceId(v string) *DescribeTagsInput
SetResourceId sets the ResourceId field's value.
func (DescribeTagsInput) String ¶ added in v1.3.0
func (s DescribeTagsInput) String() string
String returns the string representation
func (*DescribeTagsInput) Validate ¶ added in v1.3.0
func (s *DescribeTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTagsOutput ¶ added in v1.3.0
type DescribeTagsOutput struct { // The tags. TagList []*Tag `type:"list"` // contains filtered or unexported fields }
func (DescribeTagsOutput) GoString ¶ added in v1.3.0
func (s DescribeTagsOutput) GoString() string
GoString returns the string representation
func (*DescribeTagsOutput) SetTagList ¶ added in v1.6.16
func (s *DescribeTagsOutput) SetTagList(v []*Tag) *DescribeTagsOutput
SetTagList sets the TagList field's value.
func (DescribeTagsOutput) String ¶ added in v1.3.0
func (s DescribeTagsOutput) String() string
String returns the string representation
type DescribeWorkspaceBundlesInput ¶
type DescribeWorkspaceBundlesInput struct { // The IDs of the bundles. This parameter cannot be combined with any other // filter. BundleIds []*string `min:"1" type:"list"` // The token for the next set of results. (You received this token from a previous // call.) NextToken *string `min:"1" type:"string"` // The owner of the bundles. This parameter cannot be combined with any other // filter. // // Specify AMAZON to describe the bundles provided by AWS or null to describe // the bundles that belong to your account. Owner *string `type:"string"` // contains filtered or unexported fields }
func (DescribeWorkspaceBundlesInput) GoString ¶
func (s DescribeWorkspaceBundlesInput) GoString() string
GoString returns the string representation
func (*DescribeWorkspaceBundlesInput) SetBundleIds ¶ added in v1.6.16
func (s *DescribeWorkspaceBundlesInput) SetBundleIds(v []*string) *DescribeWorkspaceBundlesInput
SetBundleIds sets the BundleIds field's value.
func (*DescribeWorkspaceBundlesInput) SetNextToken ¶ added in v1.6.16
func (s *DescribeWorkspaceBundlesInput) SetNextToken(v string) *DescribeWorkspaceBundlesInput
SetNextToken sets the NextToken field's value.
func (*DescribeWorkspaceBundlesInput) SetOwner ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *DescribeWorkspaceBundlesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeWorkspaceBundlesOutput ¶
type DescribeWorkspaceBundlesOutput struct { // Information about the bundles. Bundles []*WorkspaceBundle `type:"list"` // The token to use to retrieve the next set of results, or null if there are // no more results available. 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 }
func (DescribeWorkspaceBundlesOutput) GoString ¶
func (s DescribeWorkspaceBundlesOutput) GoString() string
GoString returns the string representation
func (*DescribeWorkspaceBundlesOutput) SetBundles ¶ added in v1.6.16
func (s *DescribeWorkspaceBundlesOutput) SetBundles(v []*WorkspaceBundle) *DescribeWorkspaceBundlesOutput
SetBundles sets the Bundles field's value.
func (*DescribeWorkspaceBundlesOutput) SetNextToken ¶ added in v1.6.16
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 { // The identifiers of the directories. If the value is null, all directories // are retrieved. DirectoryIds []*string `min:"1" type:"list"` // The token for the next set of results. (You received this token from a previous // call.) NextToken *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (DescribeWorkspaceDirectoriesInput) GoString ¶
func (s DescribeWorkspaceDirectoriesInput) GoString() string
GoString returns the string representation
func (*DescribeWorkspaceDirectoriesInput) SetDirectoryIds ¶ added in v1.6.16
func (s *DescribeWorkspaceDirectoriesInput) SetDirectoryIds(v []*string) *DescribeWorkspaceDirectoriesInput
SetDirectoryIds sets the DirectoryIds field's value.
func (*DescribeWorkspaceDirectoriesInput) SetNextToken ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *DescribeWorkspaceDirectoriesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeWorkspaceDirectoriesOutput ¶
type DescribeWorkspaceDirectoriesOutput struct { // Information about the directories. Directories []*WorkspaceDirectory `type:"list"` // The token to use to retrieve the next set of results, or null if there are // no more results available. 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 }
func (DescribeWorkspaceDirectoriesOutput) GoString ¶
func (s DescribeWorkspaceDirectoriesOutput) GoString() string
GoString returns the string representation
func (*DescribeWorkspaceDirectoriesOutput) SetDirectories ¶ added in v1.6.16
func (s *DescribeWorkspaceDirectoriesOutput) SetDirectories(v []*WorkspaceDirectory) *DescribeWorkspaceDirectoriesOutput
SetDirectories sets the Directories field's value.
func (*DescribeWorkspaceDirectoriesOutput) SetNextToken ¶ added in v1.6.16
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 ¶ added in v1.6.16
type DescribeWorkspacesConnectionStatusInput struct { // The token for the next set of results. (You received this token from a previous // call.) NextToken *string `min:"1" type:"string"` // The identifiers of the WorkSpaces. WorkspaceIds []*string `min:"1" type:"list"` // contains filtered or unexported fields }
func (DescribeWorkspacesConnectionStatusInput) GoString ¶ added in v1.6.16
func (s DescribeWorkspacesConnectionStatusInput) GoString() string
GoString returns the string representation
func (*DescribeWorkspacesConnectionStatusInput) SetNextToken ¶ added in v1.6.16
func (s *DescribeWorkspacesConnectionStatusInput) SetNextToken(v string) *DescribeWorkspacesConnectionStatusInput
SetNextToken sets the NextToken field's value.
func (*DescribeWorkspacesConnectionStatusInput) SetWorkspaceIds ¶ added in v1.6.16
func (s *DescribeWorkspacesConnectionStatusInput) SetWorkspaceIds(v []*string) *DescribeWorkspacesConnectionStatusInput
SetWorkspaceIds sets the WorkspaceIds field's value.
func (DescribeWorkspacesConnectionStatusInput) String ¶ added in v1.6.16
func (s DescribeWorkspacesConnectionStatusInput) String() string
String returns the string representation
func (*DescribeWorkspacesConnectionStatusInput) Validate ¶ added in v1.6.16
func (s *DescribeWorkspacesConnectionStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeWorkspacesConnectionStatusOutput ¶ added in v1.6.16
type DescribeWorkspacesConnectionStatusOutput struct { // The token to use to retrieve the next set of results, or null if there are // no more results available. NextToken *string `min:"1" type:"string"` // Information about the connection status of the WorkSpace. WorkspacesConnectionStatus []*WorkspaceConnectionStatus `type:"list"` // contains filtered or unexported fields }
func (DescribeWorkspacesConnectionStatusOutput) GoString ¶ added in v1.6.16
func (s DescribeWorkspacesConnectionStatusOutput) GoString() string
GoString returns the string representation
func (*DescribeWorkspacesConnectionStatusOutput) SetNextToken ¶ added in v1.6.16
func (s *DescribeWorkspacesConnectionStatusOutput) SetNextToken(v string) *DescribeWorkspacesConnectionStatusOutput
SetNextToken sets the NextToken field's value.
func (*DescribeWorkspacesConnectionStatusOutput) SetWorkspacesConnectionStatus ¶ added in v1.6.16
func (s *DescribeWorkspacesConnectionStatusOutput) SetWorkspacesConnectionStatus(v []*WorkspaceConnectionStatus) *DescribeWorkspacesConnectionStatusOutput
SetWorkspacesConnectionStatus sets the WorkspacesConnectionStatus field's value.
func (DescribeWorkspacesConnectionStatusOutput) String ¶ added in v1.6.16
func (s DescribeWorkspacesConnectionStatusOutput) String() string
String returns the string representation
type DescribeWorkspacesInput ¶
type DescribeWorkspacesInput struct { // The ID of the bundle. All WorkSpaces that are created from this bundle are // retrieved. This parameter cannot be combined with any other filter. BundleId *string `type:"string"` // The ID of the directory. In addition, you can optionally specify a specific // directory user (see UserName). This parameter cannot be combined with any // other filter. DirectoryId *string `type:"string"` // The maximum number of items to return. Limit *int64 `min:"1" type:"integer"` // The token for the next set of results. (You received this token from a previous // call.) NextToken *string `min:"1" type:"string"` // The name of the directory user. You must specify this parameter with DirectoryId. UserName *string `min:"1" type:"string"` // The IDs of the WorkSpaces. This parameter cannot be combined with any other // filter. // // 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 }
func (DescribeWorkspacesInput) GoString ¶
func (s DescribeWorkspacesInput) GoString() string
GoString returns the string representation
func (*DescribeWorkspacesInput) SetBundleId ¶ added in v1.6.16
func (s *DescribeWorkspacesInput) SetBundleId(v string) *DescribeWorkspacesInput
SetBundleId sets the BundleId field's value.
func (*DescribeWorkspacesInput) SetDirectoryId ¶ added in v1.6.16
func (s *DescribeWorkspacesInput) SetDirectoryId(v string) *DescribeWorkspacesInput
SetDirectoryId sets the DirectoryId field's value.
func (*DescribeWorkspacesInput) SetLimit ¶ added in v1.6.16
func (s *DescribeWorkspacesInput) SetLimit(v int64) *DescribeWorkspacesInput
SetLimit sets the Limit field's value.
func (*DescribeWorkspacesInput) SetNextToken ¶ added in v1.6.16
func (s *DescribeWorkspacesInput) SetNextToken(v string) *DescribeWorkspacesInput
SetNextToken sets the NextToken field's value.
func (*DescribeWorkspacesInput) SetUserName ¶ added in v1.6.16
func (s *DescribeWorkspacesInput) SetUserName(v string) *DescribeWorkspacesInput
SetUserName sets the UserName field's value.
func (*DescribeWorkspacesInput) SetWorkspaceIds ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *DescribeWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeWorkspacesOutput ¶
type DescribeWorkspacesOutput struct { // The token to use to retrieve the next set of results, or null if there are // no more results available. This token is valid for one day and must be used // within that time frame. NextToken *string `min:"1" type:"string"` // Information about the WorkSpaces. // // Because CreateWorkspaces is an asynchronous operation, some of the returned // information could be incomplete. Workspaces []*Workspace `type:"list"` // contains filtered or unexported fields }
func (DescribeWorkspacesOutput) GoString ¶
func (s DescribeWorkspacesOutput) GoString() string
GoString returns the string representation
func (*DescribeWorkspacesOutput) SetNextToken ¶ added in v1.6.16
func (s *DescribeWorkspacesOutput) SetNextToken(v string) *DescribeWorkspacesOutput
SetNextToken sets the NextToken field's value.
func (*DescribeWorkspacesOutput) SetWorkspaces ¶ added in v1.6.16
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"` // Information about the WorkSpace. WorkspaceRequest *WorkspaceRequest `type:"structure"` // contains filtered or unexported fields }
Information about a WorkSpace that could not be created.
func (FailedCreateWorkspaceRequest) GoString ¶
func (s FailedCreateWorkspaceRequest) GoString() string
GoString returns the string representation
func (*FailedCreateWorkspaceRequest) SetErrorCode ¶ added in v1.6.16
func (s *FailedCreateWorkspaceRequest) SetErrorCode(v string) *FailedCreateWorkspaceRequest
SetErrorCode sets the ErrorCode field's value.
func (*FailedCreateWorkspaceRequest) SetErrorMessage ¶ added in v1.6.16
func (s *FailedCreateWorkspaceRequest) SetErrorMessage(v string) *FailedCreateWorkspaceRequest
SetErrorMessage sets the ErrorMessage field's value.
func (*FailedCreateWorkspaceRequest) SetWorkspaceRequest ¶ added in v1.6.16
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 }
Information about a WorkSpace that could not be rebooted (RebootWorkspaces), rebuilt (RebuildWorkspaces), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).
func (FailedWorkspaceChangeRequest) GoString ¶
func (s FailedWorkspaceChangeRequest) GoString() string
GoString returns the string representation
func (*FailedWorkspaceChangeRequest) SetErrorCode ¶ added in v1.6.16
func (s *FailedWorkspaceChangeRequest) SetErrorCode(v string) *FailedWorkspaceChangeRequest
SetErrorCode sets the ErrorCode field's value.
func (*FailedWorkspaceChangeRequest) SetErrorMessage ¶ added in v1.6.16
func (s *FailedWorkspaceChangeRequest) SetErrorMessage(v string) *FailedWorkspaceChangeRequest
SetErrorMessage sets the ErrorMessage field's value.
func (*FailedWorkspaceChangeRequest) SetWorkspaceId ¶ added in v1.6.16
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 ModificationState ¶ added in v1.13.9
type ModificationState struct { // The resource. Resource *string `type:"string" enum:"ModificationResourceEnum"` // The modification state. State *string `type:"string" enum:"ModificationStateEnum"` // contains filtered or unexported fields }
Information about a WorkSpace modification.
func (ModificationState) GoString ¶ added in v1.13.9
func (s ModificationState) GoString() string
GoString returns the string representation
func (*ModificationState) SetResource ¶ added in v1.13.9
func (s *ModificationState) SetResource(v string) *ModificationState
SetResource sets the Resource field's value.
func (*ModificationState) SetState ¶ added in v1.13.9
func (s *ModificationState) SetState(v string) *ModificationState
SetState sets the State field's value.
func (ModificationState) String ¶ added in v1.13.9
func (s ModificationState) String() string
String returns the string representation
type ModifyWorkspacePropertiesInput ¶ added in v1.6.16
type ModifyWorkspacePropertiesInput struct { // The ID of the WorkSpace. // // WorkspaceId is a required field WorkspaceId *string `type:"string" required:"true"` // The properties of the WorkSpace. // // WorkspaceProperties is a required field WorkspaceProperties *WorkspaceProperties `type:"structure" required:"true"` // contains filtered or unexported fields }
func (ModifyWorkspacePropertiesInput) GoString ¶ added in v1.6.16
func (s ModifyWorkspacePropertiesInput) GoString() string
GoString returns the string representation
func (*ModifyWorkspacePropertiesInput) SetWorkspaceId ¶ added in v1.6.16
func (s *ModifyWorkspacePropertiesInput) SetWorkspaceId(v string) *ModifyWorkspacePropertiesInput
SetWorkspaceId sets the WorkspaceId field's value.
func (*ModifyWorkspacePropertiesInput) SetWorkspaceProperties ¶ added in v1.6.16
func (s *ModifyWorkspacePropertiesInput) SetWorkspaceProperties(v *WorkspaceProperties) *ModifyWorkspacePropertiesInput
SetWorkspaceProperties sets the WorkspaceProperties field's value.
func (ModifyWorkspacePropertiesInput) String ¶ added in v1.6.16
func (s ModifyWorkspacePropertiesInput) String() string
String returns the string representation
func (*ModifyWorkspacePropertiesInput) Validate ¶ added in v1.6.16
func (s *ModifyWorkspacePropertiesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ModifyWorkspacePropertiesOutput ¶ added in v1.6.16
type ModifyWorkspacePropertiesOutput struct {
// contains filtered or unexported fields
}
func (ModifyWorkspacePropertiesOutput) GoString ¶ added in v1.6.16
func (s ModifyWorkspacePropertiesOutput) GoString() string
GoString returns the string representation
func (ModifyWorkspacePropertiesOutput) String ¶ added in v1.6.16
func (s ModifyWorkspacePropertiesOutput) String() string
String returns the string representation
type RebootRequest ¶
type RebootRequest struct { // The identifier of the WorkSpace. // // WorkspaceId is a required field WorkspaceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Information used to reboot a WorkSpace.
func (RebootRequest) GoString ¶
func (s RebootRequest) GoString() string
GoString returns the string representation
func (*RebootRequest) SetWorkspaceId ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *RebootRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RebootWorkspacesInput ¶
type RebootWorkspacesInput struct { // The WorkSpaces to reboot. // // RebootWorkspaceRequests is a required field RebootWorkspaceRequests []*RebootRequest `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (RebootWorkspacesInput) GoString ¶
func (s RebootWorkspacesInput) GoString() string
GoString returns the string representation
func (*RebootWorkspacesInput) SetRebootWorkspaceRequests ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *RebootWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RebootWorkspacesOutput ¶
type RebootWorkspacesOutput struct { // Information about the WorkSpaces that could not be rebooted. FailedRequests []*FailedWorkspaceChangeRequest `type:"list"` // contains filtered or unexported fields }
func (RebootWorkspacesOutput) GoString ¶
func (s RebootWorkspacesOutput) GoString() string
GoString returns the string representation
func (*RebootWorkspacesOutput) SetFailedRequests ¶ added in v1.6.16
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. // // WorkspaceId is a required field WorkspaceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Information used to rebuild a WorkSpace.
func (RebuildRequest) GoString ¶
func (s RebuildRequest) GoString() string
GoString returns the string representation
func (*RebuildRequest) SetWorkspaceId ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *RebuildRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RebuildWorkspacesInput ¶
type RebuildWorkspacesInput struct { // The WorkSpaces to rebuild. // // RebuildWorkspaceRequests is a required field RebuildWorkspaceRequests []*RebuildRequest `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (RebuildWorkspacesInput) GoString ¶
func (s RebuildWorkspacesInput) GoString() string
GoString returns the string representation
func (*RebuildWorkspacesInput) SetRebuildWorkspaceRequests ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *RebuildWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RebuildWorkspacesOutput ¶
type RebuildWorkspacesOutput struct { // Information about the WorkSpaces that could not be rebuilt. FailedRequests []*FailedWorkspaceChangeRequest `type:"list"` // contains filtered or unexported fields }
func (RebuildWorkspacesOutput) GoString ¶
func (s RebuildWorkspacesOutput) GoString() string
GoString returns the string representation
func (*RebuildWorkspacesOutput) SetFailedRequests ¶ added in v1.6.16
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 RootStorage ¶ added in v1.13.9
type RootStorage struct { // The size of the root volume. Capacity *string `min:"1" type:"string"` // contains filtered or unexported fields }
Information about the root volume for a WorkSpace bundle.
func (RootStorage) GoString ¶ added in v1.13.9
func (s RootStorage) GoString() string
GoString returns the string representation
func (*RootStorage) SetCapacity ¶ added in v1.13.9
func (s *RootStorage) SetCapacity(v string) *RootStorage
SetCapacity sets the Capacity field's value.
func (RootStorage) String ¶ added in v1.13.9
func (s RootStorage) String() string
String returns the string representation
type StartRequest ¶ added in v1.6.16
type StartRequest struct { // The ID of the WorkSpace. WorkspaceId *string `type:"string"` // contains filtered or unexported fields }
Information used to start a WorkSpace.
func (StartRequest) GoString ¶ added in v1.6.16
func (s StartRequest) GoString() string
GoString returns the string representation
func (*StartRequest) SetWorkspaceId ¶ added in v1.6.16
func (s *StartRequest) SetWorkspaceId(v string) *StartRequest
SetWorkspaceId sets the WorkspaceId field's value.
func (StartRequest) String ¶ added in v1.6.16
func (s StartRequest) String() string
String returns the string representation
type StartWorkspacesInput ¶ added in v1.6.16
type StartWorkspacesInput struct { // The WorkSpaces to start. // // StartWorkspaceRequests is a required field StartWorkspaceRequests []*StartRequest `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (StartWorkspacesInput) GoString ¶ added in v1.6.16
func (s StartWorkspacesInput) GoString() string
GoString returns the string representation
func (*StartWorkspacesInput) SetStartWorkspaceRequests ¶ added in v1.6.16
func (s *StartWorkspacesInput) SetStartWorkspaceRequests(v []*StartRequest) *StartWorkspacesInput
SetStartWorkspaceRequests sets the StartWorkspaceRequests field's value.
func (StartWorkspacesInput) String ¶ added in v1.6.16
func (s StartWorkspacesInput) String() string
String returns the string representation
func (*StartWorkspacesInput) Validate ¶ added in v1.6.16
func (s *StartWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartWorkspacesOutput ¶ added in v1.6.16
type StartWorkspacesOutput struct { // Information about the WorkSpaces that could not be started. FailedRequests []*FailedWorkspaceChangeRequest `type:"list"` // contains filtered or unexported fields }
func (StartWorkspacesOutput) GoString ¶ added in v1.6.16
func (s StartWorkspacesOutput) GoString() string
GoString returns the string representation
func (*StartWorkspacesOutput) SetFailedRequests ¶ added in v1.6.16
func (s *StartWorkspacesOutput) SetFailedRequests(v []*FailedWorkspaceChangeRequest) *StartWorkspacesOutput
SetFailedRequests sets the FailedRequests field's value.
func (StartWorkspacesOutput) String ¶ added in v1.6.16
func (s StartWorkspacesOutput) String() string
String returns the string representation
type StopRequest ¶ added in v1.6.16
type StopRequest struct { // The ID of the WorkSpace. WorkspaceId *string `type:"string"` // contains filtered or unexported fields }
Information used to stop a WorkSpace.
func (StopRequest) GoString ¶ added in v1.6.16
func (s StopRequest) GoString() string
GoString returns the string representation
func (*StopRequest) SetWorkspaceId ¶ added in v1.6.16
func (s *StopRequest) SetWorkspaceId(v string) *StopRequest
SetWorkspaceId sets the WorkspaceId field's value.
func (StopRequest) String ¶ added in v1.6.16
func (s StopRequest) String() string
String returns the string representation
type StopWorkspacesInput ¶ added in v1.6.16
type StopWorkspacesInput struct { // The WorkSpaces to stop. // // StopWorkspaceRequests is a required field StopWorkspaceRequests []*StopRequest `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (StopWorkspacesInput) GoString ¶ added in v1.6.16
func (s StopWorkspacesInput) GoString() string
GoString returns the string representation
func (*StopWorkspacesInput) SetStopWorkspaceRequests ¶ added in v1.6.16
func (s *StopWorkspacesInput) SetStopWorkspaceRequests(v []*StopRequest) *StopWorkspacesInput
SetStopWorkspaceRequests sets the StopWorkspaceRequests field's value.
func (StopWorkspacesInput) String ¶ added in v1.6.16
func (s StopWorkspacesInput) String() string
String returns the string representation
func (*StopWorkspacesInput) Validate ¶ added in v1.6.16
func (s *StopWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopWorkspacesOutput ¶ added in v1.6.16
type StopWorkspacesOutput struct { // Information about the WorkSpaces that could not be stopped. FailedRequests []*FailedWorkspaceChangeRequest `type:"list"` // contains filtered or unexported fields }
func (StopWorkspacesOutput) GoString ¶ added in v1.6.16
func (s StopWorkspacesOutput) GoString() string
GoString returns the string representation
func (*StopWorkspacesOutput) SetFailedRequests ¶ added in v1.6.16
func (s *StopWorkspacesOutput) SetFailedRequests(v []*FailedWorkspaceChangeRequest) *StopWorkspacesOutput
SetFailedRequests sets the FailedRequests field's value.
func (StopWorkspacesOutput) String ¶ added in v1.6.16
func (s StopWorkspacesOutput) String() string
String returns the string representation
type Tag ¶ added in v1.3.0
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 }
Information about a tag.
type TerminateRequest ¶
type TerminateRequest struct { // The identifier of the WorkSpace. // // WorkspaceId is a required field WorkspaceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
Information used to terminate a WorkSpace.
func (TerminateRequest) GoString ¶
func (s TerminateRequest) GoString() string
GoString returns the string representation
func (*TerminateRequest) SetWorkspaceId ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *TerminateRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TerminateWorkspacesInput ¶
type TerminateWorkspacesInput struct { // The WorkSpaces to terminate. // // TerminateWorkspaceRequests is a required field TerminateWorkspaceRequests []*TerminateRequest `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (TerminateWorkspacesInput) GoString ¶
func (s TerminateWorkspacesInput) GoString() string
GoString returns the string representation
func (*TerminateWorkspacesInput) SetTerminateWorkspaceRequests ¶ added in v1.6.16
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 ¶ added in v1.3.0
func (s *TerminateWorkspacesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TerminateWorkspacesOutput ¶
type TerminateWorkspacesOutput struct { // Information about the WorkSpaces that could not be terminated. FailedRequests []*FailedWorkspaceChangeRequest `type:"list"` // contains filtered or unexported fields }
func (TerminateWorkspacesOutput) GoString ¶
func (s TerminateWorkspacesOutput) GoString() string
GoString returns the string representation
func (*TerminateWorkspacesOutput) SetFailedRequests ¶ added in v1.6.16
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 size of the user storage. Capacity *string `min:"1" type:"string"` // contains filtered or unexported fields }
Information about the user storage for a WorkSpace bundle.
func (UserStorage) GoString ¶
func (s UserStorage) GoString() string
GoString returns the string representation
func (*UserStorage) SetCapacity ¶ added in v1.6.16
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 ¶
WorkSpaces provides the API operation methods for making requests to Amazon WorkSpaces. See this package's package overview docs for details on the service.
WorkSpaces methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *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 ¶ added in v1.3.0
func (c *WorkSpaces) CreateTags(input *CreateTagsInput) (*CreateTagsOutput, error)
CreateTags API operation for Amazon WorkSpaces.
Creates tags for the 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 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTags
func (*WorkSpaces) CreateTagsRequest ¶ added in v1.3.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateTags for more information on using the CreateTags API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateTagsRequest method. req, resp := client.CreateTagsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTags
func (*WorkSpaces) CreateTagsWithContext ¶ added in v1.9.0
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.
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaces
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateWorkspaces for more information on using the CreateWorkspaces API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateWorkspacesRequest method. req, resp := client.CreateWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaces
func (*WorkSpaces) CreateWorkspacesWithContext ¶ added in v1.9.0
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 ¶ added in v1.3.0
func (c *WorkSpaces) DeleteTags(input *DeleteTagsInput) (*DeleteTagsOutput, error)
DeleteTags API operation for Amazon WorkSpaces.
Deletes the specified 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTags
func (*WorkSpaces) DeleteTagsRequest ¶ added in v1.3.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteTags for more information on using the DeleteTags API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteTagsRequest method. req, resp := client.DeleteTagsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTags
func (*WorkSpaces) DeleteTagsWithContext ¶ added in v1.9.0
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 ¶ added in v1.3.0
func (c *WorkSpaces) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error)
DescribeTags API operation for Amazon WorkSpaces.
Describes the tags for the 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 DescribeTags for usage and error information.
Returned Error Codes:
- ErrCodeResourceNotFoundException "ResourceNotFoundException" The resource could not be found.
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTags
func (*WorkSpaces) DescribeTagsRequest ¶ added in v1.3.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeTags for more information on using the DescribeTags API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeTagsRequest method. req, resp := client.DescribeTagsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTags
func (*WorkSpaces) DescribeTagsWithContext ¶ added in v1.9.0
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.
Describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
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.
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundles
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 ¶ added in v1.9.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeWorkspaceBundles for more information on using the DescribeWorkspaceBundles API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeWorkspaceBundlesRequest method. req, resp := client.DescribeWorkspaceBundlesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundles
func (*WorkSpaces) DescribeWorkspaceBundlesWithContext ¶ added in v1.9.0
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.
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
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.
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories
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 ¶ added in v1.9.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeWorkspaceDirectories for more information on using the DescribeWorkspaceDirectories API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeWorkspaceDirectoriesRequest method. req, resp := client.DescribeWorkspaceDirectoriesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories
func (*WorkSpaces) DescribeWorkspaceDirectoriesWithContext ¶ added in v1.9.0
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.
Describes the specified WorkSpaces.
You can filter the results using bundle ID, directory ID, or owner, but you can specify only one filter at a 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 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.
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaces
func (*WorkSpaces) DescribeWorkspacesConnectionStatus ¶ added in v1.6.16
func (c *WorkSpaces) DescribeWorkspacesConnectionStatus(input *DescribeWorkspacesConnectionStatusInput) (*DescribeWorkspacesConnectionStatusOutput, error)
DescribeWorkspacesConnectionStatus API operation for Amazon WorkSpaces.
Describes the connection status of the specified WorkSpaces.
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.
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus
func (*WorkSpaces) DescribeWorkspacesConnectionStatusRequest ¶ added in v1.6.16
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeWorkspacesConnectionStatus for more information on using the DescribeWorkspacesConnectionStatus API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeWorkspacesConnectionStatusRequest method. req, resp := client.DescribeWorkspacesConnectionStatusRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus
func (*WorkSpaces) DescribeWorkspacesConnectionStatusWithContext ¶ added in v1.9.0
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 ¶ added in v1.9.0
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeWorkspaces for more information on using the DescribeWorkspaces API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeWorkspacesRequest method. req, resp := client.DescribeWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaces
func (*WorkSpaces) DescribeWorkspacesWithContext ¶ added in v1.9.0
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 ¶ added in v1.6.16
func (c *WorkSpaces) ModifyWorkspaceProperties(input *ModifyWorkspacePropertiesInput) (*ModifyWorkspacePropertiesOutput, error)
ModifyWorkspaceProperties API operation for Amazon WorkSpaces.
Modifies the specified WorkSpace properties.
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 state of the WorkSpace is not valid for this operation.
ErrCodeOperationInProgressException "OperationInProgressException" The properties of this WorkSpace are currently being modified. Try again in a moment.
ErrCodeUnsupportedWorkspaceConfigurationException "UnsupportedWorkspaceConfigurationException" The configuration of this WorkSpace is not supported 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" The user is not authorized to access a resource.
ErrCodeResourceUnavailableException "ResourceUnavailableException" The specified resource is not available.
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceProperties
func (*WorkSpaces) ModifyWorkspacePropertiesRequest ¶ added in v1.6.16
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ModifyWorkspaceProperties for more information on using the ModifyWorkspaceProperties API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ModifyWorkspacePropertiesRequest method. req, resp := client.ModifyWorkspacePropertiesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceProperties
func (*WorkSpaces) ModifyWorkspacePropertiesWithContext ¶ added in v1.9.0
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.
You cannot reboot a WorkSpace unless its state is 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. See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspaces
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See RebootWorkspaces for more information on using the RebootWorkspaces API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the RebootWorkspacesRequest method. req, resp := client.RebootWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspaces
func (*WorkSpaces) RebootWorkspacesWithContext ¶ added in v1.9.0
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.
You cannot rebuild a WorkSpace unless its state is AVAILABLE or ERROR.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace (http://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html).
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. See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspaces
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See RebuildWorkspaces for more information on using the RebuildWorkspaces API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the RebuildWorkspacesRequest method. req, resp := client.RebuildWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspaces
func (*WorkSpaces) RebuildWorkspacesWithContext ¶ added in v1.9.0
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 ¶ added in v1.6.16
func (c *WorkSpaces) StartWorkspaces(input *StartWorkspacesInput) (*StartWorkspacesOutput, error)
StartWorkspaces API operation for Amazon WorkSpaces.
Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of 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. See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspaces
func (*WorkSpaces) StartWorkspacesRequest ¶ added in v1.6.16
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartWorkspaces for more information on using the StartWorkspaces API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartWorkspacesRequest method. req, resp := client.StartWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspaces
func (*WorkSpaces) StartWorkspacesWithContext ¶ added in v1.9.0
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 ¶ added in v1.6.16
func (c *WorkSpaces) StopWorkspaces(input *StopWorkspacesInput) (*StopWorkspacesOutput, error)
StopWorkspaces API operation for Amazon WorkSpaces.
Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of 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. See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspaces
func (*WorkSpaces) StopWorkspacesRequest ¶ added in v1.6.16
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StopWorkspaces for more information on using the StopWorkspaces API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StopWorkspacesRequest method. req, resp := client.StopWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspaces
func (*WorkSpaces) StopWorkspacesWithContext ¶ added in v1.9.0
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 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. See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspaces
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 will be populated with the request's response once the request complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TerminateWorkspaces for more information on using the TerminateWorkspaces API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the TerminateWorkspacesRequest method. req, resp := client.TerminateWorkspacesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspaces
func (*WorkSpaces) TerminateWorkspacesWithContext ¶ added in v1.9.0
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 used to create the WorkSpace. 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 for the WorkSpace. DirectoryId *string `type:"string"` // If the WorkSpace could not be created, contains the error code. ErrorCode *string `type:"string"` // If the WorkSpace could not be created, contains a textual error message that // describes the failure. ErrorMessage *string `type:"string"` // The IP address of the WorkSpace. IpAddress *string `type:"string"` // The modification states of the WorkSpace. ModificationStates []*ModificationState `type:"list"` // Indicates whether the data stored on the root volume is encrypted. RootVolumeEncryptionEnabled *bool `type:"boolean"` // The operational state of the WorkSpace. State *string `type:"string" enum:"WorkspaceState"` // The identifier of the subnet for the WorkSpace. SubnetId *string `type:"string"` // The user for the WorkSpace. UserName *string `min:"1" type:"string"` // Indicates whether the data stored on the user volume 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"` // The properties of the WorkSpace. WorkspaceProperties *WorkspaceProperties `type:"structure"` // contains filtered or unexported fields }
Information about a WorkSpace.
func (*Workspace) SetBundleId ¶ added in v1.6.16
SetBundleId sets the BundleId field's value.
func (*Workspace) SetComputerName ¶ added in v1.6.16
SetComputerName sets the ComputerName field's value.
func (*Workspace) SetDirectoryId ¶ added in v1.6.16
SetDirectoryId sets the DirectoryId field's value.
func (*Workspace) SetErrorCode ¶ added in v1.6.16
SetErrorCode sets the ErrorCode field's value.
func (*Workspace) SetErrorMessage ¶ added in v1.6.16
SetErrorMessage sets the ErrorMessage field's value.
func (*Workspace) SetIpAddress ¶ added in v1.6.16
SetIpAddress sets the IpAddress field's value.
func (*Workspace) SetModificationStates ¶ added in v1.13.9
func (s *Workspace) SetModificationStates(v []*ModificationState) *Workspace
SetModificationStates sets the ModificationStates field's value.
func (*Workspace) SetRootVolumeEncryptionEnabled ¶ added in v1.6.16
SetRootVolumeEncryptionEnabled sets the RootVolumeEncryptionEnabled field's value.
func (*Workspace) SetSubnetId ¶ added in v1.6.16
SetSubnetId sets the SubnetId field's value.
func (*Workspace) SetUserName ¶ added in v1.6.16
SetUserName sets the UserName field's value.
func (*Workspace) SetUserVolumeEncryptionEnabled ¶ added in v1.6.16
SetUserVolumeEncryptionEnabled sets the UserVolumeEncryptionEnabled field's value.
func (*Workspace) SetVolumeEncryptionKey ¶ added in v1.6.16
SetVolumeEncryptionKey sets the VolumeEncryptionKey field's value.
func (*Workspace) SetWorkspaceId ¶ added in v1.6.16
SetWorkspaceId sets the WorkspaceId field's value.
func (*Workspace) SetWorkspaceProperties ¶ added in v1.6.16
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"` // The compute type. For more information, see Amazon WorkSpaces Bundles (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). ComputeType *ComputeType `type:"structure"` // A description. Description *string `type:"string"` // The name of the bundle. Name *string `min:"1" type:"string"` // The owner of the bundle. This is the account identifier of the owner, or // AMAZON if the bundle is provided by AWS. Owner *string `type:"string"` // The size of the root volume. RootStorage *RootStorage `type:"structure"` // The size of the user storage. UserStorage *UserStorage `type:"structure"` // contains filtered or unexported fields }
Information about a WorkSpace bundle.
func (WorkspaceBundle) GoString ¶
func (s WorkspaceBundle) GoString() string
GoString returns the string representation
func (*WorkspaceBundle) SetBundleId ¶ added in v1.6.16
func (s *WorkspaceBundle) SetBundleId(v string) *WorkspaceBundle
SetBundleId sets the BundleId field's value.
func (*WorkspaceBundle) SetComputeType ¶ added in v1.6.16
func (s *WorkspaceBundle) SetComputeType(v *ComputeType) *WorkspaceBundle
SetComputeType sets the ComputeType field's value.
func (*WorkspaceBundle) SetDescription ¶ added in v1.6.16
func (s *WorkspaceBundle) SetDescription(v string) *WorkspaceBundle
SetDescription sets the Description field's value.
func (*WorkspaceBundle) SetName ¶ added in v1.6.16
func (s *WorkspaceBundle) SetName(v string) *WorkspaceBundle
SetName sets the Name field's value.
func (*WorkspaceBundle) SetOwner ¶ added in v1.6.16
func (s *WorkspaceBundle) SetOwner(v string) *WorkspaceBundle
SetOwner sets the Owner field's value.
func (*WorkspaceBundle) SetRootStorage ¶ added in v1.13.9
func (s *WorkspaceBundle) SetRootStorage(v *RootStorage) *WorkspaceBundle
SetRootStorage sets the RootStorage field's value.
func (*WorkspaceBundle) SetUserStorage ¶ added in v1.6.16
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 ¶ added in v1.6.16
type WorkspaceConnectionStatus struct { // The connection state of the WorkSpace. The connection state is unknown if // the WorkSpace is stopped. 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.
func (WorkspaceConnectionStatus) GoString ¶ added in v1.6.16
func (s WorkspaceConnectionStatus) GoString() string
GoString returns the string representation
func (*WorkspaceConnectionStatus) SetConnectionState ¶ added in v1.6.16
func (s *WorkspaceConnectionStatus) SetConnectionState(v string) *WorkspaceConnectionStatus
SetConnectionState sets the ConnectionState field's value.
func (*WorkspaceConnectionStatus) SetConnectionStateCheckTimestamp ¶ added in v1.6.16
func (s *WorkspaceConnectionStatus) SetConnectionStateCheckTimestamp(v time.Time) *WorkspaceConnectionStatus
SetConnectionStateCheckTimestamp sets the ConnectionStateCheckTimestamp field's value.
func (*WorkspaceConnectionStatus) SetLastKnownUserConnectionTimestamp ¶ added in v1.6.16
func (s *WorkspaceConnectionStatus) SetLastKnownUserConnectionTimestamp(v time.Time) *WorkspaceConnectionStatus
SetLastKnownUserConnectionTimestamp sets the LastKnownUserConnectionTimestamp field's value.
func (*WorkspaceConnectionStatus) SetWorkspaceId ¶ added in v1.6.16
func (s *WorkspaceConnectionStatus) SetWorkspaceId(v string) *WorkspaceConnectionStatus
SetWorkspaceId sets the WorkspaceId field's value.
func (WorkspaceConnectionStatus) String ¶ added in v1.6.16
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"` // 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"` // The identifiers of the subnets used with the directory. SubnetIds []*string `type:"list"` // 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.
func (WorkspaceDirectory) GoString ¶
func (s WorkspaceDirectory) GoString() string
GoString returns the string representation
func (*WorkspaceDirectory) SetAlias ¶ added in v1.6.16
func (s *WorkspaceDirectory) SetAlias(v string) *WorkspaceDirectory
SetAlias sets the Alias field's value.
func (*WorkspaceDirectory) SetCustomerUserName ¶ added in v1.6.16
func (s *WorkspaceDirectory) SetCustomerUserName(v string) *WorkspaceDirectory
SetCustomerUserName sets the CustomerUserName field's value.
func (*WorkspaceDirectory) SetDirectoryId ¶ added in v1.6.16
func (s *WorkspaceDirectory) SetDirectoryId(v string) *WorkspaceDirectory
SetDirectoryId sets the DirectoryId field's value.
func (*WorkspaceDirectory) SetDirectoryName ¶ added in v1.6.16
func (s *WorkspaceDirectory) SetDirectoryName(v string) *WorkspaceDirectory
SetDirectoryName sets the DirectoryName field's value.
func (*WorkspaceDirectory) SetDirectoryType ¶ added in v1.6.16
func (s *WorkspaceDirectory) SetDirectoryType(v string) *WorkspaceDirectory
SetDirectoryType sets the DirectoryType field's value.
func (*WorkspaceDirectory) SetDnsIpAddresses ¶ added in v1.6.16
func (s *WorkspaceDirectory) SetDnsIpAddresses(v []*string) *WorkspaceDirectory
SetDnsIpAddresses sets the DnsIpAddresses field's value.
func (*WorkspaceDirectory) SetIamRoleId ¶ added in v1.6.16
func (s *WorkspaceDirectory) SetIamRoleId(v string) *WorkspaceDirectory
SetIamRoleId sets the IamRoleId field's value.
func (*WorkspaceDirectory) SetRegistrationCode ¶ added in v1.6.16
func (s *WorkspaceDirectory) SetRegistrationCode(v string) *WorkspaceDirectory
SetRegistrationCode sets the RegistrationCode field's value.
func (*WorkspaceDirectory) SetState ¶ added in v1.6.16
func (s *WorkspaceDirectory) SetState(v string) *WorkspaceDirectory
SetState sets the State field's value.
func (*WorkspaceDirectory) SetSubnetIds ¶ added in v1.6.16
func (s *WorkspaceDirectory) SetSubnetIds(v []*string) *WorkspaceDirectory
SetSubnetIds sets the SubnetIds field's value.
func (*WorkspaceDirectory) SetWorkspaceCreationProperties ¶ added in v1.6.16
func (s *WorkspaceDirectory) SetWorkspaceCreationProperties(v *DefaultWorkspaceCreationProperties) *WorkspaceDirectory
SetWorkspaceCreationProperties sets the WorkspaceCreationProperties field's value.
func (*WorkspaceDirectory) SetWorkspaceSecurityGroupId ¶ added in v1.6.16
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 ¶ added in v1.6.16
type WorkspaceProperties struct { // The compute type. For more information, see Amazon WorkSpaces Bundles (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). ComputeTypeName *string `type:"string" enum:"Compute"` // The size of the root volume. RootVolumeSizeGib *int64 `type:"integer"` // The running mode. For more information, see Manage the WorkSpace Running // Mode (http://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html). 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"` // The size of the user storage. UserVolumeSizeGib *int64 `type:"integer"` // contains filtered or unexported fields }
Information about a WorkSpace.
func (WorkspaceProperties) GoString ¶ added in v1.6.16
func (s WorkspaceProperties) GoString() string
GoString returns the string representation
func (*WorkspaceProperties) SetComputeTypeName ¶ added in v1.13.9
func (s *WorkspaceProperties) SetComputeTypeName(v string) *WorkspaceProperties
SetComputeTypeName sets the ComputeTypeName field's value.
func (*WorkspaceProperties) SetRootVolumeSizeGib ¶ added in v1.13.9
func (s *WorkspaceProperties) SetRootVolumeSizeGib(v int64) *WorkspaceProperties
SetRootVolumeSizeGib sets the RootVolumeSizeGib field's value.
func (*WorkspaceProperties) SetRunningMode ¶ added in v1.6.16
func (s *WorkspaceProperties) SetRunningMode(v string) *WorkspaceProperties
SetRunningMode sets the RunningMode field's value.
func (*WorkspaceProperties) SetRunningModeAutoStopTimeoutInMinutes ¶ added in v1.6.16
func (s *WorkspaceProperties) SetRunningModeAutoStopTimeoutInMinutes(v int64) *WorkspaceProperties
SetRunningModeAutoStopTimeoutInMinutes sets the RunningModeAutoStopTimeoutInMinutes field's value.
func (*WorkspaceProperties) SetUserVolumeSizeGib ¶ added in v1.13.9
func (s *WorkspaceProperties) SetUserVolumeSizeGib(v int64) *WorkspaceProperties
SetUserVolumeSizeGib sets the UserVolumeSizeGib field's value.
func (WorkspaceProperties) String ¶ added in v1.6.16
func (s WorkspaceProperties) String() string
String returns the string representation
type WorkspaceRequest ¶
type WorkspaceRequest struct { // The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles // to list the available bundles. // // BundleId is a required field BundleId *string `type:"string" required:"true"` // The identifier of the AWS Directory Service directory for the WorkSpace. // You can use DescribeWorkspaceDirectories to list the available directories. // // DirectoryId is a required field DirectoryId *string `type:"string" required:"true"` // Indicates whether the data stored on the root volume is encrypted. RootVolumeEncryptionEnabled *bool `type:"boolean"` // The tags for the WorkSpace. Tags []*Tag `type:"list"` // The username of the user for the WorkSpace. This username must exist in the // AWS Directory Service directory for the WorkSpace. // // UserName is a required field UserName *string `min:"1" type:"string" required:"true"` // Indicates whether the data stored on the user volume is encrypted. UserVolumeEncryptionEnabled *bool `type:"boolean"` // The KMS key used to encrypt data stored on your WorkSpace. VolumeEncryptionKey *string `type:"string"` // The WorkSpace properties. WorkspaceProperties *WorkspaceProperties `type:"structure"` // contains filtered or unexported fields }
Information used to create a WorkSpace.
func (WorkspaceRequest) GoString ¶
func (s WorkspaceRequest) GoString() string
GoString returns the string representation
func (*WorkspaceRequest) SetBundleId ¶ added in v1.6.16
func (s *WorkspaceRequest) SetBundleId(v string) *WorkspaceRequest
SetBundleId sets the BundleId field's value.
func (*WorkspaceRequest) SetDirectoryId ¶ added in v1.6.16
func (s *WorkspaceRequest) SetDirectoryId(v string) *WorkspaceRequest
SetDirectoryId sets the DirectoryId field's value.
func (*WorkspaceRequest) SetRootVolumeEncryptionEnabled ¶ added in v1.6.16
func (s *WorkspaceRequest) SetRootVolumeEncryptionEnabled(v bool) *WorkspaceRequest
SetRootVolumeEncryptionEnabled sets the RootVolumeEncryptionEnabled field's value.
func (*WorkspaceRequest) SetTags ¶ added in v1.6.16
func (s *WorkspaceRequest) SetTags(v []*Tag) *WorkspaceRequest
SetTags sets the Tags field's value.
func (*WorkspaceRequest) SetUserName ¶ added in v1.6.16
func (s *WorkspaceRequest) SetUserName(v string) *WorkspaceRequest
SetUserName sets the UserName field's value.
func (*WorkspaceRequest) SetUserVolumeEncryptionEnabled ¶ added in v1.6.16
func (s *WorkspaceRequest) SetUserVolumeEncryptionEnabled(v bool) *WorkspaceRequest
SetUserVolumeEncryptionEnabled sets the UserVolumeEncryptionEnabled field's value.
func (*WorkspaceRequest) SetVolumeEncryptionKey ¶ added in v1.6.16
func (s *WorkspaceRequest) SetVolumeEncryptionKey(v string) *WorkspaceRequest
SetVolumeEncryptionKey sets the VolumeEncryptionKey field's value.
func (*WorkspaceRequest) SetWorkspaceProperties ¶ added in v1.6.16
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 ¶ added in v1.3.0
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. |