workspaces

package
v1.4.16-0...-c0d7d32 Latest Latest
Warning

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

Go to latest
Published: Oct 7, 2016 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package workspaces provides a client for Amazon WorkSpaces.

Index

Examples

Constants

View Source
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"
)
View Source
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"
)
View Source
const (
	// RunningModeAutoStop is a RunningMode enum value
	RunningModeAutoStop = "AUTO_STOP"

	// RunningModeAlwaysOn is a RunningMode enum value
	RunningModeAlwaysOn = "ALWAYS_ON"
)
View Source
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"
)
View Source
const (
	// WorkspaceDirectoryTypeSimpleAd is a WorkspaceDirectoryType enum value
	WorkspaceDirectoryTypeSimpleAd = "SIMPLE_AD"

	// WorkspaceDirectoryTypeAdConnector is a WorkspaceDirectoryType enum value
	WorkspaceDirectoryTypeAdConnector = "AD_CONNECTOR"
)
View Source
const (
	// WorkspaceStatePending is a WorkspaceState enum value
	WorkspaceStatePending = "PENDING"

	// WorkspaceStateAvailable is a WorkspaceState enum value
	WorkspaceStateAvailable = "AVAILABLE"

	// WorkspaceStateImpaired is a WorkspaceState enum value
	WorkspaceStateImpaired = "IMPAIRED"

	// WorkspaceStateUnhealthy is a WorkspaceState enum value
	WorkspaceStateUnhealthy = "UNHEALTHY"

	// WorkspaceStateRebooting is a WorkspaceState enum value
	WorkspaceStateRebooting = "REBOOTING"

	// WorkspaceStateStarting is a WorkspaceState enum value
	WorkspaceStateStarting = "STARTING"

	// WorkspaceStateRebuilding is a WorkspaceState enum value
	WorkspaceStateRebuilding = "REBUILDING"

	// WorkspaceStateMaintenance is a WorkspaceState enum value
	WorkspaceStateMaintenance = "MAINTENANCE"

	// WorkspaceStateTerminating is a WorkspaceState enum value
	WorkspaceStateTerminating = "TERMINATING"

	// WorkspaceStateTerminated is a WorkspaceState enum value
	WorkspaceStateTerminated = "TERMINATED"

	// WorkspaceStateSuspended is a WorkspaceState enum value
	WorkspaceStateSuspended = "SUSPENDED"

	// WorkspaceStateStopping is a WorkspaceState enum value
	WorkspaceStateStopping = "STOPPING"

	// WorkspaceStateStopped is a WorkspaceState enum value
	WorkspaceStateStopped = "STOPPED"

	// WorkspaceStateError is a WorkspaceState enum value
	WorkspaceStateError = "ERROR"
)
View Source
const ServiceName = "workspaces"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type ComputeType

type ComputeType struct {

	// The name of the compute type for the bundle.
	Name *string `type:"string" enum:"Compute"`
	// contains filtered or unexported fields
}

Contains information about the compute type of a WorkSpace bundle.

func (ComputeType) GoString

func (s ComputeType) GoString() string

GoString returns the string representation

func (ComputeType) String

func (s ComputeType) String() string

String returns the string representation

type CreateTagsInput

