workspaces

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Mar 8, 2018 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

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

Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows desktops for your users.

See https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08 for more information on this service.

See workspaces package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/workspaces/

Using the Client

To 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"
	ComputePower       Compute = "POWER"
	ComputeGraphics    Compute = "GRAPHICS"
)

Enum values for Compute

func (Compute) MarshalValue added in v0.3.0

func (enum Compute) MarshalValue() (string, error)

func (Compute) MarshalValueBuf added in v0.3.0

func (enum Compute) MarshalValueBuf(b []byte) ([]byte, error)

type ComputeType

type ComputeType struct {

	// The compute type.
	Name Compute `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Information about the compute type. 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) 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

func (ConnectionState) MarshalValue added in v0.3.0

func (enum ConnectionState) MarshalValue() (string, error)

func (ConnectionState) MarshalValueBuf added in v0.3.0

func (enum ConnectionState) MarshalValueBuf(b []byte) ([]byte, error)

type CreateTagsInput

type CreateTagsInput struct {

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

	// The tags. Each resource can have a maximum of 50 tags.
	//
	// Tags is a required field
	Tags []Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

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
	Copy  func(*CreateTagsInput) CreateTagsRequest
}

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

func (CreateTagsRequest) Send

Send marshals and sends the CreateTags API request.

type CreateWorkspacesInput

type CreateWorkspacesInput struct {

	// Information about the WorkSpaces to create.
	//
	// Workspaces is a required field
	Workspaces []WorkspaceRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

	// Information about the WorkSpaces that could not be created.
	FailedRequests []FailedCreateWorkspaceRequest `type:"list"`

	// Information about the WorkSpaces that were created.
	//
	// Because this operation is asynchronous, the identifier returned is not immediately
	// available for use with other operations. For example, if you call DescribeWorkspaces
	// before the WorkSpace is created, the information returned can be incomplete.
	PendingRequests []Workspace `type:"list"`
	// contains filtered or unexported fields
}

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

func (s CreateWorkspacesOutput) String() string

String returns the string representation

type CreateWorkspacesRequest

type CreateWorkspacesRequest struct {
	*aws.Request
	Input *CreateWorkspacesInput
	Copy  func(*CreateWorkspacesInput) CreateWorkspacesRequest
}

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

func (CreateWorkspacesRequest) Send

Send marshals and sends the CreateWorkspaces API request.

type DefaultWorkspaceCreationProperties

type DefaultWorkspaceCreationProperties struct {

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

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

	// The public IP address to attach to all WorkSpaces that are created or rebuilt.
	EnableInternetAccess *bool `type:"boolean"`

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

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

Information about defaults used to create a WorkSpace. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DefaultWorkspaceCreationProperties

func (DefaultWorkspaceCreationProperties) GoString

GoString returns the string representation

func (DefaultWorkspaceCreationProperties) String

String returns the string representation

type DeleteTagsInput

type DeleteTagsInput struct {

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

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

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

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
	Copy  func(*DeleteTagsInput) DeleteTagsRequest
}

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

func (DeleteTagsRequest) Send

Send marshals and sends the DeleteTags API request.

type DescribeTagsInput

type DescribeTagsInput struct {

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

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) 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 tags.
	TagList []Tag `type:"list"`
	// contains filtered or unexported fields
}

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

func (s DescribeTagsOutput) String() string

String returns the string representation

type DescribeTagsRequest

type DescribeTagsRequest struct {
	*aws.Request
	Input *DescribeTagsInput
	Copy  func(*DescribeTagsInput) DescribeTagsRequest
}

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

func (DescribeTagsRequest) Send

Send marshals and sends the DescribeTags API request.

type DescribeWorkspaceBundlesInput

type DescribeWorkspaceBundlesInput struct {

	// The IDs of the bundles. This parameter cannot be combined with any other
	// filter.
	BundleIds []string `min:"1" type:"list"`

	// The token for the next set of results. (You received this token from a previous
	// call.)
	NextToken *string `min:"1" type:"string"`

	// The owner of the bundles. This parameter cannot be combined with any other
	// filter.
	//
	// Specify AMAZON to describe the bundles provided by AWS or null to describe
	// the bundles that belong to your account.
	Owner *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (DescribeWorkspaceBundlesInput) GoString

GoString returns the string representation

func (DescribeWorkspaceBundlesInput) String

String returns the string representation

func (*DescribeWorkspaceBundlesInput) Validate

func (s *DescribeWorkspaceBundlesInput) Validate() error

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

type DescribeWorkspaceBundlesOutput

type DescribeWorkspaceBundlesOutput struct {

	// Information about the bundles.
	Bundles []WorkspaceBundle `type:"list"`

	// The token to use to retrieve the next set of results, or null if there are
	// no more results available. This token is valid for one day and must be used
	// within that time frame.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (DescribeWorkspaceBundlesOutput) GoString

GoString returns the string representation

func (DescribeWorkspaceBundlesOutput) SDKResponseMetadata

func (s DescribeWorkspaceBundlesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeWorkspaceBundlesOutput) String

String returns the string representation

type DescribeWorkspaceBundlesPager added in v0.3.0

type DescribeWorkspaceBundlesPager struct {
	aws.Pager
}

DescribeWorkspaceBundlesPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*DescribeWorkspaceBundlesPager) CurrentPage added in v0.3.0

type DescribeWorkspaceBundlesRequest

type DescribeWorkspaceBundlesRequest struct {
	*aws.Request
	Input *DescribeWorkspaceBundlesInput
	Copy  func(*DescribeWorkspaceBundlesInput) DescribeWorkspaceBundlesRequest
}

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

func (*DescribeWorkspaceBundlesRequest) Paginate added in v0.3.0

Paginate pages iterates over the pages of a DescribeWorkspaceBundlesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a DescribeWorkspaceBundles operation.
		req := client.DescribeWorkspaceBundlesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (DescribeWorkspaceBundlesRequest) Send

Send marshals and sends the DescribeWorkspaceBundles API request.

type DescribeWorkspaceDirectoriesInput

type DescribeWorkspaceDirectoriesInput struct {

	// The identifiers of the directories. If the value is null, all directories
	// are retrieved.
	DirectoryIds []string `min:"1" type:"list"`

	// The token for the next set of results. (You received this token from a previous
	// call.)
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (DescribeWorkspaceDirectoriesInput) GoString

GoString returns the string representation

func (DescribeWorkspaceDirectoriesInput) String

String returns the string representation

func (*DescribeWorkspaceDirectoriesInput) Validate

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

type DescribeWorkspaceDirectoriesOutput

type DescribeWorkspaceDirectoriesOutput struct {

	// Information about the directories.
	Directories []WorkspaceDirectory `type:"list"`

	// The token to use to retrieve the next set of results, or null if there are
	// no more results available. This token is valid for one day and must be used
	// within that time frame.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (DescribeWorkspaceDirectoriesOutput) GoString

GoString returns the string representation

func (DescribeWorkspaceDirectoriesOutput) SDKResponseMetadata

func (s DescribeWorkspaceDirectoriesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeWorkspaceDirectoriesOutput) String

String returns the string representation

type DescribeWorkspaceDirectoriesPager added in v0.3.0

type DescribeWorkspaceDirectoriesPager struct {
	aws.Pager
}

DescribeWorkspaceDirectoriesPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*DescribeWorkspaceDirectoriesPager) CurrentPage added in v0.3.0

type DescribeWorkspaceDirectoriesRequest

type DescribeWorkspaceDirectoriesRequest struct {
	*aws.Request
	Input *DescribeWorkspaceDirectoriesInput
	Copy  func(*DescribeWorkspaceDirectoriesInput) DescribeWorkspaceDirectoriesRequest
}

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

func (*DescribeWorkspaceDirectoriesRequest) Paginate added in v0.3.0

Paginate pages iterates over the pages of a DescribeWorkspaceDirectoriesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a DescribeWorkspaceDirectories operation.
		req := client.DescribeWorkspaceDirectoriesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (DescribeWorkspaceDirectoriesRequest) Send

Send marshals and sends the DescribeWorkspaceDirectories API request.

type DescribeWorkspacesConnectionStatusInput

type DescribeWorkspacesConnectionStatusInput struct {

	// The token for the next set of results. (You received this token from a previous
	// call.)
	NextToken *string `min:"1" type:"string"`

	// The identifiers of the WorkSpaces.
	WorkspaceIds []string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

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

func (DescribeWorkspacesConnectionStatusInput) GoString

GoString returns the string representation

func (DescribeWorkspacesConnectionStatusInput) String

String returns the string representation

func (*DescribeWorkspacesConnectionStatusInput) Validate

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

type DescribeWorkspacesConnectionStatusOutput

type DescribeWorkspacesConnectionStatusOutput struct {

	// The token to use to retrieve the next set of results, or null if there are
	// no more results available.
	NextToken *string `min:"1" type:"string"`

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

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

func (DescribeWorkspacesConnectionStatusOutput) GoString

GoString returns the string representation

func (DescribeWorkspacesConnectionStatusOutput) SDKResponseMetadata

func (s DescribeWorkspacesConnectionStatusOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeWorkspacesConnectionStatusOutput) String

String returns the string representation

type DescribeWorkspacesConnectionStatusRequest

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

func (DescribeWorkspacesConnectionStatusRequest) Send

Send marshals and sends the DescribeWorkspacesConnectionStatus API request.

type DescribeWorkspacesInput

type DescribeWorkspacesInput struct {

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

	// The ID of the directory. In addition, you can optionally specify a specific
	// directory user (see UserName). This parameter cannot be combined with any
	// other filter.
	DirectoryId *string `type:"string"`

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

	// The token for the next set of results. (You received this token from a previous
	// call.)
	NextToken *string `min:"1" type:"string"`

	// The name of the directory user. You must specify this parameter with DirectoryId.
	UserName *string `min:"1" type:"string"`

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

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

	// The token to use to retrieve the next set of results, or null if there are
	// no more results available. This token is valid for one day and must be used
	// within that time frame.
	NextToken *string `min:"1" type:"string"`

	// Information about the WorkSpaces.
	//
	// Because CreateWorkspaces is an asynchronous operation, some of the returned
	// information could be incomplete.
	Workspaces []Workspace `type:"list"`
	// contains filtered or unexported fields
}

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

func (s DescribeWorkspacesOutput) String() string

String returns the string representation

type DescribeWorkspacesPager added in v0.3.0

type DescribeWorkspacesPager struct {
	aws.Pager
}

DescribeWorkspacesPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*DescribeWorkspacesPager) CurrentPage added in v0.3.0

type DescribeWorkspacesRequest

type DescribeWorkspacesRequest struct {
	*aws.Request
	Input *DescribeWorkspacesInput
	Copy  func(*DescribeWorkspacesInput) DescribeWorkspacesRequest
}

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

func (*DescribeWorkspacesRequest) Paginate added in v0.3.0

Paginate pages iterates over the pages of a DescribeWorkspacesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

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

   // Example iterating over at most 3 pages of a DescribeWorkspaces operation.
		req := client.DescribeWorkspacesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (DescribeWorkspacesRequest) Send

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

	// Information about the WorkSpace.
	WorkspaceRequest *WorkspaceRequest `type:"structure"`
	// contains filtered or unexported fields
}

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

String returns the string representation

type FailedWorkspaceChangeRequest

type FailedWorkspaceChangeRequest struct {

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

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

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

Information about a WorkSpace that could not be rebooted (RebootWorkspaces), rebuilt (RebuildWorkspaces), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces). 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) String

String returns the string representation

type ModificationResourceEnum added in v0.2.0

type ModificationResourceEnum string
const (
	ModificationResourceEnumRootVolume  ModificationResourceEnum = "ROOT_VOLUME"
	ModificationResourceEnumUserVolume  ModificationResourceEnum = "USER_VOLUME"
	ModificationResourceEnumComputeType ModificationResourceEnum = "COMPUTE_TYPE"
)

Enum values for ModificationResourceEnum

func (ModificationResourceEnum) MarshalValue added in v0.3.0

func (enum ModificationResourceEnum) MarshalValue() (string, error)

func (ModificationResourceEnum) MarshalValueBuf added in v0.3.0

func (enum ModificationResourceEnum) MarshalValueBuf(b []byte) ([]byte, error)

type ModificationState added in v0.2.0

type ModificationState struct {

	// The resource.
	Resource ModificationResourceEnum `type:"string" enum:"true"`

	// The modification state.
	State ModificationStateEnum `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Information about a WorkSpace modification. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModificationState

func (ModificationState) GoString added in v0.2.0

func (s ModificationState) GoString() string

GoString returns the string representation

func (ModificationState) String added in v0.2.0

func (s ModificationState) String() string

String returns the string representation

type ModificationStateEnum added in v0.2.0

type ModificationStateEnum string
const (
	ModificationStateEnumUpdateInitiated  ModificationStateEnum = "UPDATE_INITIATED"
	ModificationStateEnumUpdateInProgress ModificationStateEnum = "UPDATE_IN_PROGRESS"
)

Enum values for ModificationStateEnum

func (ModificationStateEnum) MarshalValue added in v0.3.0

func (enum ModificationStateEnum) MarshalValue() (string, error)

func (ModificationStateEnum) MarshalValueBuf added in v0.3.0

func (enum ModificationStateEnum) MarshalValueBuf(b []byte) ([]byte, error)

type ModifyWorkspacePropertiesInput

type ModifyWorkspacePropertiesInput struct {

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

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

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

func (ModifyWorkspacePropertiesInput) GoString

GoString returns the string representation

func (ModifyWorkspacePropertiesInput) String

String returns the string representation

func (*ModifyWorkspacePropertiesInput) Validate

func (s *ModifyWorkspacePropertiesInput) Validate() error

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

type ModifyWorkspacePropertiesOutput

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

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

func (ModifyWorkspacePropertiesOutput) GoString

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

String returns the string representation

type ModifyWorkspacePropertiesRequest

type ModifyWorkspacePropertiesRequest struct {
	*aws.Request
	Input *ModifyWorkspacePropertiesInput
	Copy  func(*ModifyWorkspacePropertiesInput) ModifyWorkspacePropertiesRequest
}

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

func (ModifyWorkspacePropertiesRequest) Send

Send marshals and sends the ModifyWorkspaceProperties API request.

type RebootRequest

type RebootRequest struct {

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

Information used to reboot a WorkSpace. 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) 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 {

	// The WorkSpaces to reboot.
	//
	// RebootWorkspaceRequests is a required field
	RebootWorkspaceRequests []RebootRequest `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/RebootWorkspacesRequest

func (RebootWorkspacesInput) GoString

func (s RebootWorkspacesInput) GoString() string

GoString returns the string representation

func (RebootWorkspacesInput) String

func (s RebootWorkspacesInput) String() string

String returns the string representation

func (*RebootWorkspacesInput) Validate

func (s *RebootWorkspacesInput) Validate() error

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

type RebootWorkspacesOutput

type RebootWorkspacesOutput struct {

	// Information about the WorkSpaces that could not be rebooted.
	FailedRequests []FailedWorkspaceChangeRequest `type:"list"`
	// contains filtered or unexported fields
}

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

func (s RebootWorkspacesOutput) String() string

String returns the string representation

type RebootWorkspacesRequest

type RebootWorkspacesRequest struct {
	*aws.Request
	Input *RebootWorkspacesInput
	Copy  func(*RebootWorkspacesInput) RebootWorkspacesRequest
}

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

func (RebootWorkspacesRequest) Send

Send marshals and sends the RebootWorkspaces API request.

type RebuildRequest

type RebuildRequest struct {

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

Information used to rebuild a WorkSpace. 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) 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 {

	// The WorkSpaces to rebuild.
	//
	// RebuildWorkspaceRequests is a required field
	RebuildWorkspaceRequests []RebuildRequest `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/RebuildWorkspacesRequest

func (RebuildWorkspacesInput) GoString

func (s RebuildWorkspacesInput) GoString() string

GoString returns the string representation

func (RebuildWorkspacesInput) String

func (s RebuildWorkspacesInput) String() string

String returns the string representation

func (*RebuildWorkspacesInput) Validate

func (s *RebuildWorkspacesInput) Validate() error

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

type RebuildWorkspacesOutput

type RebuildWorkspacesOutput struct {

	// Information about the WorkSpaces that could not be rebuilt.
	FailedRequests []FailedWorkspaceChangeRequest `type:"list"`
	// contains filtered or unexported fields
}

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

func (s RebuildWorkspacesOutput) String() string

String returns the string representation

type RebuildWorkspacesRequest

type RebuildWorkspacesRequest struct {
	*aws.Request
	Input *RebuildWorkspacesInput
	Copy  func(*RebuildWorkspacesInput) RebuildWorkspacesRequest
}

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

func (RebuildWorkspacesRequest) Send

Send marshals and sends the RebuildWorkspaces API request.

type RootStorage added in v0.2.0

type RootStorage struct {

	// The size of the root volume.
	Capacity *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Information about the root volume for a WorkSpace bundle. Please also see https://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RootStorage

func (RootStorage) GoString added in v0.2.0

func (s RootStorage) GoString() string

GoString returns the string representation

func (RootStorage) String added in v0.2.0

func (s RootStorage) String() string

String returns the string representation

type RunningMode

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

Enum values for RunningMode

func (RunningMode) MarshalValue added in v0.3.0

func (enum RunningMode) MarshalValue() (string, error)

func (RunningMode) MarshalValueBuf added in v0.3.0

func (enum RunningMode) MarshalValueBuf(b []byte) ([]byte, error)

type StartRequest

type StartRequest struct {

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

Information used to start a WorkSpace. 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) String

func (s StartRequest) String() string

String returns the string representation

type StartWorkspacesInput

type StartWorkspacesInput struct {

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

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

	// Information about the WorkSpaces that could not be started.
	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) String

func (s StartWorkspacesOutput) String() string

String returns the string representation

type StartWorkspacesRequest

type StartWorkspacesRequest struct {
	*aws.Request
	Input *StartWorkspacesInput
	Copy  func(*StartWorkspacesInput) StartWorkspacesRequest
}

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

func (StartWorkspacesRequest) Send

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
}

Information used to stop a WorkSpace. 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) String

func (s StopRequest) String() string

String returns the string representation

type StopWorkspacesInput

type StopWorkspacesInput struct {

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

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

	// Information about the WorkSpaces that could not be stopped.
	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) String

func (s StopWorkspacesOutput) String() string

String returns the string representation

type StopWorkspacesRequest

type StopWorkspacesRequest struct {
	*aws.Request
	Input *StopWorkspacesInput
	Copy  func(*StopWorkspacesInput) StopWorkspacesRequest
}

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

func (StopWorkspacesRequest) Send

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
}

Information about a tag. 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) 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.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Information used 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) 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 {

	// The WorkSpaces to terminate.
	//
	// TerminateWorkspaceRequests is a required field
	TerminateWorkspaceRequests []TerminateRequest `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/TerminateWorkspacesRequest

func (TerminateWorkspacesInput) GoString

func (s TerminateWorkspacesInput) GoString() string

GoString returns the string representation

func (TerminateWorkspacesInput) String

func (s TerminateWorkspacesInput) String() string

String returns the string representation

func (*TerminateWorkspacesInput) Validate

func (s *TerminateWorkspacesInput) Validate() error

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

type TerminateWorkspacesOutput

type TerminateWorkspacesOutput struct {

	// Information about the WorkSpaces that could not be terminated.
	FailedRequests []FailedWorkspaceChangeRequest `type:"list"`
	// contains filtered or unexported fields
}

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

func (s TerminateWorkspacesOutput) String() string

String returns the string representation

type TerminateWorkspacesRequest

type TerminateWorkspacesRequest struct {
	*aws.Request
	Input *TerminateWorkspacesInput
	Copy  func(*TerminateWorkspacesInput) TerminateWorkspacesRequest
}

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

func (TerminateWorkspacesRequest) Send

Send marshals and sends the TerminateWorkspaces API request.

type UserStorage

type UserStorage struct {

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

Information about the user storage for a WorkSpace bundle. 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) 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.

Example:

// Create a WorkSpaces client from just a config.
svc := workspaces.New(myConfig)

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 the specified 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 the specified 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 the tags for the specified 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) DescribeWorkspaceBundlesRequest

func (c *WorkSpaces) DescribeWorkspaceBundlesRequest(input *DescribeWorkspaceBundlesInput) DescribeWorkspaceBundlesRequest

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

Describes the available WorkSpace bundles.

You can filter the results using either bundle ID or owner, but not both.

// 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) DescribeWorkspaceDirectoriesRequest

func (c *WorkSpaces) DescribeWorkspaceDirectoriesRequest(input *DescribeWorkspaceDirectoriesInput) DescribeWorkspaceDirectoriesRequest

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

Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.

// 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 the specified WorkSpaces.

// 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) DescribeWorkspacesRequest

func (c *WorkSpaces) DescribeWorkspacesRequest(input *DescribeWorkspacesInput) DescribeWorkspacesRequest

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

Describes the specified WorkSpaces.

You can filter the results using bundle ID, directory ID, or owner, but you can specify only one filter at a time.

// 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 specified WorkSpace properties.

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

You cannot reboot a WorkSpace unless its state is 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.

You cannot rebuild a WorkSpace unless its state is AVAILABLE or ERROR.

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace (http://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html).

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

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

You cannot start a WorkSpace unless it has 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.

You cannot stop a WorkSpace unless it has 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 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 used to create the WorkSpace.
	BundleId *string `type:"string"`

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

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

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

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

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

	// The modification states of the WorkSpace.
	ModificationStates []ModificationState `type:"list"`

	// Indicates whether the data stored on the root volume is encrypted.
	RootVolumeEncryptionEnabled *bool `type:"boolean"`

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

	// The identifier of the subnet for the WorkSpace.
	SubnetId *string `type:"string"`

	// The user for the WorkSpace.
	UserName *string `min:"1" type:"string"`

	// Indicates whether the data stored on the user volume is encrypted.
	UserVolumeEncryptionEnabled *bool `type:"boolean"`

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

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

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

Information about a WorkSpace. 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) String

func (s Workspace) String() string

String returns the string representation

type WorkspaceBundle

type WorkspaceBundle struct {

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

	// The compute type. For more information, see Amazon WorkSpaces Bundles (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles).
	ComputeType *ComputeType `type:"structure"`

	// A description.
	Description *string `type:"string"`

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

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

	// The size of the root volume.
	RootStorage *RootStorage `type:"structure"`

	// The size of the user storage.
	UserStorage *UserStorage `type:"structure"`
	// contains filtered or unexported fields
}

Information about a WorkSpace bundle. 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) String

func (s WorkspaceBundle) String() string

String returns the string representation

type WorkspaceConnectionStatus

type WorkspaceConnectionStatus struct {

	// The connection state of the WorkSpace. The connection state is unknown if
	// the WorkSpace is stopped.
	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) 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"`

	// 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"`

	// The identifiers of the subnets used with the directory.
	SubnetIds []string `type:"list"`

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

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

Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces. 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) 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

