types

package
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: Feb 10, 2021 License: Apache-2.0 Imports: 3 Imported by: 7

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string
}

The user is not authorized to access a resource.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AccessPropertyValue 

type AccessPropertyValue string
const (
	AccessPropertyValueAllow AccessPropertyValue = "ALLOW"
	AccessPropertyValueDeny  AccessPropertyValue = "DENY"
)

Enum values for AccessPropertyValue

func (AccessPropertyValue) Values added in v0.29.0 

func (AccessPropertyValue) Values() []AccessPropertyValue

Values returns all known values for AccessPropertyValue. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AccountModification 

type AccountModification struct {

	// The IP address range, specified as an IPv4 CIDR block, for the management
	// network interface used for the account.
	DedicatedTenancyManagementCidrRange *string

	// The status of BYOL (whether BYOL is being enabled or disabled).
	DedicatedTenancySupport DedicatedTenancySupportResultEnum

	// The error code that is returned if the configuration of BYOL cannot be modified.
	ErrorCode *string

	// The text of the error message that is returned if the configuration of BYOL
	// cannot be modified.
	ErrorMessage *string

	// The state of the modification to the configuration of BYOL.
	ModificationState DedicatedTenancyModificationStateEnum

	// The timestamp when the modification of the BYOL configuration was started.
	StartTime *time.Time
}

Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.

type Application added in v0.29.0 

type Application string
const (
	ApplicationMicrosoftOffice2016 Application = "Microsoft_Office_2016"
	ApplicationMicrosoftOffice2019 Application = "Microsoft_Office_2019"
)

Enum values for Application

func (Application) Values added in v0.29.0 

func (Application) Values() []Application

Values returns all known values for Application. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type AssociationStatus added in v0.29.0 

type AssociationStatus string
const (
	AssociationStatusNotAssociated               AssociationStatus = "NOT_ASSOCIATED"
	AssociationStatusAssociatedWithOwnerAccount  AssociationStatus = "ASSOCIATED_WITH_OWNER_ACCOUNT"
	AssociationStatusAssociatedWithSharedAccount AssociationStatus = "ASSOCIATED_WITH_SHARED_ACCOUNT"
	AssociationStatusPendingAssociation          AssociationStatus = "PENDING_ASSOCIATION"
	AssociationStatusPendingDisassociation       AssociationStatus = "PENDING_DISASSOCIATION"
)

Enum values for AssociationStatus

func (AssociationStatus) Values added in v0.29.0 

func (AssociationStatus) Values() []AssociationStatus

Values returns all known values for AssociationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ClientProperties 

type ClientProperties struct {

	// Specifies whether users can cache their credentials on the Amazon WorkSpaces
	// client. When enabled, users can choose to reconnect to their WorkSpaces without
	// re-entering their credentials.
	ReconnectEnabled ReconnectEnum
}

Describes an Amazon WorkSpaces client.

type ClientPropertiesResult 

type ClientPropertiesResult struct {

	// Information about the Amazon WorkSpaces client.
	ClientProperties *ClientProperties

	// The resource identifier, in the form of a directory ID.
	ResourceId *string
}

Information about the Amazon WorkSpaces client.

type Compute 

type Compute string
const (
	ComputeValue       Compute = "VALUE"
	ComputeStandard    Compute = "STANDARD"
	ComputePerformance Compute = "PERFORMANCE"
	ComputePower       Compute = "POWER"
	ComputeGraphics    Compute = "GRAPHICS"
	ComputePowerpro    Compute = "POWERPRO"
	ComputeGraphicspro Compute = "GRAPHICSPRO"
)

Enum values for Compute

func (Compute) Values added in v0.29.0 

func (Compute) Values() []Compute

Values returns all known values for Compute. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ComputeType 

type ComputeType struct {

	// The compute type.
	Name Compute
}

Describes the compute type.

type ConnectionAlias added in v0.29.0 

type ConnectionAlias struct {

	// The identifier of the connection alias.
	AliasId *string

	// The association status of the connection alias.
	Associations []ConnectionAliasAssociation

	// The connection string specified for the connection alias. The connection string
	// must be in the form of a fully qualified domain name (FQDN), such as
	// www.example.com.
	ConnectionString *string

	// The identifier of the AWS account that owns the connection alias.
	OwnerAccountId *string

	// The current state of the connection alias.
	State ConnectionAliasState
}

Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

type ConnectionAliasAssociation added in v0.29.0 

type ConnectionAliasAssociation struct {

	// The identifier of the AWS account that associated the connection alias with a
	// directory.
	AssociatedAccountId *string

	// The association status of the connection alias.
	AssociationStatus AssociationStatus

	// The identifier of the connection alias association. You use the connection
	// identifier in the DNS TXT record when you're configuring your DNS routing
	// policies.
	ConnectionIdentifier *string

	// The identifier of the directory associated with a connection alias.
	ResourceId *string
}

Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