type CreateTagsInput struct {

	// The resource ID of the request.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`

	// The tags of the request.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

The request of the CreateTags operation.

func (CreateTagsInput) GoString

func (s CreateTagsInput) GoString() string

GoString returns the string representation

func (CreateTagsInput) String

func (s CreateTagsInput) String() string

String returns the string representation

func (*CreateTagsInput) Validate

func (s *CreateTagsInput) Validate() error

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

type CreateTagsOutput

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

The result of the CreateTags operation.

func (CreateTagsOutput) GoString

func (s CreateTagsOutput) GoString() string

GoString returns the string representation

func (CreateTagsOutput) String

func (s CreateTagsOutput) String() string

String returns the string representation

type CreateWorkspacesInput

type CreateWorkspacesInput struct {

	// An array of structures that specify the WorkSpaces to create.
	//
	// Workspaces is a required field
	Workspaces []*WorkspaceRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the CreateWorkspaces operation.

func (CreateWorkspacesInput) GoString

func (s CreateWorkspacesInput) GoString() string

GoString returns the string representation

func (CreateWorkspacesInput) String

func (s CreateWorkspacesInput) String() string

String returns the string representation

func (*CreateWorkspacesInput) Validate

func (s *CreateWorkspacesInput) Validate() error

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

type CreateWorkspacesOutput

type CreateWorkspacesOutput struct {

	// An array of structures that represent the WorkSpaces that could not be created.
	FailedRequests []*FailedCreateWorkspaceRequest `type:"list"`

	// An array of structures that represent the WorkSpaces that were created.
	//
	// Because this operation is asynchronous, the identifier in WorkspaceId is
	// not immediately available. If you immediately call DescribeWorkspaces with
	// this identifier, no information will be returned.
	PendingRequests []*Workspace `type:"list"`
	// contains filtered or unexported fields
}

Contains the result of the CreateWorkspaces operation.

func (CreateWorkspacesOutput) GoString

func (s CreateWorkspacesOutput) GoString() string

GoString returns the string representation

func (CreateWorkspacesOutput) String

func (s CreateWorkspacesOutput) String() string

String returns the string representation

type DefaultWorkspaceCreationProperties

type DefaultWorkspaceCreationProperties struct {

	// The identifier of any custom security groups that are applied to the WorkSpaces
	// when they are created.
	CustomSecurityGroupId *string `type:"string"`

	// The organizational unit (OU) in the directory that the WorkSpace machine
	// accounts are placed in.
	DefaultOu *string `type:"string"`

	// A public IP address will be attached to all WorkSpaces that are created or
	// rebuilt.
	EnableInternetAccess *bool `type:"boolean"`

	// Specifies if the directory is enabled for Amazon WorkDocs.
	EnableWorkDocs *bool `type:"boolean"`

	// The WorkSpace user is an administrator on the WorkSpace.
	UserEnabledAsLocalAdministrator *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Contains default WorkSpace creation information.

func (DefaultWorkspaceCreationProperties) GoString

GoString returns the string representation

func (DefaultWorkspaceCreationProperties) String

String returns the string representation

type DeleteTagsInput

type DeleteTagsInput struct {

	// The resource ID of the request.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`

	// The tag keys of the request.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

The request of the DeleteTags operation.

func (DeleteTagsInput) GoString

func (s DeleteTagsInput) GoString() string

GoString returns the string representation

func (DeleteTagsInput) String

func (s DeleteTagsInput) String() string

String returns the string representation

func (*DeleteTagsInput) Validate

func (s *DeleteTagsInput) Validate() error

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

type DeleteTagsOutput

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

The result of the DeleteTags operation.

func (DeleteTagsOutput) GoString

func (s DeleteTagsOutput) GoString() string

GoString returns the string representation

func (DeleteTagsOutput) String

func (s DeleteTagsOutput) String() string

String returns the string representation

type DescribeTagsInput

type DescribeTagsInput struct {

	// The resource ID of the request.
	//
	// ResourceId is a required field
	ResourceId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request of the DescribeTags operation.

func (DescribeTagsInput) GoString

func (s DescribeTagsInput) GoString() string

GoString returns the string representation

func (DescribeTagsInput) String

func (s DescribeTagsInput) String() string

String returns the string representation

func (*DescribeTagsInput) Validate

func (s *DescribeTagsInput) Validate() error

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

type DescribeTagsOutput

type DescribeTagsOutput struct {

	// The list of tags.
	TagList []*Tag `type:"list"`
	// contains filtered or unexported fields
}

The result of the DescribeTags operation.

func (DescribeTagsOutput) GoString

func (s DescribeTagsOutput) GoString() string

GoString returns the string representation

func (DescribeTagsOutput) String

func (s DescribeTagsOutput) String() string

String returns the string representation

type DescribeWorkspaceBundlesInput

type DescribeWorkspaceBundlesInput struct {

	// An array of strings that contains the identifiers of the bundles to retrieve.
	// This parameter cannot be combined with any other filter parameter.
	BundleIds []*string `min:"1" type:"list"`

	// The NextToken value from a previous call to this operation. Pass null if
	// this is the first call.
	NextToken *string `min:"1" type:"string"`

	// The owner of the bundles to retrieve. This parameter cannot be combined with
	// any other filter parameter.
	//
	// This contains one of the following values:
	//
	//   null- Retrieves the bundles that belong to the account making the call.
	//
	//    AMAZON- Retrieves the bundles that are provided by AWS.
	Owner *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the inputs for the DescribeWorkspaceBundles operation.

func (DescribeWorkspaceBundlesInput) GoString

GoString returns the string representation

func (DescribeWorkspaceBundlesInput) String

String returns the string representation

func (*DescribeWorkspaceBundlesInput) Validate

func (s *DescribeWorkspaceBundlesInput) Validate() error

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

type DescribeWorkspaceBundlesOutput

type DescribeWorkspaceBundlesOutput struct {

	// An array of structures that contain information about the bundles.
	Bundles []*WorkspaceBundle `type:"list"`

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to this operation to retrieve the next set
	// of items. This token is valid for one day and must be used within that time
	// frame.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the results of the DescribeWorkspaceBundles operation.

func (DescribeWorkspaceBundlesOutput) GoString

GoString returns the string representation

func (DescribeWorkspaceBundlesOutput) String

String returns the string representation

type DescribeWorkspaceDirectoriesInput

type DescribeWorkspaceDirectoriesInput struct {

	// An array of strings that contains the directory identifiers to retrieve information
	// for. If this member is null, all directories are retrieved.
	DirectoryIds []*string `min:"1" type:"list"`

	// The NextToken value from a previous call to this operation. Pass null if
	// this is the first call.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the inputs for the DescribeWorkspaceDirectories operation.

func (DescribeWorkspaceDirectoriesInput) GoString

GoString returns the string representation

func (DescribeWorkspaceDirectoriesInput) String

String returns the string representation

func (*DescribeWorkspaceDirectoriesInput) Validate

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

type DescribeWorkspaceDirectoriesOutput

type DescribeWorkspaceDirectoriesOutput struct {

	// An array of structures that contain information about the directories.
	Directories []*WorkspaceDirectory `type:"list"`

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to this operation to retrieve the next set
	// of items. This token is valid for one day and must be used within that time
	// frame.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains the results of the DescribeWorkspaceDirectories operation.

func (DescribeWorkspaceDirectoriesOutput) GoString

GoString returns the string representation

func (DescribeWorkspaceDirectoriesOutput) String

String returns the string representation

type DescribeWorkspacesConnectionStatusInput

type DescribeWorkspacesConnectionStatusInput struct {

	// The next token of the request.
	NextToken *string `min:"1" type:"string"`

	// An array of strings that contain the identifiers of the WorkSpaces.
	WorkspaceIds []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (DescribeWorkspacesConnectionStatusInput) GoString

GoString returns the string representation

func (DescribeWorkspacesConnectionStatusInput) String

String returns the string representation

func (*DescribeWorkspacesConnectionStatusInput) Validate

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

type DescribeWorkspacesConnectionStatusOutput

type DescribeWorkspacesConnectionStatusOutput struct {

	// The next token of the result.
	NextToken *string `min:"1" type:"string"`

	// The connection status of the WorkSpace.
	WorkspacesConnectionStatus []*WorkspaceConnectionStatus `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeWorkspacesConnectionStatusOutput) GoString

GoString returns the string representation

func (DescribeWorkspacesConnectionStatusOutput) String

String returns the string representation

type DescribeWorkspacesInput

type DescribeWorkspacesInput struct {

	// The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that
	// are created from this bundle will be retrieved. This parameter cannot be
	// combined with any other filter parameter.
	BundleId *string `type:"string"`

	// Specifies the directory identifier to which to limit the WorkSpaces. Optionally,
	// you can specify a specific directory user with the UserName parameter. This
	// parameter cannot be combined with any other filter parameter.
	DirectoryId *string `type:"string"`

	// The maximum number of items to return.
	Limit *int64 `min:"1" type:"integer"`

	// The NextToken value from a previous call to this operation. Pass null if
	// this is the first call.
	NextToken *string `min:"1" type:"string"`

	// Used with the DirectoryId parameter to specify the directory user for whom
	// to obtain the WorkSpace.
	UserName *string `min:"1" type:"string"`

	// An array of strings that contain the identifiers of the WorkSpaces for which
	// to retrieve information. This parameter cannot be combined with any other
	// filter parameter.
	//
	// Because the CreateWorkspaces operation is asynchronous, the identifier it
	// returns is not immediately available. If you immediately call DescribeWorkspaces
	// with this identifier, no information is returned.
	WorkspaceIds []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Contains the inputs for the DescribeWorkspaces operation.

func (DescribeWorkspacesInput) GoString

func (s DescribeWorkspacesInput) GoString() string

GoString returns the string representation

func (DescribeWorkspacesInput) String

func (s DescribeWorkspacesInput) String() string

String returns the string representation

func (*DescribeWorkspacesInput) Validate

func (s *DescribeWorkspacesInput) Validate() error

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

type DescribeWorkspacesOutput

type DescribeWorkspacesOutput struct {

	// If not null, more results are available. Pass this value for the NextToken
	// parameter in a subsequent call to this operation to retrieve the next set
	// of items. This token is valid for one day and must be used within that time
	// frame.
	NextToken *string `min:"1" type:"string"`

	// An array of structures that contain the information about the WorkSpaces.
	//
	// Because the CreateWorkspaces operation is asynchronous, some of this information
	// may be incomplete for a newly-created WorkSpace.
	Workspaces []*Workspace `type:"list"`
	// contains filtered or unexported fields
}

Contains the results for the DescribeWorkspaces operation.

func (DescribeWorkspacesOutput) GoString

func (s DescribeWorkspacesOutput) GoString() string

GoString returns the string representation

func (DescribeWorkspacesOutput) String

func (s DescribeWorkspacesOutput) String() string

String returns the string representation

type FailedCreateWorkspaceRequest

type FailedCreateWorkspaceRequest struct {

	// The error code.
	ErrorCode *string `type:"string"`

	// The textual error message.
	ErrorMessage *string `type:"string"`

	// A FailedCreateWorkspaceRequest$WorkspaceRequest object that contains the
	// information about the WorkSpace that could not be created.
	WorkspaceRequest *WorkspaceRequest `type:"structure"`
	// contains filtered or unexported fields
}

Contains information about a WorkSpace that could not be created.

func (FailedCreateWorkspaceRequest) GoString

func (s FailedCreateWorkspaceRequest) GoString() string

GoString returns the string representation

func (FailedCreateWorkspaceRequest) String

String returns the string representation

type FailedWorkspaceChangeRequest

type FailedWorkspaceChangeRequest struct {

	// The error code.
	ErrorCode *string `type:"string"`

	// The textual error message.
	ErrorMessage *string `type:"string"`

	// The identifier of the WorkSpace.
	WorkspaceId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about a WorkSpace that could not be rebooted (RebootWorkspaces), rebuilt (RebuildWorkspaces), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

func (FailedWorkspaceChangeRequest) GoString

func (s FailedWorkspaceChangeRequest) GoString() string

GoString returns the string representation

func (FailedWorkspaceChangeRequest) String

String returns the string representation

type ModifyWorkspacePropertiesInput

type ModifyWorkspacePropertiesInput struct {

	// The ID of the WorkSpace.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `type:"string" required:"true"`

	// The WorkSpace properties of the request.
	//
	// WorkspaceProperties is a required field
	WorkspaceProperties *WorkspaceProperties `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyWorkspacePropertiesInput) GoString

GoString returns the string representation

func (ModifyWorkspacePropertiesInput) String

String returns the string representation

func (*ModifyWorkspacePropertiesInput) Validate

func (s *ModifyWorkspacePropertiesInput) Validate() error

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

type ModifyWorkspacePropertiesOutput

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

func (ModifyWorkspacePropertiesOutput) GoString

GoString returns the string representation

func (ModifyWorkspacePropertiesOutput) String

String returns the string representation

type RebootRequest

type RebootRequest struct {

	// The identifier of the WorkSpace to reboot.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information used with the RebootWorkspaces operation to reboot a WorkSpace.

func (RebootRequest) GoString

func (s RebootRequest) GoString() string

GoString returns the string representation

func (RebootRequest) String

func (s RebootRequest) String() string

String returns the string representation

func (*RebootRequest) Validate

func (s *RebootRequest) Validate() error

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

type RebootWorkspacesInput

type RebootWorkspacesInput struct {

	// An array of structures that specify the WorkSpaces to reboot.
	//
	// RebootWorkspaceRequests is a required field
	RebootWorkspaceRequests []*RebootRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the RebootWorkspaces operation.

func (RebootWorkspacesInput) GoString

func (s RebootWorkspacesInput) GoString() string

GoString returns the string representation

func (RebootWorkspacesInput) String

func (s RebootWorkspacesInput) String() string

String returns the string representation

func (*RebootWorkspacesInput) Validate

func (s *RebootWorkspacesInput) Validate() error

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

type RebootWorkspacesOutput

type RebootWorkspacesOutput struct {

	// An array of structures representing any WorkSpaces that could not be rebooted.
	FailedRequests []*FailedWorkspaceChangeRequest `type:"list"`
	// contains filtered or unexported fields
}

Contains the results of the RebootWorkspaces operation.

func (RebootWorkspacesOutput) GoString

func (s RebootWorkspacesOutput) GoString() string

GoString returns the string representation

func (RebootWorkspacesOutput) String

func (s RebootWorkspacesOutput) String() string

String returns the string representation

type RebuildRequest

type RebuildRequest struct {

	// The identifier of the WorkSpace to rebuild.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information used with the RebuildWorkspaces operation to rebuild a WorkSpace.

func (RebuildRequest) GoString

func (s RebuildRequest) GoString() string

GoString returns the string representation

func (RebuildRequest) String

func (s RebuildRequest) String() string

String returns the string representation

func (*RebuildRequest) Validate

func (s *RebuildRequest) Validate() error

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

type RebuildWorkspacesInput

type RebuildWorkspacesInput struct {

	// An array of structures that specify the WorkSpaces to rebuild.
	//
	// RebuildWorkspaceRequests is a required field
	RebuildWorkspaceRequests []*RebuildRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the RebuildWorkspaces operation.

func (RebuildWorkspacesInput) GoString

func (s RebuildWorkspacesInput) GoString() string

GoString returns the string representation

func (RebuildWorkspacesInput) String

func (s RebuildWorkspacesInput) String() string

String returns the string representation

func (*RebuildWorkspacesInput) Validate

func (s *RebuildWorkspacesInput) Validate() error

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

type RebuildWorkspacesOutput

type RebuildWorkspacesOutput struct {

	// An array of structures representing any WorkSpaces that could not be rebuilt.
	FailedRequests []*FailedWorkspaceChangeRequest `type:"list"`
	// contains filtered or unexported fields
}

Contains the results of the RebuildWorkspaces operation.

func (RebuildWorkspacesOutput) GoString

func (s RebuildWorkspacesOutput) GoString() string

GoString returns the string representation

func (RebuildWorkspacesOutput) String

func (s RebuildWorkspacesOutput) String() string

String returns the string representation

type StartRequest

type StartRequest struct {

	// The ID of the WorkSpace.
	WorkspaceId *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the start request.

func (StartRequest) GoString

func (s StartRequest) GoString() string

GoString returns the string representation

func (StartRequest) String

func (s StartRequest) String() string

String returns the string representation

type StartWorkspacesInput

type StartWorkspacesInput struct {

	// The requests.
	//
	// StartWorkspaceRequests is a required field
	StartWorkspaceRequests []*StartRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (StartWorkspacesInput) GoString

func (s StartWorkspacesInput) GoString() string

GoString returns the string representation

func (StartWorkspacesInput) String

func (s StartWorkspacesInput) String() string

String returns the string representation

func (*StartWorkspacesInput) Validate

func (s *StartWorkspacesInput) Validate() error

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

type StartWorkspacesOutput

type StartWorkspacesOutput struct {

	// The failed requests.
	FailedRequests []*FailedWorkspaceChangeRequest `type:"list"`
	// contains filtered or unexported fields
}

func (StartWorkspacesOutput) GoString

func (s StartWorkspacesOutput) GoString() string

GoString returns the string representation

func (StartWorkspacesOutput) String

func (s StartWorkspacesOutput) String() string

String returns the string representation

type StopRequest

type StopRequest struct {

	// The ID of the WorkSpace.
	WorkspaceId *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the stop request.

func (StopRequest) GoString

func (s StopRequest) GoString() string

GoString returns the string representation

func (StopRequest) String

func (s StopRequest) String() string

String returns the string representation

type StopWorkspacesInput

type StopWorkspacesInput struct {

	// The requests.
	//
	// StopWorkspaceRequests is a required field
	StopWorkspaceRequests []*StopRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (StopWorkspacesInput) GoString

func (s StopWorkspacesInput) GoString() string

GoString returns the string representation

func (StopWorkspacesInput) String

func (s StopWorkspacesInput) String() string

String returns the string representation

func (*StopWorkspacesInput) Validate

func (s *StopWorkspacesInput) Validate() error

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

type StopWorkspacesOutput

type StopWorkspacesOutput struct {

	// The failed requests.
	FailedRequests []*FailedWorkspaceChangeRequest `type:"list"`
	// contains filtered or unexported fields
}

func (StopWorkspacesOutput) GoString

func (s StopWorkspacesOutput) GoString() string

GoString returns the string representation

func (StopWorkspacesOutput) String

func (s StopWorkspacesOutput) String() string

String returns the string representation

type Tag

type Tag struct {

	// The key of the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the tag of the WorkSpace.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation

func (Tag) String

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate

func (s *Tag) Validate() error

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

type TerminateRequest

type TerminateRequest struct {

	// The identifier of the WorkSpace to terminate.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains information used with the TerminateWorkspaces operation to terminate a WorkSpace.

func (TerminateRequest) GoString

func (s TerminateRequest) GoString() string

GoString returns the string representation

func (TerminateRequest) String

func (s TerminateRequest) String() string

String returns the string representation

func (*TerminateRequest) Validate

func (s *TerminateRequest) Validate() error

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

type TerminateWorkspacesInput

type TerminateWorkspacesInput struct {

	// An array of structures that specify the WorkSpaces to terminate.
	//
	// TerminateWorkspaceRequests is a required field
	TerminateWorkspaceRequests []*TerminateRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the TerminateWorkspaces operation.

func (TerminateWorkspacesInput) GoString

func (s TerminateWorkspacesInput) GoString() string

GoString returns the string representation

func (TerminateWorkspacesInput) String

func (s TerminateWorkspacesInput) String() string

String returns the string representation

func (*TerminateWorkspacesInput) Validate

func (s *TerminateWorkspacesInput) Validate() error

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

type TerminateWorkspacesOutput

type TerminateWorkspacesOutput struct {

	// An array of structures representing any WorkSpaces that could not be terminated.
	FailedRequests []*FailedWorkspaceChangeRequest `type:"list"`
	// contains filtered or unexported fields
}

Contains the results of the TerminateWorkspaces operation.

func (TerminateWorkspacesOutput) GoString

func (s TerminateWorkspacesOutput) GoString() string

GoString returns the string representation

func (TerminateWorkspacesOutput) String

func (s TerminateWorkspacesOutput) String() string

String returns the string representation

type UserStorage

type UserStorage struct {

	// The amount of user storage for the bundle.
	Capacity *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Contains information about the user storage for a WorkSpace bundle.

func (UserStorage) GoString

func (s UserStorage) GoString() string

GoString returns the string representation

func (UserStorage) String

func (s UserStorage) String() string

String returns the string representation

type WorkSpaces

type WorkSpaces struct {
	*client.Client
}

This reference provides detailed information about the Amazon WorkSpaces operations. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New

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

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

Example:

// Create a WorkSpaces client from just a session.
svc := workspaces.New(mySession)

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

func (*WorkSpaces) CreateTags

func (c *WorkSpaces) CreateTags(input *CreateTagsInput) (*CreateTagsOutput, error)

Creates tags for a WorkSpace.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.CreateTagsInput{
		ResourceId: aws.String("NonEmptyString"), // Required
		Tags: []*workspaces.Tag{ // Required
			{ // Required
				Key:   aws.String("TagKey"), // Required
				Value: aws.String("TagValue"),
			},
			// More values...
		},
	}
	resp, err := svc.CreateTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) CreateTagsRequest

func (c *WorkSpaces) CreateTagsRequest(input *CreateTagsInput) (req *request.Request, output *CreateTagsOutput)

CreateTagsRequest generates a "aws/request.Request" representing the client's request for the CreateTags operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateTags method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) CreateWorkspaces

func (c *WorkSpaces) CreateWorkspaces(input *CreateWorkspacesInput) (*CreateWorkspacesOutput, error)

Creates one or more WorkSpaces.

This operation is asynchronous and returns before the WorkSpaces are created.
Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.CreateWorkspacesInput{
		Workspaces: []*workspaces.WorkspaceRequest{ // Required
			{ // Required
				BundleId:                    aws.String("BundleId"),    // Required
				DirectoryId:                 aws.String("DirectoryId"), // Required
				UserName:                    aws.String("UserName"),    // Required
				RootVolumeEncryptionEnabled: aws.Bool(true),
				Tags: []*workspaces.Tag{
					{ // Required
						Key:   aws.String("TagKey"), // Required
						Value: aws.String("TagValue"),
					},
					// More values...
				},
				UserVolumeEncryptionEnabled: aws.Bool(true),
				VolumeEncryptionKey:         aws.String("VolumeEncryptionKey"),
				WorkspaceProperties: &workspaces.WorkspaceProperties{
					RunningMode:                         aws.String("RunningMode"),
					RunningModeAutoStopTimeoutInMinutes: aws.Int64(1),
				},
			},
			// More values...
		},
	}
	resp, err := svc.CreateWorkspaces(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) CreateWorkspacesRequest

func (c *WorkSpaces) CreateWorkspacesRequest(input *CreateWorkspacesInput) (req *request.Request, output *CreateWorkspacesOutput)

CreateWorkspacesRequest generates a "aws/request.Request" representing the client's request for the CreateWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateWorkspaces method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) DeleteTags

func (c *WorkSpaces) DeleteTags(input *DeleteTagsInput) (*DeleteTagsOutput, error)

Deletes tags from a WorkSpace.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.DeleteTagsInput{
		ResourceId: aws.String("NonEmptyString"), // Required
		TagKeys: []*string{ // Required
			aws.String("NonEmptyString"), // Required
			// More values...
		},
	}
	resp, err := svc.DeleteTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) DeleteTagsRequest

func (c *WorkSpaces) DeleteTagsRequest(input *DeleteTagsInput) (req *request.Request, output *DeleteTagsOutput)

DeleteTagsRequest generates a "aws/request.Request" representing the client's request for the DeleteTags operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteTags method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) DescribeTags

func (c *WorkSpaces) DescribeTags(input *DescribeTagsInput) (*DescribeTagsOutput, error)

Describes tags for a WorkSpace.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.DescribeTagsInput{
		ResourceId: aws.String("NonEmptyString"), // Required
	}
	resp, err := svc.DescribeTags(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) DescribeTagsRequest

func (c *WorkSpaces) DescribeTagsRequest(input *DescribeTagsInput) (req *request.Request, output *DescribeTagsOutput)

DescribeTagsRequest generates a "aws/request.Request" representing the client's request for the DescribeTags operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeTags method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) DescribeWorkspaceBundles

func (c *WorkSpaces) DescribeWorkspaceBundles(input *DescribeWorkspaceBundlesInput) (*DescribeWorkspaceBundlesOutput, error)

Obtains information about the WorkSpace bundles that are available to your account in the specified region.

You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.DescribeWorkspaceBundlesInput{
		BundleIds: []*string{
			aws.String("BundleId"), // Required
			// More values...
		},
		NextToken: aws.String("PaginationToken"),
		Owner:     aws.String("BundleOwner"),
	}
	resp, err := svc.DescribeWorkspaceBundles(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) DescribeWorkspaceBundlesPages

func (c *WorkSpaces) DescribeWorkspaceBundlesPages(input *DescribeWorkspaceBundlesInput, fn func(p *DescribeWorkspaceBundlesOutput, lastPage bool) (shouldContinue 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) DescribeWorkspaceBundlesRequest

func (c *WorkSpaces) DescribeWorkspaceBundlesRequest(input *DescribeWorkspaceBundlesInput) (req *request.Request, output *DescribeWorkspaceBundlesOutput)

DescribeWorkspaceBundlesRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaceBundles operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeWorkspaceBundles method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) DescribeWorkspaceDirectories

func (c *WorkSpaces) DescribeWorkspaceDirectories(input *DescribeWorkspaceDirectoriesInput) (*DescribeWorkspaceDirectoriesOutput, error)

Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.DescribeWorkspaceDirectoriesInput{
		DirectoryIds: []*string{
			aws.String("DirectoryId"), // Required
			// More values...
		},
		NextToken: aws.String("PaginationToken"),
	}
	resp, err := svc.DescribeWorkspaceDirectories(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) DescribeWorkspaceDirectoriesPages

func (c *WorkSpaces) DescribeWorkspaceDirectoriesPages(input *DescribeWorkspaceDirectoriesInput, fn func(p *DescribeWorkspaceDirectoriesOutput, lastPage bool) (shouldContinue 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) DescribeWorkspaceDirectoriesRequest

func (c *WorkSpaces) DescribeWorkspaceDirectoriesRequest(input *DescribeWorkspaceDirectoriesInput) (req *request.Request, output *DescribeWorkspaceDirectoriesOutput)

DescribeWorkspaceDirectoriesRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaceDirectories operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeWorkspaceDirectories method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) DescribeWorkspaces

func (c *WorkSpaces) DescribeWorkspaces(input *DescribeWorkspacesInput) (*DescribeWorkspacesOutput, error)

Obtains information about the specified WorkSpaces.

Only one of the filter parameters, such as BundleId, DirectoryId, or WorkspaceIds, can be specified at a time.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.DescribeWorkspacesInput{
		BundleId:    aws.String("BundleId"),
		DirectoryId: aws.String("DirectoryId"),
		Limit:       aws.Int64(1),
		NextToken:   aws.String("PaginationToken"),
		UserName:    aws.String("UserName"),
		WorkspaceIds: []*string{
			aws.String("WorkspaceId"), // Required
			// More values...
		},
	}
	resp, err := svc.DescribeWorkspaces(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) DescribeWorkspacesConnectionStatus

Describes the connection status of a specified WorkSpace.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.DescribeWorkspacesConnectionStatusInput{
		NextToken: aws.String("PaginationToken"),
		WorkspaceIds: []*string{
			aws.String("WorkspaceId"), // Required
			// More values...
		},
	}
	resp, err := svc.DescribeWorkspacesConnectionStatus(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) DescribeWorkspacesConnectionStatusRequest

func (c *WorkSpaces) DescribeWorkspacesConnectionStatusRequest(input *DescribeWorkspacesConnectionStatusInput) (req *request.Request, output *DescribeWorkspacesConnectionStatusOutput)

DescribeWorkspacesConnectionStatusRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspacesConnectionStatus operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeWorkspacesConnectionStatus method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) DescribeWorkspacesPages

func (c *WorkSpaces) DescribeWorkspacesPages(input *DescribeWorkspacesInput, fn func(p *DescribeWorkspacesOutput, lastPage bool) (shouldContinue 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) DescribeWorkspacesRequest

func (c *WorkSpaces) DescribeWorkspacesRequest(input *DescribeWorkspacesInput) (req *request.Request, output *DescribeWorkspacesOutput)

DescribeWorkspacesRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeWorkspaces method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) ModifyWorkspaceProperties

func (c *WorkSpaces) ModifyWorkspaceProperties(input *ModifyWorkspacePropertiesInput) (*ModifyWorkspacePropertiesOutput, error)

Modifies the WorkSpace properties, including the RunningMode and AutoStop time.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.ModifyWorkspacePropertiesInput{
		WorkspaceId: aws.String("WorkspaceId"), // Required
		WorkspaceProperties: &workspaces.WorkspaceProperties{ // Required
			RunningMode:                         aws.String("RunningMode"),
			RunningModeAutoStopTimeoutInMinutes: aws.Int64(1),
		},
	}
	resp, err := svc.ModifyWorkspaceProperties(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) ModifyWorkspacePropertiesRequest

func (c *WorkSpaces) ModifyWorkspacePropertiesRequest(input *ModifyWorkspacePropertiesInput) (req *request.Request, output *ModifyWorkspacePropertiesOutput)

ModifyWorkspacePropertiesRequest generates a "aws/request.Request" representing the client's request for the ModifyWorkspaceProperties operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ModifyWorkspaceProperties method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) RebootWorkspaces

func (c *WorkSpaces) RebootWorkspaces(input *RebootWorkspacesInput) (*RebootWorkspacesOutput, error)

Reboots the specified WorkSpaces.

To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE, IMPAIRED, or INOPERABLE.

This operation is asynchronous and returns before the WorkSpaces have rebooted.
Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.RebootWorkspacesInput{
		RebootWorkspaceRequests: []*workspaces.RebootRequest{ // Required
			{ // Required
				WorkspaceId: aws.String("WorkspaceId"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.RebootWorkspaces(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) RebootWorkspacesRequest

func (c *WorkSpaces) RebootWorkspacesRequest(input *RebootWorkspacesInput) (req *request.Request, output *RebootWorkspacesOutput)

RebootWorkspacesRequest generates a "aws/request.Request" representing the client's request for the RebootWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RebootWorkspaces method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) RebuildWorkspaces

func (c *WorkSpaces) RebuildWorkspaces(input *RebuildWorkspacesInput) (*RebuildWorkspacesOutput, error)

Rebuilds the specified WorkSpaces.

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur:

The system is restored to the image of the bundle that the WorkSpace is

created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.

The data drive (D drive) is re-created from the last automatic snapshot

taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.

To be able to rebuild a WorkSpace, the WorkSpace must have a State of

AVAILABLE or ERROR.

This operation is asynchronous and returns before the WorkSpaces have been

completely rebuilt.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.RebuildWorkspacesInput{
		RebuildWorkspaceRequests: []*workspaces.RebuildRequest{ // Required
			{ // Required
				WorkspaceId: aws.String("WorkspaceId"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.RebuildWorkspaces(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) RebuildWorkspacesRequest

func (c *WorkSpaces) RebuildWorkspacesRequest(input *RebuildWorkspacesInput) (req *request.Request, output *RebuildWorkspacesOutput)

RebuildWorkspacesRequest generates a "aws/request.Request" representing the client's request for the RebuildWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RebuildWorkspaces method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) StartWorkspaces

func (c *WorkSpaces) StartWorkspaces(input *StartWorkspacesInput) (*StartWorkspacesOutput, error)

Starts the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to “STOPPED.”

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.StartWorkspacesInput{
		StartWorkspaceRequests: []*workspaces.StartRequest{ // Required
			{ // Required
				WorkspaceId: aws.String("WorkspaceId"),
			},
			// More values...
		},
	}
	resp, err := svc.StartWorkspaces(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) StartWorkspacesRequest

func (c *WorkSpaces) StartWorkspacesRequest(input *StartWorkspacesInput) (req *request.Request, output *StartWorkspacesOutput)

StartWorkspacesRequest generates a "aws/request.Request" representing the client's request for the StartWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StartWorkspaces method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) StopWorkspaces

func (c *WorkSpaces) StopWorkspaces(input *StopWorkspacesInput) (*StopWorkspacesOutput, error)

Stops the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.StopWorkspacesInput{
		StopWorkspaceRequests: []*workspaces.StopRequest{ // Required
			{ // Required
				WorkspaceId: aws.String("WorkspaceId"),
			},
			// More values...
		},
	}
	resp, err := svc.StopWorkspaces(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) StopWorkspacesRequest

func (c *WorkSpaces) StopWorkspacesRequest(input *StopWorkspacesInput) (req *request.Request, output *StopWorkspacesOutput)

StopWorkspacesRequest generates a "aws/request.Request" representing the client's request for the StopWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the StopWorkspaces method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

func (*WorkSpaces) TerminateWorkspaces

func (c *WorkSpaces) TerminateWorkspaces(input *TerminateWorkspacesInput) (*TerminateWorkspacesOutput, error)

Terminates the specified WorkSpaces.

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.

You can terminate a WorkSpace that is in any state except SUSPENDED.

This operation is asynchronous and returns before the WorkSpaces have been

completely terminated.

Example
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/workspaces"
)

func main() {
	sess, err := session.NewSession()
	if err != nil {
		fmt.Println("failed to create session,", err)
		return
	}

	svc := workspaces.New(sess)

	params := &workspaces.TerminateWorkspacesInput{
		TerminateWorkspaceRequests: []*workspaces.TerminateRequest{ // Required
			{ // Required
				WorkspaceId: aws.String("WorkspaceId"), // Required
			},
			// More values...
		},
	}
	resp, err := svc.TerminateWorkspaces(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}
Output:

func (*WorkSpaces) TerminateWorkspacesRequest

func (c *WorkSpaces) TerminateWorkspacesRequest(input *TerminateWorkspacesInput) (req *request.Request, output *TerminateWorkspacesOutput)

TerminateWorkspacesRequest generates a "aws/request.Request" representing the client's request for the TerminateWorkspaces operation. The "output" return value can be used to capture response data after the request's "Send" method is called.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the TerminateWorkspaces method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

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

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

type Workspace

type Workspace struct {

	// The identifier of the bundle that the WorkSpace was created from.
	BundleId *string `type:"string"`

	// The name of the WorkSpace as seen by the operating system.
	ComputerName *string `type:"string"`

	// The identifier of the AWS Directory Service directory that the WorkSpace
	// belongs to.
	DirectoryId *string `type:"string"`

	// If the WorkSpace could not be created, this contains the error code.
	ErrorCode *string `type:"string"`

	// If the WorkSpace could not be created, this contains a textual error message
	// that describes the failure.
	ErrorMessage *string `type:"string"`

	// The IP address of the WorkSpace.
	IpAddress *string `type:"string"`

	// Specifies whether the data stored on the root volume, or C: drive, is encrypted.
	RootVolumeEncryptionEnabled *bool `type:"boolean"`

	// The operational state of the WorkSpace.
	State *string `type:"string" enum:"WorkspaceState"`

	// The identifier of the subnet that the WorkSpace is in.
	SubnetId *string `type:"string"`

	// The user that the WorkSpace is assigned to.
	UserName *string `min:"1" type:"string"`

	// Specifies whether the data stored on the user volume, or D: drive, is encrypted.
	UserVolumeEncryptionEnabled *bool `type:"boolean"`

	// The KMS key used to encrypt data stored on your WorkSpace.
	VolumeEncryptionKey *string `type:"string"`

	// The identifier of the WorkSpace.
	WorkspaceId *string `type:"string"`

	// Describes the properties of a WorkSpace.
	WorkspaceProperties *WorkspaceProperties `type:"structure"`
	// contains filtered or unexported fields
}

Contains information about a WorkSpace.

func (Workspace) GoString

func (s Workspace) GoString() string

GoString returns the string representation

func (Workspace) String

func (s Workspace) String() string

String returns the string representation

type WorkspaceBundle

type WorkspaceBundle struct {

	// The bundle identifier.
	BundleId *string `type:"string"`

	// A ComputeType object that specifies the compute type for the bundle.
	ComputeType *ComputeType `type:"structure"`

	// The bundle description.
	Description *string `type:"string"`

	// The name of the bundle.
	Name *string `min:"1" type:"string"`

	// The owner of the bundle. This contains the owner's account identifier, or
	// AMAZON if the bundle is provided by AWS.
	Owner *string `type:"string"`

	// A UserStorage object that specifies the amount of user storage that the bundle
	// contains.
	UserStorage *UserStorage `type:"structure"`
	// contains filtered or unexported fields
}

Contains information about a WorkSpace bundle.

func (WorkspaceBundle) GoString

func (s WorkspaceBundle) GoString() string

GoString returns the string representation

func (WorkspaceBundle) String

func (s WorkspaceBundle) String() string

String returns the string representation

type WorkspaceConnectionStatus

type WorkspaceConnectionStatus struct {

	// The connection state of the WorkSpace. Returns UNKOWN if the WorkSpace is
	// in a Stopped state.
	ConnectionState *string `type:"string" enum:"ConnectionState"`

	// The timestamp of the connection state check.
	ConnectionStateCheckTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The timestamp of the last known user connection.
	LastKnownUserConnectionTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The ID of the WorkSpace.
	WorkspaceId *string `type:"string"`
	// contains filtered or unexported fields
}

Describes the connection status of a WorkSpace.

func (WorkspaceConnectionStatus) GoString

func (s WorkspaceConnectionStatus) GoString() string

GoString returns the string representation

func (WorkspaceConnectionStatus) String

func (s WorkspaceConnectionStatus) String() string

String returns the string representation

type WorkspaceDirectory

type WorkspaceDirectory struct {

	// The directory alias.
	Alias *string `type:"string"`

	// The user name for the service account.
	CustomerUserName *string `min:"1" type:"string"`

	// The directory identifier.
	DirectoryId *string `type:"string"`

	// The name of the directory.
	DirectoryName *string `type:"string"`

	// The directory type.
	DirectoryType *string `type:"string" enum:"WorkspaceDirectoryType"`

	// An array of strings that contains the IP addresses of the DNS servers for
	// the directory.
	DnsIpAddresses []*string `type:"list"`

	// The identifier of the IAM role. This is the role that allows Amazon WorkSpaces
	// to make calls to other services, such as Amazon EC2, on your behalf.
	IamRoleId *string `type:"string"`

	// The registration code for the directory. This is the code that users enter
	// in their Amazon WorkSpaces client application to connect to the directory.
	RegistrationCode *string `min:"1" type:"string"`

	// The state of the directory's registration with Amazon WorkSpaces
	State *string `type:"string" enum:"WorkspaceDirectoryState"`

	// An array of strings that contains the identifiers of the subnets used with
	// the directory.
	SubnetIds []*string `type:"list"`

	// A structure that specifies the default creation properties for all WorkSpaces
	// in the directory.
	WorkspaceCreationProperties *DefaultWorkspaceCreationProperties `type:"structure"`

	// The identifier of the security group that is assigned to new WorkSpaces.
	WorkspaceSecurityGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.

func (WorkspaceDirectory) GoString

func (s WorkspaceDirectory) GoString() string

GoString returns the string representation

func (WorkspaceDirectory) String

func (s WorkspaceDirectory) String() string

String returns the string representation

type WorkspaceProperties

type WorkspaceProperties struct {

	// The running mode of the WorkSpace. AlwaysOn WorkSpaces are billed monthly.
	// AutoStop WorkSpaces are billed by the hour and stopped when no longer being
	// used in order to save on costs.
	RunningMode *string `type:"string" enum:"RunningMode"`

	// The time after a user logs off when WorkSpaces are automatically stopped.
	// Configured in 60 minute intervals.
	RunningModeAutoStopTimeoutInMinutes *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Describes the properties of a WorkSpace.

func (WorkspaceProperties) GoString

func (s WorkspaceProperties) GoString() string

GoString returns the string representation

func (WorkspaceProperties) String

func (s WorkspaceProperties) String() string

String returns the string representation

type WorkspaceRequest

type WorkspaceRequest struct {

	// The identifier of the bundle to create the WorkSpace from. You can use the
	// DescribeWorkspaceBundles operation to obtain a list of the bundles that are
	// available.
	//
	// BundleId is a required field
	BundleId *string `type:"string" required:"true"`

	// The identifier of the AWS Directory Service directory to create the WorkSpace
	// in. You can use the DescribeWorkspaceDirectories operation to obtain a list
	// of the directories that are available.
	//
	// DirectoryId is a required field
	DirectoryId *string `type:"string" required:"true"`

	// Specifies whether the data stored on the root volume, or C: drive, is encrypted.
	RootVolumeEncryptionEnabled *bool `type:"boolean"`

	// The tags of the WorkSpace request.
	Tags []*Tag `type:"list"`

	// The username that the WorkSpace is assigned to. This username must exist
	// in the AWS Directory Service directory specified by the DirectoryId member.
	//
	// UserName is a required field
	UserName *string `min:"1" type:"string" required:"true"`

	// Specifies whether the data stored on the user volume, or D: drive, is encrypted.
	UserVolumeEncryptionEnabled *bool `type:"boolean"`

	// The KMS key used to encrypt data stored on your WorkSpace.
	VolumeEncryptionKey *string `type:"string"`

	// Describes the properties of a WorkSpace.
	WorkspaceProperties *WorkspaceProperties `type:"structure"`
	// contains filtered or unexported fields
}

Contains information about a WorkSpace creation request.

func (WorkspaceRequest) GoString

func (s WorkspaceRequest) GoString() string

GoString returns the string representation

func (WorkspaceRequest) String

func (s WorkspaceRequest) String() string

String returns the string representation

func (*WorkspaceRequest) Validate

func (s *WorkspaceRequest) Validate() error

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

Directories

Path Synopsis
Package workspacesiface provides an interface to enable mocking the Amazon WorkSpaces service client for testing your code.
Package workspacesiface provides an interface to enable mocking the Amazon WorkSpaces service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL