workspaces

package
v2.0.0-preview.1+incom... Latest Latest
Warning

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

 Go to latest Published: Dec 21, 2017 License: Apache-2.0, Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package workspaces provides the client and types for making API requests to Amazon WorkSpaces.

This reference provides detailed information about the Amazon WorkSpaces operations.

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 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

View Source 
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"

	// ErrCodeResourceUnavailableException for service response error code
	// "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"
)
View Source 
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 Compute 

type Compute string
const (
	ComputeValue       Compute = "VALUE"
	ComputeStandard    Compute = "STANDARD"
	ComputePerformance Compute = "PERFORMANCE"
)

Enum values for Compute

type ComputeType 

type ComputeType struct {

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

Contains information about the compute type of a WorkSpace bundle. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ComputeType

func (ComputeType) GoString 

func (s ComputeType) GoString() string

GoString returns the string representation

func (*ComputeType) SetName 

func (s *ComputeType) SetName(v Compute) *ComputeType

SetName sets the Name field's value.

func (ComputeType) String 

func (s ComputeType) String() string

String returns the string representation

type ConnectionState 

type ConnectionState string
const (
	ConnectionStateConnected    ConnectionState = "CONNECTED"
	ConnectionStateDisconnected ConnectionState = "DISCONNECTED"
	ConnectionStateUnknown      ConnectionState = "UNKNOWN"
)

Enum values for ConnectionState

type CreateTagsInput 

type CreateTagsInput struct {

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

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

The request of the CreateTags operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTagsRequest

func (CreateTagsInput) GoString 

func (s CreateTagsInput) GoString() string

GoString returns the string representation

func (*CreateTagsInput) SetResourceId 

func (s *CreateTagsInput) SetResourceId(v string) *CreateTagsInput

SetResourceId sets the ResourceId field's value.

func (*CreateTagsInput) SetTags 

func (s *CreateTagsInput) SetTags(v []Tag) *CreateTagsInput

SetTags sets the Tags field's value.

func (CreateTagsInput) String 

func (s CreateTagsInput) String() string

String returns the string representation

func (*CreateTagsInput) Validate 

func (s *CreateTagsInput) Validate() error

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

type CreateTagsOutput 

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

The result of the CreateTags operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTagsResult

func (CreateTagsOutput) GoString 

func (s CreateTagsOutput) GoString() string

GoString returns the string representation

func (CreateTagsOutput) SDKResponseMetadata 

func (s CreateTagsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateTagsOutput) String 

func (s CreateTagsOutput) String() string

String returns the string representation

type CreateTagsRequest 

type CreateTagsRequest struct {
	*aws.Request
	Input *CreateTagsInput
}

CreateTagsRequest is a API request type for the CreateTags API operation.

func (CreateTagsRequest) Send 

func (r CreateTagsRequest) Send() (*CreateTagsOutput, error)

Send marshals and sends the CreateTags API request.

type CreateWorkspacesInput 

type CreateWorkspacesInput struct {

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

Contains the inputs for the CreateWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspacesRequest

func (CreateWorkspacesInput) GoString 

func (s CreateWorkspacesInput) GoString() string

GoString returns the string representation

func (*CreateWorkspacesInput) SetWorkspaces 

func (s *CreateWorkspacesInput) SetWorkspaces(v []WorkspaceRequest) *CreateWorkspacesInput

SetWorkspaces sets the Workspaces field's value.

func (CreateWorkspacesInput) String 

func (s CreateWorkspacesInput) String() string

String returns the string representation

func (*CreateWorkspacesInput) Validate 

func (s *CreateWorkspacesInput) Validate() error

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

type CreateWorkspacesOutput 

type CreateWorkspacesOutput struct {

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

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

Contains the result of the CreateWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspacesResult

func (CreateWorkspacesOutput) GoString 

func (s CreateWorkspacesOutput) GoString() string

GoString returns the string representation

func (CreateWorkspacesOutput) SDKResponseMetadata 

func (s CreateWorkspacesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*CreateWorkspacesOutput) SetFailedRequests 

func (s *CreateWorkspacesOutput) SetFailedRequests(v []FailedCreateWorkspaceRequest) *CreateWorkspacesOutput

SetFailedRequests sets the FailedRequests field's value.

func (*CreateWorkspacesOutput) SetPendingRequests 

func (s *CreateWorkspacesOutput) SetPendingRequests(v []Workspace) *CreateWorkspacesOutput

SetPendingRequests sets the PendingRequests field's value.

func (CreateWorkspacesOutput) String 

func (s CreateWorkspacesOutput) String() string

String returns the string representation

type CreateWorkspacesRequest 

type CreateWorkspacesRequest struct {
	*aws.Request
	Input *CreateWorkspacesInput
}

CreateWorkspacesRequest is a API request type for the CreateWorkspaces API operation.

func (CreateWorkspacesRequest) Send 

func (r CreateWorkspacesRequest) Send() (*CreateWorkspacesOutput, error)

Send marshals and sends the CreateWorkspaces API request.

type DefaultWorkspaceCreationProperties 

type DefaultWorkspaceCreationProperties struct {

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

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

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

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

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

Contains default WorkSpace creation information. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DefaultWorkspaceCreationProperties

func (DefaultWorkspaceCreationProperties) GoString 

func (s DefaultWorkspaceCreationProperties) GoString() string

GoString returns the string representation

func (*DefaultWorkspaceCreationProperties) SetCustomSecurityGroupId 

func (s *DefaultWorkspaceCreationProperties) SetCustomSecurityGroupId(v string) *DefaultWorkspaceCreationProperties

SetCustomSecurityGroupId sets the CustomSecurityGroupId field's value.

func (*DefaultWorkspaceCreationProperties) SetDefaultOu 

func (s *DefaultWorkspaceCreationProperties) SetDefaultOu(v string) *DefaultWorkspaceCreationProperties

SetDefaultOu sets the DefaultOu field's value.

func (*DefaultWorkspaceCreationProperties) SetEnableInternetAccess 

func (s *DefaultWorkspaceCreationProperties) SetEnableInternetAccess(v bool) *DefaultWorkspaceCreationProperties

SetEnableInternetAccess sets the EnableInternetAccess field's value.

func (*DefaultWorkspaceCreationProperties) SetEnableWorkDocs 

func (s *DefaultWorkspaceCreationProperties) SetEnableWorkDocs(v bool) *DefaultWorkspaceCreationProperties

SetEnableWorkDocs sets the EnableWorkDocs field's value.

func (*DefaultWorkspaceCreationProperties) SetUserEnabledAsLocalAdministrator 

func (s *DefaultWorkspaceCreationProperties) SetUserEnabledAsLocalAdministrator(v bool) *DefaultWorkspaceCreationProperties

SetUserEnabledAsLocalAdministrator sets the UserEnabledAsLocalAdministrator field's value.

func (DefaultWorkspaceCreationProperties) String 

func (s DefaultWorkspaceCreationProperties) String() string

String returns the string representation

type DeleteTagsInput 

type DeleteTagsInput struct {

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

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

The request of the DeleteTags operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTagsRequest

func (DeleteTagsInput) GoString 

func (s DeleteTagsInput) GoString() string

GoString returns the string representation

func (*DeleteTagsInput) SetResourceId 

func (s *DeleteTagsInput) SetResourceId(v string) *DeleteTagsInput

SetResourceId sets the ResourceId field's value.

func (*DeleteTagsInput) SetTagKeys 

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

SetTagKeys sets the TagKeys field's value.

func (DeleteTagsInput) String 

func (s DeleteTagsInput) String() string

String returns the string representation

func (*DeleteTagsInput) Validate 

func (s *DeleteTagsInput) Validate() error

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

type DeleteTagsOutput 

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

The result of the DeleteTags operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTagsResult

func (DeleteTagsOutput) GoString 

func (s DeleteTagsOutput) GoString() string

GoString returns the string representation

func (DeleteTagsOutput) SDKResponseMetadata 

func (s DeleteTagsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteTagsOutput) String 

func (s DeleteTagsOutput) String() string

String returns the string representation

type DeleteTagsRequest 

type DeleteTagsRequest struct {
	*aws.Request
	Input *DeleteTagsInput
}

DeleteTagsRequest is a API request type for the DeleteTags API operation.

func (DeleteTagsRequest) Send 

func (r DeleteTagsRequest) Send() (*DeleteTagsOutput, error)

Send marshals and sends the DeleteTags API request.

type DescribeTagsInput 

type DescribeTagsInput struct {

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

The request of the DescribeTags operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTagsRequest

func (DescribeTagsInput) GoString 

func (s DescribeTagsInput) GoString() string

GoString returns the string representation

func (*DescribeTagsInput) SetResourceId 

func (s *DescribeTagsInput) SetResourceId(v string) *DescribeTagsInput

SetResourceId sets the ResourceId field's value.

func (DescribeTagsInput) String 

func (s DescribeTagsInput) String() string

String returns the string representation

func (*DescribeTagsInput) Validate 

func (s *DescribeTagsInput) Validate() error

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

type DescribeTagsOutput 

type DescribeTagsOutput struct {

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

The result of the DescribeTags operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTagsResult

func (DescribeTagsOutput) GoString 

func (s DescribeTagsOutput) GoString() string

GoString returns the string representation

func (DescribeTagsOutput) SDKResponseMetadata 

func (s DescribeTagsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*DescribeTagsOutput) SetTagList 

func (s *DescribeTagsOutput) SetTagList(v []Tag) *DescribeTagsOutput

SetTagList sets the TagList field's value.

func (DescribeTagsOutput) String 

func (s DescribeTagsOutput) String() string

String returns the string representation

type DescribeTagsRequest 

type DescribeTagsRequest struct {
	*aws.Request
	Input *DescribeTagsInput
}

DescribeTagsRequest is a API request type for the DescribeTags API operation.

func (DescribeTagsRequest) Send 

func (r DescribeTagsRequest) Send() (*DescribeTagsOutput, error)

Send marshals and sends the DescribeTags API request.

type DescribeWorkspaceBundlesInput 

type DescribeWorkspaceBundlesInput struct {

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

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

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

Contains the inputs for the DescribeWorkspaceBundles operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundlesRequest

func (DescribeWorkspaceBundlesInput) GoString 

func (s DescribeWorkspaceBundlesInput) GoString() string

GoString returns the string representation

func (*DescribeWorkspaceBundlesInput) SetBundleIds 

func (s *DescribeWorkspaceBundlesInput) SetBundleIds(v []string) *DescribeWorkspaceBundlesInput

SetBundleIds sets the BundleIds field's value.

func (*DescribeWorkspaceBundlesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*DescribeWorkspaceBundlesInput) SetOwner 

func (s *DescribeWorkspaceBundlesInput) SetOwner(v string) *DescribeWorkspaceBundlesInput

SetOwner sets the Owner field's value.

func (DescribeWorkspaceBundlesInput) String 

func (s DescribeWorkspaceBundlesInput) String() string

String returns the string representation

func (*DescribeWorkspaceBundlesInput) Validate 

func (s *DescribeWorkspaceBundlesInput) Validate() error

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

type DescribeWorkspaceBundlesOutput 

type DescribeWorkspaceBundlesOutput struct {

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

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

Contains the results of the DescribeWorkspaceBundles operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundlesResult

func (DescribeWorkspaceBundlesOutput) GoString 

func (s DescribeWorkspaceBundlesOutput) GoString() string

GoString returns the string representation

func (DescribeWorkspaceBundlesOutput) SDKResponseMetadata 

func (s DescribeWorkspaceBundlesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*DescribeWorkspaceBundlesOutput) SetBundles 

func (s *DescribeWorkspaceBundlesOutput) SetBundles(v []WorkspaceBundle) *DescribeWorkspaceBundlesOutput

SetBundles sets the Bundles field's value.

func (*DescribeWorkspaceBundlesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (DescribeWorkspaceBundlesOutput) String 

func (s DescribeWorkspaceBundlesOutput) String() string

String returns the string representation

type DescribeWorkspaceBundlesRequest 

type DescribeWorkspaceBundlesRequest struct {
	*aws.Request
	Input *DescribeWorkspaceBundlesInput
}

DescribeWorkspaceBundlesRequest is a API request type for the DescribeWorkspaceBundles API operation.

func (DescribeWorkspaceBundlesRequest) Send 

func (r DescribeWorkspaceBundlesRequest) Send() (*DescribeWorkspaceBundlesOutput, error)

Send marshals and sends the DescribeWorkspaceBundles API request.

type DescribeWorkspaceDirectoriesInput 

type DescribeWorkspaceDirectoriesInput struct {

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

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

Contains the inputs for the DescribeWorkspaceDirectories operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectoriesRequest

func (DescribeWorkspaceDirectoriesInput) GoString 

func (s DescribeWorkspaceDirectoriesInput) GoString() string

GoString returns the string representation

func (*DescribeWorkspaceDirectoriesInput) SetDirectoryIds 

func (s *DescribeWorkspaceDirectoriesInput) SetDirectoryIds(v []string) *DescribeWorkspaceDirectoriesInput

SetDirectoryIds sets the DirectoryIds field's value.

func (*DescribeWorkspaceDirectoriesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (DescribeWorkspaceDirectoriesInput) String 

func (s DescribeWorkspaceDirectoriesInput) String() string

String returns the string representation

func (*DescribeWorkspaceDirectoriesInput) Validate 

func (s *DescribeWorkspaceDirectoriesInput) Validate() error

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

type DescribeWorkspaceDirectoriesOutput 

type DescribeWorkspaceDirectoriesOutput struct {

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

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

Contains the results of the DescribeWorkspaceDirectories operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectoriesResult

func (DescribeWorkspaceDirectoriesOutput) GoString 

func (s DescribeWorkspaceDirectoriesOutput) GoString() string

GoString returns the string representation

func (DescribeWorkspaceDirectoriesOutput) SDKResponseMetadata 

func (s DescribeWorkspaceDirectoriesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*DescribeWorkspaceDirectoriesOutput) SetDirectories 

func (s *DescribeWorkspaceDirectoriesOutput) SetDirectories(v []WorkspaceDirectory) *DescribeWorkspaceDirectoriesOutput

SetDirectories sets the Directories field's value.

func (*DescribeWorkspaceDirectoriesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (DescribeWorkspaceDirectoriesOutput) String 

func (s DescribeWorkspaceDirectoriesOutput) String() string

String returns the string representation

type DescribeWorkspaceDirectoriesRequest 

type DescribeWorkspaceDirectoriesRequest struct {
	*aws.Request
	Input *DescribeWorkspaceDirectoriesInput
}

DescribeWorkspaceDirectoriesRequest is a API request type for the DescribeWorkspaceDirectories API operation.

func (DescribeWorkspaceDirectoriesRequest) Send 

func (r DescribeWorkspaceDirectoriesRequest) Send() (*DescribeWorkspaceDirectoriesOutput, error)

Send marshals and sends the DescribeWorkspaceDirectories API request.

type DescribeWorkspacesConnectionStatusInput 

type DescribeWorkspacesConnectionStatusInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatusRequest

func (DescribeWorkspacesConnectionStatusInput) GoString 

func (s DescribeWorkspacesConnectionStatusInput) GoString() string

GoString returns the string representation

func (*DescribeWorkspacesConnectionStatusInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*DescribeWorkspacesConnectionStatusInput) SetWorkspaceIds 

func (s *DescribeWorkspacesConnectionStatusInput) SetWorkspaceIds(v []string) *DescribeWorkspacesConnectionStatusInput

SetWorkspaceIds sets the WorkspaceIds field's value.

func (DescribeWorkspacesConnectionStatusInput) String 

func (s DescribeWorkspacesConnectionStatusInput) String() string

String returns the string representation

func (*DescribeWorkspacesConnectionStatusInput) Validate 

func (s *DescribeWorkspacesConnectionStatusInput) Validate() error

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

type DescribeWorkspacesConnectionStatusOutput 

type DescribeWorkspacesConnectionStatusOutput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatusResult

func (DescribeWorkspacesConnectionStatusOutput) GoString 

func (s DescribeWorkspacesConnectionStatusOutput) GoString() string

GoString returns the string representation

func (DescribeWorkspacesConnectionStatusOutput) SDKResponseMetadata 

func (s DescribeWorkspacesConnectionStatusOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*DescribeWorkspacesConnectionStatusOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*DescribeWorkspacesConnectionStatusOutput) SetWorkspacesConnectionStatus 

func (s *DescribeWorkspacesConnectionStatusOutput) SetWorkspacesConnectionStatus(v []WorkspaceConnectionStatus) *DescribeWorkspacesConnectionStatusOutput

SetWorkspacesConnectionStatus sets the WorkspacesConnectionStatus field's value.

func (DescribeWorkspacesConnectionStatusOutput) String 

func (s DescribeWorkspacesConnectionStatusOutput) String() string

String returns the string representation

type DescribeWorkspacesConnectionStatusRequest 

type DescribeWorkspacesConnectionStatusRequest struct {
	*aws.Request
	Input *DescribeWorkspacesConnectionStatusInput
}

DescribeWorkspacesConnectionStatusRequest is a API request type for the DescribeWorkspacesConnectionStatus API operation.

func (DescribeWorkspacesConnectionStatusRequest) Send 

func (r DescribeWorkspacesConnectionStatusRequest) Send() (*DescribeWorkspacesConnectionStatusOutput, error)

Send marshals and sends the DescribeWorkspacesConnectionStatus API request.

type DescribeWorkspacesInput 

type DescribeWorkspacesInput struct {

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

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

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

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

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

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

Contains the inputs for the DescribeWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesRequest

func (DescribeWorkspacesInput) GoString 

func (s DescribeWorkspacesInput) GoString() string

GoString returns the string representation

func (*DescribeWorkspacesInput) SetBundleId 

func (s *DescribeWorkspacesInput) SetBundleId(v string) *DescribeWorkspacesInput

SetBundleId sets the BundleId field's value.

func (*DescribeWorkspacesInput) SetDirectoryId 

func (s *DescribeWorkspacesInput) SetDirectoryId(v string) *DescribeWorkspacesInput

SetDirectoryId sets the DirectoryId field's value.

func (*DescribeWorkspacesInput) SetLimit 

func (s *DescribeWorkspacesInput) SetLimit(v int64) *DescribeWorkspacesInput

SetLimit sets the Limit field's value.

func (*DescribeWorkspacesInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*DescribeWorkspacesInput) SetUserName 

func (s *DescribeWorkspacesInput) SetUserName(v string) *DescribeWorkspacesInput

SetUserName sets the UserName field's value.

func (*DescribeWorkspacesInput) SetWorkspaceIds 

func (s *DescribeWorkspacesInput) SetWorkspaceIds(v []string) *DescribeWorkspacesInput

SetWorkspaceIds sets the WorkspaceIds field's value.

func (DescribeWorkspacesInput) String 

func (s DescribeWorkspacesInput) String() string

String returns the string representation

func (*DescribeWorkspacesInput) Validate 

func (s *DescribeWorkspacesInput) Validate() error

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

type DescribeWorkspacesOutput 

type DescribeWorkspacesOutput struct {

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

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

Contains the results for the DescribeWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesResult

func (DescribeWorkspacesOutput) GoString 

func (s DescribeWorkspacesOutput) GoString() string

GoString returns the string representation

func (DescribeWorkspacesOutput) SDKResponseMetadata 

func (s DescribeWorkspacesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*DescribeWorkspacesOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*DescribeWorkspacesOutput) SetWorkspaces 

func (s *DescribeWorkspacesOutput) SetWorkspaces(v []Workspace) *DescribeWorkspacesOutput

SetWorkspaces sets the Workspaces field's value.

func (DescribeWorkspacesOutput) String 

func (s DescribeWorkspacesOutput) String() string

String returns the string representation

type DescribeWorkspacesRequest 

type DescribeWorkspacesRequest struct {
	*aws.Request
	Input *DescribeWorkspacesInput
}

DescribeWorkspacesRequest is a API request type for the DescribeWorkspaces API operation.

func (DescribeWorkspacesRequest) Send 

func (r DescribeWorkspacesRequest) Send() (*DescribeWorkspacesOutput, error)

Send marshals and sends the DescribeWorkspaces API request.

type FailedCreateWorkspaceRequest 

type FailedCreateWorkspaceRequest struct {

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

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

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

Contains information about a WorkSpace that could not be created. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/FailedCreateWorkspaceRequest

func (FailedCreateWorkspaceRequest) GoString 

func (s FailedCreateWorkspaceRequest) GoString() string

GoString returns the string representation

func (*FailedCreateWorkspaceRequest) SetErrorCode 

func (s *FailedCreateWorkspaceRequest) SetErrorCode(v string) *FailedCreateWorkspaceRequest

SetErrorCode sets the ErrorCode field's value.

func (*FailedCreateWorkspaceRequest) SetErrorMessage 

func (s *FailedCreateWorkspaceRequest) SetErrorMessage(v string) *FailedCreateWorkspaceRequest

SetErrorMessage sets the ErrorMessage field's value.

func (*FailedCreateWorkspaceRequest) SetWorkspaceRequest 

func (s *FailedCreateWorkspaceRequest) SetWorkspaceRequest(v *WorkspaceRequest) *FailedCreateWorkspaceRequest

SetWorkspaceRequest sets the WorkspaceRequest field's value.

func (FailedCreateWorkspaceRequest) String 

func (s FailedCreateWorkspaceRequest) String() string

String returns the string representation

type FailedWorkspaceChangeRequest 

type FailedWorkspaceChangeRequest struct {

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

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

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

Contains information about a WorkSpace that could not be rebooted (RebootWorkspaces), rebuilt (RebuildWorkspaces), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces). Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/FailedWorkspaceChangeRequest

func (FailedWorkspaceChangeRequest) GoString 

func (s FailedWorkspaceChangeRequest) GoString() string

GoString returns the string representation

func (*FailedWorkspaceChangeRequest) SetErrorCode 

func (s *FailedWorkspaceChangeRequest) SetErrorCode(v string) *FailedWorkspaceChangeRequest

SetErrorCode sets the ErrorCode field's value.

func (*FailedWorkspaceChangeRequest) SetErrorMessage 

func (s *FailedWorkspaceChangeRequest) SetErrorMessage(v string) *FailedWorkspaceChangeRequest

SetErrorMessage sets the ErrorMessage field's value.

func (*FailedWorkspaceChangeRequest) SetWorkspaceId 

func (s *FailedWorkspaceChangeRequest) SetWorkspaceId(v string) *FailedWorkspaceChangeRequest

SetWorkspaceId sets the WorkspaceId field's value.

func (FailedWorkspaceChangeRequest) String 

func (s FailedWorkspaceChangeRequest) String() string

String returns the string representation

type ModifyWorkspacePropertiesInput 

type ModifyWorkspacePropertiesInput struct {

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspacePropertiesRequest

func (ModifyWorkspacePropertiesInput) GoString 

func (s ModifyWorkspacePropertiesInput) GoString() string

GoString returns the string representation

func (*ModifyWorkspacePropertiesInput) SetWorkspaceId 

func (s *ModifyWorkspacePropertiesInput) SetWorkspaceId(v string) *ModifyWorkspacePropertiesInput

SetWorkspaceId sets the WorkspaceId field's value.

func (*ModifyWorkspacePropertiesInput) SetWorkspaceProperties 

func (s *ModifyWorkspacePropertiesInput) SetWorkspaceProperties(v *WorkspaceProperties) *ModifyWorkspacePropertiesInput

SetWorkspaceProperties sets the WorkspaceProperties field's value.

func (ModifyWorkspacePropertiesInput) String 

func (s ModifyWorkspacePropertiesInput) String() string

String returns the string representation

func (*ModifyWorkspacePropertiesInput) Validate 

func (s *ModifyWorkspacePropertiesInput) Validate() error

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

type ModifyWorkspacePropertiesOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspacePropertiesResult

func (ModifyWorkspacePropertiesOutput) GoString 

func (s ModifyWorkspacePropertiesOutput) GoString() string

GoString returns the string representation

func (ModifyWorkspacePropertiesOutput) SDKResponseMetadata 

func (s ModifyWorkspacePropertiesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ModifyWorkspacePropertiesOutput) String 

func (s ModifyWorkspacePropertiesOutput) String() string

String returns the string representation

type ModifyWorkspacePropertiesRequest 

type ModifyWorkspacePropertiesRequest struct {
	*aws.Request
	Input *ModifyWorkspacePropertiesInput
}

ModifyWorkspacePropertiesRequest is a API request type for the ModifyWorkspaceProperties API operation.

func (ModifyWorkspacePropertiesRequest) Send 

func (r ModifyWorkspacePropertiesRequest) Send() (*ModifyWorkspacePropertiesOutput, error)

Send marshals and sends the ModifyWorkspaceProperties API request.

type RebootRequest 

type RebootRequest struct {

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

Contains information used with the RebootWorkspaces operation to reboot a WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootRequest

func (RebootRequest) GoString 

func (s RebootRequest) GoString() string

GoString returns the string representation

func (*RebootRequest) SetWorkspaceId 

func (s *RebootRequest) SetWorkspaceId(v string) *RebootRequest

SetWorkspaceId sets the WorkspaceId field's value.

func (RebootRequest) String 

func (s RebootRequest) String() string

String returns the string representation

func (*RebootRequest) Validate 

func (s *RebootRequest) Validate() error

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

type RebootWorkspacesInput 

type RebootWorkspacesInput struct {

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

Contains the inputs for the RebootWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspacesRequest

func (RebootWorkspacesInput) GoString 

func (s RebootWorkspacesInput) GoString() string

GoString returns the string representation

func (*RebootWorkspacesInput) SetRebootWorkspaceRequests 

func (s *RebootWorkspacesInput) SetRebootWorkspaceRequests(v []RebootRequest) *RebootWorkspacesInput

SetRebootWorkspaceRequests sets the RebootWorkspaceRequests field's value.

func (RebootWorkspacesInput) String 

func (s RebootWorkspacesInput) String() string

String returns the string representation

func (*RebootWorkspacesInput) Validate 

func (s *RebootWorkspacesInput) Validate() error

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

type RebootWorkspacesOutput 

type RebootWorkspacesOutput struct {

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

Contains the results of the RebootWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspacesResult

func (RebootWorkspacesOutput) GoString 

func (s RebootWorkspacesOutput) GoString() string

GoString returns the string representation

func (RebootWorkspacesOutput) SDKResponseMetadata 

func (s RebootWorkspacesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*RebootWorkspacesOutput) SetFailedRequests 

func (s *RebootWorkspacesOutput) SetFailedRequests(v []FailedWorkspaceChangeRequest) *RebootWorkspacesOutput

SetFailedRequests sets the FailedRequests field's value.

func (RebootWorkspacesOutput) String 

func (s RebootWorkspacesOutput) String() string

String returns the string representation

type RebootWorkspacesRequest 

type RebootWorkspacesRequest struct {
	*aws.Request
	Input *RebootWorkspacesInput
}

RebootWorkspacesRequest is a API request type for the RebootWorkspaces API operation.

func (RebootWorkspacesRequest) Send 

func (r RebootWorkspacesRequest) Send() (*RebootWorkspacesOutput, error)

Send marshals and sends the RebootWorkspaces API request.

type RebuildRequest 

type RebuildRequest struct {

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

Contains information used with the RebuildWorkspaces operation to rebuild a WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildRequest

func (RebuildRequest) GoString 

func (s RebuildRequest) GoString() string

GoString returns the string representation

func (*RebuildRequest) SetWorkspaceId 

func (s *RebuildRequest) SetWorkspaceId(v string) *RebuildRequest

SetWorkspaceId sets the WorkspaceId field's value.

func (RebuildRequest) String 

func (s RebuildRequest) String() string

String returns the string representation

func (*RebuildRequest) Validate 

func (s *RebuildRequest) Validate() error

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

type RebuildWorkspacesInput 

type RebuildWorkspacesInput struct {

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

Contains the inputs for the RebuildWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspacesRequest

func (RebuildWorkspacesInput) GoString 

func (s RebuildWorkspacesInput) GoString() string

GoString returns the string representation

func (*RebuildWorkspacesInput) SetRebuildWorkspaceRequests 

func (s *RebuildWorkspacesInput) SetRebuildWorkspaceRequests(v []RebuildRequest) *RebuildWorkspacesInput

SetRebuildWorkspaceRequests sets the RebuildWorkspaceRequests field's value.

func (RebuildWorkspacesInput) String 

func (s RebuildWorkspacesInput) String() string

String returns the string representation

func (*RebuildWorkspacesInput) Validate 

func (s *RebuildWorkspacesInput) Validate() error

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

type RebuildWorkspacesOutput 

type RebuildWorkspacesOutput struct {

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

Contains the results of the RebuildWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspacesResult

func (RebuildWorkspacesOutput) GoString 

func (s RebuildWorkspacesOutput) GoString() string

GoString returns the string representation

func (RebuildWorkspacesOutput) SDKResponseMetadata 

func (s RebuildWorkspacesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*RebuildWorkspacesOutput) SetFailedRequests 

func (s *RebuildWorkspacesOutput) SetFailedRequests(v []FailedWorkspaceChangeRequest) *RebuildWorkspacesOutput

SetFailedRequests sets the FailedRequests field's value.

func (RebuildWorkspacesOutput) String 

func (s RebuildWorkspacesOutput) String() string

String returns the string representation

type RebuildWorkspacesRequest 

type RebuildWorkspacesRequest struct {
	*aws.Request
	Input *RebuildWorkspacesInput
}

RebuildWorkspacesRequest is a API request type for the RebuildWorkspaces API operation.

func (RebuildWorkspacesRequest) Send 

func (r RebuildWorkspacesRequest) Send() (*RebuildWorkspacesOutput, error)

Send marshals and sends the RebuildWorkspaces API request.

type RunningMode 

type RunningMode string
const (
	RunningModeAutoStop RunningMode = "AUTO_STOP"
	RunningModeAlwaysOn RunningMode = "ALWAYS_ON"
)

Enum values for RunningMode

type StartRequest 

type StartRequest struct {

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

Describes the start request. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartRequest

func (StartRequest) GoString 

func (s StartRequest) GoString() string

GoString returns the string representation

func (*StartRequest) SetWorkspaceId 

func (s *StartRequest) SetWorkspaceId(v string) *StartRequest

SetWorkspaceId sets the WorkspaceId field's value.

func (StartRequest) String 

func (s StartRequest) String() string

String returns the string representation

type StartWorkspacesInput 

type StartWorkspacesInput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspacesRequest

func (StartWorkspacesInput) GoString 

func (s StartWorkspacesInput) GoString() string

GoString returns the string representation

func (*StartWorkspacesInput) SetStartWorkspaceRequests 

func (s *StartWorkspacesInput) SetStartWorkspaceRequests(v []StartRequest) *StartWorkspacesInput

SetStartWorkspaceRequests sets the StartWorkspaceRequests field's value.

func (StartWorkspacesInput) String 

func (s StartWorkspacesInput) String() string

String returns the string representation

func (*StartWorkspacesInput) Validate 

func (s *StartWorkspacesInput) Validate() error

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

type StartWorkspacesOutput 

type StartWorkspacesOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspacesResult

func (StartWorkspacesOutput) GoString 

func (s StartWorkspacesOutput) GoString() string

GoString returns the string representation

func (StartWorkspacesOutput) SDKResponseMetadata 

func (s StartWorkspacesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*StartWorkspacesOutput) SetFailedRequests 

func (s *StartWorkspacesOutput) SetFailedRequests(v []FailedWorkspaceChangeRequest) *StartWorkspacesOutput

SetFailedRequests sets the FailedRequests field's value.

func (StartWorkspacesOutput) String 

func (s StartWorkspacesOutput) String() string

String returns the string representation

type StartWorkspacesRequest 

type StartWorkspacesRequest struct {
	*aws.Request
	Input *StartWorkspacesInput
}

StartWorkspacesRequest is a API request type for the StartWorkspaces API operation.

func (StartWorkspacesRequest) Send 

func (r StartWorkspacesRequest) Send() (*StartWorkspacesOutput, error)

Send marshals and sends the StartWorkspaces API request.

type StopRequest 

type StopRequest struct {

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

Describes the stop request. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopRequest

func (StopRequest) GoString 

func (s StopRequest) GoString() string

GoString returns the string representation

func (*StopRequest) SetWorkspaceId 

func (s *StopRequest) SetWorkspaceId(v string) *StopRequest

SetWorkspaceId sets the WorkspaceId field's value.

func (StopRequest) String 

func (s StopRequest) String() string

String returns the string representation

type StopWorkspacesInput 

type StopWorkspacesInput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspacesRequest

func (StopWorkspacesInput) GoString 

func (s StopWorkspacesInput) GoString() string

GoString returns the string representation

func (*StopWorkspacesInput) SetStopWorkspaceRequests 

func (s *StopWorkspacesInput) SetStopWorkspaceRequests(v []StopRequest) *StopWorkspacesInput

SetStopWorkspaceRequests sets the StopWorkspaceRequests field's value.

func (StopWorkspacesInput) String 

func (s StopWorkspacesInput) String() string

String returns the string representation

func (*StopWorkspacesInput) Validate 

func (s *StopWorkspacesInput) Validate() error

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

type StopWorkspacesOutput 

type StopWorkspacesOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspacesResult

func (StopWorkspacesOutput) GoString 

func (s StopWorkspacesOutput) GoString() string

GoString returns the string representation

func (StopWorkspacesOutput) SDKResponseMetadata 

func (s StopWorkspacesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*StopWorkspacesOutput) SetFailedRequests 

func (s *StopWorkspacesOutput) SetFailedRequests(v []FailedWorkspaceChangeRequest) *StopWorkspacesOutput

SetFailedRequests sets the FailedRequests field's value.

func (StopWorkspacesOutput) String 

func (s StopWorkspacesOutput) String() string

String returns the string representation

type StopWorkspacesRequest 

type StopWorkspacesRequest struct {
	*aws.Request
	Input *StopWorkspacesInput
}

StopWorkspacesRequest is a API request type for the StopWorkspaces API operation.

func (StopWorkspacesRequest) Send 

func (r StopWorkspacesRequest) Send() (*StopWorkspacesOutput, error)

Send marshals and sends the StopWorkspaces API request.

type Tag 

type Tag struct {

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

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

Describes the tag of the WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/Tag

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateRequest

func (TerminateRequest) GoString 

func (s TerminateRequest) GoString() string

GoString returns the string representation

func (*TerminateRequest) SetWorkspaceId 

func (s *TerminateRequest) SetWorkspaceId(v string) *TerminateRequest

SetWorkspaceId sets the WorkspaceId field's value.

func (TerminateRequest) String 

func (s TerminateRequest) String() string

String returns the string representation

func (*TerminateRequest) Validate 

func (s *TerminateRequest) Validate() error

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

type TerminateWorkspacesInput 

type TerminateWorkspacesInput struct {

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

Contains the inputs for the TerminateWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspacesRequest

func (TerminateWorkspacesInput) GoString 

func (s TerminateWorkspacesInput) GoString() string

GoString returns the string representation

func (*TerminateWorkspacesInput) SetTerminateWorkspaceRequests 

func (s *TerminateWorkspacesInput) SetTerminateWorkspaceRequests(v []TerminateRequest) *TerminateWorkspacesInput

SetTerminateWorkspaceRequests sets the TerminateWorkspaceRequests field's value.

func (TerminateWorkspacesInput) String 

func (s TerminateWorkspacesInput) String() string

String returns the string representation

func (*TerminateWorkspacesInput) Validate 

func (s *TerminateWorkspacesInput) Validate() error

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

type TerminateWorkspacesOutput 

type TerminateWorkspacesOutput struct {

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

Contains the results of the TerminateWorkspaces operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspacesResult

func (TerminateWorkspacesOutput) GoString 

func (s TerminateWorkspacesOutput) GoString() string

GoString returns the string representation

func (TerminateWorkspacesOutput) SDKResponseMetadata 

func (s TerminateWorkspacesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (*TerminateWorkspacesOutput) SetFailedRequests 

func (s *TerminateWorkspacesOutput) SetFailedRequests(v []FailedWorkspaceChangeRequest) *TerminateWorkspacesOutput

SetFailedRequests sets the FailedRequests field's value.

func (TerminateWorkspacesOutput) String 

func (s TerminateWorkspacesOutput) String() string

String returns the string representation

type TerminateWorkspacesRequest 

type TerminateWorkspacesRequest struct {
	*aws.Request
	Input *TerminateWorkspacesInput
}

TerminateWorkspacesRequest is a API request type for the TerminateWorkspaces API operation.

func (TerminateWorkspacesRequest) Send 

func (r TerminateWorkspacesRequest) Send() (*TerminateWorkspacesOutput, error)

Send marshals and sends the TerminateWorkspaces API request.

type UserStorage 

type UserStorage struct {

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

Contains information about the user storage for a WorkSpace bundle. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UserStorage

func (UserStorage) GoString 

func (s UserStorage) GoString() string

GoString returns the string representation

func (*UserStorage) SetCapacity 

func (s *UserStorage) SetCapacity(v string) *UserStorage

SetCapacity sets the Capacity field's value.

func (UserStorage) String 

func (s UserStorage) String() string

String returns the string representation

type WorkSpaces 

type WorkSpaces struct {
	*aws.Client
}

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(config aws.Config) *WorkSpaces

New creates a new instance of the WorkSpaces client with a config. 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 config.
svc := workspaces.New(myConfig)

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

func (*WorkSpaces) CreateTagsRequest 

func (c *WorkSpaces) CreateTagsRequest(input *CreateTagsInput) CreateTagsRequest

CreateTagsRequest returns a request value for making API operation for Amazon WorkSpaces.

Creates tags for a WorkSpace. 

// Example sending a request using the CreateTagsRequest method.
req := client.CreateTagsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTags

func (*WorkSpaces) CreateWorkspacesRequest 

func (c *WorkSpaces) CreateWorkspacesRequest(input *CreateWorkspacesInput) CreateWorkspacesRequest

CreateWorkspacesRequest returns a request value for making API operation for Amazon WorkSpaces.

Creates one or more WorkSpaces.

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

// Example sending a request using the CreateWorkspacesRequest method.
req := client.CreateWorkspacesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaces

func (*WorkSpaces) DeleteTagsRequest 

func (c *WorkSpaces) DeleteTagsRequest(input *DeleteTagsInput) DeleteTagsRequest

DeleteTagsRequest returns a request value for making API operation for Amazon WorkSpaces.

Deletes tags from a WorkSpace. 

// Example sending a request using the DeleteTagsRequest method.
req := client.DeleteTagsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTags

func (*WorkSpaces) DescribeTagsRequest 

func (c *WorkSpaces) DescribeTagsRequest(input *DescribeTagsInput) DescribeTagsRequest

DescribeTagsRequest returns a request value for making API operation for Amazon WorkSpaces.

Describes tags for a WorkSpace. 

// Example sending a request using the DescribeTagsRequest method.
req := client.DescribeTagsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTags

func (*WorkSpaces) DescribeWorkspaceBundlesPages 

func (c *WorkSpaces) DescribeWorkspaceBundlesPages(input *DescribeWorkspaceBundlesInput, fn func(*DescribeWorkspaceBundlesOutput, bool) bool) error

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

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

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

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

func (*WorkSpaces) DescribeWorkspaceBundlesPagesWithContext 

func (c *WorkSpaces) DescribeWorkspaceBundlesPagesWithContext(ctx aws.Context, input *DescribeWorkspaceBundlesInput, fn func(*DescribeWorkspaceBundlesOutput, bool) bool, opts ...aws.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) DescribeWorkspaceBundlesRequest

DescribeWorkspaceBundlesRequest returns a request value for making API operation for Amazon WorkSpaces.

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

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

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

// Example sending a request using the DescribeWorkspaceBundlesRequest method.
req := client.DescribeWorkspaceBundlesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundles

func (*WorkSpaces) DescribeWorkspaceDirectoriesPages 

func (c *WorkSpaces) DescribeWorkspaceDirectoriesPages(input *DescribeWorkspaceDirectoriesInput, fn func(*DescribeWorkspaceDirectoriesOutput, bool) bool) error

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

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

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

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

func (*WorkSpaces) DescribeWorkspaceDirectoriesPagesWithContext 

func (c *WorkSpaces) DescribeWorkspaceDirectoriesPagesWithContext(ctx aws.Context, input *DescribeWorkspaceDirectoriesInput, fn func(*DescribeWorkspaceDirectoriesOutput, bool) bool, opts ...aws.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) DescribeWorkspaceDirectoriesRequest

DescribeWorkspaceDirectoriesRequest returns a request value for making API operation for Amazon WorkSpaces.

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

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

// Example sending a request using the DescribeWorkspaceDirectoriesRequest method.
req := client.DescribeWorkspaceDirectoriesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories

func (*WorkSpaces) DescribeWorkspacesConnectionStatusRequest 

func (c *WorkSpaces) DescribeWorkspacesConnectionStatusRequest(input *DescribeWorkspacesConnectionStatusInput) DescribeWorkspacesConnectionStatusRequest

DescribeWorkspacesConnectionStatusRequest returns a request value for making API operation for Amazon WorkSpaces.

Describes the connection status of a specified WorkSpace. 

// Example sending a request using the DescribeWorkspacesConnectionStatusRequest method.
req := client.DescribeWorkspacesConnectionStatusRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus

func (*WorkSpaces) DescribeWorkspacesPages 

func (c *WorkSpaces) DescribeWorkspacesPages(input *DescribeWorkspacesInput, fn func(*DescribeWorkspacesOutput, bool) bool) error

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

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

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

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

func (*WorkSpaces) DescribeWorkspacesPagesWithContext 

func (c *WorkSpaces) DescribeWorkspacesPagesWithContext(ctx aws.Context, input *DescribeWorkspacesInput, fn func(*DescribeWorkspacesOutput, bool) bool, opts ...aws.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) DescribeWorkspacesRequest

DescribeWorkspacesRequest returns a request value for making API operation for Amazon WorkSpaces.

Obtains information about the specified WorkSpaces.

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

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

// Example sending a request using the DescribeWorkspacesRequest method.
req := client.DescribeWorkspacesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaces

func (*WorkSpaces) ModifyWorkspacePropertiesRequest 

func (c *WorkSpaces) ModifyWorkspacePropertiesRequest(input *ModifyWorkspacePropertiesInput) ModifyWorkspacePropertiesRequest

ModifyWorkspacePropertiesRequest returns a request value for making API operation for Amazon WorkSpaces.

Modifies the WorkSpace properties, including the running mode and AutoStop time. 

// Example sending a request using the ModifyWorkspacePropertiesRequest method.
req := client.ModifyWorkspacePropertiesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceProperties

func (*WorkSpaces) RebootWorkspacesRequest 

func (c *WorkSpaces) RebootWorkspacesRequest(input *RebootWorkspacesInput) RebootWorkspacesRequest

RebootWorkspacesRequest returns a request value for making API operation for Amazon WorkSpaces.

Reboots the specified WorkSpaces.

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

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

// Example sending a request using the RebootWorkspacesRequest method.
req := client.RebootWorkspacesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspaces

func (*WorkSpaces) RebuildWorkspacesRequest 

func (c *WorkSpaces) RebuildWorkspacesRequest(input *RebuildWorkspacesInput) RebuildWorkspacesRequest

RebuildWorkspacesRequest returns a request value for making API operation for Amazon WorkSpaces.

Rebuilds the specified WorkSpaces.

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

  • The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.

  • The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.

To be able to rebuild a WorkSpace, the WorkSpace must have a State of AVAILABLE or ERROR.

This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt. 

// Example sending a request using the RebuildWorkspacesRequest method.
req := client.RebuildWorkspacesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspaces

func (*WorkSpaces) StartWorkspacesRequest 

func (c *WorkSpaces) StartWorkspacesRequest(input *StartWorkspacesInput) StartWorkspacesRequest

StartWorkspacesRequest returns a request value for making API operation for Amazon WorkSpaces.

Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED. 

// Example sending a request using the StartWorkspacesRequest method.
req := client.StartWorkspacesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspaces

func (*WorkSpaces) StopWorkspacesRequest 

func (c *WorkSpaces) StopWorkspacesRequest(input *StopWorkspacesInput) StopWorkspacesRequest

StopWorkspacesRequest returns a request value for making API operation for Amazon WorkSpaces.

Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR. 

// Example sending a request using the StopWorkspacesRequest method.
req := client.StopWorkspacesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspaces

func (*WorkSpaces) TerminateWorkspacesRequest 

func (c *WorkSpaces) TerminateWorkspacesRequest(input *TerminateWorkspacesInput) TerminateWorkspacesRequest

TerminateWorkspacesRequest returns a request value for making API operation for Amazon WorkSpaces.

Terminates the specified WorkSpaces.

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

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

This operation is asynchronous and returns before the WorkSpaces have been completely terminated. 

// Example sending a request using the TerminateWorkspacesRequest method.
req := client.TerminateWorkspacesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspaces

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 WorkspaceState `type:"string" enum:"true"`

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

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

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

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

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

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

Contains information about a WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/Workspace

func (Workspace) GoString 

func (s Workspace) GoString() string

GoString returns the string representation

func (*Workspace) SetBundleId 

func (s *Workspace) SetBundleId(v string) *Workspace

SetBundleId sets the BundleId field's value.

func (*Workspace) SetComputerName 

func (s *Workspace) SetComputerName(v string) *Workspace

SetComputerName sets the ComputerName field's value.

func (*Workspace) SetDirectoryId 

func (s *Workspace) SetDirectoryId(v string) *Workspace

SetDirectoryId sets the DirectoryId field's value.

func (*Workspace) SetErrorCode 

func (s *Workspace) SetErrorCode(v string) *Workspace

SetErrorCode sets the ErrorCode field's value.

func (*Workspace) SetErrorMessage 

func (s *Workspace) SetErrorMessage(v string) *Workspace

SetErrorMessage sets the ErrorMessage field's value.

func (*Workspace) SetIpAddress 

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

SetIpAddress sets the IpAddress field's value.

func (*Workspace) SetRootVolumeEncryptionEnabled 

func (s *Workspace) SetRootVolumeEncryptionEnabled(v bool) *Workspace

SetRootVolumeEncryptionEnabled sets the RootVolumeEncryptionEnabled field's value.

func (*Workspace) SetState 

func (s *Workspace) SetState(v WorkspaceState) *Workspace

SetState sets the State field's value.

func (*Workspace) SetSubnetId 

func (s *Workspace) SetSubnetId(v string) *Workspace

SetSubnetId sets the SubnetId field's value.

func (*Workspace) SetUserName 

func (s *Workspace) SetUserName(v string) *Workspace

SetUserName sets the UserName field's value.

func (*Workspace) SetUserVolumeEncryptionEnabled 

func (s *Workspace) SetUserVolumeEncryptionEnabled(v bool) *Workspace

SetUserVolumeEncryptionEnabled sets the UserVolumeEncryptionEnabled field's value.

func (*Workspace) SetVolumeEncryptionKey 

func (s *Workspace) SetVolumeEncryptionKey(v string) *Workspace

SetVolumeEncryptionKey sets the VolumeEncryptionKey field's value.

func (*Workspace) SetWorkspaceId 

func (s *Workspace) SetWorkspaceId(v string) *Workspace

SetWorkspaceId sets the WorkspaceId field's value.

func (*Workspace) SetWorkspaceProperties 

func (s *Workspace) SetWorkspaceProperties(v *WorkspaceProperties) *Workspace

SetWorkspaceProperties sets the WorkspaceProperties field's value.

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceBundle

func (WorkspaceBundle) GoString 

func (s WorkspaceBundle) GoString() string

GoString returns the string representation

func (*WorkspaceBundle) SetBundleId 

func (s *WorkspaceBundle) SetBundleId(v string) *WorkspaceBundle

SetBundleId sets the BundleId field's value.

func (*WorkspaceBundle) SetComputeType 

func (s *WorkspaceBundle) SetComputeType(v *ComputeType) *WorkspaceBundle

SetComputeType sets the ComputeType field's value.

func (*WorkspaceBundle) SetDescription 

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

SetDescription sets the Description field's value.

func (*WorkspaceBundle) SetName 

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

SetName sets the Name field's value.

func (*WorkspaceBundle) SetOwner 

func (s *WorkspaceBundle) SetOwner(v string) *WorkspaceBundle

SetOwner sets the Owner field's value.

func (*WorkspaceBundle) SetUserStorage 

func (s *WorkspaceBundle) SetUserStorage(v *UserStorage) *WorkspaceBundle

SetUserStorage sets the UserStorage field's value.

func (WorkspaceBundle) String 

func (s WorkspaceBundle) String() string

String returns the string representation

type WorkspaceConnectionStatus 

type WorkspaceConnectionStatus struct {

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

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

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

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

Describes the connection status of a WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceConnectionStatus

func (WorkspaceConnectionStatus) GoString 

func (s WorkspaceConnectionStatus) GoString() string

GoString returns the string representation

func (*WorkspaceConnectionStatus) SetConnectionState 

func (s *WorkspaceConnectionStatus) SetConnectionState(v ConnectionState) *WorkspaceConnectionStatus

SetConnectionState sets the ConnectionState field's value.

func (*WorkspaceConnectionStatus) SetConnectionStateCheckTimestamp 

func (s *WorkspaceConnectionStatus) SetConnectionStateCheckTimestamp(v time.Time) *WorkspaceConnectionStatus

SetConnectionStateCheckTimestamp sets the ConnectionStateCheckTimestamp field's value.

func (*WorkspaceConnectionStatus) SetLastKnownUserConnectionTimestamp 

func (s *WorkspaceConnectionStatus) SetLastKnownUserConnectionTimestamp(v time.Time) *WorkspaceConnectionStatus

SetLastKnownUserConnectionTimestamp sets the LastKnownUserConnectionTimestamp field's value.

func (*WorkspaceConnectionStatus) SetWorkspaceId 

func (s *WorkspaceConnectionStatus) SetWorkspaceId(v string) *WorkspaceConnectionStatus

SetWorkspaceId sets the WorkspaceId field's value.

func (WorkspaceConnectionStatus) String 

func (s WorkspaceConnectionStatus) String() string

String returns the string representation

type WorkspaceDirectory 

type WorkspaceDirectory struct {

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

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

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

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

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

	// 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 WorkspaceDirectoryState `type:"string" enum:"true"`

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

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

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

Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceDirectory

func (WorkspaceDirectory) GoString 

func (s WorkspaceDirectory) GoString() string

GoString returns the string representation

func (*WorkspaceDirectory) SetAlias 

func (s *WorkspaceDirectory) SetAlias(v string) *WorkspaceDirectory

SetAlias sets the Alias field's value.

func (*WorkspaceDirectory) SetCustomerUserName 

func (s *WorkspaceDirectory) SetCustomerUserName(v string) *WorkspaceDirectory

SetCustomerUserName sets the CustomerUserName field's value.

func (*WorkspaceDirectory) SetDirectoryId 

func (s *WorkspaceDirectory) SetDirectoryId(v string) *WorkspaceDirectory

SetDirectoryId sets the DirectoryId field's value.

func (*WorkspaceDirectory) SetDirectoryName 

func (s *WorkspaceDirectory) SetDirectoryName(v string) *WorkspaceDirectory

SetDirectoryName sets the DirectoryName field's value.

func (*WorkspaceDirectory) SetDirectoryType 

func (s *WorkspaceDirectory) SetDirectoryType(v WorkspaceDirectoryType) *WorkspaceDirectory

SetDirectoryType sets the DirectoryType field's value.

func (*WorkspaceDirectory) SetDnsIpAddresses 

func (s *WorkspaceDirectory) SetDnsIpAddresses(v []string) *WorkspaceDirectory

SetDnsIpAddresses sets the DnsIpAddresses field's value.

func (*WorkspaceDirectory) SetIamRoleId 

func (s *WorkspaceDirectory) SetIamRoleId(v string) *WorkspaceDirectory

SetIamRoleId sets the IamRoleId field's value.

func (*WorkspaceDirectory) SetRegistrationCode 

func (s *WorkspaceDirectory) SetRegistrationCode(v string) *WorkspaceDirectory

SetRegistrationCode sets the RegistrationCode field's value.

func (*WorkspaceDirectory) SetState 

func (s *WorkspaceDirectory) SetState(v WorkspaceDirectoryState) *WorkspaceDirectory

SetState sets the State field's value.

func (*WorkspaceDirectory) SetSubnetIds 

func (s *WorkspaceDirectory) SetSubnetIds(v []string) *WorkspaceDirectory

SetSubnetIds sets the SubnetIds field's value.

func (*WorkspaceDirectory) SetWorkspaceCreationProperties 

func (s *WorkspaceDirectory) SetWorkspaceCreationProperties(v *DefaultWorkspaceCreationProperties) *WorkspaceDirectory

SetWorkspaceCreationProperties sets the WorkspaceCreationProperties field's value.

func (*WorkspaceDirectory) SetWorkspaceSecurityGroupId 

func (s *WorkspaceDirectory) SetWorkspaceSecurityGroupId(v string) *WorkspaceDirectory

SetWorkspaceSecurityGroupId sets the WorkspaceSecurityGroupId field's value.

func (WorkspaceDirectory) String 

func (s WorkspaceDirectory) String() string

String returns the string representation

type WorkspaceDirectoryState 

type WorkspaceDirectoryState string
const (
	WorkspaceDirectoryStateRegistering   WorkspaceDirectoryState = "REGISTERING"
	WorkspaceDirectoryStateRegistered    WorkspaceDirectoryState = "REGISTERED"
	WorkspaceDirectoryStateDeregistering WorkspaceDirectoryState = "DEREGISTERING"
	WorkspaceDirectoryStateDeregistered  WorkspaceDirectoryState = "DEREGISTERED"
	WorkspaceDirectoryStateError         WorkspaceDirectoryState = "ERROR"
)

Enum values for WorkspaceDirectoryState

type WorkspaceDirectoryType 

type WorkspaceDirectoryType string
const (
	WorkspaceDirectoryTypeSimpleAd    WorkspaceDirectoryType = "SIMPLE_AD"
	WorkspaceDirectoryTypeAdConnector WorkspaceDirectoryType = "AD_CONNECTOR"
)

Enum values for WorkspaceDirectoryType

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 RunningMode `type:"string" enum:"true"`

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

Describes the properties of a WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceProperties

func (WorkspaceProperties) GoString 

func (s WorkspaceProperties) GoString() string

GoString returns the string representation

func (*WorkspaceProperties) SetRunningMode 

func (s *WorkspaceProperties) SetRunningMode(v RunningMode) *WorkspaceProperties

SetRunningMode sets the RunningMode field's value.

func (*WorkspaceProperties) SetRunningModeAutoStopTimeoutInMinutes 

func (s *WorkspaceProperties) SetRunningModeAutoStopTimeoutInMinutes(v int64) *WorkspaceProperties

SetRunningModeAutoStopTimeoutInMinutes sets the RunningModeAutoStopTimeoutInMinutes field's value.

func (WorkspaceProperties) String 

func (s WorkspaceProperties) String() string

String returns the string representation

type WorkspaceRequest 

type WorkspaceRequest struct {

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

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

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

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

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

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

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

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

Contains information about a WorkSpace creation request. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceRequest

func (WorkspaceRequest) GoString 

func (s WorkspaceRequest) GoString() string

GoString returns the string representation

func (*WorkspaceRequest) SetBundleId 

func (s *WorkspaceRequest) SetBundleId(v string) *WorkspaceRequest

SetBundleId sets the BundleId field's value.

func (*WorkspaceRequest) SetDirectoryId 

func (s *WorkspaceRequest) SetDirectoryId(v string) *WorkspaceRequest

SetDirectoryId sets the DirectoryId field's value.

func (*WorkspaceRequest) SetRootVolumeEncryptionEnabled 

func (s *WorkspaceRequest) SetRootVolumeEncryptionEnabled(v bool) *WorkspaceRequest

SetRootVolumeEncryptionEnabled sets the RootVolumeEncryptionEnabled field's value.

func (*WorkspaceRequest) SetTags 

func (s *WorkspaceRequest) SetTags(v []Tag) *WorkspaceRequest

SetTags sets the Tags field's value.

func (*WorkspaceRequest) SetUserName 

func (s *WorkspaceRequest) SetUserName(v string) *WorkspaceRequest

SetUserName sets the UserName field's value.

func (*WorkspaceRequest) SetUserVolumeEncryptionEnabled 

func (s *WorkspaceRequest) SetUserVolumeEncryptionEnabled(v bool) *WorkspaceRequest

SetUserVolumeEncryptionEnabled sets the UserVolumeEncryptionEnabled field's value.

func (*WorkspaceRequest) SetVolumeEncryptionKey 

func (s *WorkspaceRequest) SetVolumeEncryptionKey(v string) *WorkspaceRequest

SetVolumeEncryptionKey sets the VolumeEncryptionKey field's value.

func (*WorkspaceRequest) SetWorkspaceProperties 

func (s *WorkspaceRequest) SetWorkspaceProperties(v *WorkspaceProperties) *WorkspaceRequest

SetWorkspaceProperties sets the WorkspaceProperties field's value.

func (WorkspaceRequest) String 

func (s WorkspaceRequest) String() string

String returns the string representation

func (*WorkspaceRequest) Validate 

func (s *WorkspaceRequest) Validate() error

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

type WorkspaceState 

type WorkspaceState string
const (
	WorkspaceStatePending     WorkspaceState = "PENDING"
	WorkspaceStateAvailable   WorkspaceState = "AVAILABLE"
	WorkspaceStateImpaired    WorkspaceState = "IMPAIRED"
	WorkspaceStateUnhealthy   WorkspaceState = "UNHEALTHY"
	WorkspaceStateRebooting   WorkspaceState = "REBOOTING"
	WorkspaceStateStarting    WorkspaceState = "STARTING"
	WorkspaceStateRebuilding  WorkspaceState = "REBUILDING"
	WorkspaceStateMaintenance WorkspaceState = "MAINTENANCE"
	WorkspaceStateTerminating WorkspaceState = "TERMINATING"
	WorkspaceStateTerminated  WorkspaceState = "TERMINATED"
	WorkspaceStateSuspended   WorkspaceState = "SUSPENDED"
	WorkspaceStateStopping    WorkspaceState = "STOPPING"
	WorkspaceStateStopped     WorkspaceState = "STOPPED"
	WorkspaceStateError       WorkspaceState = "ERROR"
)

Enum values for WorkspaceState

Source Files

View all Source files

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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.