type ConnectionAliasPermission added in v0.29.0 

type ConnectionAliasPermission struct {

	// Indicates whether the specified AWS account is allowed to associate the
	// connection alias with a directory.
	//
	// This member is required.
	AllowAssociation *bool

	// The identifier of the AWS account that the connection alias is shared with.
	//
	// This member is required.
	SharedAccountId *string
}

Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html).

type ConnectionAliasState added in v0.29.0 

type ConnectionAliasState string
const (
	ConnectionAliasStateCreating ConnectionAliasState = "CREATING"
	ConnectionAliasStateCreated  ConnectionAliasState = "CREATED"
	ConnectionAliasStateDeleting ConnectionAliasState = "DELETING"
)

Enum values for ConnectionAliasState

func (ConnectionAliasState) Values added in v0.29.0 

func (ConnectionAliasState) Values() []ConnectionAliasState

Values returns all known values for ConnectionAliasState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ConnectionState 

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

Enum values for ConnectionState

func (ConnectionState) Values added in v0.29.0 

func (ConnectionState) Values() []ConnectionState

Values returns all known values for ConnectionState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DedicatedTenancyModificationStateEnum 

type DedicatedTenancyModificationStateEnum string
const (
	DedicatedTenancyModificationStateEnumPending   DedicatedTenancyModificationStateEnum = "PENDING"
	DedicatedTenancyModificationStateEnumCompleted DedicatedTenancyModificationStateEnum = "COMPLETED"
	DedicatedTenancyModificationStateEnumFailed    DedicatedTenancyModificationStateEnum = "FAILED"
)

Enum values for DedicatedTenancyModificationStateEnum

func (DedicatedTenancyModificationStateEnum) Values added in v0.29.0 

func (DedicatedTenancyModificationStateEnum) Values() []DedicatedTenancyModificationStateEnum

Values returns all known values for DedicatedTenancyModificationStateEnum. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DedicatedTenancySupportEnum 

type DedicatedTenancySupportEnum string
const (
	DedicatedTenancySupportEnumEnabled DedicatedTenancySupportEnum = "ENABLED"
)

Enum values for DedicatedTenancySupportEnum

func (DedicatedTenancySupportEnum) Values added in v0.29.0 

func (DedicatedTenancySupportEnum) Values() []DedicatedTenancySupportEnum

Values returns all known values for DedicatedTenancySupportEnum. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DedicatedTenancySupportResultEnum 

type DedicatedTenancySupportResultEnum string
const (
	DedicatedTenancySupportResultEnumEnabled  DedicatedTenancySupportResultEnum = "ENABLED"
	DedicatedTenancySupportResultEnumDisabled DedicatedTenancySupportResultEnum = "DISABLED"
)

Enum values for DedicatedTenancySupportResultEnum

func (DedicatedTenancySupportResultEnum) Values added in v0.29.0 

func (DedicatedTenancySupportResultEnum) Values() []DedicatedTenancySupportResultEnum

Values returns all known values for DedicatedTenancySupportResultEnum. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DefaultWorkspaceCreationProperties 

type DefaultWorkspaceCreationProperties struct {

	// The identifier of the default security group to apply to WorkSpaces when they
	// are created. For more information, see  Security Groups for Your WorkSpaces
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-security-groups.html).
	CustomSecurityGroupId *string

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

	// Specifies whether to automatically assign an Elastic public IP address to
	// WorkSpaces in this directory by default. If enabled, the Elastic public IP
	// address allows outbound internet access from your WorkSpaces when you’re using
	// an internet gateway in the Amazon VPC in which your WorkSpaces are located. If
	// you're using a Network Address Translation (NAT) gateway for outbound internet
	// access from your VPC, or if your WorkSpaces are in public subnets and you
	// manually assign them Elastic IP addresses, you should disable this setting. This
	// setting applies to new WorkSpaces that you launch or to existing WorkSpaces that
	// you rebuild. For more information, see  Configure a VPC for Amazon WorkSpaces
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html).
	EnableInternetAccess *bool

	// Specifies whether maintenance mode is enabled for WorkSpaces. For more
	// information, see WorkSpace Maintenance
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html).
	EnableMaintenanceMode *bool

	// Specifies whether the directory is enabled for Amazon WorkDocs.
	EnableWorkDocs *bool

	// Specifies whether WorkSpace users are local administrators on their WorkSpaces.
	UserEnabledAsLocalAdministrator *bool
}

Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html).

type FailedCreateWorkspaceRequest 