func (WorkspaceDirectoryState) MarshalValue added in v0.3.0

func (enum WorkspaceDirectoryState) MarshalValue() (string, error)

func (WorkspaceDirectoryState) MarshalValueBuf added in v0.3.0

func (enum WorkspaceDirectoryState) MarshalValueBuf(b []byte) ([]byte, error)

type WorkspaceDirectoryType

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

Enum values for WorkspaceDirectoryType

func (WorkspaceDirectoryType) MarshalValue added in v0.3.0

func (enum WorkspaceDirectoryType) MarshalValue() (string, error)

func (WorkspaceDirectoryType) MarshalValueBuf added in v0.3.0

func (enum WorkspaceDirectoryType) MarshalValueBuf(b []byte) ([]byte, error)

type WorkspaceProperties

type WorkspaceProperties struct {

	// The compute type. For more information, see Amazon WorkSpaces Bundles (http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles).
	ComputeTypeName Compute `type:"string" enum:"true"`

	// The size of the root volume.
	RootVolumeSizeGib *int64 `type:"integer"`

	// The running mode. For more information, see Manage the WorkSpace Running
	// Mode (http://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html).
	RunningMode 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"`

	// The size of the user storage.
	UserVolumeSizeGib *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Information about 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) String

func (s WorkspaceProperties) String() string