type FailedCreateWorkspaceRequest struct {

	// The error code that is returned if the WorkSpace cannot be created.
	ErrorCode *string

	// The text of the error message that is returned if the WorkSpace cannot be
	// created.
	ErrorMessage *string

	// Information about the WorkSpace.
	WorkspaceRequest *WorkspaceRequest
}

Describes a WorkSpace that cannot be created.

type FailedWorkspaceChangeRequest 

type FailedWorkspaceChangeRequest struct {

	// The error code that is returned if the WorkSpace cannot be rebooted.
	ErrorCode *string

	// The text of the error message that is returned if the WorkSpace cannot be
	// rebooted.
	ErrorMessage *string

	// The identifier of the WorkSpace.
	WorkspaceId *string
}

Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

type ImagePermission 

type ImagePermission struct {

	// The identifier of the AWS account that an image has been shared with.
	SharedAccountId *string
}

Describes the AWS accounts that have been granted permission to use a shared image. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image (https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html).

type ImageType 

type ImageType string
const (
	ImageTypeOwned  ImageType = "OWNED"
	ImageTypeShared ImageType = "SHARED"
)

Enum values for ImageType

func (ImageType) Values added in v0.29.0 

func (ImageType) Values() []ImageType

Values returns all known values for ImageType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type InvalidParameterValuesException 

type InvalidParameterValuesException struct {
	Message *string
}

One or more parameter values are not valid.

func (*InvalidParameterValuesException) Error 

func (e *InvalidParameterValuesException) Error() string

func (*InvalidParameterValuesException) ErrorCode 

func (e *InvalidParameterValuesException) ErrorCode() string

func (*InvalidParameterValuesException) ErrorFault 

func (e *InvalidParameterValuesException) ErrorFault() smithy.ErrorFault

func (*InvalidParameterValuesException) ErrorMessage 

func (e *InvalidParameterValuesException) ErrorMessage() string

type InvalidResourceStateException 

type InvalidResourceStateException struct {
	Message *string
}

The state of the resource is not valid for this operation.

func (*InvalidResourceStateException) Error 

func (e *InvalidResourceStateException) Error() string

func (*InvalidResourceStateException) ErrorCode 

func (e *InvalidResourceStateException) ErrorCode() string

func (*InvalidResourceStateException) ErrorFault 

func (e *InvalidResourceStateException) ErrorFault() smithy.ErrorFault

func (*InvalidResourceStateException) ErrorMessage 

func (e *InvalidResourceStateException) ErrorMessage() string

type IpRuleItem 

type IpRuleItem struct {

	// The IP address range, in CIDR notation.
	IpRule *string

	// The description.
	RuleDesc *string
}

Describes a rule for an IP access control group.

type ModificationResourceEnum 

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

Enum values for ModificationResourceEnum

func (ModificationResourceEnum) Values added in v0.29.0 

func (ModificationResourceEnum) Values() []ModificationResourceEnum

Values returns all known values for ModificationResourceEnum. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ModificationState 

type ModificationState struct {

	// The resource.
	Resource ModificationResourceEnum

	// The modification state.
	State ModificationStateEnum
}

Describes a WorkSpace modification.

type ModificationStateEnum 

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

Enum values for ModificationStateEnum

func (ModificationStateEnum) Values added in v0.29.0 

func (ModificationStateEnum) Values() []ModificationStateEnum

Values returns all known values for ModificationStateEnum. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OperatingSystem 

type OperatingSystem struct {

	// The operating system.
	Type OperatingSystemType
}

The operating system that the image is running.

type OperatingSystemType 

type OperatingSystemType string
const (
	OperatingSystemTypeWindows OperatingSystemType = "WINDOWS"
	OperatingSystemTypeLinux   OperatingSystemType = "LINUX"
)

Enum values for OperatingSystemType

func (OperatingSystemType) Values added in v0.29.0 

func (OperatingSystemType) Values() []OperatingSystemType

Values returns all known values for OperatingSystemType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type OperationInProgressException 

type OperationInProgressException struct {
	Message *string
}

The properties of this WorkSpace are currently being modified. Try again in a moment.

func (*OperationInProgressException) Error 

func (e *OperationInProgressException) Error() string

func (*OperationInProgressException) ErrorCode 

func (e *OperationInProgressException) ErrorCode() string

func (*OperationInProgressException) ErrorFault 

func (e *OperationInProgressException) ErrorFault() smithy.ErrorFault

func (*OperationInProgressException) ErrorMessage 

func (e *OperationInProgressException) ErrorMessage() string

type OperationNotSupportedException 

type OperationNotSupportedException struct {
	Message *string
}

This operation is not supported.

func (*OperationNotSupportedException) Error 

func (e *OperationNotSupportedException) Error() string

func (*OperationNotSupportedException) ErrorCode 

func (e *OperationNotSupportedException) ErrorCode() string

func (*OperationNotSupportedException) ErrorFault 

func (e *OperationNotSupportedException) ErrorFault() smithy.ErrorFault

func (*OperationNotSupportedException) ErrorMessage 

func (e *OperationNotSupportedException) ErrorMessage() string

type RebootRequest 

type RebootRequest struct {

	// The identifier of the WorkSpace.
	//
	// This member is required.
	WorkspaceId *string
}

Describes the information used to reboot a WorkSpace.

type RebuildRequest 

type RebuildRequest struct {

	// The identifier of the WorkSpace.
	//
	// This member is required.
	WorkspaceId *string
}

Describes the information used to rebuild a WorkSpace.

type ReconnectEnum 

type ReconnectEnum string
const (
	ReconnectEnumEnabled  ReconnectEnum = "ENABLED"
	ReconnectEnumDisabled ReconnectEnum = "DISABLED"
)

Enum values for ReconnectEnum

func (ReconnectEnum) Values added in v0.29.0 

func (ReconnectEnum) Values() []ReconnectEnum

Values returns all known values for ReconnectEnum. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceAlreadyExistsException 

type ResourceAlreadyExistsException struct {
	Message *string
}

The specified resource already exists.

func (*ResourceAlreadyExistsException) Error 

func (e *ResourceAlreadyExistsException) Error() string

func (*ResourceAlreadyExistsException) ErrorCode 

func (e *ResourceAlreadyExistsException) ErrorCode() string

func (*ResourceAlreadyExistsException) ErrorFault 

func (e *ResourceAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*ResourceAlreadyExistsException) ErrorMessage 

func (e *ResourceAlreadyExistsException) ErrorMessage() string

type ResourceAssociatedException 

type ResourceAssociatedException struct {
	Message *string
}

The resource is associated with a directory.

func (*ResourceAssociatedException) Error 

func (e *ResourceAssociatedException) Error() string

func (*ResourceAssociatedException) ErrorCode 

func (e *ResourceAssociatedException) ErrorCode() string

func (*ResourceAssociatedException) ErrorFault 

func (e *ResourceAssociatedException) ErrorFault() smithy.ErrorFault

func (*ResourceAssociatedException) ErrorMessage 

func (e *ResourceAssociatedException) ErrorMessage() string

type ResourceCreationFailedException 

type ResourceCreationFailedException struct {
	Message *string
}

The resource could not be created.

func (*ResourceCreationFailedException) Error 

func (e *ResourceCreationFailedException) Error() string

func (*ResourceCreationFailedException) ErrorCode 

func (e *ResourceCreationFailedException) ErrorCode() string

func (*ResourceCreationFailedException) ErrorFault 

func (e *ResourceCreationFailedException) ErrorFault() smithy.ErrorFault

func (*ResourceCreationFailedException) ErrorMessage 

func (e *ResourceCreationFailedException) ErrorMessage() string

type ResourceLimitExceededException 

type ResourceLimitExceededException struct {
	Message *string
}

Your resource limits have been exceeded.

func (*ResourceLimitExceededException) Error 

func (e *ResourceLimitExceededException) Error() string

func (*ResourceLimitExceededException) ErrorCode 

func (e *ResourceLimitExceededException) ErrorCode() string

func (*ResourceLimitExceededException) ErrorFault 

func (e *ResourceLimitExceededException) ErrorFault() smithy.ErrorFault

func (*ResourceLimitExceededException) ErrorMessage 

func (e *ResourceLimitExceededException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ResourceId *string
}

The resource could not be found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceUnavailableException 

type ResourceUnavailableException struct {
	Message *string

	ResourceId *string
}

The specified resource is not available.

func (*ResourceUnavailableException) Error 

func (e *ResourceUnavailableException) Error() string

func (*ResourceUnavailableException) ErrorCode 

func (e *ResourceUnavailableException) ErrorCode() string

func (*ResourceUnavailableException) ErrorFault 

func (e *ResourceUnavailableException) ErrorFault() smithy.ErrorFault

func (*ResourceUnavailableException) ErrorMessage 

func (e *ResourceUnavailableException) ErrorMessage() string

type RootStorage 

type RootStorage struct {

	// The size of the root volume.
	Capacity *string
}

Describes the root volume for a WorkSpace bundle.

type RunningMode 

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

Enum values for RunningMode

func (RunningMode) Values added in v0.29.0 

func (RunningMode) Values() []RunningMode

Values returns all known values for RunningMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SelfservicePermissions 