String returns the string representation

type WorkspaceRequest

type WorkspaceRequest struct {

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

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

	// Indicates whether the data stored on the root volume is encrypted.
	RootVolumeEncryptionEnabled *bool `type:"boolean"`

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

	// The username of the user for the WorkSpace. This username must exist in the
	// AWS Directory Service directory for the WorkSpace.
	//
	// UserName is a required field
	UserName *string `min:"1" type:"string" required:"true"`

	// Indicates whether the data stored on the user volume is encrypted.
	UserVolumeEncryptionEnabled *bool `type:"boolean"`

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

	// The WorkSpace properties.
	WorkspaceProperties *WorkspaceProperties `type:"structure"`
	// contains filtered or unexported fields
}

Information used to create a WorkSpace. 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) 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"
	WorkspaceStateUpdating    WorkspaceState = "UPDATING"
	WorkspaceStateStopping    WorkspaceState = "STOPPING"
	WorkspaceStateStopped     WorkspaceState = "STOPPED"
	WorkspaceStateError       WorkspaceState = "ERROR"
)

Enum values for WorkspaceState

func (WorkspaceState) MarshalValue added in v0.3.0

func (enum WorkspaceState) MarshalValue() (string, error)

func (WorkspaceState) MarshalValueBuf added in v0.3.0

func (enum WorkspaceState) MarshalValueBuf(b []byte) ([]byte, error)

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