type SelfservicePermissions struct {

	// Specifies whether users can change the compute type (bundle) for their
	// WorkSpace.
	ChangeComputeType ReconnectEnum

	// Specifies whether users can increase the volume size of the drives on their
	// WorkSpace.
	IncreaseVolumeSize ReconnectEnum

	// Specifies whether users can rebuild the operating system of a WorkSpace to its
	// original state.
	RebuildWorkspace ReconnectEnum

	// Specifies whether users can restart their WorkSpace.
	RestartWorkspace ReconnectEnum

	// Specifies whether users can switch the running mode of their WorkSpace.
	SwitchRunningMode ReconnectEnum
}

Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users (https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html).

type Snapshot 

type Snapshot struct {

	// The time when the snapshot was created.
	SnapshotTime *time.Time
}

Describes a snapshot.

type StartRequest 

type StartRequest struct {

	// The identifier of the WorkSpace.
	WorkspaceId *string
}

Information used to start a WorkSpace.

type StopRequest 

type StopRequest struct {

	// The identifier of the WorkSpace.
	WorkspaceId *string
}

Describes the information used to stop a WorkSpace.

type Tag 

type Tag struct {

	// The key of the tag.
	//
	// This member is required.
	Key *string

	// The value of the tag.
	Value *string
}

Describes a tag.

type TargetWorkspaceState 

type TargetWorkspaceState string
const (
	TargetWorkspaceStateAvailable        TargetWorkspaceState = "AVAILABLE"
	TargetWorkspaceStateAdminMaintenance TargetWorkspaceState = "ADMIN_MAINTENANCE"
)

Enum values for TargetWorkspaceState

func (TargetWorkspaceState) Values added in v0.29.0 

func (TargetWorkspaceState) Values() []TargetWorkspaceState

Values returns all known values for TargetWorkspaceState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Tenancy 

type Tenancy string
const (
	TenancyDedicated Tenancy = "DEDICATED"
	TenancyShared    Tenancy = "SHARED"
)

Enum values for Tenancy

func (Tenancy) Values added in v0.29.0 

func (Tenancy) Values() []Tenancy

Values returns all known values for Tenancy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type TerminateRequest 

type TerminateRequest struct {

	// The identifier of the WorkSpace.
	//
	// This member is required.
	WorkspaceId *string
}

Describes the information used to terminate a WorkSpace.

type UnsupportedNetworkConfigurationException 

type UnsupportedNetworkConfigurationException struct {
	Message *string
}

The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html).

func (*UnsupportedNetworkConfigurationException) Error 

func (e *UnsupportedNetworkConfigurationException) Error() string

func (*UnsupportedNetworkConfigurationException) ErrorCode 

func (e *UnsupportedNetworkConfigurationException) ErrorCode() string

func (*UnsupportedNetworkConfigurationException) ErrorFault 

func (e *UnsupportedNetworkConfigurationException) ErrorFault() smithy.ErrorFault

func (*UnsupportedNetworkConfigurationException) ErrorMessage 

func (e *UnsupportedNetworkConfigurationException) ErrorMessage() string

type UnsupportedWorkspaceConfigurationException 

type UnsupportedWorkspaceConfigurationException struct {
	Message *string
}

The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/required-service-components.html).

func (*UnsupportedWorkspaceConfigurationException) Error 

func (e *UnsupportedWorkspaceConfigurationException) Error() string

func (*UnsupportedWorkspaceConfigurationException) ErrorCode 

func (e *UnsupportedWorkspaceConfigurationException) ErrorCode() string

func (*UnsupportedWorkspaceConfigurationException) ErrorFault 

func (e *UnsupportedWorkspaceConfigurationException) ErrorFault() smithy.ErrorFault

func (*UnsupportedWorkspaceConfigurationException) ErrorMessage 

func (e *UnsupportedWorkspaceConfigurationException) ErrorMessage() string

type UserStorage 

type UserStorage struct {

	// The size of the user storage.
	Capacity *string
}

Describes the user storage for a WorkSpace bundle.

type Workspace 

type Workspace struct {

	// The identifier of the bundle used to create the WorkSpace.
	BundleId *string

	// The name of the WorkSpace, as seen by the operating system. The format of this
	// name varies. For more information, see  Launch a WorkSpace
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html).
	ComputerName *string

	// The identifier of the AWS Directory Service directory for the WorkSpace.
	DirectoryId *string

	// The error code that is returned if the WorkSpace cannot be created.
	ErrorCode *string

	// The text of the error message that is returned if the WorkSpace cannot be
	// created.
	ErrorMessage *string

	// The IP address of the WorkSpace.
	IpAddress *string

	// The modification states of the WorkSpace.
	ModificationStates []ModificationState

	// Indicates whether the data stored on the root volume is encrypted.
	RootVolumeEncryptionEnabled *bool

	// The operational state of the WorkSpace. After a WorkSpace is terminated, the
	// TERMINATED state is returned only briefly before the WorkSpace directory
	// metadata is cleaned up, so this state is rarely returned. To confirm that a
	// WorkSpace is terminated, check for the WorkSpace ID by using  DescribeWorkSpaces
	// (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html).
	// If the WorkSpace ID isn't returned, then the WorkSpace has been successfully
	// terminated.
	State WorkspaceState

	// The identifier of the subnet for the WorkSpace.
	SubnetId *string

	// The user for the WorkSpace.
	UserName *string

	// Indicates whether the data stored on the user volume is encrypted.
	UserVolumeEncryptionEnabled *bool

	// The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on
	// your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
	VolumeEncryptionKey *string

	// The identifier of the WorkSpace.
	WorkspaceId *string

	// The properties of the WorkSpace.
	WorkspaceProperties *WorkspaceProperties
}

Describes a WorkSpace.

type WorkspaceAccessProperties 

type WorkspaceAccessProperties struct {

	// Indicates whether users can use Android devices to access their WorkSpaces.
	DeviceTypeAndroid AccessPropertyValue

	// Indicates whether users can use Chromebooks to access their WorkSpaces.
	DeviceTypeChromeOs AccessPropertyValue

	// Indicates whether users can use iOS devices to access their WorkSpaces.
	DeviceTypeIos AccessPropertyValue

	// Indicates whether users can use macOS clients to access their WorkSpaces. To
	// restrict WorkSpaces access to trusted devices (also known as managed devices)
	// with valid certificates, specify a value of TRUST. For more information, see
	// Restrict WorkSpaces Access to Trusted Devices
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/trusted-devices.html).
	DeviceTypeOsx AccessPropertyValue

	// Indicates whether users can access their WorkSpaces through a web browser.
	DeviceTypeWeb AccessPropertyValue

	// Indicates whether users can use Windows clients to access their WorkSpaces. To
	// restrict WorkSpaces access to trusted devices (also known as managed devices)
	// with valid certificates, specify a value of TRUST. For more information, see
	// Restrict WorkSpaces Access to Trusted Devices
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/trusted-devices.html).
	DeviceTypeWindows AccessPropertyValue

	// Indicates whether users can use zero client devices to access their WorkSpaces.
	DeviceTypeZeroClient AccessPropertyValue
}

The device types and operating systems that can be used to access a WorkSpace. For more information, see Amazon WorkSpaces Client Network Requirements (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-network-requirements.html).

type WorkspaceBundle 

type WorkspaceBundle struct {

	// The bundle identifier.
	BundleId *string

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

	// A description.
	Description *string

	// The image identifier of the bundle.
	ImageId *string

	// The last time that the bundle was updated.
	LastUpdatedTime *time.Time

	// The name of the bundle.
	Name *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

	// The size of the root volume.
	RootStorage *RootStorage

	// The size of the user storage.
	UserStorage *UserStorage
}

Describes a WorkSpace bundle.

type WorkspaceConnectionStatus 

type WorkspaceConnectionStatus struct {

	// The connection state of the WorkSpace. The connection state is unknown if the
	// WorkSpace is stopped.
	ConnectionState ConnectionState

	// The timestamp of the connection status check.
	ConnectionStateCheckTimestamp *time.Time

	// The timestamp of the last known user connection.
	LastKnownUserConnectionTimestamp *time.Time

	// The identifier of the WorkSpace.
	WorkspaceId *string
}

Describes the connection status of a WorkSpace.

type WorkspaceCreationProperties 

type WorkspaceCreationProperties struct {

	// The identifier of your custom security group.
	CustomSecurityGroupId *string

	// The default organizational unit (OU) for your WorkSpaces directories. This
	// string must be the full Lightweight Directory Access Protocol (LDAP)
	// distinguished name for the target domain and OU. It must be in the form
	// "OU=value,DC=value,DC=value", where value is any string of characters, and the
	// number of domain components (DCs) is two or more. For example,
	// OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.
	//
	// * To avoid errors,
	// certain characters in the distinguished name must be escaped. For more
	// information, see  Distinguished Names
	// (https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names)
	// in the Microsoft documentation.
	//
	// * The API doesn't validate whether the OU
	// exists.
	DefaultOu *string

	// Indicates whether internet access is enabled for your WorkSpaces.
	EnableInternetAccess *bool

	// Indicates whether maintenance mode is enabled for your WorkSpaces. For more
	// information, see WorkSpace Maintenance
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html).
	EnableMaintenanceMode *bool

	// Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
	//
	// If WorkDocs
	// is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces
	// launched in the directory will not have WorkDocs enabled. However, WorkDocs
	// remains enabled for any existing WorkSpaces, unless you either disable users'
	// access to WorkDocs or you delete the WorkDocs site. To disable users' access to
	// WorkDocs, see Disabling Users
	// (https://docs.aws.amazon.com/workdocs/latest/adminguide/inactive-user.html) in
	// the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see
	// Deleting a Site
	// (https://docs.aws.amazon.com/workdocs/latest/adminguide/manage-sites.html) in
	// the Amazon WorkDocs Administration Guide. If you enable WorkDocs on a directory
	// that already has existing WorkSpaces, the existing WorkSpaces and any new
	// WorkSpaces that are launched in the directory will have WorkDocs enabled.
	EnableWorkDocs *bool

	// Indicates whether users are local administrators of their WorkSpaces.
	UserEnabledAsLocalAdministrator *bool
}

Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces (https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html).

type WorkspaceDirectory 

type WorkspaceDirectory struct {

	// The directory alias.
	Alias *string

	// The user name for the service account.
	CustomerUserName *string

	// The directory identifier.
	DirectoryId *string

	// The name of the directory.
	DirectoryName *string

	// The directory type.
	DirectoryType WorkspaceDirectoryType

	// The IP addresses of the DNS servers for the directory.
	DnsIpAddresses []string

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

	// The identifiers of the IP access control groups associated with the directory.
	IpGroupIds []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

	// The default self-service permissions for WorkSpaces in the directory.
	SelfservicePermissions *SelfservicePermissions

	// The state of the directory's registration with Amazon WorkSpaces. After a
	// directory is deregistered, the DEREGISTERED state is returned very briefly
	// before the directory metadata is cleaned up, so this state is rarely returned.
	// To confirm that a directory is deregistered, check for the directory ID by using
	// DescribeWorkspaceDirectories
	// (https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html).
	// If the directory ID isn't returned, then the directory has been successfully
	// deregistered.
	State WorkspaceDirectoryState

	// The identifiers of the subnets used with the directory.
	SubnetIds []string

	// Specifies whether the directory is dedicated or shared. To use Bring Your Own
	// License (BYOL), this value must be set to DEDICATED. For more information, see
	// Bring Your Own Windows Desktop Images
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html).
	Tenancy Tenancy

	// The devices and operating systems that users can use to access WorkSpaces.
	WorkspaceAccessProperties *WorkspaceAccessProperties

	// The default creation properties for all WorkSpaces in the directory.
	WorkspaceCreationProperties *DefaultWorkspaceCreationProperties

	// The identifier of the security group that is assigned to new WorkSpaces.
	WorkspaceSecurityGroupId *string
}

Describes a directory that is used with Amazon WorkSpaces.

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) Values added in v0.29.0 

func (WorkspaceDirectoryState) Values() []WorkspaceDirectoryState

Values returns all known values for WorkspaceDirectoryState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type WorkspaceDirectoryType 

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

Enum values for WorkspaceDirectoryType

func (WorkspaceDirectoryType) Values added in v0.29.0 

func (WorkspaceDirectoryType) Values() []WorkspaceDirectoryType

Values returns all known values for WorkspaceDirectoryType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type WorkspaceImage 

type WorkspaceImage struct {

	// The date when the image was created. If the image has been shared, the AWS
	// account that the image has been shared with sees the original creation date of
	// the image.
	Created *time.Time

	// The description of the image.
	Description *string

	// The error code that is returned for the image.
	ErrorCode *string

	// The text of the error message that is returned for the image.
	ErrorMessage *string

	// The identifier of the image.
	ImageId *string

	// The name of the image.
	Name *string

	// The operating system that the image is running.
	OperatingSystem *OperatingSystem

	// The identifier of the AWS account that owns the image.
	OwnerAccountId *string

	// Specifies whether the image is running on dedicated hardware. When Bring Your
	// Own License (BYOL) is enabled, this value is set to DEDICATED. For more
	// information, see Bring Your Own Windows Desktop Images
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html).
	RequiredTenancy WorkspaceImageRequiredTenancy

	// The status of the image.
	State WorkspaceImageState
}

Describes a WorkSpace image.

type WorkspaceImageIngestionProcess 

type WorkspaceImageIngestionProcess string
const (
	WorkspaceImageIngestionProcessByolRegular     WorkspaceImageIngestionProcess = "BYOL_REGULAR"
	WorkspaceImageIngestionProcessByolGraphics    WorkspaceImageIngestionProcess = "BYOL_GRAPHICS"
	WorkspaceImageIngestionProcessByolGraphicspro WorkspaceImageIngestionProcess = "BYOL_GRAPHICSPRO"
	WorkspaceImageIngestionProcessByolRegularWsp  WorkspaceImageIngestionProcess = "BYOL_REGULAR_WSP"
)

Enum values for WorkspaceImageIngestionProcess

func (WorkspaceImageIngestionProcess) Values added in v0.29.0 

func (WorkspaceImageIngestionProcess) Values() []WorkspaceImageIngestionProcess

Values returns all known values for WorkspaceImageIngestionProcess. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type WorkspaceImageRequiredTenancy 

type WorkspaceImageRequiredTenancy string
const (
	WorkspaceImageRequiredTenancyDefault   WorkspaceImageRequiredTenancy = "DEFAULT"
	WorkspaceImageRequiredTenancyDedicated WorkspaceImageRequiredTenancy = "DEDICATED"
)

Enum values for WorkspaceImageRequiredTenancy

func (WorkspaceImageRequiredTenancy) Values added in v0.29.0 

func (WorkspaceImageRequiredTenancy) Values() []WorkspaceImageRequiredTenancy

Values returns all known values for WorkspaceImageRequiredTenancy. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type WorkspaceImageState 

type WorkspaceImageState string
const (
	WorkspaceImageStateAvailable WorkspaceImageState = "AVAILABLE"
	WorkspaceImageStatePending   WorkspaceImageState = "PENDING"
	WorkspaceImageStateError     WorkspaceImageState = "ERROR"
)

Enum values for WorkspaceImageState

func (WorkspaceImageState) Values added in v0.29.0 

func (WorkspaceImageState) Values() []WorkspaceImageState

Values returns all known values for WorkspaceImageState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

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

	// The size of the root volume. For important information about how to modify the
	// size of the root and user volumes, see Modify a WorkSpace
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html).
	RootVolumeSizeGib *int32

	// The running mode. For more information, see Manage the WorkSpace Running Mode
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html).
	RunningMode RunningMode

	// The time after a user logs off when WorkSpaces are automatically stopped.
	// Configured in 60-minute intervals.
	RunningModeAutoStopTimeoutInMinutes *int32

	// The size of the user storage. For important information about how to modify the
	// size of the root and user volumes, see Modify a WorkSpace
	// (https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html).
	UserVolumeSizeGib *int32
}

Describes a WorkSpace.

type WorkspaceRequest 

type WorkspaceRequest struct {

	// The identifier of the bundle for the WorkSpace. You can use
	// DescribeWorkspaceBundles to list the available bundles.
	//
	// This member is required.
	BundleId *string

	// The identifier of the AWS Directory Service directory for the WorkSpace. You can
	// use DescribeWorkspaceDirectories to list the available directories.
	//
	// This member is required.
	DirectoryId *string

	// The user name of the user for the WorkSpace. This user name must exist in the
	// AWS Directory Service directory for the WorkSpace.
	//
	// This member is required.
	UserName *string

	// Indicates whether the data stored on the root volume is encrypted.
	RootVolumeEncryptionEnabled *bool

	// The tags for the WorkSpace.
	Tags []Tag

	// Indicates whether the data stored on the user volume is encrypted.
	UserVolumeEncryptionEnabled *bool

	// The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on
	// your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
	VolumeEncryptionKey *string

	// The WorkSpace properties.
	WorkspaceProperties *WorkspaceProperties
}

Describes the information used to create a WorkSpace.

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"
	WorkspaceStateRestoring        WorkspaceState = "RESTORING"
	WorkspaceStateMaintenance      WorkspaceState = "MAINTENANCE"
	WorkspaceStateAdminMaintenance WorkspaceState = "ADMIN_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) Values added in v0.29.0 

func (WorkspaceState) Values() []WorkspaceState

Values returns all known values for WorkspaceState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type WorkspacesDefaultRoleNotFoundException 

type WorkspacesDefaultRoleNotFoundException struct {
	Message *string
}

The workspaces_DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role (https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role).

func (*WorkspacesDefaultRoleNotFoundException) Error 

func (e *WorkspacesDefaultRoleNotFoundException) Error() string

func (*WorkspacesDefaultRoleNotFoundException) ErrorCode 

func (e *WorkspacesDefaultRoleNotFoundException) ErrorCode() string

func (*WorkspacesDefaultRoleNotFoundException) ErrorFault 

func (e *WorkspacesDefaultRoleNotFoundException) ErrorFault() smithy.ErrorFault

func (*WorkspacesDefaultRoleNotFoundException) ErrorMessage 

func (e *WorkspacesDefaultRoleNotFoundException) ErrorMessage() string

type WorkspacesIpGroup 

type WorkspacesIpGroup struct {

	// The description of the group.
	GroupDesc *string

	// The identifier of the group.
	GroupId *string

	// The name of the group.
	GroupName *string

	// The rules.
	UserRules []IpRuleItem
}

Describes an IP access control group.

Source Files

View all Source files

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.